Class: FlatApi::ResourceRights
- Inherits:
-
Object
- Object
- FlatApi::ResourceRights
- Defined in:
- lib/flat_api/models/resource_rights.rb
Overview
The rights of the current user on a score or collection
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#acl_admin ⇒ Object
‘True` if the current user can manage the current document (i.e. share, delete) If this is a right of a Collection, the capabilities of the associated user can be lower than this permission, check out the `capabilities` property as the end-user to have the complete possibilities with the collection.
-
#acl_read ⇒ Object
‘True` if the current user can read the current document.
-
#acl_write ⇒ Object
‘True` if the current user can modify the current document.
-
#collaborator_type ⇒ Object
The type of the collaborator for the resource.
-
#is_collaborator ⇒ Object
‘True` if the current user is a collaborator of the current document (direct or via group).
Class Method Summary collapse
-
._deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about.
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ ResourceRights
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ ResourceRights
Initializes the object
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 |
# File 'lib/flat_api/models/resource_rights.rb', line 91 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `FlatApi::ResourceRights` 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::ResourceRights`. 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?(:'acl_read') self.acl_read = attributes[:'acl_read'] else self.acl_read = false end if attributes.key?(:'acl_write') self.acl_write = attributes[:'acl_write'] else self.acl_write = false end if attributes.key?(:'acl_admin') self.acl_admin = attributes[:'acl_admin'] else self.acl_admin = false end if attributes.key?(:'is_collaborator') self.is_collaborator = attributes[:'is_collaborator'] else self.is_collaborator = false end if attributes.key?(:'collaborator_type') self.collaborator_type = attributes[:'collaborator_type'] end end |
Instance Attribute Details
#acl_admin ⇒ Object
‘True` if the current user can manage the current document (i.e. share, delete) If this is a right of a Collection, the capabilities of the associated user can be lower than this permission, check out the `capabilities` property as the end-user to have the complete possibilities with the collection.
26 27 28 |
# File 'lib/flat_api/models/resource_rights.rb', line 26 def acl_admin @acl_admin end |
#acl_read ⇒ Object
‘True` if the current user can read the current document
20 21 22 |
# File 'lib/flat_api/models/resource_rights.rb', line 20 def acl_read @acl_read end |
#acl_write ⇒ Object
‘True` if the current user can modify the current document. If this is a right of a Collection, the capabilities of the associated user can be lower than this permission, check out the `capabilities` property as the end-user to have the complete possibilities with the collection.
23 24 25 |
# File 'lib/flat_api/models/resource_rights.rb', line 23 def acl_write @acl_write end |
#collaborator_type ⇒ Object
The type of the collaborator for the resource
32 33 34 |
# File 'lib/flat_api/models/resource_rights.rb', line 32 def collaborator_type @collaborator_type end |
#is_collaborator ⇒ Object
‘True` if the current user is a collaborator of the current document (direct or via group).
29 30 31 |
# File 'lib/flat_api/models/resource_rights.rb', line 29 def is_collaborator @is_collaborator end |
Class Method Details
._deserialize(type, value) ⇒ Object
Deserializes the data based on type
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 |
# File 'lib/flat_api/models/resource_rights.rb', line 231 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
68 69 70 |
# File 'lib/flat_api/models/resource_rights.rb', line 68 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
57 58 59 60 61 62 63 64 65 |
# File 'lib/flat_api/models/resource_rights.rb', line 57 def self.attribute_map { :'acl_read' => :'aclRead', :'acl_write' => :'aclWrite', :'acl_admin' => :'aclAdmin', :'is_collaborator' => :'isCollaborator', :'collaborator_type' => :'collaboratorType' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 |
# File 'lib/flat_api/models/resource_rights.rb', line 207 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
84 85 86 87 |
# File 'lib/flat_api/models/resource_rights.rb', line 84 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
73 74 75 76 77 78 79 80 81 |
# File 'lib/flat_api/models/resource_rights.rb', line 73 def self.openapi_types { :'acl_read' => :'Boolean', :'acl_write' => :'Boolean', :'acl_admin' => :'Boolean', :'is_collaborator' => :'Boolean', :'collaborator_type' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
182 183 184 185 186 187 188 189 190 |
# File 'lib/flat_api/models/resource_rights.rb', line 182 def ==(o) return true if self.equal?(o) self.class == o.class && acl_read == o.acl_read && acl_write == o.acl_write && acl_admin == o.acl_admin && is_collaborator == o.is_collaborator && collaborator_type == o.collaborator_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
302 303 304 305 306 307 308 309 310 311 312 313 314 |
# File 'lib/flat_api/models/resource_rights.rb', line 302 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
194 195 196 |
# File 'lib/flat_api/models/resource_rights.rb', line 194 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
200 201 202 |
# File 'lib/flat_api/models/resource_rights.rb', line 200 def hash [acl_read, acl_write, acl_admin, is_collaborator, collaborator_type].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 |
# File 'lib/flat_api/models/resource_rights.rb', line 135 def list_invalid_properties warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' invalid_properties = Array.new if @acl_read.nil? invalid_properties.push('invalid value for "acl_read", acl_read cannot be nil.') end if @acl_write.nil? invalid_properties.push('invalid value for "acl_write", acl_write cannot be nil.') end if @acl_admin.nil? invalid_properties.push('invalid value for "acl_admin", acl_admin cannot be nil.') end if @is_collaborator.nil? invalid_properties.push('invalid value for "is_collaborator", is_collaborator cannot be nil.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
278 279 280 |
# File 'lib/flat_api/models/resource_rights.rb', line 278 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
284 285 286 287 288 289 290 291 292 293 294 295 296 |
# File 'lib/flat_api/models/resource_rights.rb', line 284 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
272 273 274 |
# File 'lib/flat_api/models/resource_rights.rb', line 272 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
159 160 161 162 163 164 165 166 167 168 |
# File 'lib/flat_api/models/resource_rights.rb', line 159 def valid? warn '[DEPRECATED] the `valid?` method is obsolete' return false if @acl_read.nil? return false if @acl_write.nil? return false if @acl_admin.nil? return false if @is_collaborator.nil? collaborator_type_validator = EnumAttributeValidator.new('String', ["owner", "user", "group"]) return false unless collaborator_type_validator.valid?(@collaborator_type) true end |