Class: SwaggerClient::GetEnrollmentsRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GetEnrollmentsRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
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
 
# File 'lib/swagger_client/models/get_enrollments_request.rb', line 76

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

  if attributes.has_key?(:'EndDate')
    self.end_date = attributes[:'EndDate']
  end

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

  if attributes.has_key?(:'StartDate')
    self.start_date = attributes[:'StartDate']
  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_schedule_ids ⇒ Object

A list of the requested class schedule IDs. If omitted, all class schedule IDs return.



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

def class_schedule_ids
  @class_schedule_ids
end

#end_date ⇒ Object

The end of the date range. The response returns any active enrollments that occur on or before this day.<br /> Default: StartDate



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

def end_date
  @end_date
end

#limit ⇒ Object

Number of results to include, defaults to 100



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

def limit
  @limit
end

#location_ids ⇒ Object

List of the IDs for the requested locations. If omitted, all location IDs return.



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

def location_ids
  @location_ids
end

#offset ⇒ Object

Page offset, defaults to 0.



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

def offset
  @offset
end

#program_ids ⇒ Object

List of the IDs for the requested programs. If omitted, all program IDs return.



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

def program_ids
  @program_ids
end

#session_type_ids ⇒ Object

List of the IDs for the requested session types. If omitted, all session types IDs return.



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

def session_type_ids
  @session_type_ids
end

#staff_ids ⇒ Object

List of the IDs for the requested staff IDs. If omitted, all staff IDs return.



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

def staff_ids
  @staff_ids
end

#start_date ⇒ Object

The start of the date range. The response returns any active enrollments that occur on or after this day.<br /> Default: **today’s date**



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

def start_date
  @start_date
end

Class Method Details

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/swagger_client/models/get_enrollments_request.rb', line 45

def self.attribute_map
  {
    :'class_schedule_ids' => :'ClassScheduleIds',
    :'end_date' => :'EndDate',
    :'location_ids' => :'LocationIds',
    :'program_ids' => :'ProgramIds',
    :'session_type_ids' => :'SessionTypeIds',
    :'staff_ids' => :'StaffIds',
    :'start_date' => :'StartDate',
    :'limit' => :'Limit',
    :'offset' => :'Offset'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/swagger_client/models/get_enrollments_request.rb', line 60

def self.swagger_types
  {
    :'class_schedule_ids' => :'Array<Integer>',
    :'end_date' => :'DateTime',
    :'location_ids' => :'Array<Integer>',
    :'program_ids' => :'Array<Integer>',
    :'session_type_ids' => :'Array<Integer>',
    :'staff_ids' => :'Array<Integer>',
    :'start_date' => :'DateTime',
    :'limit' => :'Integer',
    :'offset' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/swagger_client/models/get_enrollments_request.rb', line 144

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_schedule_ids == o.class_schedule_ids &&
      end_date == o.end_date &&
      location_ids == o.location_ids &&
      program_ids == o.program_ids &&
      session_type_ids == o.session_type_ids &&
      staff_ids == o.staff_ids &&
      start_date == o.start_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



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

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



260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/swagger_client/models/get_enrollments_request.rb', line 260

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



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/swagger_client/models/get_enrollments_request.rb', line 173

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


160
161
162
 
# File 'lib/swagger_client/models/get_enrollments_request.rb', line 160

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



166
167
168
 
# File 'lib/swagger_client/models/get_enrollments_request.rb', line 166

def hash
  [class_schedule_ids, end_date, location_ids, program_ids, session_type_ids, staff_ids, start_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



131
132
133
134
 
# File 'lib/swagger_client/models/get_enrollments_request.rb', line 131

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



240
241
242
 
# File 'lib/swagger_client/models/get_enrollments_request.rb', line 240

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



246
247
248
249
250
251
252
253
254
 
# File 'lib/swagger_client/models/get_enrollments_request.rb', line 246

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



234
235
236
 
# File 'lib/swagger_client/models/get_enrollments_request.rb', line 234

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



138
139
140
 
# File 'lib/swagger_client/models/get_enrollments_request.rb', line 138

def valid?
  true
end