class ReliefWebAPI::Report

Attributes

body[RW]
country[RW]
date[RW]
format[RW]

Format of report.

id[RW]
language[RW]
primary_country[RW]
source[RW]

Report production and coordination bodies.

status[RW]
theme[RW]

Category of information contained in the report.

title[RW]
type[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/reliefweb-api/models/report.rb, line 45
def self.attribute_map
  {
    :'body' => :'body',
    :'country' => :'country',
    :'date' => :'date',
    :'format' => :'format',
    :'id' => :'id',
    :'language' => :'language',
    :'primary_country' => :'primary_country',
    :'source' => :'source',
    :'status' => :'status',
    :'theme' => :'theme',
    :'title' => :'title',
    :'type' => :'type'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/reliefweb-api/models/report.rb, line 82
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'body')
    self.body = attributes[:'body']
  end

  if attributes.has_key?(:'country')
    if (value = attributes[:'country']).is_a?(Array)
      self.country = value
    end
  end

  if attributes.has_key?(:'date')
    self.date = attributes[:'date']
  end

  if attributes.has_key?(:'format')
    if (value = attributes[:'format']).is_a?(Array)
      self.format = value
    end
  end

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'language')
    self.language = attributes[:'language']
  end

  if attributes.has_key?(:'primary_country')
    self.primary_country = attributes[:'primary_country']
  end

  if attributes.has_key?(:'source')
    if (value = attributes[:'source']).is_a?(Array)
      self.source = value
    end
  end

  if attributes.has_key?(:'status')
    self.status = attributes[:'status']
  end

  if attributes.has_key?(:'theme')
    if (value = attributes[:'theme']).is_a?(Array)
      self.theme = value
    end
  end

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

  if attributes.has_key?(:'type')
    self.type = attributes[:'type']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/reliefweb-api/models/report.rb, line 63
def self.swagger_types
  {
    :'body' => :'String',
    :'country' => :'Array<Country>',
    :'date' => :'Date',
    :'format' => :'Array<Category>',
    :'id' => :'Integer',
    :'language' => :'Language',
    :'primary_country' => :'Country',
    :'source' => :'Array<Source>',
    :'status' => :'BOOLEAN',
    :'theme' => :'Array<Category>',
    :'title' => :'String',
    :'type' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/reliefweb-api/models/report.rb, line 160
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      body == o.body &&
      country == o.country &&
      date == o.date &&
      format == o.format &&
      id == o.id &&
      language == o.language &&
      primary_country == o.primary_country &&
      source == o.source &&
      status == o.status &&
      theme == o.theme &&
      title == o.title &&
      type == o.type
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/reliefweb-api/models/report.rb, line 213
def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = ReliefWebAPI.const_get(type).new
    temp_model.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/reliefweb-api/models/report.rb, line 279
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) 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/reliefweb-api/models/report.rb, line 192
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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 # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
eql?(o) click to toggle source

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

# File lib/reliefweb-api/models/report.rb, line 179
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/reliefweb-api/models/report.rb, line 185
def hash
  [body, country, date, format, id, language, primary_country, source, status, theme, title, type].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/reliefweb-api/models/report.rb, line 147
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
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/reliefweb-api/models/report.rb, line 259
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/reliefweb-api/models/report.rb, line 265
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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/reliefweb-api/models/report.rb, line 253
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/reliefweb-api/models/report.rb, line 154
def valid?
  true
end