Class: FlatApi::ClassAttachmentCreation

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

Overview

Attachment creation for an assignment or stream post. This attachment must contain a ‘score` or an `url`, all the details of this one will be resolved and returned as `ClassAttachment` once the assignment or stream post is created.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ClassAttachmentCreation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/flat_api/models/class_attachment_creation.rb', line 100

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

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

  if attributes.key?(:'sharing_mode')
    self.sharing_mode = attributes[:'sharing_mode']
  else
    self.sharing_mode = 'read'
  end

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

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

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

Instance Attribute Details

#google_drive_file_id ⇒ Object

The ID of the Google Drive File



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

def google_drive_file_id
  @google_drive_file_id
end

#lock_score_template ⇒ Object

To be used with a score attached in ‘sharingMode` `copy` (score used as template). If true, students won’t be able to change the original notes of the template.



31
32
33
 
# File 'lib/flat_api/models/class_attachment_creation.rb', line 31

def lock_score_template
  @lock_score_template
end

#score ⇒ Object

A unique Flat score identifier. The user creating the assignment must at least have read access to the document. If the user has admin rights, new group permissions will be automatically added for the teachers and students of the class.



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

def score
  @score
end

#sharing_mode ⇒ Object

Returns the value of attribute sharing_mode.



28
29
30
 
# File 'lib/flat_api/models/class_attachment_creation.rb', line 28

def sharing_mode
  @sharing_mode
end

#type ⇒ Object

The type of the attachment posted: * ‘rich`, `photo`, `video` are attachment types that are automatically resolved from a `link` attachment. * A `flat` attachment is a score document where the unique identifier will be specified in the `score` property. Its sharing mode will be provided in the `sharingMode` property.



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

def type
  @type
end

#url ⇒ Object

The URL of the attachment.



34
35
36
 
# File 'lib/flat_api/models/class_attachment_creation.rb', line 34

def url
  @url
end

#worksheet ⇒ Object

An unique worksheet identifier



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

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



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
 
# File 'lib/flat_api/models/class_attachment_creation.rb', line 224

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



75
76
77
 
# File 'lib/flat_api/models/class_attachment_creation.rb', line 75

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/flat_api/models/class_attachment_creation.rb', line 62

def self.attribute_map
  {
    :'type' => :'type',
    :'score' => :'score',
    :'worksheet' => :'worksheet',
    :'sharing_mode' => :'sharingMode',
    :'lock_score_template' => :'lockScoreTemplate',
    :'url' => :'url',
    :'google_drive_file_id' => :'googleDriveFileId'
  }
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



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/flat_api/models/class_attachment_creation.rb', line 200

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



93
94
95
96
 
# File 'lib/flat_api/models/class_attachment_creation.rb', line 93

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

.openapi_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/flat_api/models/class_attachment_creation.rb', line 80

def self.openapi_types
  {
    :'type' => :'String',
    :'score' => :'String',
    :'worksheet' => :'String',
    :'sharing_mode' => :'MediaScoreSharingMode',
    :'lock_score_template' => :'Boolean',
    :'url' => :'String',
    :'google_drive_file_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/flat_api/models/class_attachment_creation.rb', line 173

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      score == o.score &&
      worksheet == o.worksheet &&
      sharing_mode == o.sharing_mode &&
      lock_score_template == o.lock_score_template &&
      url == o.url &&
      google_drive_file_id == o.google_drive_file_id
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



295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/flat_api/models/class_attachment_creation.rb', line 295

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


187
188
189
 
# File 'lib/flat_api/models/class_attachment_creation.rb', line 187

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



193
194
195
 
# File 'lib/flat_api/models/class_attachment_creation.rb', line 193

def hash
  [type, score, worksheet, sharing_mode, lock_score_template, url, google_drive_file_id].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



146
147
148
149
150
 
# File 'lib/flat_api/models/class_attachment_creation.rb', line 146

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  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



271
272
273
 
# File 'lib/flat_api/models/class_attachment_creation.rb', line 271

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



277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/flat_api/models/class_attachment_creation.rb', line 277

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



265
266
267
 
# File 'lib/flat_api/models/class_attachment_creation.rb', line 265

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



154
155
156
157
158
159
 
# File 'lib/flat_api/models/class_attachment_creation.rb', line 154

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  type_validator = EnumAttributeValidator.new('String', ["rich", "photo", "video", "link", "flat", "googleDrive", "worksheet", "performance"])
  return false unless type_validator.valid?(@type)
  true
end