Class: FlatApi::Collection

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

Overview

Collection of scores

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Collection

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/flat_api/models/collection.rb', line 130

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'capabilities')
    self.capabilities = attributes[:'capabilities']
  else
    self.capabilities = nil
  end

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

Instance Attribute Details

#app ⇒ Object

Returns the value of attribute app.



35
36
37
 
# File 'lib/flat_api/models/collection.rb', line 35

def app
  @app
end

#capabilities ⇒ Object

Returns the value of attribute capabilities.



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

def capabilities
  @capabilities
end

#collaborators ⇒ Object

The list of the collaborators of the collection



48
49
50
 
# File 'lib/flat_api/models/collection.rb', line 48

def collaborators
  @collaborators
end

#collections ⇒ Object

The List of parent collections, which includes all the collections this score is included. Please note that you might not have access to all of them.



53
54
55
 
# File 'lib/flat_api/models/collection.rb', line 53

def collections
  @collections
end

#creation_date ⇒ Object

The date when the collection was created



38
39
40
 
# File 'lib/flat_api/models/collection.rb', line 38

def creation_date
  @creation_date
end

#html_url ⇒ Object

The url where the collection can be viewed in a web browser



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

def html_url
  @html_url
end

#id ⇒ Object

Unique identifier of the collection



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

def id
  @id
end

#organization ⇒ Object

If the score has been created in an organization, the identifier of this organization.



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

def organization
  @organization
end

#privacy ⇒ Object

Returns the value of attribute privacy.



30
31
32
 
# File 'lib/flat_api/models/collection.rb', line 30

def privacy
  @privacy
end

#rights ⇒ Object

Returns the value of attribute rights.



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

def rights
  @rights
end

#sharing_key ⇒ Object

The private sharing key of the collection (available when the ‘privacy` mode is set to `privateLink`)



33
34
35
 
# File 'lib/flat_api/models/collection.rb', line 33

def sharing_key
  @sharing_key
end

#title ⇒ Object

The title of the collection



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

def title
  @title
end

#type ⇒ Object

Returns the value of attribute type.



28
29
30
 
# File 'lib/flat_api/models/collection.rb', line 28

def type
  @type
end

#user ⇒ Object

Returns the value of attribute user.



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

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



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

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



98
99
100
 
# File 'lib/flat_api/models/collection.rb', line 98

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/flat_api/models/collection.rb', line 78

def self.attribute_map
  {
    :'id' => :'id',
    :'title' => :'title',
    :'html_url' => :'htmlUrl',
    :'type' => :'type',
    :'privacy' => :'privacy',
    :'sharing_key' => :'sharingKey',
    :'app' => :'app',
    :'creation_date' => :'creationDate',
    :'user' => :'user',
    :'organization' => :'organization',
    :'rights' => :'rights',
    :'collaborators' => :'collaborators',
    :'capabilities' => :'capabilities',
    :'collections' => :'collections'
  }
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



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/flat_api/models/collection.rb', line 262

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



123
124
125
126
 
# File 'lib/flat_api/models/collection.rb', line 123

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

.openapi_types ⇒ Object

Attribute type mapping.



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/flat_api/models/collection.rb', line 103

def self.openapi_types
  {
    :'id' => :'String',
    :'title' => :'String',
    :'html_url' => :'String',
    :'type' => :'CollectionType',
    :'privacy' => :'CollectionPrivacy',
    :'sharing_key' => :'String',
    :'app' => :'CollectionApp',
    :'creation_date' => :'Time',
    :'user' => :'UserPublicSummary',
    :'organization' => :'String',
    :'rights' => :'ResourceRights',
    :'collaborators' => :'Array<ResourceCollaborator>',
    :'capabilities' => :'CollectionCapabilities',
    :'collections' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/flat_api/models/collection.rb', line 228

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      title == o.title &&
      html_url == o.html_url &&
      type == o.type &&
      privacy == o.privacy &&
      sharing_key == o.sharing_key &&
      app == o.app &&
      creation_date == o.creation_date &&
      user == o.user &&
      organization == o.organization &&
      rights == o.rights &&
      collaborators == o.collaborators &&
      capabilities == o.capabilities &&
      collections == o.collections
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



357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/flat_api/models/collection.rb', line 357

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


249
250
251
 
# File 'lib/flat_api/models/collection.rb', line 249

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



255
256
257
 
# File 'lib/flat_api/models/collection.rb', line 255

def hash
  [id, title, html_url, type, privacy, sharing_key, app, creation_date, user, organization, rights, collaborators, capabilities, collections].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



208
209
210
211
212
213
214
215
216
 
# File 'lib/flat_api/models/collection.rb', line 208

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @capabilities.nil?
    invalid_properties.push('invalid value for "capabilities", capabilities 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



333
334
335
 
# File 'lib/flat_api/models/collection.rb', line 333

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



339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/flat_api/models/collection.rb', line 339

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



327
328
329
 
# File 'lib/flat_api/models/collection.rb', line 327

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



220
221
222
223
224
 
# File 'lib/flat_api/models/collection.rb', line 220

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @capabilities.nil?
  true
end