Class: Shortcut::LinkedFile

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

Overview

Linked files are stored on a third-party website and linked to one or more Stories. Shortcut currently supports linking files from Google Drive, Dropbox, Box, and by URL.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LinkedFile

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

The content type of the image (e.g. txt/plain).



50
51
52
 
# File 'lib/shortcut_client_ruby/models/linked_file.rb', line 50

def content_type
  @content_type
end

#created_at ⇒ Object

The time/date the LinkedFile was created.



65
66
67
 
# File 'lib/shortcut_client_ruby/models/linked_file.rb', line 65

def created_at
  @created_at
end

#description ⇒ Object

The description of the file.



20
21
22
 
# File 'lib/shortcut_client_ruby/models/linked_file.rb', line 20

def description
  @description
end

#entity_type ⇒ Object

A string description of this resource.



23
24
25
 
# File 'lib/shortcut_client_ruby/models/linked_file.rb', line 23

def entity_type
  @entity_type
end

#group_mention_ids ⇒ Object

The groups that are mentioned in the description of the file.



56
57
58
 
# File 'lib/shortcut_client_ruby/models/linked_file.rb', line 56

def group_mention_ids
  @group_mention_ids
end

#id ⇒ Object

The unique identifier for the file.



59
60
61
 
# File 'lib/shortcut_client_ruby/models/linked_file.rb', line 59

def id
  @id
end

#member_mention_ids ⇒ Object

The members that are mentioned in the description of the file.



32
33
34
 
# File 'lib/shortcut_client_ruby/models/linked_file.rb', line 32

def member_mention_ids
  @member_mention_ids
end

#mention_ids ⇒ Object

Deprecated: use member_mention_ids.



29
30
31
 
# File 'lib/shortcut_client_ruby/models/linked_file.rb', line 29

def mention_ids
  @mention_ids
end

#name ⇒ Object

The name of the linked file.



35
36
37
 
# File 'lib/shortcut_client_ruby/models/linked_file.rb', line 35

def name
  @name
end

#size ⇒ Object

The filesize, if the integration provided it.



44
45
46
 
# File 'lib/shortcut_client_ruby/models/linked_file.rb', line 44

def size
  @size
end

#story_ids ⇒ Object

The IDs of the stories this file is attached to.



26
27
28
 
# File 'lib/shortcut_client_ruby/models/linked_file.rb', line 26

def story_ids
  @story_ids
end

#thumbnail_url ⇒ Object

The URL of the file thumbnail, if the integration provided it.



38
39
40
 
# File 'lib/shortcut_client_ruby/models/linked_file.rb', line 38

def thumbnail_url
  @thumbnail_url
end

#type ⇒ Object

The integration type (e.g. google, dropbox, box).



41
42
43
 
# File 'lib/shortcut_client_ruby/models/linked_file.rb', line 41

def type
  @type
end

#updated_at ⇒ Object

The time/date the LinkedFile was updated.



53
54
55
 
# File 'lib/shortcut_client_ruby/models/linked_file.rb', line 53

def updated_at
  @updated_at
end

#uploader_id ⇒ Object

The UUID of the member that uploaded the file.



47
48
49
 
# File 'lib/shortcut_client_ruby/models/linked_file.rb', line 47

def uploader_id
  @uploader_id
end

#url ⇒ Object

The URL of the file.



62
63
64
 
# File 'lib/shortcut_client_ruby/models/linked_file.rb', line 62

def url
  @url
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



90
91
92
 
# File 'lib/shortcut_client_ruby/models/linked_file.rb', line 90

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

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',
    :'type' => :'type',
    :'size' => :'size',
    :'uploader_id' => :'uploader_id',
    :'content_type' => :'content_type',
    :'updated_at' => :'updated_at',
    :'group_mention_ids' => :'group_mention_ids',
    :'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



325
326
327
 
# File 'lib/shortcut_client_ruby/models/linked_file.rb', line 325

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



117
118
119
120
121
122
123
124
 
# File 'lib/shortcut_client_ruby/models/linked_file.rb', line 117

def self.openapi_nullable
  Set.new([
    :'description',
    :'thumbnail_url',
    :'size',
    :'content_type',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'description' => :'String',
    :'entity_type' => :'String',
    :'story_ids' => :'Array<Integer>',
    :'mention_ids' => :'Array<String>',
    :'member_mention_ids' => :'Array<String>',
    :'name' => :'String',
    :'thumbnail_url' => :'String',
    :'type' => :'String',
    :'size' => :'Integer',
    :'uploader_id' => :'String',
    :'content_type' => :'String',
    :'updated_at' => :'Time',
    :'group_mention_ids' => :'Array<String>',
    :'id' => :'Integer',
    :'url' => :'String',
    :'created_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/shortcut_client_ruby/models/linked_file.rb', line 289

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 &&
      type == o.type &&
      size == o.size &&
      uploader_id == o.uploader_id &&
      content_type == o.content_type &&
      updated_at == o.updated_at &&
      group_mention_ids == o.group_mention_ids &&
      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



356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/shortcut_client_ruby/models/linked_file.rb', line 356

def _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 = Shortcut.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



427
428
429
430
431
432
433
434
435
436
437
438
439
 
# File 'lib/shortcut_client_ruby/models/linked_file.rb', line 427

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



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/shortcut_client_ruby/models/linked_file.rb', line 332

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


312
313
314
 
# File 'lib/shortcut_client_ruby/models/linked_file.rb', line 312

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



318
319
320
 
# File 'lib/shortcut_client_ruby/models/linked_file.rb', line 318

def hash
  [description, entity_type, story_ids, mention_ids, member_mention_ids, name, thumbnail_url, type, size, uploader_id, content_type, updated_at, group_mention_ids, 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



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
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/shortcut_client_ruby/models/linked_file.rb', line 216

def list_invalid_properties
  invalid_properties = Array.new
  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 @type.nil?
    invalid_properties.push('invalid value for "type", type cannot be nil.')
  end

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

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



403
404
405
 
# File 'lib/shortcut_client_ruby/models/linked_file.rb', line 403

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



409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/shortcut_client_ruby/models/linked_file.rb', line 409

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



397
398
399
 
# File 'lib/shortcut_client_ruby/models/linked_file.rb', line 397

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



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/shortcut_client_ruby/models/linked_file.rb', line 271

def valid?
  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 @type.nil?
  return false if @uploader_id.nil?
  return false if @updated_at.nil?
  return false if @group_mention_ids.nil?
  return false if @id.nil?
  return false if @url.nil?
  return false if @created_at.nil?
  true
end