Class: Shortcut::CreateLinkedFile

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateLinkedFile

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/shortcut_client_ruby/models/create_linked_file.rb', line 110

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

Instance Attribute Details

#content_type ⇒ Object

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



40
41
42
 
# File 'lib/shortcut_client_ruby/models/create_linked_file.rb', line 40

def content_type
  @content_type
end

#description ⇒ Object

The description of the file.



19
20
21
 
# File 'lib/shortcut_client_ruby/models/create_linked_file.rb', line 19

def description
  @description
end

#name ⇒ Object

The name of the file.



25
26
27
 
# File 'lib/shortcut_client_ruby/models/create_linked_file.rb', line 25

def name
  @name
end

#size ⇒ Object

The filesize, if the integration provided it.



34
35
36
 
# File 'lib/shortcut_client_ruby/models/create_linked_file.rb', line 34

def size
  @size
end

#story_id ⇒ Object

The ID of the linked story.



22
23
24
 
# File 'lib/shortcut_client_ruby/models/create_linked_file.rb', line 22

def story_id
  @story_id
end

#thumbnail_url ⇒ Object

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



28
29
30
 
# File 'lib/shortcut_client_ruby/models/create_linked_file.rb', line 28

def thumbnail_url
  @thumbnail_url
end

#type ⇒ Object

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



31
32
33
 
# File 'lib/shortcut_client_ruby/models/create_linked_file.rb', line 31

def type
  @type
end

#uploader_id ⇒ Object

The UUID of the member that uploaded the file.



37
38
39
 
# File 'lib/shortcut_client_ruby/models/create_linked_file.rb', line 37

def uploader_id
  @uploader_id
end

#url ⇒ Object

The URL of linked file.



43
44
45
 
# File 'lib/shortcut_client_ruby/models/create_linked_file.rb', line 43

def url
  @url
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



83
84
85
 
# File 'lib/shortcut_client_ruby/models/create_linked_file.rb', line 83

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

def self.attribute_map
  {
    :'description' => :'description',
    :'story_id' => :'story_id',
    :'name' => :'name',
    :'thumbnail_url' => :'thumbnail_url',
    :'type' => :'type',
    :'size' => :'size',
    :'uploader_id' => :'uploader_id',
    :'content_type' => :'content_type',
    :'url' => :'url'
  }
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



306
307
308
 
# File 'lib/shortcut_client_ruby/models/create_linked_file.rb', line 306

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



103
104
105
106
 
# File 'lib/shortcut_client_ruby/models/create_linked_file.rb', line 103

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

.openapi_types ⇒ Object

Attribute type mapping.



88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/shortcut_client_ruby/models/create_linked_file.rb', line 88

def self.openapi_types
  {
    :'description' => :'String',
    :'story_id' => :'Integer',
    :'name' => :'String',
    :'thumbnail_url' => :'String',
    :'type' => :'String',
    :'size' => :'Integer',
    :'uploader_id' => :'String',
    :'content_type' => :'String',
    :'url' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      description == o.description &&
      story_id == o.story_id &&
      name == o.name &&
      thumbnail_url == o.thumbnail_url &&
      type == o.type &&
      size == o.size &&
      uploader_id == o.uploader_id &&
      content_type == o.content_type &&
      url == o.url
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



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/shortcut_client_ruby/models/create_linked_file.rb', line 337

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



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

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



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/shortcut_client_ruby/models/create_linked_file.rb', line 313

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


293
294
295
 
# File 'lib/shortcut_client_ruby/models/create_linked_file.rb', line 293

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



299
300
301
 
# File 'lib/shortcut_client_ruby/models/create_linked_file.rb', line 299

def hash
  [description, story_id, name, thumbnail_url, type, size, uploader_id, content_type, url].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



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/shortcut_client_ruby/models/create_linked_file.rb', line 162

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

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

  if !@thumbnail_url.nil? && @thumbnail_url.to_s.length > 2048
    invalid_properties.push('invalid value for "thumbnail_url", the character length must be smaller than or equal to 2048.')
  end

  pattern = Regexp.new(/^https?:\/\/.+$/)
  if !@thumbnail_url.nil? && @thumbnail_url !~ pattern
    invalid_properties.push("invalid value for \"thumbnail_url\", must conform to the pattern #{pattern}.")
  end

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

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

  if @url.to_s.length > 2048
    invalid_properties.push('invalid value for "url", the character length must be smaller than or equal to 2048.')
  end

  pattern = Regexp.new(/^https?:\/\/.+$/)
  if @url !~ pattern
    invalid_properties.push("invalid value for \"url\", must conform to the pattern #{pattern}.")
  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



384
385
386
 
# File 'lib/shortcut_client_ruby/models/create_linked_file.rb', line 384

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



390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/shortcut_client_ruby/models/create_linked_file.rb', line 390

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



378
379
380
 
# File 'lib/shortcut_client_ruby/models/create_linked_file.rb', line 378

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



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

def valid?
  return false if @name.nil?
  return false if @name.to_s.length < 1
  return false if !@thumbnail_url.nil? && @thumbnail_url.to_s.length > 2048
  return false if !@thumbnail_url.nil? && @thumbnail_url !~ Regexp.new(/^https?:\/\/.+$/)
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["google", "url", "dropbox", "box", "onedrive"])
  return false unless type_validator.valid?(@type)
  return false if @url.nil?
  return false if @url.to_s.length > 2048
  return false if @url !~ Regexp.new(/^https?:\/\/.+$/)
  true
end