Class: Zernio::CreatePostRequest

Inherits:
ApiModelBase show all
Defined in:
lib/zernio-sdk/models/create_post_request.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 = {}) ⇒ CreatePostRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
252
253
 
# File 'lib/zernio-sdk/models/create_post_request.rb', line 142

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

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

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

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

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

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

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

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

  if attributes.key?(:'timezone')
    self.timezone = attributes[:'timezone']
  else
    self.timezone = 'UTC'
  end

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#content ⇒ Object

Post caption/text. Optional when media is attached, all platforms have customContent, every platform entry is an X Article (platformSpecificData.article), or every platform entry is a LinkedIn text-free reshare (platformSpecificData.reshareUrl with no text). Required for other text-only posts.



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

def content
  @content
end

#crossposting_enabled ⇒ Object

Stored on the post and echoed back on reads. Publishing does not branch on it: every entry in platforms is published regardless, so treat it as a label for your own tooling.



55
56
57
 
# File 'lib/zernio-sdk/models/create_post_request.rb', line 55

def crossposting_enabled
  @crossposting_enabled
end

#dry_run ⇒ Object

TikTok only. Preview whether each tiktok entry in platforms could publish right now under the TikTok Direct Post daily limits, without creating, scheduling or publishing anything: no post is persisted and no upload slot is claimed, so it can be repeated freely. The request still goes through auth, the payment gate and body validation, then returns HTTP 200 with { dryRun: true, canPublish, tiktok: [...] } instead of 201. Only tiktok entries are evaluated; other platforms in the body are ignored, and a body with no tiktok entry is rejected with 400 invalid_field_value on platforms. An entry with platformSpecificData.tiktokSettings.draft: true (Creator Inbox upload) is not subject to the limit and always reports canPublish: true. Accounts connected through the TikTok for Business app do not go through these limits at all and also always report canPublish: true, so on those accounts a dry run confirms the request is well-formed rather than gating it.



40
41
42
 
# File 'lib/zernio-sdk/models/create_post_request.rb', line 40

def dry_run
  @dry_run
end

#facebook_settings ⇒ Object

Root-level Facebook settings applied to the Facebook platforms sent in the same request. Merged into each platform's platformSpecificData.facebookSettings, with platform-specific settings taking precedence.



64
65
66
 
# File 'lib/zernio-sdk/models/create_post_request.rb', line 64

def facebook_settings
  @facebook_settings
end

#hashtags ⇒ Object

Stored for reference only. Hashtags are NOT automatically appended to the caption when publishing. Include hashtags directly in the content field (platforms like Instagram only support hashtags as caption text). For YouTube keywords, use the tags field instead.



49
50
51
 
# File 'lib/zernio-sdk/models/create_post_request.rb', line 49

def hashtags
  @hashtags
end

#is_draft ⇒ Object

When true, saves the post as a draft. When none of scheduledFor, publishNow, or queuedFromProfile are provided, the post defaults to draft automatically.



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

def is_draft
  @is_draft
end

#media_items ⇒ Object

Media attached to every platform in the request (a platform entry can override it with customMedia). Each entry needs a publicly reachable HTTPS url; type (image, video, gif, document) is inferred from the URL extension when omitted and a type that contradicts the extension is rejected with 400. Upload files with POST /v1/media/presign first; per-platform size, duration and format limits are listed on each platform schema.



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

def media_items
  @media_items
end

#mentions ⇒ Object

Stored for reference only. This field does NOT automatically create @mentions when publishing. For LinkedIn @mentions, use the /v1/accounts/accountId/linkedin-mentions endpoint to resolve profile URLs to URNs, then embed the returned mentionFormat directly in the post content field.



52
53
54
 
# File 'lib/zernio-sdk/models/create_post_request.rb', line 52

def mentions
  @mentions
end

#metadata ⇒ Object

Free-form key/value pairs of your own, stored on the post and returned on reads and in webhook payloads. Zernio also writes the bookkeeping keys usageCounted, usageRefunded and hidden into this object; do not set them, and they are stripped from webhook payloads.



58
59
60
 
# File 'lib/zernio-sdk/models/create_post_request.rb', line 58

def metadata
  @metadata
end

#platforms ⇒ Object

Target platforms and accounts for this post. Required for non-draft posts (returns 400 if empty). Drafts can omit platforms.



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

def platforms
  @platforms
end

#publish_now ⇒ Object

Publish to every platform synchronously in this request instead of scheduling; the response then carries each platform result and platformPostUrl, with HTTP 207 when some platforms failed. Takes precedence over scheduledFor; ignored when isDraft is true.



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

def publish_now
  @publish_now
end

#queue_id ⇒ Object

Specific queue ID to use when scheduling via queue. Only used when queuedFromProfile is also provided. If omitted, uses the profile's default queue.



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

def queue_id
  @queue_id
end

#queued_from_profile ⇒ Object

Profile ID to schedule via queue. When provided without scheduledFor, the post is auto-assigned to the next available slot. Do not call /v1/queue/next-slot and use that time in scheduledFor, as that bypasses queue locking.



69
70
71
 
# File 'lib/zernio-sdk/models/create_post_request.rb', line 69

def queued_from_profile
  @queued_from_profile
end

#recycling ⇒ Object

Returns the value of attribute recycling.



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

def recycling
  @recycling
end

#scheduled_for ⇒ Object

When to publish. Required unless publishNow is true, queuedFromProfile is set, or the post is a draft. An ISO 8601 value with a Z or offset (2026-01-15T10:00:00Z, 2026-01-15T11:00:00+01:00) is taken as-is; a value without one (2026-01-15T10:00:00 or 2026-01-15 10:00) is read as local time in timezone. A value already in the past is published synchronously in the same request. Ignored when publishNow is true.



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

def scheduled_for
  @scheduled_for
end

#tags ⇒ Object

Tags/keywords. YouTube constraints: each tag max 100 chars, combined max 500 chars, duplicates auto-removed.



46
47
48
 
# File 'lib/zernio-sdk/models/create_post_request.rb', line 46

def tags
  @tags
end

#tiktok_settings ⇒ Object

Root-level TikTok settings applied to the TikTok platforms sent in the same request. Merged into each platform's platformSpecificData, with platform-specific settings taking precedence.



61
62
63
 
# File 'lib/zernio-sdk/models/create_post_request.rb', line 61

def tiktok_settings
  @tiktok_settings
end

#timezone ⇒ Object

IANA timezone (Europe/Madrid, America/New_York) used to interpret a scheduledFor (root or per-platform) that carries no Z or offset. Has no effect on values that already carry one. An unknown name returns 400 when scheduledFor is set.



43
44
45
 
# File 'lib/zernio-sdk/models/create_post_request.rb', line 43

def timezone
  @timezone
end

#title ⇒ Object

Stored on the post for reference/display only. This field is NOT used as the video title when publishing. To set a YouTube video title, use platformSpecificData.title on the youtube platform target (falls back to the first line of content when omitted).



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

def title
  @title
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



100
101
102
 
# File 'lib/zernio-sdk/models/create_post_request.rb', line 100

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



105
106
107
 
# File 'lib/zernio-sdk/models/create_post_request.rb', line 105

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/zernio-sdk/models/create_post_request.rb', line 75

def self.attribute_map
  {
    :'title' => :'title',
    :'content' => :'content',
    :'media_items' => :'mediaItems',
    :'platforms' => :'platforms',
    :'scheduled_for' => :'scheduledFor',
    :'publish_now' => :'publishNow',
    :'is_draft' => :'isDraft',
    :'dry_run' => :'dryRun',
    :'timezone' => :'timezone',
    :'tags' => :'tags',
    :'hashtags' => :'hashtags',
    :'mentions' => :'mentions',
    :'crossposting_enabled' => :'crosspostingEnabled',
    :'metadata' => :'metadata',
    :'tiktok_settings' => :'tiktokSettings',
    :'facebook_settings' => :'facebookSettings',
    :'recycling' => :'recycling',
    :'queued_from_profile' => :'queuedFromProfile',
    :'queue_id' => :'queueId'
  }
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



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/zernio-sdk/models/create_post_request.rb', line 311

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



135
136
137
138
 
# File 'lib/zernio-sdk/models/create_post_request.rb', line 135

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

.openapi_types ⇒ Object

Attribute type mapping.



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/zernio-sdk/models/create_post_request.rb', line 110

def self.openapi_types
  {
    :'title' => :'String',
    :'content' => :'String',
    :'media_items' => :'Array<MediaItem>',
    :'platforms' => :'Array<CreatePostRequestPlatformsInner>',
    :'scheduled_for' => :'Time',
    :'publish_now' => :'Boolean',
    :'is_draft' => :'Boolean',
    :'dry_run' => :'Boolean',
    :'timezone' => :'String',
    :'tags' => :'Array<String>',
    :'hashtags' => :'Array<String>',
    :'mentions' => :'Array<String>',
    :'crossposting_enabled' => :'Boolean',
    :'metadata' => :'Hash<String, Object>',
    :'tiktok_settings' => :'TikTokPlatformData',
    :'facebook_settings' => :'FacebookSettings',
    :'recycling' => :'RecyclingConfig',
    :'queued_from_profile' => :'String',
    :'queue_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/zernio-sdk/models/create_post_request.rb', line 272

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      title == o.title &&
      content == o.content &&
      media_items == o.media_items &&
      platforms == o.platforms &&
      scheduled_for == o.scheduled_for &&
      publish_now == o.publish_now &&
      is_draft == o.is_draft &&
      dry_run == o.dry_run &&
      timezone == o.timezone &&
      tags == o.tags &&
      hashtags == o.hashtags &&
      mentions == o.mentions &&
      crossposting_enabled == o.crossposting_enabled &&
      metadata == o.metadata &&
      tiktok_settings == o.tiktok_settings &&
      facebook_settings == o.facebook_settings &&
      recycling == o.recycling &&
      queued_from_profile == o.queued_from_profile &&
      queue_id == o.queue_id
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


298
299
300
 
# File 'lib/zernio-sdk/models/create_post_request.rb', line 298

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



304
305
306
 
# File 'lib/zernio-sdk/models/create_post_request.rb', line 304

def hash
  [title, content, media_items, platforms, scheduled_for, publish_now, is_draft, dry_run, timezone, tags, hashtags, mentions, crossposting_enabled, metadata, tiktok_settings, facebook_settings, recycling, queued_from_profile, queue_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



257
258
259
260
261
 
# File 'lib/zernio-sdk/models/create_post_request.rb', line 257

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



333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/zernio-sdk/models/create_post_request.rb', line 333

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



265
266
267
268
 
# File 'lib/zernio-sdk/models/create_post_request.rb', line 265

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end