Class: Zernio::InstagramPlatformData

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

Overview

Feed aspect ratio 0.5625-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



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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/zernio-sdk/models/instagram_platform_data.rb', line 154

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?(:'mute_audio')
    self.mute_audio = attributes[:'mute_audio']
  else
    self.mute_audio = false
  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

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

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

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

  if attributes.key?(:'location_id')
    self.location_id = attributes[:'location_id']
  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

#branded_content_sponsors ⇒ Object

Up to 2 brands to tag as sponsors, each an Instagram username (leading @ optional) or a numeric Instagram user ID. Usernames are resolved at publish time via the Business Discovery API on the publishing account; a sponsor that cannot be resolved (private, personal, or nonexistent account) fails the post with a user error naming it. Sponsors must be professional (Business or Creator) accounts. A brand that has pre-approved the creator shows as "Paid partnership with @brand" immediately; otherwise the plain label shows and the brand receives an approval request. Sets isPaidPartnership. Same login and content-type rules as isPaidPartnership.



60
61
62
 
# File 'lib/zernio-sdk/models/instagram_platform_data.rb', line 60

def branded_content_sponsors
  @branded_content_sponsors
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

#comments_enabled ⇒ Object

When false, comments are turned off on the post right after it is published (Meta exposes this as comment_enabled on the media object). Applies to feed posts, Reels, and carousels; ignored for Stories, which have no comments. Works with both Instagram connection methods. Best-effort: if the toggle fails after a successful publish, the post still succeeds and stays live with comments on.



63
64
65
 
# File 'lib/zernio-sdk/models/instagram_platform_data.rb', line 63

def comments_enabled
  @comments_enabled
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).



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

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.



54
55
56
 
# File 'lib/zernio-sdk/models/instagram_platform_data.rb', line 54

def is_ai_generated
  @is_ai_generated
end

#is_paid_partnership ⇒ Object

When true, Instagram shows the "Paid partnership" label on the post. Applies to feed posts, Reels, and carousels; not supported on Stories (400). Requires an Instagram account connected via Facebook Login; classic Instagram Login accounts get a 400 (instagram_paid_partnership_requires_facebook_login). Implied when brandedContentSponsors is set.



57
58
59
 
# File 'lib/zernio-sdk/models/instagram_platform_data.rb', line 57

def is_paid_partnership
  @is_paid_partnership
end

#location_id ⇒ Object

Tags the post with a location. The ID of a Facebook Page that has location data (digits only); it is sent to Instagram as location_id. Applies to feed posts, Reels, and the carousel as a whole; Stories and individual carousel slides are unsupported (a Story with locationId is rejected with a 400). A Page without location data or that does not exist fails the post with a user error at publish time.



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

def location_id
  @location_id
end

#mute_audio ⇒ Object

Publish the video without sound. Applies to Reels, Stories, and video carousel slides; ignored for images. Instagram has no mute parameter, so we strip the audio track from the file before handing it to Instagram: the published video is permanently silent and the original audio cannot be restored from Instagram. If the audio cannot be stripped the post fails rather than publishing with sound; videos above 200MB cannot be muted at all, so mute them before uploading. Unrelated to audioConfiguration.videoVolume, which only lowers the original sound when a catalog track is attached.



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

def mute_audio
  @mute_audio
end

#reel_cover ⇒ Object

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



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

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.



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

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



114
115
116
 
# File 'lib/zernio-sdk/models/instagram_platform_data.rb', line 114

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



119
120
121
 
# File 'lib/zernio-sdk/models/instagram_platform_data.rb', line 119

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/zernio-sdk/models/instagram_platform_data.rb', line 91

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',
    :'mute_audio' => :'muteAudio',
    :'thumb_offset' => :'thumbOffset',
    :'instagram_thumbnail' => :'instagramThumbnail',
    :'reel_cover' => :'reelCover',
    :'is_ai_generated' => :'isAiGenerated',
    :'is_paid_partnership' => :'isPaidPartnership',
    :'branded_content_sponsors' => :'brandedContentSponsors',
    :'comments_enabled' => :'commentsEnabled',
    :'location_id' => :'locationId'
  }
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



378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/zernio-sdk/models/instagram_platform_data.rb', line 378

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



147
148
149
150
 
# File 'lib/zernio-sdk/models/instagram_platform_data.rb', line 147

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

.openapi_types ⇒ Object

Attribute type mapping.



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/zernio-sdk/models/instagram_platform_data.rb', line 124

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',
    :'mute_audio' => :'Boolean',
    :'thumb_offset' => :'Integer',
    :'instagram_thumbnail' => :'String',
    :'reel_cover' => :'String',
    :'is_ai_generated' => :'Boolean',
    :'is_paid_partnership' => :'Boolean',
    :'branded_content_sponsors' => :'Array<String>',
    :'comments_enabled' => :'Boolean',
    :'location_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/zernio-sdk/models/instagram_platform_data.rb', line 341

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 &&
      mute_audio == o.mute_audio &&
      thumb_offset == o.thumb_offset &&
      instagram_thumbnail == o.instagram_thumbnail &&
      reel_cover == o.reel_cover &&
      is_ai_generated == o.is_ai_generated &&
      is_paid_partnership == o.is_paid_partnership &&
      branded_content_sponsors == o.branded_content_sponsors &&
      comments_enabled == o.comments_enabled &&
      location_id == o.location_id
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


365
366
367
 
# File 'lib/zernio-sdk/models/instagram_platform_data.rb', line 365

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



371
372
373
 
# File 'lib/zernio-sdk/models/instagram_platform_data.rb', line 371

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



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/zernio-sdk/models/instagram_platform_data.rb', line 255

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

  if !@branded_content_sponsors.nil? && @branded_content_sponsors.length > 2
    invalid_properties.push('invalid value for "branded_content_sponsors", number of items must be less than or equal to 2.')
  end

  pattern = Regexp.new(/^[0-9]+$/)
  if !@location_id.nil? && @location_id !~ pattern
    invalid_properties.push("invalid value for \"location_id\", must conform to the pattern #{pattern}.")
  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



400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/zernio-sdk/models/instagram_platform_data.rb', line 400

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



276
277
278
279
280
281
282
283
284
 
# File 'lib/zernio-sdk/models/instagram_platform_data.rb', line 276

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
  return false if !@branded_content_sponsors.nil? && @branded_content_sponsors.length > 2
  return false if !@location_id.nil? && @location_id !~ Regexp.new(/^[0-9]+$/)
  true
end