Humaans.Resources.Person (Humaans v0.4.0)

View Source

Representation of a Person resource.

Summary

Types

t()

@type t() :: %Humaans.Resources.Person{
  address: binary(),
  bio: binary(),
  birthday: binary(),
  calendar_feed_token: binary() | nil,
  city: binary(),
  company_id: binary(),
  contract_type: binary() | nil,
  country: binary(),
  country_code: binary(),
  created_at: binary(),
  demo: boolean(),
  dietary_preference: binary(),
  email: binary(),
  employee_id: binary() | nil,
  employment_end_date: binary() | nil,
  employment_start_date: binary(),
  first_name: binary(),
  first_working_day: binary(),
  food_allergies: [String.t()],
  formatted_personal_phone_number: binary() | nil,
  formatted_phone_number: binary() | nil,
  gender: binary(),
  github: binary(),
  id: binary(),
  is_birthday_hidden: boolean(),
  is_verified: boolean(),
  is_work_email_hidden: boolean(),
  last_name: binary(),
  last_working_day: binary() | nil,
  leaving_file_id: binary() | nil,
  leaving_note: binary() | nil,
  leaving_reason: leaving_reason(),
  linked_in: binary(),
  location_id: binary(),
  middle_name: binary() | nil,
  nationalities: [String.t()],
  nationality: binary(),
  payroll_provider: binary() | nil,
  personal_email: binary(),
  personal_phone_number: binary() | nil,
  phone_number: binary() | nil,
  postcode: binary(),
  preferred_name: binary() | nil,
  probation_end_date: binary() | nil,
  profile_photo: map() | nil,
  profile_photo_id: binary(),
  public_holiday_calendar_id: binary(),
  remote_city: binary() | nil,
  remote_country_code: binary() | nil,
  remote_region_code: binary() | nil,
  remote_timezone: binary() | nil,
  role: binary(),
  seen_documents_at: binary() | nil,
  source: binary() | nil,
  source_id: binary() | nil,
  spoken_languages: [String.t()],
  state: binary(),
  status: status(),
  tax_code: binary() | nil,
  tax_id: binary() | nil,
  teams: [team()],
  timezone: binary(),
  turnover_impact: binary() | nil,
  twitter: binary(),
  updated_at: binary(),
  working_days: [working_day()]
}

Functions

new(map_or_kwlist, opts \\ [])

@spec new(ExConstructor.map_or_kwlist(), Keyword.t()) :: %Humaans.Resources.Person{
  address: term(),
  bio: term(),
  birthday: term(),
  calendar_feed_token: term(),
  city: term(),
  company_id: term(),
  contract_type: term(),
  country: term(),
  country_code: term(),
  created_at: term(),
  demo: term(),
  dietary_preference: term(),
  email: term(),
  employee_id: term(),
  employment_end_date: term(),
  employment_start_date: term(),
  first_name: term(),
  first_working_day: term(),
  food_allergies: term(),
  formatted_personal_phone_number: term(),
  formatted_phone_number: term(),
  gender: term(),
  github: term(),
  id: term(),
  is_birthday_hidden: term(),
  is_verified: term(),
  is_work_email_hidden: term(),
  last_name: term(),
  last_working_day: term(),
  leaving_file_id: term(),
  leaving_note: term(),
  leaving_reason: term(),
  linked_in: term(),
  location_id: term(),
  middle_name: term(),
  nationalities: term(),
  nationality: term(),
  payroll_provider: term(),
  personal_email: term(),
  personal_phone_number: term(),
  phone_number: term(),
  postcode: term(),
  preferred_name: term(),
  probation_end_date: term(),
  profile_photo: term(),
  profile_photo_id: term(),
  public_holiday_calendar_id: term(),
  remote_city: term(),
  remote_country_code: term(),
  remote_region_code: term(),
  remote_timezone: term(),
  role: term(),
  seen_documents_at: term(),
  source: term(),
  source_id: term(),
  spoken_languages: term(),
  state: term(),
  status: term(),
  tax_code: term(),
  tax_id: term(),
  teams: term(),
  timezone: term(),
  turnover_impact: term(),
  twitter: term(),
  updated_at: term(),
  working_days: term()
}