Humaans.PerformanceCycles (Humaans v0.6.0)

This module provides functions for listing and retrieving performance cycle resources in the Humaans API. Performance cycles are read-only via the API.

Summary

Types

list_response()

response()

Functions

list(client, params \\ %{})

Lists all performance_cycles.

retrieve(client, id)

Retrieves a specific performance_cycle by ID.

Types

list_response()

@type list_response() ::
  {:ok,
   [
     %Humaans.Resources.PerformanceCycle{
       company_id: term(),
       created_at: term(),
       end_date: term(),
       id: term(),
       name: term(),
       start_date: term(),
       status: term(),
       updated_at: term()
     }
   ]}
  | {:error, Humaans.Error.t()}

response()

@type response() ::
  {:ok,
   %Humaans.Resources.PerformanceCycle{
     company_id: term(),
     created_at: term(),
     end_date: term(),
     id: term(),
     name: term(),
     start_date: term(),
     status: term(),
     updated_at: term()
   }}
  | {:error, Humaans.Error.t()}

Functions

list(client, params \\ %{})

@spec list(client :: map(), params :: map() | keyword() | [{String.t(), term()}]) ::
  {:ok, [Humaans.Resources.PerformanceCycle.t()]} | {:error, Humaans.Error.t()}

Lists all performance_cycles.

Returns a list of performance_cycles matching the optional filter params.

Parameters

client - Client created with Humaans.new/1
params - Optional map of filter parameters (default: %{})

Examples

client = Humaans.new(access_token: "your_access_token")
{:ok, performance_cycles} = Humaans.PerformanceCycles.list(client)
{:ok, performance_cycles} = Humaans.PerformanceCycles.list(client, %{})

retrieve(client, id)

@spec retrieve(client :: map(), id :: String.t()) ::
  {:ok, Humaans.Resources.PerformanceCycle.t()} | {:error, Humaans.Error.t()}

Retrieves a specific performance_cycle by ID.

Parameters

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

Examples

client = Humaans.new(access_token: "your_access_token")
{:ok, performance_cycle} = Humaans.PerformanceCycles.retrieve(client, "performance_cycle_id")