class FlatApi::ResourceCollaboratorCreation
Add a collaborator to a resource.
Attributes
`True` if the related user can can manage the current document, i.e. changing the document permissions and deleting the document
`True` if the related user can read the score. (probably true if the user has a permission on the document).
`True` if the related user can modify the score.
The unique identifier of a Flat group
The unique identifier of a Flat user
Fill this field to invite an individual user by email.
Token received in an invitation to join the score.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/flat_api/models/resource_collaborator_creation.rb, line 41 def self.attribute_map { :'user' => :'user', :'group' => :'group', :'user_email' => :'userEmail', :'user_token' => :'userToken', :'acl_read' => :'aclRead', :'acl_write' => :'aclWrite', :'acl_admin' => :'aclAdmin' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/flat_api/models/resource_collaborator_creation.rb, line 68 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?(:'userToken') self.user_token = attributes[:'userToken'] 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
Attribute type mapping.
# File lib/flat_api/models/resource_collaborator_creation.rb, line 54 def self.swagger_types { :'user' => :'String', :'group' => :'String', :'user_email' => :'String', :'user_token' => :'String', :'acl_read' => :'BOOLEAN', :'acl_write' => :'BOOLEAN', :'acl_admin' => :'BOOLEAN' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/flat_api/models/resource_collaborator_creation.rb, line 125 def ==(o) return true if self.equal?(o) self.class == o.class && user == o.user && group == o.group && user_email == o.user_email && user_token == o.user_token && acl_read == o.acl_read && acl_write == o.acl_write && acl_admin == o.acl_admin end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/flat_api/models/resource_collaborator_creation.rb, line 173 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
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/flat_api/models/resource_collaborator_creation.rb, line 239 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/flat_api/models/resource_collaborator_creation.rb, line 152 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
@see the `==` method @param [Object] Object to be compared
# File lib/flat_api/models/resource_collaborator_creation.rb, line 139 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/flat_api/models/resource_collaborator_creation.rb, line 145 def hash [user, group, user_email, user_token, acl_read, acl_write, acl_admin].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/flat_api/models/resource_collaborator_creation.rb, line 112 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/flat_api/models/resource_collaborator_creation.rb, line 225 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/flat_api/models/resource_collaborator_creation.rb, line 213 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/flat_api/models/resource_collaborator_creation.rb, line 119 def valid? return true end