Class: Zernio::WebhookPayloadMessageMessageAttachmentsInner

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

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



73
74
75
76
77
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
 
# File 'lib/zernio-sdk/models/webhook_payload_message_message_attachments_inner.rb', line 73

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

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

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

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

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

Instance Attribute Details

#mime_type ⇒ Object

MIME type of the media when Zernio knows it. On Instagram and Facebook it is set for shares resolved by content type (originalType: \"unsupported_type\").



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

def mime_type
  @mime_type
end

#original_type ⇒ Object

Instagram and Facebook only, and present only when it differs from type. Meta's own attachment type before Zernio normalized it: ig_reel and reel become video, while ig_post, post, ig_story and story_mention all become share. Read it before rendering, because type: \"share\" alone is ambiguous. In particular a story mention arrives as type: \"share\" with originalType: \"story_mention\"; treating an unrecognized type as a generic document shows your agent "document received" for what is usually a lead. originalType: \"unsupported_type\" marks a share Meta did not classify, resolved by content type. Download it on receipt: Meta answers is_unsupported with no attachments when the message node is read back, so the attachment-resolve endpoint cannot re-mint this url once it expires.



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

def original_type
  @original_type
end

#payload ⇒ Object

Additional attachment metadata



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

def payload
  @payload
end

#type ⇒ Object

Attachment type (image, video, file, sticker, audio, share). Instagram and Facebook deliver a shared reel, post or ad with no type of its own (Meta's unsupported_type). Zernio resolves it from the media's Content-Type at ingest, so it arrives as image, video, audio or file with originalType: \"unsupported_type\". type: \"unsupported_type\" itself is emitted only when the CDN could not be classified in time; the url still works.



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

def type
  @type
end

#url ⇒ Object

Where to fetch the attachment. The contract differs by platform. - WhatsApp: points at GET /v1/whatsapp/media/{mediaId}, an authenticated Zernio endpoint. You MUST send Authorization: Bearer <your API key>; fetching it without that header returns 401. Download and store the bytes when this webhook arrives: Meta drops inbound media after a limited retention window, after which the endpoint answers 400 permanently and the media is unrecoverable. - Instagram / Facebook / Telegram: a direct platform CDN link that needs no authentication and expires on the platform's own schedule. Webhook attachments carry no refreshUrl. That field is stamped only when you read a message back over REST (GET /v1/inbox/conversations/{conversationId}/messages). On Instagram and Facebook the url above is a signed Meta CDN link that expires, so do not persist it: store the message id and resolve the media through GET /v1/inbox/conversations/{conversationId}/messages/{messageId}/attachments/{index}?accountId={accountId}, which re-mints it on demand. Every value that URL needs is already in this payload: message.conversationId, message.platformMessageId, account.accountId, and the attachment's zero-based position in this array.



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

def url
  @url
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



45
46
47
 
# File 'lib/zernio-sdk/models/webhook_payload_message_message_attachments_inner.rb', line 45

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
41
42
 
# File 'lib/zernio-sdk/models/webhook_payload_message_message_attachments_inner.rb', line 34

def self.attribute_map
  {
    :'type' => :'type',
    :'original_type' => :'originalType',
    :'mime_type' => :'mimeType',
    :'url' => :'url',
    :'payload' => :'payload'
  }
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



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/zernio-sdk/models/webhook_payload_message_message_attachments_inner.rb', line 184

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



66
67
68
69
 
# File 'lib/zernio-sdk/models/webhook_payload_message_message_attachments_inner.rb', line 66

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

.openapi_types ⇒ Object

Attribute type mapping.



55
56
57
58
59
60
61
62
63
 
# File 'lib/zernio-sdk/models/webhook_payload_message_message_attachments_inner.rb', line 55

def self.openapi_types
  {
    :'type' => :'String',
    :'original_type' => :'String',
    :'mime_type' => :'String',
    :'url' => :'String',
    :'payload' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



159
160
161
162
163
164
165
166
167
 
# File 'lib/zernio-sdk/models/webhook_payload_message_message_attachments_inner.rb', line 159

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      original_type == o.original_type &&
      mime_type == o.mime_type &&
      url == o.url &&
      payload == o.payload
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


171
172
173
 
# File 'lib/zernio-sdk/models/webhook_payload_message_message_attachments_inner.rb', line 171

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



177
178
179
 
# File 'lib/zernio-sdk/models/webhook_payload_message_message_attachments_inner.rb', line 177

def hash
  [type, original_type, mime_type, url, payload].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



114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/zernio-sdk/models/webhook_payload_message_message_attachments_inner.rb', line 114

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

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



206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/zernio-sdk/models/webhook_payload_message_message_attachments_inner.rb', line 206

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



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

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @type.nil?
  return false if @url.nil?
  true
end