Humaans.Resources.Compensation (Humaans v0.5.1)

Representation of a Compensation resource.

Summary

Types

base_type()

t()

Functions

build(map_or_kwlist, opts \\ [])

new(data)

Types

base_type()

@type base_type() :: :salary | :bonus | :commission | :equity | :custom

t()

@type t() :: %Humaans.Resources.Compensation{
  amount: binary(),
  compensation_type_id: binary(),
  created_at: DateTime.t() | nil,
  currency: binary(),
  effective_date: Date.t() | nil,
  end_date: Date.t() | nil,
  end_reason: binary(),
  id: binary(),
  note: binary(),
  period: binary(),
  person_id: binary(),
  updated_at: DateTime.t() | nil
}

Functions

build(map_or_kwlist, opts \\ [])

@spec build(ExConstructor.map_or_kwlist(), Keyword.t()) ::
  %Humaans.Resources.Compensation{
    amount: term(),
    compensation_type_id: term(),
    created_at: term(),
    currency: term(),
    effective_date: term(),
    end_date: term(),
    end_reason: term(),
    id: term(),
    note: term(),
    period: term(),
    person_id: term(),
    updated_at: term()
  }