Class: FlatApi::GroupDetails

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

Overview

The details of a group

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GroupDetails

Initializes the object



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

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `FlatApi::GroupDetails` 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::GroupDetails`. 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?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  end

  if attributes.key?(:'organization')
    self.organization = attributes[:'organization']
  end

  if attributes.key?(:'creation_date')
    self.creation_date = attributes[:'creation_date']
  end

  if attributes.key?(:'users_count')
    self.users_count = attributes[:'users_count']
  end

  if attributes.key?(:'read_only')
    self.read_only = attributes[:'read_only']
  end
end

Instance Attribute Details

#creation_date ⇒ Object

The date when the group was create



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

def creation_date
  @creation_date
end

#id ⇒ Object

The unique identifier of the group



20
21
22
 
# File 'lib/flat_api/models/group_details.rb', line 20

def id
  @id
end

#name ⇒ Object

The displayable name of the group



23
24
25
 
# File 'lib/flat_api/models/group_details.rb', line 23

def name
  @name
end

#organization ⇒ Object

The unique identifier of the Organization owning the group



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

def organization
  @organization
end

#read_only ⇒ Object

true if the properties and members of this group are in in read-only



37
38
39
 
# File 'lib/flat_api/models/group_details.rb', line 37

def read_only
  @read_only
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

#users_count ⇒ Object

The number of students in this group



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

def users_count
  @users_count
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/flat_api/models/group_details.rb', line 210

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



75
76
77
 
# File 'lib/flat_api/models/group_details.rb', line 75

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/flat_api/models/group_details.rb', line 62

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'type' => :'type',
    :'organization' => :'organization',
    :'creation_date' => :'creationDate',
    :'users_count' => :'usersCount',
    :'read_only' => :'readOnly'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/flat_api/models/group_details.rb', line 186

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



93
94
95
96
 
# File 'lib/flat_api/models/group_details.rb', line 93

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/flat_api/models/group_details.rb', line 80

def self.openapi_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'type' => :'GroupType',
    :'organization' => :'String',
    :'creation_date' => :'Time',
    :'users_count' => :'Float',
    :'read_only' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/flat_api/models/group_details.rb', line 159

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      type == o.type &&
      organization == o.organization &&
      creation_date == o.creation_date &&
      users_count == o.users_count &&
      read_only == o.read_only
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/flat_api/models/group_details.rb', line 281

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

See Also:

  • `==` method


173
174
175
 
# File 'lib/flat_api/models/group_details.rb', line 173

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



179
180
181
 
# File 'lib/flat_api/models/group_details.rb', line 179

def hash
  [id, name, type, organization, creation_date, users_count, read_only].hash
end

#list_invalid_properties ⇒ Object

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



144
145
146
147
148
 
# File 'lib/flat_api/models/group_details.rb', line 144

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



257
258
259
 
# File 'lib/flat_api/models/group_details.rb', line 257

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/flat_api/models/group_details.rb', line 263

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



251
252
253
 
# File 'lib/flat_api/models/group_details.rb', line 251

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



152
153
154
155
 
# File 'lib/flat_api/models/group_details.rb', line 152

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end