Humaans.CompensationTypes behaviour (Humaans v0.4.0)

This module provides functions for managing compensation type resources in the Humaans API. Compensation types are used to define different categories of compensation such as salary, bonus, commission, etc.

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 type resource.

delete(client, id)

Deletes a specific compensation type by ID.

list(client, params \\ %{})

Lists all compensation type resources.

retrieve(client, id)

Retrieves a specific compensation type by ID.

update(client, id, params)

Updates a specific compensation type by ID.

Types

delete_response()

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

list_response()

@type list_response() ::
  {:ok,
   [
     %Humaans.Resources.CompensationType{
       base_type: term(),
       company_id: term(),
       created_at: term(),
       id: term(),
       name: term(),
       updated_at: term()
     }
   ]}
  | {:error, any()}

response()

@type response() ::
  {:ok,
   %Humaans.Resources.CompensationType{
     base_type: term(),
     company_id: term(),
     created_at: term(),
     id: term(),
     name: 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 type resource.

Parameters

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

Examples

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

params = %{
  name: "Annual Bonus",
  category: "bonus",
  payFrequency: "once",
  recurring: true
}

{:ok, comp_type} = Humaans.CompensationTypes.create(client, params)

delete(client, id)

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

Deletes a specific compensation type by ID.

Parameters

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

Examples

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

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

list(client, params \\ %{})

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

Lists all compensation type resources.

Returns a list of compensation type 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 compensation types
{:ok, types} = Humaans.CompensationTypes.list(client)

# List with filtering parameters
{:ok, types} = Humaans.CompensationTypes.list(client, %{limit: 10})

retrieve(client, id)

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

Retrieves a specific compensation type by ID.

Parameters

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

Examples

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

{:ok, comp_type} = Humaans.CompensationTypes.retrieve(client, "type_id")

update(client, id, params)

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

Updates a specific compensation type by ID.

Parameters

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

Examples

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

params = %{name: "Quarterly Bonus", payFrequency: "quarterly"}

{:ok, updated_type} = Humaans.CompensationTypes.update(client, "type_id", params)