Class: Phyllo::ActivityContent1

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ActivityContent1

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/phyllo/models/activity_content1.rb', line 138

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

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

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

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

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

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

Instance Attribute Details

#account ⇒ Object

Returns the value of attribute account.



27
28
29
 
# File 'lib/phyllo/models/activity_content1.rb', line 27

def 
  @account
end

#activity_type ⇒ Object

Whether the media content is in the ‘TOP` contents of the user (as defined by the work platform) or is `SAVED` by the user or was a `RECENT` media played by the user.



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

def activity_type
  @activity_type
end

#additional_info ⇒ Object

Returns the value of attribute additional_info.



58
59
60
 
# File 'lib/phyllo/models/activity_content1.rb', line 58

def additional_info
  @additional_info
end

#created_at ⇒ Object

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



20
21
22
 
# File 'lib/phyllo/models/activity_content1.rb', line 20

def created_at
  @created_at
end

#description ⇒ Object

Description of the content item.



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

def description
  @description
end

#embed_url ⇒ Object

Embed URL of the content item, which can be used to embed the media item.



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

def embed_url
  @embed_url
end

#format ⇒ Object

Media type of the content item.



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

def format
  @format
end

#id ⇒ Object

Unique ID of the content item.



17
18
19
 
# File 'lib/phyllo/models/activity_content1.rb', line 17

def id
  @id
end

#platform_content_id ⇒ Object

Unique content ID on the platform.



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

def platform_content_id
  @platform_content_id
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.



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

def thumbnail_url
  @thumbnail_url
end

#title ⇒ Object

Title of the content item.



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

def title
  @title
end

#type ⇒ Object

Platform specific content type.



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

def type
  @type
end

#updated_at ⇒ Object

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



23
24
25
 
# File 'lib/phyllo/models/activity_content1.rb', line 23

def updated_at
  @updated_at
end

#url ⇒ Object

Platform content URL.



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

def url
  @url
end

#user ⇒ Object

Returns the value of attribute user.



25
26
27
 
# File 'lib/phyllo/models/activity_content1.rb', line 25

def user
  @user
end

#work_platform ⇒ Object

Returns the value of attribute work_platform.



29
30
31
 
# File 'lib/phyllo/models/activity_content1.rb', line 29

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



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

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



105
106
107
 
# File 'lib/phyllo/models/activity_content1.rb', line 105

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/phyllo/models/activity_content1.rb', line 83

def self.attribute_map
  {
    id: :id,
    created_at: :created_at,
    updated_at: :updated_at,
    user: :user,
    account: :account,
    work_platform: :work_platform,
    platform_content_id: :platform_content_id,
    title: :title,
    format: :format,
    type: :type,
    url: :url,
    description: :description,
    thumbnail_url: :thumbnail_url,
    embed_url: :embed_url,
    activity_type: :activity_type,
    additional_info: :additional_info
  }
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



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/phyllo/models/activity_content1.rb', line 345

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



132
133
134
 
# File 'lib/phyllo/models/activity_content1.rb', line 132

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

def self.openapi_types
  {
    id: :String,
    created_at: :Time,
    updated_at: :Time,
    user: :UserAttribute1,
    account: :AccountAttribute1,
    work_platform: :WorkPlatformAttribute1,
    platform_content_id: :String,
    title: :String,
    format: :String,
    type: :String,
    url: :String,
    description: :String,
    thumbnail_url: :String,
    embed_url: :String,
    activity_type: :String,
    additional_info: :ActivityContent1AdditionalInfo
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/phyllo/models/activity_content1.rb', line 309

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 &&
    platform_content_id == other.platform_content_id &&
    title == other.title &&
    format == other.format &&
    type == other.type &&
    url == other.url &&
    description == other.description &&
    thumbnail_url == other.thumbnail_url &&
    embed_url == other.embed_url &&
    activity_type == other.activity_type &&
    additional_info == other.additional_info
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



440
441
442
443
444
445
446
447
448
449
450
451
452
 
# File 'lib/phyllo/models/activity_content1.rb', line 440

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


332
333
334
 
# File 'lib/phyllo/models/activity_content1.rb', line 332

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



338
339
340
 
# File 'lib/phyllo/models/activity_content1.rb', line 338

def hash
  [id, created_at, updated_at, user, , work_platform, platform_content_id, title, format, type, url, description, thumbnail_url, embed_url, activity_type, additional_info].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



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

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 @platform_content_id.nil?
    invalid_properties.push('invalid value for "platform_content_id", platform_content_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 @activity_type.nil?
    invalid_properties.push('invalid value for "activity_type", activity_type 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



416
417
418
 
# File 'lib/phyllo/models/activity_content1.rb', line 416

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



422
423
424
425
426
427
428
429
430
431
432
433
434
 
# File 'lib/phyllo/models/activity_content1.rb', line 422

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



410
411
412
 
# File 'lib/phyllo/models/activity_content1.rb', line 410

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



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/phyllo/models/activity_content1.rb', line 258

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 @platform_content_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?
  return false if @activity_type.nil?
  activity_type_validator = EnumAttributeValidator.new("String", ["TOP", "RECENT", "SAVED"])
  return false unless activity_type_validator.valid?(@activity_type)
  true
end