Class: SwaggerClient::ModelClass

Inherits:
Object
  • Object
show all
Defined in:
lib/swagger_client/models/model_class.rb

Overview

Represents a single class instance. The class meets at the start time, goes until the end time.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ModelClass

Initializes the object

Parameters:

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

    Model attributes in the form of hash



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
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
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/swagger_client/models/model_class.rb', line 184

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?(:'ClassScheduleId')
    self.class_schedule_id = attributes[:'ClassScheduleId']
  end

  if attributes.has_key?(:'Visits')
    if (value = attributes[:'Visits']).is_a?(Array)
      self.visits = value
    end
  end

  if attributes.has_key?(:'Clients')
    if (value = attributes[:'Clients']).is_a?(Array)
      self.clients = value
    end
  end

  if attributes.has_key?(:'Location')
    self.location = attributes[:'Location']
  end

  if attributes.has_key?(:'Resource')
    self.resource = attributes[:'Resource']
  end

  if attributes.has_key?(:'MaxCapacity')
    self.max_capacity = attributes[:'MaxCapacity']
  end

  if attributes.has_key?(:'WebCapacity')
    self.web_capacity = attributes[:'WebCapacity']
  end

  if attributes.has_key?(:'TotalBooked')
    self.total_booked = attributes[:'TotalBooked']
  end

  if attributes.has_key?(:'TotalBookedWaitlist')
    self.total_booked_waitlist = attributes[:'TotalBookedWaitlist']
  end

  if attributes.has_key?(:'WebBooked')
    self.web_booked = attributes[:'WebBooked']
  end

  if attributes.has_key?(:'SemesterId')
    self.semester_id = attributes[:'SemesterId']
  end

  if attributes.has_key?(:'IsCanceled')
    self.is_canceled = attributes[:'IsCanceled']
  end

  if attributes.has_key?(:'Substitute')
    self.substitute = attributes[:'Substitute']
  end

  if attributes.has_key?(:'Active')
    self.active = attributes[:'Active']
  end

  if attributes.has_key?(:'IsWaitlistAvailable')
    self.is_waitlist_available = attributes[:'IsWaitlistAvailable']
  end

  if attributes.has_key?(:'IsEnrolled')
    self.is_enrolled = attributes[:'IsEnrolled']
  end

  if attributes.has_key?(:'HideCancel')
    self.hide_cancel = attributes[:'HideCancel']
  end

  if attributes.has_key?(:'Id')
    self.id = attributes[:'Id']
  end

  if attributes.has_key?(:'IsAvailable')
    self.is_available = attributes[:'IsAvailable']
  end

  if attributes.has_key?(:'StartDateTime')
    self.start_date_time = attributes[:'StartDateTime']
  end

  if attributes.has_key?(:'EndDateTime')
    self.end_date_time = attributes[:'EndDateTime']
  end

  if attributes.has_key?(:'LastModifiedDateTime')
    self.last_modified_date_time = attributes[:'LastModifiedDateTime']
  end

  if attributes.has_key?(:'ClassDescription')
    self.class_description = attributes[:'ClassDescription']
  end

  if attributes.has_key?(:'Staff')
    self.staff = attributes[:'Staff']
  end

  if attributes.has_key?(:'BookingWindow')
    self.booking_window = attributes[:'BookingWindow']
  end

  if attributes.has_key?(:'BookingStatus')
    self.booking_status = attributes[:'BookingStatus']
  end
end

Instance Attribute Details

#active ⇒ Object

When ‘true`, indicates that the class is shown to clients when in consumer mode.<br /> When `false`, indicates that the class is not shown to clients when in consumer mode.



58
59
60
 
# File 'lib/swagger_client/models/model_class.rb', line 58

def active
  @active
end

#booking_status ⇒ Object

Contains the booking’s payment status.



94
95
96
 
# File 'lib/swagger_client/models/model_class.rb', line 94

def booking_status
  @booking_status
end

#booking_window ⇒ Object

Contains information about the window for booking.



91
92
93
 
# File 'lib/swagger_client/models/model_class.rb', line 91

def booking_window
  @booking_window
end

#class_description ⇒ Object

Contains information that defines the class.



85
86
87
 
# File 'lib/swagger_client/models/model_class.rb', line 85

def class_description
  @class_description
end

#class_schedule_id ⇒ Object

The ID used to retrieve the class schedule for the desired class.



19
20
21
 
# File 'lib/swagger_client/models/model_class.rb', line 19

def class_schedule_id
  @class_schedule_id
end

#clients ⇒ Object

Contains information about clients.



25
26
27
 
# File 'lib/swagger_client/models/model_class.rb', line 25

def clients
  @clients
end

#end_date_time ⇒ Object

The time this class is scheduled to end.



79
80
81
 
# File 'lib/swagger_client/models/model_class.rb', line 79

def end_date_time
  @end_date_time
end

#hide_cancel ⇒ Object

When ‘true`, indicates that this class is hidden when cancelled.<br /> When `false`, indicates that this class is not hidden when cancelled.



67
68
69
 
# File 'lib/swagger_client/models/model_class.rb', line 67

def hide_cancel
  @hide_cancel
end

#id ⇒ Object

The unique identifier for the class.



70
71
72
 
# File 'lib/swagger_client/models/model_class.rb', line 70

def id
  @id
end

#is_available ⇒ Object

When ‘true`, indicates that the client with the given client ID can book this class.<br /> When `false`, indicates that the client with the given client ID cannot book this class.



73
74
75
 
# File 'lib/swagger_client/models/model_class.rb', line 73

def is_available
  @is_available
end

#is_canceled ⇒ Object

When ‘true`, indicates that the class has been cancelled.<br /> When `false`, indicates that the class has not been cancelled.



52
53
54
 
# File 'lib/swagger_client/models/model_class.rb', line 52

def is_canceled
  @is_canceled
end

#is_enrolled ⇒ Object

When ‘true`, indicates that the client with the given `ClientId` is enrolled in this class.<br /> When `false`, indicates that the client with the given `ClientId` is not enrolled in this class.



64
65
66
 
# File 'lib/swagger_client/models/model_class.rb', line 64

def is_enrolled
  @is_enrolled
end

#is_waitlist_available ⇒ Object

When ‘true`, indicates that the clients can be placed on a waiting list for the class.<br /> When `false`, indicates that the clients cannot be placed on a waiting list for the class.



61
62
63
 
# File 'lib/swagger_client/models/model_class.rb', line 61

def is_waitlist_available
  @is_waitlist_available
end

#last_modified_date_time ⇒ Object

The last time this class was modified.



82
83
84
 
# File 'lib/swagger_client/models/model_class.rb', line 82

def last_modified_date_time
  @last_modified_date_time
end

#location ⇒ Object

Contains information about a location.



28
29
30
 
# File 'lib/swagger_client/models/model_class.rb', line 28

def location
  @location
end

#max_capacity ⇒ Object

The maximum number of clients allowed in the class.



34
35
36
 
# File 'lib/swagger_client/models/model_class.rb', line 34

def max_capacity
  @max_capacity
end

#resource ⇒ Object

Contains information about a resource, such as a room, assigned to a class.



31
32
33
 
# File 'lib/swagger_client/models/model_class.rb', line 31

def resource
  @resource
end

#semester_id ⇒ Object

The ID of the semester that the class is a part of, if any.



49
50
51
 
# File 'lib/swagger_client/models/model_class.rb', line 49

def semester_id
  @semester_id
end

#staff ⇒ Object

Contains information about the staff member.



88
89
90
 
# File 'lib/swagger_client/models/model_class.rb', line 88

def staff
  @staff
end

#start_date_time ⇒ Object

The time this class is scheduled to start.



76
77
78
 
# File 'lib/swagger_client/models/model_class.rb', line 76

def start_date_time
  @start_date_time
end

#substitute ⇒ Object

When ‘true`, indicates that the class is being taught by a substitute teacher.<br /> When `false`, indicates that the class is being taught by its regular teacher.



55
56
57
 
# File 'lib/swagger_client/models/model_class.rb', line 55

def substitute
  @substitute
end

#total_booked ⇒ Object

The total number of clients booked in the class.



40
41
42
 
# File 'lib/swagger_client/models/model_class.rb', line 40

def total_booked
  @total_booked
end

#total_booked_waitlist ⇒ Object

The total number of booked clients on the waiting list for the class.



43
44
45
 
# File 'lib/swagger_client/models/model_class.rb', line 43

def total_booked_waitlist
  @total_booked_waitlist
end

#visits ⇒ Object

Contains information about visits.



22
23
24
 
# File 'lib/swagger_client/models/model_class.rb', line 22

def visits
  @visits
end

#web_booked ⇒ Object

The total number of clients who signed up online for the class.



46
47
48
 
# File 'lib/swagger_client/models/model_class.rb', line 46

def web_booked
  @web_booked
end

#web_capacity ⇒ Object

The maximum number of clients allowed to sign up online for the class.



37
38
39
 
# File 'lib/swagger_client/models/model_class.rb', line 37

def web_capacity
  @web_capacity
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/swagger_client/models/model_class.rb', line 119

def self.attribute_map
  {
    :'class_schedule_id' => :'ClassScheduleId',
    :'visits' => :'Visits',
    :'clients' => :'Clients',
    :'location' => :'Location',
    :'resource' => :'Resource',
    :'max_capacity' => :'MaxCapacity',
    :'web_capacity' => :'WebCapacity',
    :'total_booked' => :'TotalBooked',
    :'total_booked_waitlist' => :'TotalBookedWaitlist',
    :'web_booked' => :'WebBooked',
    :'semester_id' => :'SemesterId',
    :'is_canceled' => :'IsCanceled',
    :'substitute' => :'Substitute',
    :'active' => :'Active',
    :'is_waitlist_available' => :'IsWaitlistAvailable',
    :'is_enrolled' => :'IsEnrolled',
    :'hide_cancel' => :'HideCancel',
    :'id' => :'Id',
    :'is_available' => :'IsAvailable',
    :'start_date_time' => :'StartDateTime',
    :'end_date_time' => :'EndDateTime',
    :'last_modified_date_time' => :'LastModifiedDateTime',
    :'class_description' => :'ClassDescription',
    :'staff' => :'Staff',
    :'booking_window' => :'BookingWindow',
    :'booking_status' => :'BookingStatus'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/swagger_client/models/model_class.rb', line 151

def self.swagger_types
  {
    :'class_schedule_id' => :'Integer',
    :'visits' => :'Array<Visit>',
    :'clients' => :'Array<Client>',
    :'location' => :'Location',
    :'resource' => :'Resource',
    :'max_capacity' => :'Integer',
    :'web_capacity' => :'Integer',
    :'total_booked' => :'Integer',
    :'total_booked_waitlist' => :'Integer',
    :'web_booked' => :'Integer',
    :'semester_id' => :'Integer',
    :'is_canceled' => :'BOOLEAN',
    :'substitute' => :'BOOLEAN',
    :'active' => :'BOOLEAN',
    :'is_waitlist_available' => :'BOOLEAN',
    :'is_enrolled' => :'BOOLEAN',
    :'hide_cancel' => :'BOOLEAN',
    :'id' => :'Integer',
    :'is_available' => :'BOOLEAN',
    :'start_date_time' => :'DateTime',
    :'end_date_time' => :'DateTime',
    :'last_modified_date_time' => :'DateTime',
    :'class_description' => :'ClassDescription',
    :'staff' => :'Staff',
    :'booking_window' => :'BookingWindow',
    :'booking_status' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/swagger_client/models/model_class.rb', line 326

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_schedule_id == o.class_schedule_id &&
      visits == o.visits &&
      clients == o.clients &&
      location == o.location &&
      resource == o.resource &&
      max_capacity == o.max_capacity &&
      web_capacity == o.web_capacity &&
      total_booked == o.total_booked &&
      total_booked_waitlist == o.total_booked_waitlist &&
      web_booked == o.web_booked &&
      semester_id == o.semester_id &&
      is_canceled == o.is_canceled &&
      substitute == o.substitute &&
      active == o.active &&
      is_waitlist_available == o.is_waitlist_available &&
      is_enrolled == o.is_enrolled &&
      hide_cancel == o.hide_cancel &&
      id == o.id &&
      is_available == o.is_available &&
      start_date_time == o.start_date_time &&
      end_date_time == o.end_date_time &&
      last_modified_date_time == o.last_modified_date_time &&
      class_description == o.class_description &&
      staff == o.staff &&
      booking_window == o.booking_window &&
      booking_status == o.booking_status
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



393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/swagger_client/models/model_class.rb', line 393

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 = SwaggerClient.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



459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'lib/swagger_client/models/model_class.rb', line 459

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



372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/swagger_client/models/model_class.rb', line 372

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


359
360
361
 
# File 'lib/swagger_client/models/model_class.rb', line 359

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



365
366
367
 
# File 'lib/swagger_client/models/model_class.rb', line 365

def hash
  [class_schedule_id, visits, clients, location, resource, max_capacity, web_capacity, total_booked, total_booked_waitlist, web_booked, semester_id, is_canceled, substitute, active, is_waitlist_available, is_enrolled, hide_cancel, id, is_available, start_date_time, end_date_time, last_modified_date_time, class_description, staff, booking_window, booking_status].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



301
302
303
304
 
# File 'lib/swagger_client/models/model_class.rb', line 301

def list_invalid_properties
  invalid_properties = Array.new
  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



439
440
441
 
# File 'lib/swagger_client/models/model_class.rb', line 439

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



445
446
447
448
449
450
451
452
453
 
# File 'lib/swagger_client/models/model_class.rb', line 445

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



433
434
435
 
# File 'lib/swagger_client/models/model_class.rb', line 433

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



308
309
310
311
312
 
# File 'lib/swagger_client/models/model_class.rb', line 308

def valid?
  booking_status_validator = EnumAttributeValidator.new('String', ['PaymentRequired', 'BookAndPayLater', 'Free'])
  return false unless booking_status_validator.valid?(@booking_status)
  true
end