Class: Zernio::InstagramPlatformData

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

Overview

Feed aspect ratio 0.8-1.91, carousels up to 10 items, stories require media (no captions). User tag coordinates 0.0-1.0 from top-left. Images over 8 MB and videos over platform limits are auto-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 = {}) ⇒ InstagramPlatformData

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/zernio-sdk/models/instagram_platform_data.rb', line 129

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

  if attributes.key?(:'share_to_feed')
    self.share_to_feed = attributes[:'share_to_feed']
  else
    self.share_to_feed = true
  end

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'is_ai_generated')
    self.is_ai_generated = attributes[:'is_ai_generated']
  else
    self.is_ai_generated = false
  end
end

Instance Attribute Details

#audio_configuration ⇒ Object

Returns the value of attribute audio_configuration.



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

def audio_configuration
  @audio_configuration
end

#audio_name ⇒ Object

Custom name for original audio in Reels. Replaces the default "Original Audio" label. Can only be set once. Unrelated to audioConfiguration, which attaches a catalog track.



37
38
39
 
# File 'lib/zernio-sdk/models/instagram_platform_data.rb', line 37

def audio_name
  @audio_name
end

#collaborators ⇒ Object

Up to 3 Instagram usernames to invite as collaborators (feed/Reels only)



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

def collaborators
  @collaborators
end

#content_type ⇒ Object

Set to 'story' to publish as a Story. Default posts become Reels or feed depending on media.



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

def content_type
  @content_type
end

#first_comment ⇒ Object

Optional first comment to add after the post is created (not applied to Stories)



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

def first_comment
  @first_comment
end

#instagram_thumbnail ⇒ Object

Custom cover image URL for Instagram Reels (JPG or PNG, publicly accessible). Overrides thumbOffset when provided. Also accepted as reelCover (alias).



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

def instagram_thumbnail
  @instagram_thumbnail
end

#is_ai_generated ⇒ Object

When true, the post is labeled by Instagram as containing AI-generated media. Per Meta, this self-disclosure label is for AI-generated media, not AI-written captions. Applies to feed posts, Reels, Stories, and carousels.



51
52
53
 
# File 'lib/zernio-sdk/models/instagram_platform_data.rb', line 51

def is_ai_generated
  @is_ai_generated
end

#reel_cover ⇒ Object

Alias for instagramThumbnail. If both are provided, instagramThumbnail takes priority.



48
49
50
 
# File 'lib/zernio-sdk/models/instagram_platform_data.rb', line 48

def reel_cover
  @reel_cover
end

#share_to_feed ⇒ Object

For Reels only. When true (default), the Reel appears on both the Reels tab and your main profile feed. Set to false to post to the Reels tab only.



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

def share_to_feed
  @share_to_feed
end

#thumb_offset ⇒ Object

Millisecond offset from video start for the Reel cover frame. Ignored when instagramThumbnail or reelCover is provided. Defaults to 0.



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

def thumb_offset
  @thumb_offset
end

#trial_params ⇒ Object

Returns the value of attribute trial_params.



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

def trial_params
  @trial_params
end

#user_tags ⇒ Object

Tag Instagram users by username. The tag shape depends on the media: photos require x/y coordinates, Reels and videos take username only (coordinates are ignored), stories accept optional coordinates. For carousels, use mediaIndex to target specific slides (defaults to 0); video slides take username-only tags. Photo tags without valid coordinates are skipped.



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

def user_tags
  @user_tags
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



94
95
96
 
# File 'lib/zernio-sdk/models/instagram_platform_data.rb', line 94

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



99
100
101
 
# File 'lib/zernio-sdk/models/instagram_platform_data.rb', line 99

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/zernio-sdk/models/instagram_platform_data.rb', line 76

def self.attribute_map
  {
    :'content_type' => :'contentType',
    :'share_to_feed' => :'shareToFeed',
    :'collaborators' => :'collaborators',
    :'first_comment' => :'firstComment',
    :'trial_params' => :'trialParams',
    :'user_tags' => :'userTags',
    :'audio_name' => :'audioName',
    :'audio_configuration' => :'audioConfiguration',
    :'thumb_offset' => :'thumbOffset',
    :'instagram_thumbnail' => :'instagramThumbnail',
    :'reel_cover' => :'reelCover',
    :'is_ai_generated' => :'isAiGenerated'
  }
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



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/zernio-sdk/models/instagram_platform_data.rb', line 280

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



122
123
124
125
 
# File 'lib/zernio-sdk/models/instagram_platform_data.rb', line 122

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

.openapi_types ⇒ Object

Attribute type mapping.



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/zernio-sdk/models/instagram_platform_data.rb', line 104

def self.openapi_types
  {
    :'content_type' => :'String',
    :'share_to_feed' => :'Boolean',
    :'collaborators' => :'Array<String>',
    :'first_comment' => :'String',
    :'trial_params' => :'InstagramPlatformDataTrialParams',
    :'user_tags' => :'Array<InstagramPlatformDataUserTagsInner>',
    :'audio_name' => :'String',
    :'audio_configuration' => :'InstagramPlatformDataAudioConfiguration',
    :'thumb_offset' => :'Integer',
    :'instagram_thumbnail' => :'String',
    :'reel_cover' => :'String',
    :'is_ai_generated' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/zernio-sdk/models/instagram_platform_data.rb', line 248

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      content_type == o.content_type &&
      share_to_feed == o.share_to_feed &&
      collaborators == o.collaborators &&
      first_comment == o.first_comment &&
      trial_params == o.trial_params &&
      user_tags == o.user_tags &&
      audio_name == o.audio_name &&
      audio_configuration == o.audio_configuration &&
      thumb_offset == o.thumb_offset &&
      instagram_thumbnail == o.instagram_thumbnail &&
      reel_cover == o.reel_cover &&
      is_ai_generated == o.is_ai_generated
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


267
268
269
 
# File 'lib/zernio-sdk/models/instagram_platform_data.rb', line 267

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



273
274
275
 
# File 'lib/zernio-sdk/models/instagram_platform_data.rb', line 273

def hash
  [content_type, share_to_feed, collaborators, first_comment, trial_params, user_tags, audio_name, audio_configuration, thumb_offset, instagram_thumbnail, reel_cover, is_ai_generated].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



202
203
204
205
206
207
208
209
210
 
# File 'lib/zernio-sdk/models/instagram_platform_data.rb', line 202

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@thumb_offset.nil? && @thumb_offset < 0
    invalid_properties.push('invalid value for "thumb_offset", must be greater than or equal to 0.')
  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



302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/zernio-sdk/models/instagram_platform_data.rb', line 302

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



214
215
216
217
218
219
220
 
# File 'lib/zernio-sdk/models/instagram_platform_data.rb', line 214

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  content_type_validator = EnumAttributeValidator.new('String', ["story"])
  return false unless content_type_validator.valid?(@content_type)
  return false if !@thumb_offset.nil? && @thumb_offset < 0
  true
end