Humaans.PerformanceSummaries (Humaans v0.6.0)

Copy Markdown View Source

This module provides functions for retrieving performance summary resources in the Humaans API. Performance summaries are retrieve-only via the API.

Summary

Types

response()

Functions

retrieve(client, id)

Retrieves a specific performance_summary by ID.

Types

response()

@type response() ::
  {:ok,
   %Humaans.Resources.PerformanceSummary{
     company_id: term(),
     created_at: term(),
     id: term(),
     performance_cycle_id: term(),
     person_id: term(),
     summary: term(),
     updated_at: term()
   }}
  | {:error, Humaans.Error.t()}

Functions

retrieve(client, id)

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

Retrieves a specific performance_summary by ID.

Parameters

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

Examples

client = Humaans.new(access_token: "your_access_token")
{:ok, performance_summary} = Humaans.PerformanceSummaries.retrieve(client, "performance_summary_id")