Class: Shortcut::UploadedFile

Inherits:
Object
  • Object
show all
Defined in:
lib/shortcut_client_ruby/models/uploaded_file.rb

Overview

An UploadedFile is any document uploaded to your Shortcut Workspace. Files attached from a third-party service are different: see the Linked Files endpoint.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UploadedFile

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/shortcut_client_ruby/models/uploaded_file.rb', line 127

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#content_type ⇒ Object

Free form string corresponding to a text or image file.



45
46
47
 
# File 'lib/shortcut_client_ruby/models/uploaded_file.rb', line 45

def content_type
  @content_type
end

#created_at ⇒ Object

The time/date that the file was created.



66
67
68
 
# File 'lib/shortcut_client_ruby/models/uploaded_file.rb', line 66

def created_at
  @created_at
end

#description ⇒ Object

The description of the file.



18
19
20
 
# File 'lib/shortcut_client_ruby/models/uploaded_file.rb', line 18

def description
  @description
end

#entity_type ⇒ Object

A string description of this resource.



21
22
23
 
# File 'lib/shortcut_client_ruby/models/uploaded_file.rb', line 21

def entity_type
  @entity_type
end

#external_id ⇒ Object

This field can be set to another unique ID. In the case that the File has been imported from another tool, the ID in the other tool can be indicated here.



57
58
59
 
# File 'lib/shortcut_client_ruby/models/uploaded_file.rb', line 57

def external_id
  @external_id
end

#filename ⇒ Object

The name assigned to the file in Shortcut upon upload.



51
52
53
 
# File 'lib/shortcut_client_ruby/models/uploaded_file.rb', line 51

def filename
  @filename
end

#group_mention_ids ⇒ Object

The unique IDs of the Groups who are mentioned in the file description.



54
55
56
 
# File 'lib/shortcut_client_ruby/models/uploaded_file.rb', line 54

def group_mention_ids
  @group_mention_ids
end

#id ⇒ Object

The unique ID for the file.



60
61
62
 
# File 'lib/shortcut_client_ruby/models/uploaded_file.rb', line 60

def id
  @id
end

#member_mention_ids ⇒ Object

The unique IDs of the Members who are mentioned in the file description.



30
31
32
 
# File 'lib/shortcut_client_ruby/models/uploaded_file.rb', line 30

def member_mention_ids
  @member_mention_ids
end

#mention_ids ⇒ Object

Deprecated: use member_mention_ids.



27
28
29
 
# File 'lib/shortcut_client_ruby/models/uploaded_file.rb', line 27

def mention_ids
  @mention_ids
end

#name ⇒ Object

The optional User-specified name of the file.



33
34
35
 
# File 'lib/shortcut_client_ruby/models/uploaded_file.rb', line 33

def name
  @name
end

#size ⇒ Object

The size of the file.



39
40
41
 
# File 'lib/shortcut_client_ruby/models/uploaded_file.rb', line 39

def size
  @size
end

#story_ids ⇒ Object

The unique IDs of the Stories associated with this file.



24
25
26
 
# File 'lib/shortcut_client_ruby/models/uploaded_file.rb', line 24

def story_ids
  @story_ids
end

#thumbnail_url ⇒ Object

The url where the thumbnail of the file can be found in Shortcut.



36
37
38
 
# File 'lib/shortcut_client_ruby/models/uploaded_file.rb', line 36

def thumbnail_url
  @thumbnail_url
end

#updated_at ⇒ Object

The time/date that the file was updated.



48
49
50
 
# File 'lib/shortcut_client_ruby/models/uploaded_file.rb', line 48

def updated_at
  @updated_at
end

#uploader_id ⇒ Object

The unique ID of the Member who uploaded the file.



42
43
44
 
# File 'lib/shortcut_client_ruby/models/uploaded_file.rb', line 42

def uploader_id
  @uploader_id
end

#url ⇒ Object

The URL for the file.



63
64
65
 
# File 'lib/shortcut_client_ruby/models/uploaded_file.rb', line 63

def url
  @url
end

Class Method Details

.attribute_map ⇒ Object

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



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/shortcut_client_ruby/models/uploaded_file.rb', line 69

def self.attribute_map
  {
    :'description' => :'description',
    :'entity_type' => :'entity_type',
    :'story_ids' => :'story_ids',
    :'mention_ids' => :'mention_ids',
    :'member_mention_ids' => :'member_mention_ids',
    :'name' => :'name',
    :'thumbnail_url' => :'thumbnail_url',
    :'size' => :'size',
    :'uploader_id' => :'uploader_id',
    :'content_type' => :'content_type',
    :'updated_at' => :'updated_at',
    :'filename' => :'filename',
    :'group_mention_ids' => :'group_mention_ids',
    :'external_id' => :'external_id',
    :'id' => :'id',
    :'url' => :'url',
    :'created_at' => :'created_at'
  }
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



354
355
356
 
# File 'lib/shortcut_client_ruby/models/uploaded_file.rb', line 354

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



115
116
117
118
119
120
121
122
123
 
# File 'lib/shortcut_client_ruby/models/uploaded_file.rb', line 115

def self.openapi_nullable
  Set.new([
    :'description',
    :'thumbnail_url',
    :'updated_at',
    :'external_id',
    :'url',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'description' => :'Object',
    :'entity_type' => :'Object',
    :'story_ids' => :'Object',
    :'mention_ids' => :'Object',
    :'member_mention_ids' => :'Object',
    :'name' => :'Object',
    :'thumbnail_url' => :'Object',
    :'size' => :'Object',
    :'uploader_id' => :'Object',
    :'content_type' => :'Object',
    :'updated_at' => :'Object',
    :'filename' => :'Object',
    :'group_mention_ids' => :'Object',
    :'external_id' => :'Object',
    :'id' => :'Object',
    :'url' => :'Object',
    :'created_at' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/shortcut_client_ruby/models/uploaded_file.rb', line 317

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      description == o.description &&
      entity_type == o.entity_type &&
      story_ids == o.story_ids &&
      mention_ids == o.mention_ids &&
      member_mention_ids == o.member_mention_ids &&
      name == o.name &&
      thumbnail_url == o.thumbnail_url &&
      size == o.size &&
      uploader_id == o.uploader_id &&
      content_type == o.content_type &&
      updated_at == o.updated_at &&
      filename == o.filename &&
      group_mention_ids == o.group_mention_ids &&
      external_id == o.external_id &&
      id == o.id &&
      url == o.url &&
      created_at == o.created_at
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



384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/shortcut_client_ruby/models/uploaded_file.rb', line 384

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
    Shortcut.const_get(type).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



453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/shortcut_client_ruby/models/uploaded_file.rb', line 453

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



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/shortcut_client_ruby/models/uploaded_file.rb', line 361

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if 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[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]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


341
342
343
 
# File 'lib/shortcut_client_ruby/models/uploaded_file.rb', line 341

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



347
348
349
 
# File 'lib/shortcut_client_ruby/models/uploaded_file.rb', line 347

def hash
  [description, entity_type, story_ids, mention_ids, member_mention_ids, name, thumbnail_url, size, uploader_id, content_type, updated_at, filename, group_mention_ids, external_id, id, url, created_at].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



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
254
255
256
257
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
 
# File 'lib/shortcut_client_ruby/models/uploaded_file.rb', line 219

def list_invalid_properties
  invalid_properties = Array.new
  if @description.nil?
    invalid_properties.push('invalid value for "description", description cannot be nil.')
  end

  if @entity_type.nil?
    invalid_properties.push('invalid value for "entity_type", entity_type cannot be nil.')
  end

  if @story_ids.nil?
    invalid_properties.push('invalid value for "story_ids", story_ids cannot be nil.')
  end

  if @mention_ids.nil?
    invalid_properties.push('invalid value for "mention_ids", mention_ids cannot be nil.')
  end

  if @member_mention_ids.nil?
    invalid_properties.push('invalid value for "member_mention_ids", member_mention_ids cannot be nil.')
  end

  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @thumbnail_url.nil?
    invalid_properties.push('invalid value for "thumbnail_url", thumbnail_url cannot be nil.')
  end

  if @size.nil?
    invalid_properties.push('invalid value for "size", size cannot be nil.')
  end

  if @uploader_id.nil?
    invalid_properties.push('invalid value for "uploader_id", uploader_id cannot be nil.')
  end

  if @content_type.nil?
    invalid_properties.push('invalid value for "content_type", content_type cannot be nil.')
  end

  if @updated_at.nil?
    invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.')
  end

  if @filename.nil?
    invalid_properties.push('invalid value for "filename", filename cannot be nil.')
  end

  if @group_mention_ids.nil?
    invalid_properties.push('invalid value for "group_mention_ids", group_mention_ids cannot be nil.')
  end

  if @external_id.nil?
    invalid_properties.push('invalid value for "external_id", external_id cannot be nil.')
  end

  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

  if @url.nil?
    invalid_properties.push('invalid value for "url", url cannot be nil.')
  end

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



429
430
431
 
# File 'lib/shortcut_client_ruby/models/uploaded_file.rb', line 429

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



435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/shortcut_client_ruby/models/uploaded_file.rb', line 435

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



423
424
425
 
# File 'lib/shortcut_client_ruby/models/uploaded_file.rb', line 423

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



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/shortcut_client_ruby/models/uploaded_file.rb', line 294

def valid?
  return false if @description.nil?
  return false if @entity_type.nil?
  return false if @story_ids.nil?
  return false if @mention_ids.nil?
  return false if @member_mention_ids.nil?
  return false if @name.nil?
  return false if @thumbnail_url.nil?
  return false if @size.nil?
  return false if @uploader_id.nil?
  return false if @content_type.nil?
  return false if @updated_at.nil?
  return false if @filename.nil?
  return false if @group_mention_ids.nil?
  return false if @external_id.nil?
  return false if @id.nil?
  return false if @url.nil?
  return false if @created_at.nil?
  true
end