Class: FlatApi::AssignmentSubmissionHistory

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

Overview

History item of the submission

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AssignmentSubmissionHistory

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/flat_api/models/assignment_submission_history.rb', line 129

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#assignment ⇒ Object

The assignment unique identifier where the submission was changed



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

def assignment
  @assignment
end

#attachment ⇒ Object

Returns the value of attribute attachment.



54
55
56
 
# File 'lib/flat_api/models/assignment_submission_history.rb', line 54

def attachment
  @attachment
end

#classroom ⇒ Object

The classroom unique identifier where the submission was changed



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

def classroom
  @classroom
end

#comment ⇒ Object

The comment that is made to this submission



49
50
51
 
# File 'lib/flat_api/models/assignment_submission_history.rb', line 49

def comment
  @comment
end

#date ⇒ Object

The date when the submission was changed



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

def date
  @date
end

#draft_grade ⇒ Object

The numerator of the grade at this time in the submission grade history



40
41
42
 
# File 'lib/flat_api/models/assignment_submission_history.rb', line 40

def draft_grade
  @draft_grade
end

#due_date ⇒ Object

The due date of this assignment



52
53
54
 
# File 'lib/flat_api/models/assignment_submission_history.rb', line 52

def due_date
  @due_date
end

#grade ⇒ Object

The numerator of the grade at this time in the submission grade history



43
44
45
 
# File 'lib/flat_api/models/assignment_submission_history.rb', line 43

def grade
  @grade
end

#max_points ⇒ Object

The denominator of the grade at this time in the submission grade history



46
47
48
 
# File 'lib/flat_api/models/assignment_submission_history.rb', line 46

def max_points
  @max_points
end

#source ⇒ Object

The source of the change if the change was made by a third-party software



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

def source
  @source
end

#state ⇒ Object

Returns the value of attribute state.



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

def state
  @state
end

#submission ⇒ Object

The submission unique identifier



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

def submission
  @submission
end

#users ⇒ Object

The user(s) unique identifier(s) who made the change



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

def users
  @users
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



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/flat_api/models/assignment_submission_history.rb', line 297

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



98
99
100
 
# File 'lib/flat_api/models/assignment_submission_history.rb', line 98

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/flat_api/models/assignment_submission_history.rb', line 79

def self.attribute_map
  {
    :'date' => :'date',
    :'classroom' => :'classroom',
    :'assignment' => :'assignment',
    :'submission' => :'submission',
    :'users' => :'users',
    :'source' => :'source',
    :'state' => :'state',
    :'draft_grade' => :'draftGrade',
    :'grade' => :'grade',
    :'max_points' => :'maxPoints',
    :'comment' => :'comment',
    :'due_date' => :'dueDate',
    :'attachment' => :'attachment'
  }
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



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/flat_api/models/assignment_submission_history.rb', line 273

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



122
123
124
125
 
# File 'lib/flat_api/models/assignment_submission_history.rb', line 122

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

.openapi_types ⇒ Object

Attribute type mapping.



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/flat_api/models/assignment_submission_history.rb', line 103

def self.openapi_types
  {
    :'date' => :'Time',
    :'classroom' => :'String',
    :'assignment' => :'String',
    :'submission' => :'String',
    :'users' => :'Array<String>',
    :'source' => :'String',
    :'state' => :'AssignmentSubmissionHistoryState',
    :'draft_grade' => :'Float',
    :'grade' => :'Float',
    :'max_points' => :'Float',
    :'comment' => :'String',
    :'due_date' => :'Time',
    :'attachment' => :'AssignmentSubmissionHistoryAttachment'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/flat_api/models/assignment_submission_history.rb', line 240

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      date == o.date &&
      classroom == o.classroom &&
      assignment == o.assignment &&
      submission == o.submission &&
      users == o.users &&
      source == o.source &&
      state == o.state &&
      draft_grade == o.draft_grade &&
      grade == o.grade &&
      max_points == o.max_points &&
      comment == o.comment &&
      due_date == o.due_date &&
      attachment == o.attachment
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



368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/flat_api/models/assignment_submission_history.rb', line 368

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


260
261
262
 
# File 'lib/flat_api/models/assignment_submission_history.rb', line 260

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



266
267
268
 
# File 'lib/flat_api/models/assignment_submission_history.rb', line 266

def hash
  [date, classroom, assignment, submission, users, source, state, draft_grade, grade, max_points, comment, due_date, attachment].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



203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/flat_api/models/assignment_submission_history.rb', line 203

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @date.nil?
    invalid_properties.push('invalid value for "date", date cannot be nil.')
  end

  if @users.nil?
    invalid_properties.push('invalid value for "users", users cannot be nil.')
  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



344
345
346
 
# File 'lib/flat_api/models/assignment_submission_history.rb', line 344

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



350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/flat_api/models/assignment_submission_history.rb', line 350

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



338
339
340
 
# File 'lib/flat_api/models/assignment_submission_history.rb', line 338

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



219
220
221
222
223
224
225
226
 
# File 'lib/flat_api/models/assignment_submission_history.rb', line 219

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @date.nil?
  return false if @users.nil?
  source_validator = EnumAttributeValidator.new('String', ["lti", "googleClassroom", "microsoftGraph"])
  return false unless source_validator.valid?(@source)
  true
end