Class: FireflyIIIClient::Attachment

Inherits:
Object
  • Object
show all
Defined in:
lib/firefly_iii_client/models/attachment.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Attachment

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/firefly_iii_client/models/attachment.rb', line 126

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#attachable_id ⇒ Object

ID of the model this attachment is linked to.



31
32
33
 
# File 'lib/firefly_iii_client/models/attachment.rb', line 31

def attachable_id
  @attachable_id
end

#attachable_type ⇒ Object

The object class to which the attachment must be linked.



25
26
27
 
# File 'lib/firefly_iii_client/models/attachment.rb', line 25

def attachable_type
  @attachable_type
end

#created_at ⇒ Object

Returns the value of attribute created_at.



18
19
20
 
# File 'lib/firefly_iii_client/models/attachment.rb', line 18

def created_at
  @created_at
end

#download_uri ⇒ Object

Returns the value of attribute download_uri.



39
40
41
 
# File 'lib/firefly_iii_client/models/attachment.rb', line 39

def download_uri
  @download_uri
end

#filename ⇒ Object

Returns the value of attribute filename.



22
23
24
 
# File 'lib/firefly_iii_client/models/attachment.rb', line 22

def filename
  @filename
end

#md5 ⇒ Object

MD5 hash of the file for basic duplicate detection.



37
38
39
 
# File 'lib/firefly_iii_client/models/attachment.rb', line 37

def md5
  @md5
end

#mime ⇒ Object

Returns the value of attribute mime.



47
48
49
 
# File 'lib/firefly_iii_client/models/attachment.rb', line 47

def mime
  @mime
end

#model ⇒ Object

The object class to which the attachment must be linked.



28
29
30
 
# File 'lib/firefly_iii_client/models/attachment.rb', line 28

def model
  @model
end

#model_id ⇒ Object

ID of the model this attachment is linked to.



34
35
36
 
# File 'lib/firefly_iii_client/models/attachment.rb', line 34

def model_id
  @model_id
end

#notes ⇒ Object

Returns the value of attribute notes.



45
46
47
 
# File 'lib/firefly_iii_client/models/attachment.rb', line 45

def notes
  @notes
end

#size ⇒ Object

Returns the value of attribute size.



49
50
51
 
# File 'lib/firefly_iii_client/models/attachment.rb', line 49

def size
  @size
end

#title ⇒ Object

Returns the value of attribute title.



43
44
45
 
# File 'lib/firefly_iii_client/models/attachment.rb', line 43

def title
  @title
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



20
21
22
 
# File 'lib/firefly_iii_client/models/attachment.rb', line 20

def updated_at
  @updated_at
end

#upload_uri ⇒ Object

Returns the value of attribute upload_uri.



41
42
43
 
# File 'lib/firefly_iii_client/models/attachment.rb', line 41

def upload_uri
  @upload_uri
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



94
95
96
 
# File 'lib/firefly_iii_client/models/attachment.rb', line 94

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/firefly_iii_client/models/attachment.rb', line 74

def self.attribute_map
  {
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at',
    :'filename' => :'filename',
    :'attachable_type' => :'attachable_type',
    :'model' => :'model',
    :'attachable_id' => :'attachable_id',
    :'model_id' => :'model_id',
    :'md5' => :'md5',
    :'download_uri' => :'download_uri',
    :'upload_uri' => :'upload_uri',
    :'title' => :'title',
    :'notes' => :'notes',
    :'mime' => :'mime',
    :'size' => :'size'
  }
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



284
285
286
 
# File 'lib/firefly_iii_client/models/attachment.rb', line 284

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



119
120
121
122
 
# File 'lib/firefly_iii_client/models/attachment.rb', line 119

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

.openapi_types ⇒ Object

Attribute type mapping.



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/firefly_iii_client/models/attachment.rb', line 99

def self.openapi_types
  {
    :'created_at' => :'Time',
    :'updated_at' => :'Time',
    :'filename' => :'String',
    :'attachable_type' => :'String',
    :'model' => :'String',
    :'attachable_id' => :'Integer',
    :'model_id' => :'Integer',
    :'md5' => :'String',
    :'download_uri' => :'String',
    :'upload_uri' => :'String',
    :'title' => :'String',
    :'notes' => :'String',
    :'mime' => :'String',
    :'size' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/firefly_iii_client/models/attachment.rb', line 250

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      filename == o.filename &&
      attachable_type == o.attachable_type &&
      model == o.model &&
      attachable_id == o.attachable_id &&
      model_id == o.model_id &&
      md5 == o.md5 &&
      download_uri == o.download_uri &&
      upload_uri == o.upload_uri &&
      title == o.title &&
      notes == o.notes &&
      mime == o.mime &&
      size == o.size
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



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/firefly_iii_client/models/attachment.rb', line 314

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 = FireflyIIIClient.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



385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/firefly_iii_client/models/attachment.rb', line 385

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



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

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  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


271
272
273
 
# File 'lib/firefly_iii_client/models/attachment.rb', line 271

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



277
278
279
 
# File 'lib/firefly_iii_client/models/attachment.rb', line 277

def hash
  [created_at, updated_at, filename, attachable_type, model, attachable_id, model_id, md5, download_uri, upload_uri, title, notes, mime, size].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



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/firefly_iii_client/models/attachment.rb', line 198

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

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

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



361
362
363
 
# File 'lib/firefly_iii_client/models/attachment.rb', line 361

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



367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/firefly_iii_client/models/attachment.rb', line 367

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



355
356
357
 
# File 'lib/firefly_iii_client/models/attachment.rb', line 355

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



217
218
219
220
221
222
223
224
225
226
 
# File 'lib/firefly_iii_client/models/attachment.rb', line 217

def valid?
  return false if @filename.nil?
  attachable_type_validator = EnumAttributeValidator.new('String', ["Bill", "TransactionJournal", "ImportJob"])
  return false unless attachable_type_validator.valid?(@attachable_type)
  return false if @model.nil?
  model_validator = EnumAttributeValidator.new('String', ["Bill", "TransactionJournal", "ImportJob"])
  return false unless model_validator.valid?(@model)
  return false if @model_id.nil?
  true
end