Class: Zernio::MediaItem

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

Overview

Media referenced in posts. URLs must be publicly reachable over HTTPS. Use POST /v1/media/presign for uploads up to 5GB. Zernio auto-compresses images and videos that exceed platform limits (videos over 200 MB may not be compressed).

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/zernio-sdk/models/media_item.rb', line 119

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#alt_text ⇒ Object

Accessibility alternative text for an image, applied on every platform that supports it: Instagram (feed images only, not Reels/Stories), Facebook, Threads, X (max 1000 chars), LinkedIn, Bluesky, and Pinterest (max 500 chars). Ignored on platforms without alt-text support (TikTok, YouTube, Snapchat, Telegram, Reddit, Google Business Profile, WhatsApp) and on video items where the platform does not accept it. Set once per image; the same value is sent to each selected platform.



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

def alt_text
  @alt_text
end

#filename ⇒ Object

Returns the value of attribute filename.



30
31
32
 
# File 'lib/zernio-sdk/models/media_item.rb', line 30

def filename
  @filename
end

#instagram_thumbnail ⇒ Object

Custom cover image URL for Instagram Reels. Can also be set via platformSpecificData.instagramThumbnail or platformSpecificData.reelCover. Resolution order: this field > platformSpecificData.instagramThumbnail > platformSpecificData.reelCover > platformSpecificData.thumbnailUrl (legacy).



42
43
44
 
# File 'lib/zernio-sdk/models/media_item.rb', line 42

def instagram_thumbnail
  @instagram_thumbnail
end

#mime_type ⇒ Object

Optional MIME type (e.g. image/jpeg, video/mp4)



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

def mime_type
  @mime_type
end

#size ⇒ Object

Optional file size in bytes



33
34
35
 
# File 'lib/zernio-sdk/models/media_item.rb', line 33

def size
  @size
end

#thumbnail ⇒ Object

Optional custom thumbnail/cover image URL for videos. Supported for Facebook video posts, Facebook Reels, regular video uploads, and LinkedIn video posts. Max 10MB, JPG/PNG recommended.



39
40
41
 
# File 'lib/zernio-sdk/models/media_item.rb', line 39

def thumbnail
  @thumbnail
end

#tiktok_processed ⇒ Object

Internal flag indicating the image was resized for TikTok



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

def tiktok_processed
  @tiktok_processed
end

#title ⇒ Object

Optional title for the media item. Used as the document title for LinkedIn PDF/carousel posts. If omitted, falls back to the post title, then the filename.



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

def title
  @title
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

#url ⇒ Object

A media item with a null, missing or empty url is dropped.



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

def url
  @url
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



86
87
88
 
# File 'lib/zernio-sdk/models/media_item.rb', line 86

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



91
92
93
 
# File 'lib/zernio-sdk/models/media_item.rb', line 91

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/zernio-sdk/models/media_item.rb', line 70

def self.attribute_map
  {
    :'type' => :'type',
    :'url' => :'url',
    :'title' => :'title',
    :'alt_text' => :'altText',
    :'filename' => :'filename',
    :'size' => :'size',
    :'mime_type' => :'mimeType',
    :'thumbnail' => :'thumbnail',
    :'instagram_thumbnail' => :'instagramThumbnail',
    :'tiktok_processed' => :'tiktokProcessed'
  }
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



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/zernio-sdk/models/media_item.rb', line 233

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



112
113
114
115
 
# File 'lib/zernio-sdk/models/media_item.rb', line 112

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

.openapi_types ⇒ Object

Attribute type mapping.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/zernio-sdk/models/media_item.rb', line 96

def self.openapi_types
  {
    :'type' => :'String',
    :'url' => :'String',
    :'title' => :'String',
    :'alt_text' => :'String',
    :'filename' => :'String',
    :'size' => :'Integer',
    :'mime_type' => :'String',
    :'thumbnail' => :'String',
    :'instagram_thumbnail' => :'String',
    :'tiktok_processed' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/zernio-sdk/models/media_item.rb', line 203

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      url == o.url &&
      title == o.title &&
      alt_text == o.alt_text &&
      filename == o.filename &&
      size == o.size &&
      mime_type == o.mime_type &&
      thumbnail == o.thumbnail &&
      instagram_thumbnail == o.instagram_thumbnail &&
      tiktok_processed == o.tiktok_processed
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


220
221
222
 
# File 'lib/zernio-sdk/models/media_item.rb', line 220

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

def hash
  [type, url, title, alt_text, filename, size, mime_type, thumbnail, instagram_thumbnail, tiktok_processed].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



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

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



255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/zernio-sdk/models/media_item.rb', line 255

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



184
185
186
187
188
189
 
# File 'lib/zernio-sdk/models/media_item.rb', line 184

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  type_validator = EnumAttributeValidator.new('String', ["image", "video", "gif", "document"])
  return false unless type_validator.valid?(@type)
  true
end