Class: Bfwd::Role

Inherits:
Object
  • Object
show all
Defined in:
lib/bf_ruby2/models/role.rb

Overview

Role

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Role

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# 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

Instance Attribute Details

#changed_by ⇒ Object

{ "description" : "ID of the user who last updated the entity.", "verbs":[] }



22
23
24
 
# File 'lib/bf_ruby2/models/role.rb', line 22

def changed_by
  @changed_by
end

#created ⇒ Object

{ "description" : "The UTC DateTime when the object was created.", "verbs":[] }



19
20
21
 
# File 'lib/bf_ruby2/models/role.rb', line 19

def created
  @created
end

#default_returned ⇒ Object

{ "default" : "false", "description" : "When returning the list of roles for an account, this indicates if the role was returned due to defaulting.", "verbs“: }



49
50
51
 
# File 'lib/bf_ruby2/models/role.rb', line 49

def default_returned
  @default_returned
end

#default_role ⇒ Object

{ "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“: }



46
47
48
 
# File 'lib/bf_ruby2/models/role.rb', line 46

def default_role
  @default_role
end

#deleted ⇒ Object

{ "default" : "false", "description" : "If a role is deleted any account in the role will no longer have its permissions.", "verbs“: }



43
44
45
 
# File 'lib/bf_ruby2/models/role.rb', line 43

def deleted
  @deleted
end

#description ⇒ Object

{ "description" : "Friendly description of the role.", "verbs“: }



37
38
39
 
# File 'lib/bf_ruby2/models/role.rb', line 37

def description
  @description
end

#id ⇒ Object

{ "description" : "", "verbs“: }



28
29
30
 
# File 'lib/bf_ruby2/models/role.rb', line 28

def id
  @id
end

#name ⇒ Object

{ "description" : "Friendly name of the role.", "verbs“: }



34
35
36
 
# File 'lib/bf_ruby2/models/role.rb', line 34

def name
  @name
end

#organization_id ⇒ Object

{ "description" : "", "verbs“: }



31
32
33
 
# File 'lib/bf_ruby2/models/role.rb', line 31

def organization_id
  @organization_id
end

#permissions ⇒ Object

{ "description" : "List of permissions in this role.", "verbs“: }



52
53
54
 
# File 'lib/bf_ruby2/models/role.rb', line 52

def permissions
  @permissions
end

#revoked ⇒ Object

{ "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“: }



40
41
42
 
# File 'lib/bf_ruby2/models/role.rb', line 40

def revoked
  @revoked
end

#updated ⇒ Object

{ "description" : "The UTC DateTime when the object was last updated.", "verbs":[] }



25
26
27
 
# File 'lib/bf_ruby2/models/role.rb', line 25

def updated
  @updated
end

Class Method Details

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# 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

.swagger_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# 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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# 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

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



225
226
227
228
229
230
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
 
# 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

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



291
292
293
294
295
296
297
298
299
300
301
302
303
 
# 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

#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



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# 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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


191
192
193
 
# File 'lib/bf_ruby2/models/role.rb', line 191

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



197
198
199
 
# 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

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



159
160
161
162
 
# File 'lib/bf_ruby2/models/role.rb', line 159

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



271
272
273
 
# File 'lib/bf_ruby2/models/role.rb', line 271

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



277
278
279
280
281
282
283
284
285
 
# 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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



265
266
267
 
# File 'lib/bf_ruby2/models/role.rb', line 265

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



166
167
168
 
# File 'lib/bf_ruby2/models/role.rb', line 166

def valid?
  return true
end