Class: Zernio::ExternalPostMediaItem

Inherits:
ApiModelBase show all
Defined in:
lib/zernio-sdk/models/external_post_media_item.rb

Overview

A media item on a native (external/synced) post, as carried by post.external.* webhook payloads. Distinct from the richer MediaItem used for Zernio-authored posts: external items are always already-published and limited to image or video. Kept as a separate schema so the generated SDK model does not collide with MediaItem.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



96
97
98
99
100
101
102
103
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
 
# File 'lib/zernio-sdk/models/external_post_media_item.rb', line 96

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

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

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

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

Instance Attribute Details

#media_status ⇒ Object

unavailable means the media file could not be retrieved (url is null or, for LinkedIn videos, a cover image standing in for the file). available or absent means the file is available at url (older synced items omit the field).



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

def media_status
  @media_status
end

#thumbnail ⇒ Object

Cover image. Still present when url is null.



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

def thumbnail
  @thumbnail
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

#unavailable_reason ⇒ Object

Why the file is missing. platform_withheld means the platform declined to return it and retrying will not help.



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

def unavailable_reason
  @unavailable_reason
end

#url ⇒ Object

'Direct URL to the media file. Null when the platform withholds it: check mediaStatus before downloading. Instagram omits the video file for Reels it flags as containing copyrighted material (its docs name audio as the usual cause), so type stays "video" while the file is permanently unreachable. For LinkedIn videos where the platform returns no file, url falls back to the cover image and the item carries mediaStatus: unavailable.'



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

def url
  @url
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'type' => :'type',
    :'url' => :'url',
    :'thumbnail' => :'thumbnail',
    :'media_status' => :'mediaStatus',
    :'unavailable_reason' => :'unavailableReason'
  }
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



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/zernio-sdk/models/external_post_media_item.rb', line 218

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



88
89
90
91
92
 
# File 'lib/zernio-sdk/models/external_post_media_item.rb', line 88

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

.openapi_types ⇒ Object

Attribute type mapping.



77
78
79
80
81
82
83
84
85
 
# File 'lib/zernio-sdk/models/external_post_media_item.rb', line 77

def self.openapi_types
  {
    :'type' => :'String',
    :'url' => :'String',
    :'thumbnail' => :'String',
    :'media_status' => :'String',
    :'unavailable_reason' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



193
194
195
196
197
198
199
200
201
 
# File 'lib/zernio-sdk/models/external_post_media_item.rb', line 193

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      url == o.url &&
      thumbnail == o.thumbnail &&
      media_status == o.media_status &&
      unavailable_reason == o.unavailable_reason
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


205
206
207
 
# File 'lib/zernio-sdk/models/external_post_media_item.rb', line 205

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



211
212
213
 
# File 'lib/zernio-sdk/models/external_post_media_item.rb', line 211

def hash
  [type, url, thumbnail, media_status, unavailable_reason].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



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

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

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/zernio-sdk/models/external_post_media_item.rb', line 240

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



149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/zernio-sdk/models/external_post_media_item.rb', line 149

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["image", "video"])
  return false unless type_validator.valid?(@type)
  media_status_validator = EnumAttributeValidator.new('String', ["available", "unavailable"])
  return false unless media_status_validator.valid?(@media_status)
  unavailable_reason_validator = EnumAttributeValidator.new('String', ["platform_withheld"])
  return false unless unavailable_reason_validator.valid?(@unavailable_reason)
  true
end