class FireflyIIIClient::Attachment

Attributes

attachable_id[RW]

ID of the model this attachment is linked to.

attachable_type[RW]

The object class to which the attachment must be linked.

created_at[RW]
download_uri[RW]
filename[RW]
md5[RW]

MD5 hash of the file for basic duplicate detection.

mime[RW]
model[RW]

The object class to which the attachment must be linked.

model_id[RW]

ID of the model this attachment is linked to.

notes[RW]
size[RW]
title[RW]
updated_at[RW]
upload_uri[RW]

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/firefly_iii_client/models/attachment.rb, line 94
def self.acceptable_attributes
  attribute_map.values
end
attribute_map() click to toggle source

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

# 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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/firefly_iii_client/models/attachment.rb, line 284
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# 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
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/firefly_iii_client/models/attachment.rb, line 119
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# 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

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# 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) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# 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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# 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
attachable_type=(attachable_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] attachable_type Object to be assigned

# File lib/firefly_iii_client/models/attachment.rb, line 230
def attachable_type=(attachable_type)
  validator = EnumAttributeValidator.new('String', ["Bill", "TransactionJournal", "ImportJob"])
  unless validator.valid?(attachable_type)
    fail ArgumentError, "invalid value for \"attachable_type\", must be one of #{validator.allowable_values}."
  end
  @attachable_type = attachable_type
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# 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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/firefly_iii_client/models/attachment.rb, line 271
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# 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() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# 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
model=(model) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] model Object to be assigned

# File lib/firefly_iii_client/models/attachment.rb, line 240
def model=(model)
  validator = EnumAttributeValidator.new('String', ["Bill", "TransactionJournal", "ImportJob"])
  unless validator.valid?(model)
    fail ArgumentError, "invalid value for \"model\", must be one of #{validator.allowable_values}."
  end
  @model = model
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/firefly_iii_client/models/attachment.rb, line 361
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# 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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/firefly_iii_client/models/attachment.rb, line 355
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# 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