Class: FlatApi::ClassAssignmentUpdate

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ClassAssignmentUpdate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
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
 
# File 'lib/flat_api/models/class_assignment_update.rb', line 165

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

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

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

  if attributes.key?(:'attachments')
    if (value = attributes[:'attachments']).is_a?(Array)
      self.attachments = value
    end
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'assigned_students')
    if (value = attributes[:'assigned_students']).is_a?(Array)
      self.assigned_students = value
    end
  end
end

Instance Attribute Details

#assigned_students ⇒ Object

Identifiers for the students that have access to the assignment



66
67
68
 
# File 'lib/flat_api/models/class_assignment_update.rb', line 66

def assigned_students
  @assigned_students
end

#assignee_mode ⇒ Object

Possible modes of assigning assignments



63
64
65
 
# File 'lib/flat_api/models/class_assignment_update.rb', line 63

def assignee_mode
  @assignee_mode
end

#attachments ⇒ Object

Returns the value of attribute attachments.



26
27
28
 
# File 'lib/flat_api/models/class_assignment_update.rb', line 26

def attachments
  @attachments
end

#cover ⇒ Object

The URL of the cover to display



38
39
40
 
# File 'lib/flat_api/models/class_assignment_update.rb', line 38

def cover
  @cover
end

#cover_file ⇒ Object

The id of the cover to display



35
36
37
 
# File 'lib/flat_api/models/class_assignment_update.rb', line 35

def cover_file
  @cover_file
end

#description ⇒ Object

Description and content of the assignment



24
25
26
 
# File 'lib/flat_api/models/class_assignment_update.rb', line 24

def description
  @description
end

#due_date ⇒ Object

The due date of this assignment, late submissions will be marked as paste due. If not set, the assignment won’t have a due date.



53
54
55
 
# File 'lib/flat_api/models/class_assignment_update.rb', line 53

def due_date
  @due_date
end

#google_classroom ⇒ Object

Returns the value of attribute google_classroom.



58
59
60
 
# File 'lib/flat_api/models/class_assignment_update.rb', line 58

def google_classroom
  @google_classroom
end

#max_points ⇒ Object

If set, the grading will be enabled for the assignement with this value as the maximum of points



41
42
43
 
# File 'lib/flat_api/models/class_assignment_update.rb', line 41

def max_points
  @max_points
end

#microsoft_graph ⇒ Object

Returns the value of attribute microsoft_graph.



60
61
62
 
# File 'lib/flat_api/models/class_assignment_update.rb', line 60

def microsoft_graph
  @microsoft_graph
end

#nb_playback_authorized ⇒ Object

The number of playback authorized on the scores of the assignment.



29
30
31
 
# File 'lib/flat_api/models/class_assignment_update.rb', line 29

def nb_playback_authorized
  @nb_playback_authorized
end

#release_grades ⇒ Object

For worksheets, how grading will work for the assignment: - If set to ‘auto`, the grades will be automatically released when the student submits the submissions - If set to `manual`, the grades will only be set as `draftGrade` and will be released when the teacher returns the submissions



44
45
46
 
# File 'lib/flat_api/models/class_assignment_update.rb', line 44

def release_grades
  @release_grades
end

#scheduled_date ⇒ Object

The publication (scheduled) date of the assignment. If this one is specified, the assignment will only be listed to the teachers of the class.



56
57
58
 
# File 'lib/flat_api/models/class_assignment_update.rb', line 56

def scheduled_date
  @scheduled_date
end

#shuffle_exercises ⇒ Object

Mixing worksheets exercises for each student



47
48
49
 
# File 'lib/flat_api/models/class_assignment_update.rb', line 47

def shuffle_exercises
  @shuffle_exercises
end

#state ⇒ Object

State of the assignment



50
51
52
 
# File 'lib/flat_api/models/class_assignment_update.rb', line 50

def state
  @state
end

#title ⇒ Object

Title of the assignment



21
22
23
 
# File 'lib/flat_api/models/class_assignment_update.rb', line 21

def title
  @title
end

#toolset ⇒ Object

The id of the toolset to apply to this assignment. The toolset will be copied to the assignment as a dedicated object to prevent unexpected changes when making modifications to the template toolset. This property can be set to null to delete the linked toolset and switch back to all the tools available for this assignment.



32
33
34
 
# File 'lib/flat_api/models/class_assignment_update.rb', line 32

def toolset
  @toolset
end

#type ⇒ Object

Returns the value of attribute type.



18
19
20
 
# File 'lib/flat_api/models/class_assignment_update.rb', line 18

def type
  @type
end

Class Method Details

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



422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
 
# File 'lib/flat_api/models/class_assignment_update.rb', line 422

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



115
116
117
 
# File 'lib/flat_api/models/class_assignment_update.rb', line 115

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/flat_api/models/class_assignment_update.rb', line 91

def self.attribute_map
  {
    :'type' => :'type',
    :'title' => :'title',
    :'description' => :'description',
    :'attachments' => :'attachments',
    :'nb_playback_authorized' => :'nbPlaybackAuthorized',
    :'toolset' => :'toolset',
    :'cover_file' => :'coverFile',
    :'cover' => :'cover',
    :'max_points' => :'maxPoints',
    :'release_grades' => :'releaseGrades',
    :'shuffle_exercises' => :'shuffleExercises',
    :'state' => :'state',
    :'due_date' => :'dueDate',
    :'scheduled_date' => :'scheduledDate',
    :'google_classroom' => :'googleClassroom',
    :'microsoft_graph' => :'microsoftGraph',
    :'assignee_mode' => :'assigneeMode',
    :'assigned_students' => :'assignedStudents'
  }
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



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
 
# File 'lib/flat_api/models/class_assignment_update.rb', line 398

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_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



157
158
159
160
161
 
# File 'lib/flat_api/models/class_assignment_update.rb', line 157

def self.openapi_all_of
  [
  :'AssignmentUpdate'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/flat_api/models/class_assignment_update.rb', line 144

def self.openapi_nullable
  Set.new([
    :'nb_playback_authorized',
    :'toolset',
    :'cover_file',
    :'cover',
    :'max_points',
    :'due_date',
    :'scheduled_date',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/flat_api/models/class_assignment_update.rb', line 120

def self.openapi_types
  {
    :'type' => :'AssignmentType',
    :'title' => :'String',
    :'description' => :'String',
    :'attachments' => :'Array<ClassAttachmentCreation>',
    :'nb_playback_authorized' => :'Float',
    :'toolset' => :'String',
    :'cover_file' => :'String',
    :'cover' => :'String',
    :'max_points' => :'Float',
    :'release_grades' => :'String',
    :'shuffle_exercises' => :'Boolean',
    :'state' => :'String',
    :'due_date' => :'Time',
    :'scheduled_date' => :'Time',
    :'google_classroom' => :'ClassAssignmentUpdateAllOfGoogleClassroom',
    :'microsoft_graph' => :'ClassAssignmentUpdateAllOfMicrosoftGraph',
    :'assignee_mode' => :'String',
    :'assigned_students' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/flat_api/models/class_assignment_update.rb', line 360

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      title == o.title &&
      description == o.description &&
      attachments == o.attachments &&
      nb_playback_authorized == o.nb_playback_authorized &&
      toolset == o.toolset &&
      cover_file == o.cover_file &&
      cover == o.cover &&
      max_points == o.max_points &&
      release_grades == o.release_grades &&
      shuffle_exercises == o.shuffle_exercises &&
      state == o.state &&
      due_date == o.due_date &&
      scheduled_date == o.scheduled_date &&
      google_classroom == o.google_classroom &&
      microsoft_graph == o.microsoft_graph &&
      assignee_mode == o.assignee_mode &&
      assigned_students == o.assigned_students
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



493
494
495
496
497
498
499
500
501
502
503
504
505
 
# File 'lib/flat_api/models/class_assignment_update.rb', line 493

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


385
386
387
 
# File 'lib/flat_api/models/class_assignment_update.rb', line 385

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



391
392
393
 
# File 'lib/flat_api/models/class_assignment_update.rb', line 391

def hash
  [type, title, description, attachments, nb_playback_authorized, toolset, cover_file, cover, max_points, release_grades, shuffle_exercises, state, due_date, scheduled_date, google_classroom, microsoft_graph, assignee_mode, assigned_students].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



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/flat_api/models/class_assignment_update.rb', line 257

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@title.nil? && @title.to_s.length > 1000
    invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 1000.')
  end

  if !@title.nil? && @title.to_s.length < 1
    invalid_properties.push('invalid value for "title", the character length must be great than or equal to 1.')
  end

  if !@max_points.nil? && @max_points > 10000
    invalid_properties.push('invalid value for "max_points", must be smaller than or equal to 10000.')
  end

  if !@max_points.nil? && @max_points < 0
    invalid_properties.push('invalid value for "max_points", must be greater than or equal to 0.')
  end

  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



469
470
471
 
# File 'lib/flat_api/models/class_assignment_update.rb', line 469

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



475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'lib/flat_api/models/class_assignment_update.rb', line 475

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

Returns:

  • (String) —

    String presentation of the object



463
464
465
 
# File 'lib/flat_api/models/class_assignment_update.rb', line 463

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



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

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@title.nil? && @title.to_s.length > 1000
  return false if !@title.nil? && @title.to_s.length < 1
  return false if !@max_points.nil? && @max_points > 10000
  return false if !@max_points.nil? && @max_points < 0
  release_grades_validator = EnumAttributeValidator.new('String', ["auto", "manual"])
  return false unless release_grades_validator.valid?(@release_grades)
  state_validator = EnumAttributeValidator.new('String', ["draft", "active"])
  return false unless state_validator.valid?(@state)
  assignee_mode_validator = EnumAttributeValidator.new('String', ["everyone", "selected"])
  return false unless assignee_mode_validator.valid?(@assignee_mode)
  true
end