Humaans.Compensations behaviour (Humaans v0.4.0)

This module provides functions for managing compensation resources in the Humaans API. Compensations represent the actual monetary values assigned to a person under a specific compensation type (e.g., a specific person's salary or bonus).

Summary

Types

delete_response()

list_response()

response()

Callbacks

create(client, map)

delete(client, t)

list(client, map)

retrieve(client, t)

update(client, t, map)

Functions

create(client, params)

Creates a new compensation resource.

delete(client, id)

Deletes a specific compensation by ID.

list(client, params \\ %{})

Lists all compensation resources.

retrieve(client, id)

Retrieves a specific compensation by ID.

update(client, id, params)

Updates a specific compensation by ID.

Types

delete_response()

@type delete_response() :: {:ok, %{id: String.t(), deleted: bool()}} | {:error, any()}

list_response()

@type list_response() ::
  {:ok,
   [
     %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()
     }
   ]}
  | {:error, any()}

response()

@type response() ::
  {:ok,
   %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()
   }}
  | {:error, any()}

Callbacks

create(client, map)

@callback create(client :: map(), map()) :: {:ok, map()} | {:error, any()}

delete(client, t)

@callback delete(client :: map(), String.t()) :: {:ok, map()} | {:error, any()}

list(client, map)

@callback list(client :: map(), map()) :: {:ok, map()} | {:error, any()}

retrieve(client, t)

@callback retrieve(client :: map(), String.t()) :: {:ok, map()} | {:error, any()}

update(client, t, map)

@callback update(client :: map(), String.t(), map()) :: {:ok, map()} | {:error, any()}

Functions

create(client, params)

@spec create(client :: map(), params :: keyword()) :: response()

Creates a new compensation resource.

Parameters

client - Client map created with Humaans.new/1
params - Map of parameters for the new compensation

Examples

client = Humaans.new(access_token: "your_access_token")

params = %{
  personId: "person_id",
  compensationTypeId: "comp_type_id",
  amount: "70000",
  currency: "EUR",
  period: "annual",
  effectiveDate: "2023-01-01"
}

{:ok, compensation} = Humaans.Compensations.create(client, params)

delete(client, id)

@spec delete(client :: map(), id :: String.t()) :: delete_response()

Deletes a specific compensation by ID.

Parameters

client - Client map created with Humaans.new/1
id - String ID of the compensation to delete

Examples

client = Humaans.new(access_token: "your_access_token")

{:ok, result} = Humaans.Compensations.delete(client, "comp_id")
# result contains %{id: "comp_id", deleted: true}

list(client, params \\ %{})

@spec list(client :: map(), params :: keyword()) :: list_response()

Lists all compensation resources.

Returns a list of compensation resources that match the optional filters provided in params.

Parameters

client - Client map created with Humaans.new/1
params - Optional parameters for filtering the results (default: %{})

Examples

client = Humaans.new(access_token: "your_access_token")

# List all compensations
{:ok, compensations} = Humaans.Compensations.list(client)

# List with filtering parameters
{:ok, compensations} = Humaans.Compensations.list(client, %{personId: "person_id"})

retrieve(client, id)

@spec retrieve(client :: map(), id :: String.t()) :: response()

Retrieves a specific compensation by ID.

Parameters

client - Client map created with Humaans.new/1
id - String ID of the compensation to retrieve

Examples

client = Humaans.new(access_token: "your_access_token")

{:ok, compensation} = Humaans.Compensations.retrieve(client, "comp_id")

update(client, id, params)

@spec update(client :: map(), id :: String.t(), params :: keyword()) :: response()

Updates a specific compensation by ID.

Parameters

client - Client map created with Humaans.new/1
id - String ID of the compensation to update
params - Map of parameters to update

Examples

client = Humaans.new(access_token: "your_access_token")

params = %{amount: "75000", note: "Annual raise"}

{:ok, updated_comp} = Humaans.Compensations.update(client, "comp_id", params)