Class: Phyllo::Content1

Inherits:
Object
  • Object
show all
Defined in:
lib/phyllo/models/content1.rb

Overview

Represents the Content object. It contains data of media (images, videos, audio) present in a connected account.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Content1

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/phyllo/models/content1.rb', line 214

def initialize(attributes = {})
  if !attributes.is_a?(Hash)
    fail ArgumentError, "The input argument (attributes) must be a hash in `Phyllo::Content1` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if !self.class.attribute_map.key?(k.to_sym)
      fail ArgumentError, "`#{k}` is not a valid attribute in `Phyllo::Content1`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account ⇒ Object

Returns the value of attribute account.



28
29
30
 
# File 'lib/phyllo/models/content1.rb', line 28

def 
  @account
end

#audience ⇒ Object

Audience type that the post will be accessible to.



86
87
88
 
# File 'lib/phyllo/models/content1.rb', line 86

def audience
  @audience
end

#authors ⇒ Object

Names of the authors of the publication



83
84
85
 
# File 'lib/phyllo/models/content1.rb', line 83

def authors
  @authors
end

#collaboration ⇒ Object

Returns the value of attribute collaboration.



96
97
98
 
# File 'lib/phyllo/models/content1.rb', line 96

def collaboration
  @collaboration
end

#content_tags ⇒ Object

Content tags associated with the publica



92
93
94
 
# File 'lib/phyllo/models/content1.rb', line 92

def content_tags
  @content_tags
end

#created_at ⇒ Object

Object creation time (UTC date and time in ISO 8601 format)



21
22
23
 
# File 'lib/phyllo/models/content1.rb', line 21

def created_at
  @created_at
end

#description ⇒ Object

Description of the content item.



56
57
58
 
# File 'lib/phyllo/models/content1.rb', line 56

def description
  @description
end

#duration ⇒ Object

Video duration in seconds (only available for YouTube).



53
54
55
 
# File 'lib/phyllo/models/content1.rb', line 53

def duration
  @duration
end

#engagement ⇒ Object

Returns the value of attribute engagement.



32
33
34
 
# File 'lib/phyllo/models/content1.rb', line 32

def engagement
  @engagement
end

#external_id ⇒ Object

Unique content ID on the platform.



35
36
37
 
# File 'lib/phyllo/models/content1.rb', line 35

def external_id
  @external_id
end

#format ⇒ Object

Media type of the content item.



41
42
43
 
# File 'lib/phyllo/models/content1.rb', line 41

def format
  @format
end

#hashtags ⇒ Object

List of hashtags found in the title or description of the content item. If there are no hashtags in the title or description of the content item, then the attribute will be null.



59
60
61
 
# File 'lib/phyllo/models/content1.rb', line 59

def hashtags
  @hashtags
end

#id ⇒ Object

Unique ID of the content item.



18
19
20
 
# File 'lib/phyllo/models/content1.rb', line 18

def id
  @id
end

#is_owned_by_platform_user ⇒ Object

true, if the content is owned by the creator. In YouTube, it is possible that content is actually owned by another creator, but current creator has linked that content in their playlist. In such a case the content will still be listed for the current creator.



99
100
101
 
# File 'lib/phyllo/models/content1.rb', line 99

def is_owned_by_platform_user
  @is_owned_by_platform_user
end

#media_url ⇒ Object

Direct media URL of the content item, which can be used to download the media item. This is usually a signed URL and may have certain expiry limits so we recommend using it for downloads as soon as possible (such as when a webhook is received), if you are looking to cache media files with you.



50
51
52
 
# File 'lib/phyllo/models/content1.rb', line 50

def media_url
  @media_url
end

#mentions ⇒ Object

List of mentions found in the title or description of the content item. If there are no mentions in the title or description of the content item, then the attribute will be null.



62
63
64
 
# File 'lib/phyllo/models/content1.rb', line 62

def mentions
  @mentions
end

#persistent_thumbnail_url ⇒ Object

Persistent thumbnail URL of the content item.



71
72
73
 
# File 'lib/phyllo/models/content1.rb', line 71

def persistent_thumbnail_url
  @persistent_thumbnail_url
end

#platform ⇒ Object

Platform the the post was published to.



89
90
91
 
# File 'lib/phyllo/models/content1.rb', line 89

def platform
  @platform
end

#platform_profile_id ⇒ Object

Unique profile ID of the user on the work platform. Ex - For YouTube it’s the channel ID and for Instagram it’s the Instagram page ID.



77
78
79
 
# File 'lib/phyllo/models/content1.rb', line 77

def platform_profile_id
  @platform_profile_id
end

#platform_profile_name ⇒ Object

User’s profile name on the work platform. This is not unique, is displayed prominently on the profile, usually editable and is most commonly associated with that user’s identity on the platform. Ex - For YouTube, it’s the channel name displayed on the channel page and for Instagram / Twitter / TikTok etc, it’s the name displayed on the user’s profile page.



80
81
82
 
# File 'lib/phyllo/models/content1.rb', line 80

def platform_profile_name
  @platform_profile_name
end

#published_at ⇒ Object

Publishing timestamp of the content item.



74
75
76
 
# File 'lib/phyllo/models/content1.rb', line 74

def published_at
  @published_at
end

Returns the value of attribute sponsored.



94
95
96
 
# File 'lib/phyllo/models/content1.rb', line 94

def sponsored
  @sponsored
end

#thumbnail_url ⇒ Object

Thumbnail URL of the content item, which can be used to download the media thumbnail. This is usually a signed URL and may have certain expiry limits so we recommend using it for downloads as soon as possible (such as when a webhook is received), if you are looking to cache thumbnails with you.



68
69
70
 
# File 'lib/phyllo/models/content1.rb', line 68

def thumbnail_url
  @thumbnail_url
end

#title ⇒ Object

Title of the content item.



38
39
40
 
# File 'lib/phyllo/models/content1.rb', line 38

def title
  @title
end

#type ⇒ Object

Platform specific content type.



44
45
46
 
# File 'lib/phyllo/models/content1.rb', line 44

def type
  @type
end

#updated_at ⇒ Object

Object updation time (UTC date and time in ISO 8601 format)



24
25
26
 
# File 'lib/phyllo/models/content1.rb', line 24

def updated_at
  @updated_at
end

#url ⇒ Object

Platform content URL.



47
48
49
 
# File 'lib/phyllo/models/content1.rb', line 47

def url
  @url
end

#user ⇒ Object

Returns the value of attribute user.



26
27
28
 
# File 'lib/phyllo/models/content1.rb', line 26

def user
  @user
end

#visibility ⇒ Object

Visibility of the content item.



65
66
67
 
# File 'lib/phyllo/models/content1.rb', line 65

def visibility
  @visibility
end

#work_platform ⇒ Object

Returns the value of attribute work_platform.



30
31
32
 
# File 'lib/phyllo/models/content1.rb', line 30

def work_platform
  @work_platform
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
 
# File 'lib/phyllo/models/content1.rb', line 564

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = Phyllo.const_get(type)
    (klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of)) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



160
161
162
 
# File 'lib/phyllo/models/content1.rb', line 160

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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
 
# File 'lib/phyllo/models/content1.rb', line 124

def self.attribute_map
  {
    id: :id,
    created_at: :created_at,
    updated_at: :updated_at,
    user: :user,
    account: :account,
    work_platform: :work_platform,
    engagement: :engagement,
    external_id: :external_id,
    title: :title,
    format: :format,
    type: :type,
    url: :url,
    media_url: :media_url,
    duration: :duration,
    description: :description,
    hashtags: :hashtags,
    mentions: :mentions,
    visibility: :visibility,
    thumbnail_url: :thumbnail_url,
    persistent_thumbnail_url: :persistent_thumbnail_url,
    published_at: :published_at,
    platform_profile_id: :platform_profile_id,
    platform_profile_name: :platform_profile_name,
    authors: :authors,
    audience: :audience,
    platform: :platform,
    content_tags: :content_tags,
    sponsored: :sponsored,
    collaboration: :collaboration,
    is_owned_by_platform_user: :is_owned_by_platform_user
  }
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



540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
 
# File 'lib/phyllo/models/content1.rb', line 540

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.to_s] = 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.to_s] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash[key.to_s] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



201
202
203
204
205
206
207
208
209
210
 
# File 'lib/phyllo/models/content1.rb', line 201

def self.openapi_nullable
  Set.new([
    :media_url,
    :duration,
    :hashtags,
    :mentions,
    :sponsored,
    :collaboration
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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/phyllo/models/content1.rb', line 165

def self.openapi_types
  {
    id: :String,
    created_at: :Time,
    updated_at: :Time,
    user: :UserAttribute1,
    account: :AccountAttribute1,
    work_platform: :WorkPlatformAttribute1,
    engagement: :Content1Engagement,
    external_id: :String,
    title: :String,
    format: :String,
    type: :String,
    url: :String,
    media_url: :String,
    duration: :Integer,
    description: :String,
    hashtags: :"Array<String>",
    mentions: :"Array<String>",
    visibility: :String,
    thumbnail_url: :String,
    persistent_thumbnail_url: :String,
    published_at: :Time,
    platform_profile_id: :String,
    platform_profile_name: :String,
    authors: :"Array<String>",
    audience: :String,
    platform: :String,
    content_tags: :"Array<String>",
    sponsored: :Content1Sponsored,
    collaboration: :Content1Collaboration,
    is_owned_by_platform_user: :Boolean
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
 
# File 'lib/phyllo/models/content1.rb', line 490

def ==(other)
  return true if equal?(other)
  self.class == other.class &&
    id == other.id &&
    created_at == other.created_at &&
    updated_at == other.updated_at &&
    user == other.user &&
     == other. &&
    work_platform == other.work_platform &&
    engagement == other.engagement &&
    external_id == other.external_id &&
    title == other.title &&
    format == other.format &&
    type == other.type &&
    url == other.url &&
    media_url == other.media_url &&
    duration == other.duration &&
    description == other.description &&
    hashtags == other.hashtags &&
    mentions == other.mentions &&
    visibility == other.visibility &&
    thumbnail_url == other.thumbnail_url &&
    persistent_thumbnail_url == other.persistent_thumbnail_url &&
    published_at == other.published_at &&
    platform_profile_id == other.platform_profile_id &&
    platform_profile_name == other.platform_profile_name &&
    authors == other.authors &&
    audience == other.audience &&
    platform == other.platform &&
    content_tags == other.content_tags &&
    sponsored == other.sponsored &&
    collaboration == other.collaboration &&
    is_owned_by_platform_user == other.is_owned_by_platform_user
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



635
636
637
638
639
640
641
642
643
644
645
646
647
 
# File 'lib/phyllo/models/content1.rb', line 635

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


527
528
529
 
# File 'lib/phyllo/models/content1.rb', line 527

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



533
534
535
 
# File 'lib/phyllo/models/content1.rb', line 533

def hash
  [id, created_at, updated_at, user, , work_platform, engagement, external_id, title, format, type, url, media_url, duration, description, hashtags, mentions, visibility, thumbnail_url, persistent_thumbnail_url, published_at, platform_profile_id, platform_profile_name, authors, audience, platform, content_tags, sponsored, collaboration, is_owned_by_platform_user].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



360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/phyllo/models/content1.rb', line 360

def list_invalid_properties
  warn "[DEPRECATED] the `list_invalid_properties` method is obsolete"
  invalid_properties = []
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

  if @created_at.nil?
    invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
  end

  if @updated_at.nil?
    invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.')
  end

  if @external_id.nil?
    invalid_properties.push('invalid value for "external_id", external_id cannot be nil.')
  end

  if @title.nil?
    invalid_properties.push('invalid value for "title", title cannot be nil.')
  end

  if @type.nil?
    invalid_properties.push('invalid value for "type", type cannot be nil.')
  end

  if @url.nil?
    invalid_properties.push('invalid value for "url", url cannot be nil.')
  end

  if @published_at.nil?
    invalid_properties.push('invalid value for "published_at", published_at cannot be nil.')
  end

  if @platform_profile_id.nil?
    invalid_properties.push('invalid value for "platform_profile_id", platform_profile_id cannot be nil.')
  end

  if @platform_profile_name.nil?
    invalid_properties.push('invalid value for "platform_profile_name", platform_profile_name cannot be nil.')
  end

  if @is_owned_by_platform_user.nil?
    invalid_properties.push('invalid value for "is_owned_by_platform_user", is_owned_by_platform_user cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



611
612
613
 
# File 'lib/phyllo/models/content1.rb', line 611

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



617
618
619
620
621
622
623
624
625
626
627
628
629
 
# File 'lib/phyllo/models/content1.rb', line 617

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = 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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



605
606
607
 
# File 'lib/phyllo/models/content1.rb', line 605

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
 
# File 'lib/phyllo/models/content1.rb', line 412

def valid?
  warn "[DEPRECATED] the `valid?` method is obsolete"
  return false if @id.nil?
  return false if @created_at.nil?
  return false if @updated_at.nil?
  return false if @external_id.nil?
  return false if @title.nil?
  format_validator = EnumAttributeValidator.new("String", ["VIDEO", "IMAGE", "AUDIO", "TEXT", "OTHER"])
  return false unless format_validator.valid?(@format)
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new("String", ["VIDEO", "POST", "STORY", "TWEET", "BLOG", "IMAGE", "THREAD", "PODCAST", "TRACK", "OTHER", "REELS", "STREAM", "FEED", "IGTV"])
  return false unless type_validator.valid?(@type)
  return false if @url.nil?
  visibility_validator = EnumAttributeValidator.new("String", ["PUBLIC", "PRIVATE"])
  return false unless visibility_validator.valid?(@visibility)
  return false if @published_at.nil?
  return false if @platform_profile_id.nil?
  return false if @platform_profile_name.nil?
  audience_validator = EnumAttributeValidator.new("String", ["FREE", "PAID", "BOTH"])
  return false unless audience_validator.valid?(@audience)
  platform_validator = EnumAttributeValidator.new("String", ["WEB", "EMAIL", "BOTH"])
  return false unless platform_validator.valid?(@platform)
  return false if @is_owned_by_platform_user.nil?
  true
end