Humaans.Resources.Company (Humaans v0.4.0)

Representation of a Company resource.

Summary

Types

payment_status()

status()

t()

Functions

new(map_or_kwlist, opts \\ [])

Types

payment_status()

@type payment_status() :: :requires_action | :past_due | :ok

status()

@type status() :: :terms | :trialing | :expired | :active | :suspended

t()

@type t() :: %Humaans.Resources.Company{
  autogenerate_employee_id: boolean(),
  autogenerate_employee_id_for_new_hires: boolean(),
  created_at: binary() | nil,
  domains: [String.t()] | nil,
  id: binary() | nil,
  is_timesheet_enabled: boolean(),
  name: binary() | nil,
  next_employee_id: pos_integer(),
  package: binary() | nil,
  payment_status: payment_status(),
  status: status(),
  trial_end_date: binary() | nil,
  updated_at: binary() | nil
}

Functions

new(map_or_kwlist, opts \\ [])

@spec new(ExConstructor.map_or_kwlist(), Keyword.t()) :: %Humaans.Resources.Company{
  autogenerate_employee_id: term(),
  autogenerate_employee_id_for_new_hires: term(),
  created_at: term(),
  domains: term(),
  id: term(),
  is_timesheet_enabled: term(),
  name: term(),
  next_employee_id: term(),
  package: term(),
  payment_status: term(),
  status: term(),
  trial_end_date: term(),
  updated_at: term()
}