Class: FlatApi::ScoreCollaboratorCreation

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

Overview

A collaborator of a score. The ‘userEmail` and `group` are only available if the requesting user is a collaborator of the related score (in this case these permissions will eventualy not be listed and exposed publicly).

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ScoreCollaboratorCreation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/flat_api/models/score_collaborator_creation.rb', line 63

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

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

  if attributes.has_key?(:'group')
    self.group = attributes[:'group']
  end

  if attributes.has_key?(:'userEmail')
    self.user_email = attributes[:'userEmail']
  end

  if attributes.has_key?(:'aclRead')
    self.acl_read = attributes[:'aclRead']
  else
    self.acl_read = true
  end

  if attributes.has_key?(:'aclWrite')
    self.acl_write = attributes[:'aclWrite']
  else
    self.acl_write = false
  end

  if attributes.has_key?(:'aclAdmin')
    self.acl_admin = attributes[:'aclAdmin']
  else
    self.acl_admin = false
  end

end

Instance Attribute Details

#acl_admin ⇒ Object

‘True` if the related user can can manage the current document, i.e. changing the document permissions and deleting the document



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

def acl_admin
  @acl_admin
end

#acl_read ⇒ Object

‘True` if the related user can read the score. (probably true if the user has a permission on the document).



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

def acl_read
  @acl_read
end

#acl_write ⇒ Object

‘True` if the related user can modify the score.



31
32
33
 
# File 'lib/flat_api/models/score_collaborator_creation.rb', line 31

def acl_write
  @acl_write
end

#group ⇒ Object

The unique identifier of a Flat group



22
23
24
 
# File 'lib/flat_api/models/score_collaborator_creation.rb', line 22

def group
  @group
end

#user ⇒ Object

The unique identifier of a Flat user



19
20
21
 
# File 'lib/flat_api/models/score_collaborator_creation.rb', line 19

def user
  @user
end

#user_email ⇒ Object

Fill this field to invite an individual user by email.



25
26
27
 
# File 'lib/flat_api/models/score_collaborator_creation.rb', line 25

def user_email
  @user_email
end

Class Method Details

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
 
# File 'lib/flat_api/models/score_collaborator_creation.rb', line 38

def self.attribute_map
  {
    :'user' => :'user',
    :'group' => :'group',
    :'user_email' => :'userEmail',
    :'acl_read' => :'aclRead',
    :'acl_write' => :'aclWrite',
    :'acl_admin' => :'aclAdmin'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



50
51
52
53
54
55
56
57
58
59
 
# File 'lib/flat_api/models/score_collaborator_creation.rb', line 50

def self.swagger_types
  {
    :'user' => :'String',
    :'group' => :'String',
    :'user_email' => :'String',
    :'acl_read' => :'BOOLEAN',
    :'acl_write' => :'BOOLEAN',
    :'acl_admin' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      user == o.user &&
      group == o.group &&
      user_email == o.user_email &&
      acl_read == o.acl_read &&
      acl_write == o.acl_write &&
      acl_admin == o.acl_admin
end

#_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



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

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = FlatApi.const_get(type).new
    temp_model.build_from_hash(value)
  end
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



229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/flat_api/models/score_collaborator_creation.rb', line 229

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

#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



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/flat_api/models/score_collaborator_creation.rb', line 142

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


129
130
131
 
# File 'lib/flat_api/models/score_collaborator_creation.rb', line 129

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



135
136
137
 
# File 'lib/flat_api/models/score_collaborator_creation.rb', line 135

def hash
  [user, group, user_email, acl_read, acl_write, acl_admin].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



103
104
105
106
 
# File 'lib/flat_api/models/score_collaborator_creation.rb', line 103

def list_invalid_properties
  invalid_properties = Array.new
  return 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



209
210
211
 
# File 'lib/flat_api/models/score_collaborator_creation.rb', line 209

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



215
216
217
218
219
220
221
222
223
 
# File 'lib/flat_api/models/score_collaborator_creation.rb', line 215

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



203
204
205
 
# File 'lib/flat_api/models/score_collaborator_creation.rb', line 203

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



110
111
112
 
# File 'lib/flat_api/models/score_collaborator_creation.rb', line 110

def valid?
  return true
end