class Bfwd::Role
Attributes
{ "description" : "ID of the user who last updated the entity.", "verbs":[] }
{ "description" : "The UTC DateTime when the object was created.", "verbs":[] }
{ "default" : "false", "description" : "When returning the list of roles for an account, this indicates if the role was returned due to defaulting.", "verbs":["GET","POST","PUT"] }
{ "default" : "false", "description" : "If set this role will become the default role for the organization. Any accounts without an explicitly set role will have this applied.", "verbs":["GET","POST","PUT"] }
{ "default" : "false", "description" : "If a role is deleted any account in the role will no longer have its permissions.", "verbs":["GET","POST","PUT"] }
{ "description" : "Friendly description of the role.", "verbs":["GET","POST","PUT"] }
{ "description" : "", "verbs":["GET"] }
{ "description" : "Friendly name of the role.", "verbs":["GET","POST","PUT"] }
{ "description" : "", "verbs":[""] }
{ "description" : "List of permissions in this role.", "verbs":["GET","POST","PUT"] }
{ "description" : "If a role is deleted it is set as revoked from this date. Any account in the role will no longer have its permissions.", "verbs":["GET","POST","PUT"] }
{ "description" : "The UTC DateTime when the object was last updated.", "verbs":[] }
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/bf_ruby2/models/role.rb, line 56 def self.attribute_map { :'created' => :'created', :'changed_by' => :'changedBy', :'updated' => :'updated', :'id' => :'id', :'organization_id' => :'organizationID', :'name' => :'name', :'description' => :'description', :'revoked' => :'revoked', :'deleted' => :'deleted', :'default_role' => :'defaultRole', :'default_returned' => :'defaultReturned', :'permissions' => :'permissions' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/bf_ruby2/models/role.rb, line 93 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?(:'created') self.created = attributes[:'created'] end if attributes.has_key?(:'changedBy') self.changed_by = attributes[:'changedBy'] end if attributes.has_key?(:'updated') self.updated = attributes[:'updated'] end if attributes.has_key?(:'id') self.id = attributes[:'id'] end if attributes.has_key?(:'organizationID') self.organization_id = attributes[:'organizationID'] end if attributes.has_key?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'description') self.description = attributes[:'description'] end if attributes.has_key?(:'revoked') self.revoked = attributes[:'revoked'] end if attributes.has_key?(:'deleted') self.deleted = attributes[:'deleted'] else self.deleted = false end if attributes.has_key?(:'defaultRole') self.default_role = attributes[:'defaultRole'] else self.default_role = false end if attributes.has_key?(:'defaultReturned') self.default_returned = attributes[:'defaultReturned'] else self.default_returned = false end if attributes.has_key?(:'permissions') if (value = attributes[:'permissions']).is_a?(Array) self.permissions = value end end end
Attribute type mapping.
# File lib/bf_ruby2/models/role.rb, line 74 def self.swagger_types { :'created' => :'DateTime', :'changed_by' => :'String', :'updated' => :'DateTime', :'id' => :'String', :'organization_id' => :'String', :'name' => :'String', :'description' => :'String', :'revoked' => :'DateTime', :'deleted' => :'BOOLEAN', :'default_role' => :'BOOLEAN', :'default_returned' => :'BOOLEAN', :'permissions' => :'Array<BFPermission>' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/bf_ruby2/models/role.rb, line 172 def ==(o) return true if self.equal?(o) self.class == o.class && created == o.created && changed_by == o.changed_by && updated == o.updated && id == o.id && organization_id == o.organization_id && name == o.name && description == o.description && revoked == o.revoked && deleted == o.deleted && default_role == o.default_role && default_returned == o.default_returned && permissions == o.permissions 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/bf_ruby2/models/role.rb, line 225 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 = Bfwd.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/bf_ruby2/models/role.rb, line 291 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/bf_ruby2/models/role.rb, line 204 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/bf_ruby2/models/role.rb, line 191 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/bf_ruby2/models/role.rb, line 197 def hash [created, changed_by, updated, id, organization_id, name, description, revoked, deleted, default_role, default_returned, permissions].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/bf_ruby2/models/role.rb, line 159 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/bf_ruby2/models/role.rb, line 277 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/bf_ruby2/models/role.rb, line 265 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/bf_ruby2/models/role.rb, line 166 def valid? return true end