Class: Shortcut::UpdateFile

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateFile

Initializes the object

Parameters:

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

    Model attributes in the form of hash



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/shortcut_client_ruby/models/update_file.rb', line 73

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

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

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

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

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

Instance Attribute Details

#created_at ⇒ Object

The time/date that the file was uploaded.



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

def created_at
  @created_at
end

#description ⇒ Object

The description of the file.



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

def description
  @description
end

#external_id ⇒ Object

An additional ID that you may wish to assign to the file.



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

def external_id
  @external_id
end

#name ⇒ Object

The name of the file.



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

def name
  @name
end

#updated_at ⇒ Object

The time/date that the file was last updated.



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

def updated_at
  @updated_at
end

#uploader_id ⇒ Object

The unique ID assigned to the Member who uploaded the file to Shortcut.



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

def uploader_id
  @uploader_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



49
50
51
 
# File 'lib/shortcut_client_ruby/models/update_file.rb', line 49

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
46
 
# File 'lib/shortcut_client_ruby/models/update_file.rb', line 37

def self.attribute_map
  {
    :'description' => :'description',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at',
    :'name' => :'name',
    :'uploader_id' => :'uploader_id',
    :'external_id' => :'external_id'
  }
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



176
177
178
 
# File 'lib/shortcut_client_ruby/models/update_file.rb', line 176

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
62
63
 
# File 'lib/shortcut_client_ruby/models/update_file.rb', line 54

def self.openapi_types
  {
    :'description' => :'String',
    :'created_at' => :'Time',
    :'updated_at' => :'Time',
    :'name' => :'String',
    :'uploader_id' => :'String',
    :'external_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



150
151
152
153
154
155
156
157
158
159
 
# File 'lib/shortcut_client_ruby/models/update_file.rb', line 150

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      description == o.description &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      name == o.name &&
      uploader_id == o.uploader_id &&
      external_id == o.external_id
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



207
208
209
210
211
212
213
214
215
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
 
# File 'lib/shortcut_client_ruby/models/update_file.rb', line 207

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



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

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



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/shortcut_client_ruby/models/update_file.rb', line 183

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


163
164
165
 
# File 'lib/shortcut_client_ruby/models/update_file.rb', line 163

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



169
170
171
 
# File 'lib/shortcut_client_ruby/models/update_file.rb', line 169

def hash
  [description, created_at, updated_at, name, uploader_id, external_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



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

def list_invalid_properties
  invalid_properties = Array.new
  if !@name.nil? && @name.to_s.length > 1024
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 1024.')
  end

  if !@name.nil? && @name.to_s.length < 1
    invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
  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



254
255
256
 
# File 'lib/shortcut_client_ruby/models/update_file.rb', line 254

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



260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/shortcut_client_ruby/models/update_file.rb', line 260

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



248
249
250
 
# File 'lib/shortcut_client_ruby/models/update_file.rb', line 248

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



128
129
130
131
132
 
# File 'lib/shortcut_client_ruby/models/update_file.rb', line 128

def valid?
  return false if !@name.nil? && @name.to_s.length > 1024
  return false if !@name.nil? && @name.to_s.length < 1
  true
end