Class: FlatApi::ScoreModification

Inherits:
Object
  • Object
show all
Defined in:
lib/flat_api/models/score_modification.rb

Overview

Edit the score metadata

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ScoreModification

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/flat_api/models/score_modification.rb', line 131

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

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

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

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

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

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

  if attributes.key?(:'privacy')
    self.privacy = attributes[:'privacy']
  else
    self.privacy = 'private'
  end

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

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

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

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

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

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

Instance Attribute Details

#arranger ⇒ Object

The arranger of the score



32
33
34
 
# File 'lib/flat_api/models/score_modification.rb', line 32

def arranger
  @arranger
end

#composer ⇒ Object

The composer of the score



26
27
28
 
# File 'lib/flat_api/models/score_modification.rb', line 26

def composer
  @composer
end

#creation_type ⇒ Object

Returns the value of attribute creation_type.



45
46
47
 
# File 'lib/flat_api/models/score_modification.rb', line 45

def creation_type
  @creation_type
end

#description ⇒ Object

Description of the creation



40
41
42
 
# File 'lib/flat_api/models/score_modification.rb', line 40

def description
  @description
end

#license ⇒ Object

Returns the value of attribute license.



47
48
49
 
# File 'lib/flat_api/models/score_modification.rb', line 47

def license
  @license
end

#license_text ⇒ Object

The rights info written on the score



50
51
52
 
# File 'lib/flat_api/models/score_modification.rb', line 50

def license_text
  @license_text
end

#lyricist ⇒ Object

The lyricist of the score



29
30
31
 
# File 'lib/flat_api/models/score_modification.rb', line 29

def lyricist
  @lyricist
end

#privacy ⇒ Object

Returns the value of attribute privacy.



34
35
36
 
# File 'lib/flat_api/models/score_modification.rb', line 34

def privacy
  @privacy
end

#sharing_key ⇒ Object

When using the ‘privacy` mode `privateLink`, this property can be used to set a custom sharing key, otherwise a new key will be generated.



37
38
39
 
# File 'lib/flat_api/models/score_modification.rb', line 37

def sharing_key
  @sharing_key
end

#subtitle ⇒ Object

The subtitle of the score



23
24
25
 
# File 'lib/flat_api/models/score_modification.rb', line 23

def subtitle
  @subtitle
end

#tags ⇒ Object

Tags describing the score



43
44
45
 
# File 'lib/flat_api/models/score_modification.rb', line 43

def tags
  @tags
end

#title ⇒ Object

The title of the score



20
21
22
 
# File 'lib/flat_api/models/score_modification.rb', line 20

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



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
 
# File 'lib/flat_api/models/score_modification.rb', line 306

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 = FlatApi.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



93
94
95
 
# File 'lib/flat_api/models/score_modification.rb', line 93

def self.acceptable_attributes
  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
 
# File 'lib/flat_api/models/score_modification.rb', line 75

def self.attribute_map
  {
    :'title' => :'title',
    :'subtitle' => :'subtitle',
    :'composer' => :'composer',
    :'lyricist' => :'lyricist',
    :'arranger' => :'arranger',
    :'privacy' => :'privacy',
    :'sharing_key' => :'sharingKey',
    :'description' => :'description',
    :'tags' => :'tags',
    :'creation_type' => :'creationType',
    :'license' => :'license',
    :'license_text' => :'licenseText'
  }
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



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/flat_api/models/score_modification.rb', line 282

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



116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/flat_api/models/score_modification.rb', line 116

def self.openapi_nullable
  Set.new([
    :'subtitle',
    :'composer',
    :'lyricist',
    :'arranger',
    :'description',
    :'creation_type',
    :'license',
    :'license_text'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/flat_api/models/score_modification.rb', line 98

def self.openapi_types
  {
    :'title' => :'String',
    :'subtitle' => :'String',
    :'composer' => :'String',
    :'lyricist' => :'String',
    :'arranger' => :'String',
    :'privacy' => :'ScorePrivacy',
    :'sharing_key' => :'String',
    :'description' => :'String',
    :'tags' => :'Array<String>',
    :'creation_type' => :'ScoreCreationType',
    :'license' => :'ScoreLicense',
    :'license_text' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/flat_api/models/score_modification.rb', line 250

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      title == o.title &&
      subtitle == o.subtitle &&
      composer == o.composer &&
      lyricist == o.lyricist &&
      arranger == o.arranger &&
      privacy == o.privacy &&
      sharing_key == o.sharing_key &&
      description == o.description &&
      tags == o.tags &&
      creation_type == o.creation_type &&
      license == o.license &&
      license_text == o.license_text
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



377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/flat_api/models/score_modification.rb', line 377

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?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


269
270
271
 
# File 'lib/flat_api/models/score_modification.rb', line 269

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



275
276
277
 
# File 'lib/flat_api/models/score_modification.rb', line 275

def hash
  [title, subtitle, composer, lyricist, arranger, privacy, sharing_key, description, tags, creation_type, license, license_text].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



199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/flat_api/models/score_modification.rb', line 199

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  pattern = Regexp.new(/^[a-f0-9]{128}$/)
  if !@sharing_key.nil? && @sharing_key !~ pattern
    invalid_properties.push("invalid value for \"sharing_key\", must conform to the pattern #{pattern}.")
  end

  if !@description.nil? && @description.to_s.length > 2000
    invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 2000.')
  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



353
354
355
 
# File 'lib/flat_api/models/score_modification.rb', line 353

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



359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/flat_api/models/score_modification.rb', line 359

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



347
348
349
 
# File 'lib/flat_api/models/score_modification.rb', line 347

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



216
217
218
219
220
221
 
# File 'lib/flat_api/models/score_modification.rb', line 216

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@sharing_key.nil? && @sharing_key !~ Regexp.new(/^[a-f0-9]{128}$/)
  return false if !@description.nil? && @description.to_s.length > 2000
  true
end