Class: SwaggerClient::GetClassesRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GetClassesRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
181
182
183
184
185
 
# File 'lib/swagger_client/models/get_classes_request.rb', line 106

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?(:'ClassDescriptionIds')
    if (value = attributes[:'ClassDescriptionIds']).is_a?(Array)
      self.class_description_ids = value
    end
  end

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

  if attributes.has_key?(:'StaffIds')
    if (value = attributes[:'StaffIds']).is_a?(Array)
      self.staff_ids = value
    end
  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?(:'ClientId')
    self.client_id = attributes[:'ClientId']
  end

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

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

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

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

  if attributes.has_key?(:'HideCanceledClasses')
    self.hide_canceled_classes = attributes[:'HideCanceledClasses']
  end

  if attributes.has_key?(:'SchedulingWindow')
    self.scheduling_window = attributes[:'SchedulingWindow']
  end

  if attributes.has_key?(:'LastModifiedDate')
    self.last_modified_date = attributes[:'LastModifiedDate']
  end

  if attributes.has_key?(:'Limit')
    self.limit = attributes[:'Limit']
  end

  if attributes.has_key?(:'Offset')
    self.offset = attributes[:'Offset']
  end
end

Instance Attribute Details

#class_description_ids ⇒ Object

The requested class description IDs.



18
19
20
 
# File 'lib/swagger_client/models/get_classes_request.rb', line 18

def class_description_ids
  @class_description_ids
end

#class_ids ⇒ Object

The requested class IDs.



21
22
23
 
# File 'lib/swagger_client/models/get_classes_request.rb', line 21

def class_ids
  @class_ids
end

#client_id ⇒ Object

The client ID of the client who is viewing this class list. Based on identity, the client may be able to see additional information, such as membership specials.



33
34
35
 
# File 'lib/swagger_client/models/get_classes_request.rb', line 33

def client_id
  @client_id
end

#end_date_time ⇒ Object

The requested end date for filtering. <br />Default: **today’s date**



30
31
32
 
# File 'lib/swagger_client/models/get_classes_request.rb', line 30

def end_date_time
  @end_date_time
end

#hide_canceled_classes ⇒ Object

When ‘true`, canceled classes are removed from the response.<br /> When `false`, canceled classes are included in the response.<br /> Default: false



48
49
50
 
# File 'lib/swagger_client/models/get_classes_request.rb', line 48

def hide_canceled_classes
  @hide_canceled_classes
end

#last_modified_date ⇒ Object

When included in the request, only records modified on or after the ‘LastModifiedDate` specified are included in the response.



54
55
56
 
# File 'lib/swagger_client/models/get_classes_request.rb', line 54

def last_modified_date
  @last_modified_date
end

#limit ⇒ Object

Number of results to include, defaults to 100



57
58
59
 
# File 'lib/swagger_client/models/get_classes_request.rb', line 57

def limit
  @limit
end

#location_ids ⇒ Object

A list of location IDs on which to base the search.



42
43
44
 
# File 'lib/swagger_client/models/get_classes_request.rb', line 42

def location_ids
  @location_ids
end

#offset ⇒ Object

Page offset, defaults to 0.



60
61
62
 
# File 'lib/swagger_client/models/get_classes_request.rb', line 60

def offset
  @offset
end

#program_ids ⇒ Object

A list of program IDs on which to base the search.



36
37
38
 
# File 'lib/swagger_client/models/get_classes_request.rb', line 36

def program_ids
  @program_ids
end

#scheduling_window ⇒ Object

When ‘true`, classes outside scheduling window are removed from the response.<br /> When `false`, classes are included in the response, regardless of the scheduling window.<br /> Default: false



51
52
53
 
# File 'lib/swagger_client/models/get_classes_request.rb', line 51

def scheduling_window
  @scheduling_window
end

#semester_ids ⇒ Object

A list of semester IDs on which to base the search.



45
46
47
 
# File 'lib/swagger_client/models/get_classes_request.rb', line 45

def semester_ids
  @semester_ids
end

#session_type_ids ⇒ Object

A list of session type IDs on which to base the search.



39
40
41
 
# File 'lib/swagger_client/models/get_classes_request.rb', line 39

def session_type_ids
  @session_type_ids
end

#staff_ids ⇒ Object

The requested IDs of the teaching staff members.



24
25
26
 
# File 'lib/swagger_client/models/get_classes_request.rb', line 24

def staff_ids
  @staff_ids
end

#start_date_time ⇒ Object

The requested start date for filtering. <br />Default: **today’s date**



27
28
29
 
# File 'lib/swagger_client/models/get_classes_request.rb', line 27

def start_date_time
  @start_date_time
end

Class Method Details

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/swagger_client/models/get_classes_request.rb', line 63

def self.attribute_map
  {
    :'class_description_ids' => :'ClassDescriptionIds',
    :'class_ids' => :'ClassIds',
    :'staff_ids' => :'StaffIds',
    :'start_date_time' => :'StartDateTime',
    :'end_date_time' => :'EndDateTime',
    :'client_id' => :'ClientId',
    :'program_ids' => :'ProgramIds',
    :'session_type_ids' => :'SessionTypeIds',
    :'location_ids' => :'LocationIds',
    :'semester_ids' => :'SemesterIds',
    :'hide_canceled_classes' => :'HideCanceledClasses',
    :'scheduling_window' => :'SchedulingWindow',
    :'last_modified_date' => :'LastModifiedDate',
    :'limit' => :'Limit',
    :'offset' => :'Offset'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/swagger_client/models/get_classes_request.rb', line 84

def self.swagger_types
  {
    :'class_description_ids' => :'Array<Integer>',
    :'class_ids' => :'Array<Integer>',
    :'staff_ids' => :'Array<Integer>',
    :'start_date_time' => :'DateTime',
    :'end_date_time' => :'DateTime',
    :'client_id' => :'String',
    :'program_ids' => :'Array<Integer>',
    :'session_type_ids' => :'Array<Integer>',
    :'location_ids' => :'Array<Integer>',
    :'semester_ids' => :'Array<Integer>',
    :'hide_canceled_classes' => :'BOOLEAN',
    :'scheduling_window' => :'BOOLEAN',
    :'last_modified_date' => :'DateTime',
    :'limit' => :'Integer',
    :'offset' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/swagger_client/models/get_classes_request.rb', line 202

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_description_ids == o.class_description_ids &&
      class_ids == o.class_ids &&
      staff_ids == o.staff_ids &&
      start_date_time == o.start_date_time &&
      end_date_time == o.end_date_time &&
      client_id == o.client_id &&
      program_ids == o.program_ids &&
      session_type_ids == o.session_type_ids &&
      location_ids == o.location_ids &&
      semester_ids == o.semester_ids &&
      hide_canceled_classes == o.hide_canceled_classes &&
      scheduling_window == o.scheduling_window &&
      last_modified_date == o.last_modified_date &&
      limit == o.limit &&
      offset == o.offset
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



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

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



324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/swagger_client/models/get_classes_request.rb', line 324

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



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/swagger_client/models/get_classes_request.rb', line 237

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


224
225
226
 
# File 'lib/swagger_client/models/get_classes_request.rb', line 224

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



230
231
232
 
# File 'lib/swagger_client/models/get_classes_request.rb', line 230

def hash
  [class_description_ids, class_ids, staff_ids, start_date_time, end_date_time, client_id, program_ids, session_type_ids, location_ids, semester_ids, hide_canceled_classes, scheduling_window, last_modified_date, limit, offset].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



189
190
191
192
 
# File 'lib/swagger_client/models/get_classes_request.rb', line 189

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



304
305
306
 
# File 'lib/swagger_client/models/get_classes_request.rb', line 304

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



310
311
312
313
314
315
316
317
318
 
# File 'lib/swagger_client/models/get_classes_request.rb', line 310

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



298
299
300
 
# File 'lib/swagger_client/models/get_classes_request.rb', line 298

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



196
197
198
 
# File 'lib/swagger_client/models/get_classes_request.rb', line 196

def valid?
  true
end