class Yapstone::PropertyOwnerResource

The information about the customer as an asset owner.

Attributes

asset_count[RW]

The number of assets ownered.

charge_count[RW]

The number of charges.

estimated_volume[RW]
inquiry_count[RW]

The number of inquries.

owner_since[RW]

How long has the customer owned an asset in the marketplace.

processing_volume[RW]
rating[RW]

The rating of the asset for the owner.

rating_count[RW]

The number of ratings.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/yapstone-so/models/property_owner_resource.rb, line 41
def self.attribute_map
  {
    :'owner_since' => :'ownerSince',
    :'inquiry_count' => :'inquiryCount',
    :'charge_count' => :'chargeCount',
    :'rating_count' => :'ratingCount',
    :'rating' => :'rating',
    :'processing_volume' => :'processingVolume',
    :'estimated_volume' => :'estimatedVolume',
    :'asset_count' => :'assetCount'
  }
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/yapstone-so/models/property_owner_resource.rb, line 234
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/yapstone-so/models/property_owner_resource.rb, line 70
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Yapstone::PropertyOwnerResource` 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 `Yapstone::PropertyOwnerResource`. 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?(:'owner_since')
    self.owner_since = attributes[:'owner_since']
  end

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

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

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

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

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

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

  if attributes.key?(:'asset_count')
    self.asset_count = attributes[:'asset_count']
  end
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/yapstone-so/models/property_owner_resource.rb, line 55
def self.openapi_types
  {
    :'owner_since' => :'Date',
    :'inquiry_count' => :'Integer',
    :'charge_count' => :'Integer',
    :'rating_count' => :'Integer',
    :'rating' => :'Float',
    :'processing_volume' => :'MoneyResource',
    :'estimated_volume' => :'MoneyResource',
    :'asset_count' => :'Integer'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/yapstone-so/models/property_owner_resource.rb, line 206
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      owner_since == o.owner_since &&
      inquiry_count == o.inquiry_count &&
      charge_count == o.charge_count &&
      rating_count == o.rating_count &&
      rating == o.rating &&
      processing_volume == o.processing_volume &&
      estimated_volume == o.estimated_volume &&
      asset_count == o.asset_count
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/yapstone-so/models/property_owner_resource.rb, line 262
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
    Yapstone.const_get(type).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/yapstone-so/models/property_owner_resource.rb, line 327
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
asset_count=(asset_count) click to toggle source

Custom attribute writer method with validation @param [Object] asset_count Value to be assigned

# File lib/yapstone-so/models/property_owner_resource.rb, line 196
def asset_count=(asset_count)
  if !asset_count.nil? && asset_count < 0
    fail ArgumentError, 'invalid value for "asset_count", must be greater than or equal to 0.'
  end

  @asset_count = asset_count
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/yapstone-so/models/property_owner_resource.rb, line 241
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if 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 # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
charge_count=(charge_count) click to toggle source

Custom attribute writer method with validation @param [Object] charge_count Value to be assigned

# File lib/yapstone-so/models/property_owner_resource.rb, line 166
def charge_count=(charge_count)
  if !charge_count.nil? && charge_count < 0
    fail ArgumentError, 'invalid value for "charge_count", must be greater than or equal to 0.'
  end

  @charge_count = charge_count
end
eql?(o) click to toggle source

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

# File lib/yapstone-so/models/property_owner_resource.rb, line 221
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/yapstone-so/models/property_owner_resource.rb, line 227
def hash
  [owner_since, inquiry_count, charge_count, rating_count, rating, processing_volume, estimated_volume, asset_count].hash
end
inquiry_count=(inquiry_count) click to toggle source

Custom attribute writer method with validation @param [Object] inquiry_count Value to be assigned

# File lib/yapstone-so/models/property_owner_resource.rb, line 156
def inquiry_count=(inquiry_count)
  if !inquiry_count.nil? && inquiry_count < 0
    fail ArgumentError, 'invalid value for "inquiry_count", must be greater than or equal to 0.'
  end

  @inquiry_count = inquiry_count
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/yapstone-so/models/property_owner_resource.rb, line 118
def list_invalid_properties
  invalid_properties = Array.new
  if !@inquiry_count.nil? && @inquiry_count < 0
    invalid_properties.push('invalid value for "inquiry_count", must be greater than or equal to 0.')
  end

  if !@charge_count.nil? && @charge_count < 0
    invalid_properties.push('invalid value for "charge_count", must be greater than or equal to 0.')
  end

  if !@rating_count.nil? && @rating_count < 0
    invalid_properties.push('invalid value for "rating_count", must be greater than or equal to 0.')
  end

  if !@rating.nil? && @rating < 0
    invalid_properties.push('invalid value for "rating", must be greater than or equal to 0.')
  end

  if !@asset_count.nil? && @asset_count < 0
    invalid_properties.push('invalid value for "asset_count", must be greater than or equal to 0.')
  end

  invalid_properties
end
rating=(rating) click to toggle source

Custom attribute writer method with validation @param [Object] rating Value to be assigned

# File lib/yapstone-so/models/property_owner_resource.rb, line 186
def rating=(rating)
  if !rating.nil? && rating < 0
    fail ArgumentError, 'invalid value for "rating", must be greater than or equal to 0.'
  end

  @rating = rating
end
rating_count=(rating_count) click to toggle source

Custom attribute writer method with validation @param [Object] rating_count Value to be assigned

# File lib/yapstone-so/models/property_owner_resource.rb, line 176
def rating_count=(rating_count)
  if !rating_count.nil? && rating_count < 0
    fail ArgumentError, 'invalid value for "rating_count", must be greater than or equal to 0.'
  end

  @rating_count = rating_count
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/yapstone-so/models/property_owner_resource.rb, line 307
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/yapstone-so/models/property_owner_resource.rb, line 313
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/yapstone-so/models/property_owner_resource.rb, line 301
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/yapstone-so/models/property_owner_resource.rb, line 145
def valid?
  return false if !@inquiry_count.nil? && @inquiry_count < 0
  return false if !@charge_count.nil? && @charge_count < 0
  return false if !@rating_count.nil? && @rating_count < 0
  return false if !@rating.nil? && @rating < 0
  return false if !@asset_count.nil? && @asset_count < 0
  true
end