class MergeATSClient::Candidate

The Candidate Object ### Description The `Candidate` object is used to represent a Candidate for various positions. ### Usage Example Fetch from the `LIST Candidates` endpoint and filter by `ID` to show all candidates.

Attributes

applications[RW]
attachments[RW]
can_email[RW]

Whether or not the candidate can be emailed.

company[RW]

The candidate's current company.

email_addresses[RW]
first_name[RW]

The candidate's first name.

id[RW]
is_private[RW]

Whether or not the candidate is private.

last_interaction_at[RW]

When the most recent candidate interaction occurred.

last_name[RW]

The candidate's last name.

locations[RW]

The candidate's locations.

phone_numbers[RW]
remote_created_at[RW]

When the third party's candidate was created.

remote_data[RW]
remote_id[RW]

The third-party API ID of the matching object.

remote_updated_at[RW]

When the third party's candidate was updated.

tags[RW]
title[RW]

The candidate's current title.

urls[RW]

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/merge_ats_client/models/candidate.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/merge_ats_client/models/candidate.rb, line 69
def self.attribute_map
  {
    :'id' => :'id',
    :'remote_id' => :'remote_id',
    :'first_name' => :'first_name',
    :'last_name' => :'last_name',
    :'company' => :'company',
    :'title' => :'title',
    :'remote_created_at' => :'remote_created_at',
    :'remote_updated_at' => :'remote_updated_at',
    :'last_interaction_at' => :'last_interaction_at',
    :'is_private' => :'is_private',
    :'can_email' => :'can_email',
    :'locations' => :'locations',
    :'phone_numbers' => :'phone_numbers',
    :'email_addresses' => :'email_addresses',
    :'urls' => :'urls',
    :'tags' => :'tags',
    :'applications' => :'applications',
    :'attachments' => :'attachments',
    :'remote_data' => :'remote_data'
  }
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/merge_ats_client/models/candidate.rb, line 303
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/merge_ats_client/models/candidate.rb, line 143
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `MergeATSClient::Candidate` 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 `MergeATSClient::Candidate`. 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?(:'id')
    self.id = attributes[:'id']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'remote_data')
    if (value = attributes[:'remote_data']).is_a?(Array)
      self.remote_data = value
    end
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/merge_ats_client/models/candidate.rb, line 124
def self.openapi_nullable
  Set.new([
    :'remote_id',
    :'first_name',
    :'last_name',
    :'company',
    :'title',
    :'remote_created_at',
    :'remote_updated_at',
    :'last_interaction_at',
    :'is_private',
    :'can_email',
    :'locations',
    :'remote_data'
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/merge_ats_client/models/candidate.rb, line 99
def self.openapi_types
  {
    :'id' => :'String',
    :'remote_id' => :'String',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'company' => :'String',
    :'title' => :'String',
    :'remote_created_at' => :'Time',
    :'remote_updated_at' => :'Time',
    :'last_interaction_at' => :'Time',
    :'is_private' => :'Boolean',
    :'can_email' => :'Boolean',
    :'locations' => :'Array<String>',
    :'phone_numbers' => :'Array<PhoneNumber>',
    :'email_addresses' => :'Array<EmailAddress>',
    :'urls' => :'Array<Url>',
    :'tags' => :'Array<String>',
    :'applications' => :'Array<String>',
    :'attachments' => :'Array<String>',
    :'remote_data' => :'Array<RemoteData>'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/merge_ats_client/models/candidate.rb, line 264
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      remote_id == o.remote_id &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      company == o.company &&
      title == o.title &&
      remote_created_at == o.remote_created_at &&
      remote_updated_at == o.remote_updated_at &&
      last_interaction_at == o.last_interaction_at &&
      is_private == o.is_private &&
      can_email == o.can_email &&
      locations == o.locations &&
      phone_numbers == o.phone_numbers &&
      email_addresses == o.email_addresses &&
      urls == o.urls &&
      tags == o.tags &&
      applications == o.applications &&
      attachments == o.attachments &&
      remote_data == o.remote_data
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/merge_ats_client/models/candidate.rb, line 333
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 = MergeATSClient.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/merge_ats_client/models/candidate.rb, line 404
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/merge_ats_client/models/candidate.rb, line 310
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/merge_ats_client/models/candidate.rb, line 290
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/merge_ats_client/models/candidate.rb, line 296
def hash
  [id, remote_id, first_name, last_name, company, title, remote_created_at, remote_updated_at, last_interaction_at, is_private, can_email, locations, phone_numbers, email_addresses, urls, tags, applications, attachments, remote_data].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/merge_ats_client/models/candidate.rb, line 251
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/merge_ats_client/models/candidate.rb, line 380
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/merge_ats_client/models/candidate.rb, line 386
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/merge_ats_client/models/candidate.rb, line 374
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/merge_ats_client/models/candidate.rb, line 258
def valid?
  true
end