Class: Phyllo::ActivityArtist

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ActivityArtist

Initializes the object

Parameters:

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

    Model attributes in the form of hash



122
123
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
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
# File 'lib/phyllo/models/activity_artist.rb', line 122

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#accountObject

Returns the value of attribute account.



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

def 
  @account
end

#activity_typeObject

Whether the artist is in the ‘TOP` artists of the user (as defined by the work platform) or is `FOLLOWED` by the user.



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

def activity_type
  @activity_type
end

#artist_nameObject

Artist’s name on the platform.



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

def artist_name
  @artist_name
end

#artist_urlObject

URL of the artist’s page/profile on the platform.



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

def artist_url
  @artist_url
end

#created_atObject

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



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

def created_at
  @created_at
end

#genreObject

List of genres that the artist is categorised into by the work platform.



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

def genre
  @genre
end

#idObject

Unique ID of the artist.



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

def id
  @id
end

#image_urlObject

Image URL of the artist on the platform.



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

def image_url
  @image_url
end

#platform_artist_idObject

Unique artist ID given by the source platform.



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

def platform_artist_id
  @platform_artist_id
end

#updated_atObject

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



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

def updated_at
  @updated_at
end

#userObject

Returns the value of attribute user.



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

def user
  @user
end

#work_platformObject

Returns the value of attribute work_platform.



29
30
31
# File 'lib/phyllo/models/activity_artist.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



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

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_attributesObject

Returns all the JSON keys this model knows about



90
91
92
# File 'lib/phyllo/models/activity_artist.rb', line 90

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
# File 'lib/phyllo/models/activity_artist.rb', line 72

def self.attribute_map
  {
    id: :id,
    created_at: :created_at,
    updated_at: :updated_at,
    user: :user,
    account: :account,
    work_platform: :work_platform,
    platform_artist_id: :platform_artist_id,
    image_url: :image_url,
    artist_name: :artist_name,
    artist_url: :artist_url,
    genre: :genre,
    activity_type: :activity_type
  }
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



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
# File 'lib/phyllo/models/activity_artist.rb', line 292

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_nullableObject

List of attributes with nullable: true



113
114
115
116
117
118
# File 'lib/phyllo/models/activity_artist.rb', line 113

def self.openapi_nullable
  Set.new([
    :image_url,
    :artist_url
  ])
end

.openapi_typesObject

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
# File 'lib/phyllo/models/activity_artist.rb', line 95

def self.openapi_types
  {
    id: :String,
    created_at: :Time,
    updated_at: :Time,
    user: :UserAttribute1,
    account: :AccountAttribute1,
    work_platform: :WorkPlatformAttribute1,
    platform_artist_id: :String,
    image_url: :String,
    artist_name: :String,
    artist_url: :String,
    genre: :"Array<String>",
    activity_type: :String
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



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

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_artist_id == other.platform_artist_id &&
    image_url == other.image_url &&
    artist_name == other.artist_name &&
    artist_url == other.artist_url &&
    genre == other.genre &&
    activity_type == other.activity_type
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



387
388
389
390
391
392
393
394
395
396
397
398
399
# File 'lib/phyllo/models/activity_artist.rb', line 387

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


279
280
281
# File 'lib/phyllo/models/activity_artist.rb', line 279

def eql?(other)
  self == other
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



285
286
287
# File 'lib/phyllo/models/activity_artist.rb', line 285

def hash
  [id, created_at, updated_at, user, , work_platform, platform_artist_id, image_url, artist_name, artist_url, genre, activity_type].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



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

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 @user.nil?
    invalid_properties.push('invalid value for "user", user cannot be nil.')
  end

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

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

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

  if @artist_name.nil?
    invalid_properties.push('invalid value for "artist_name", artist_name 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_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



363
364
365
# File 'lib/phyllo/models/activity_artist.rb', line 363

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



369
370
371
372
373
374
375
376
377
378
379
380
381
# File 'lib/phyllo/models/activity_artist.rb', line 369

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



357
358
359
# File 'lib/phyllo/models/activity_artist.rb', line 357

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



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
# File 'lib/phyllo/models/activity_artist.rb', line 232

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 @user.nil?
  return false if @account.nil?
  return false if @work_platform.nil?
  return false if @platform_artist_id.nil?
  return false if @artist_name.nil?
  return false if @activity_type.nil?
  activity_type_validator = EnumAttributeValidator.new("String", ["FOLLOWED", "TOP"])
  return false unless activity_type_validator.valid?(@activity_type)
  true
end