Humaans.PublicHolidayCalendars (Humaans v0.6.0)

This module provides functions for listing public holiday calendar resources in the Humaans API. Public holiday calendars are read-only via the API.

Summary

Types

list_response()

Functions

list(client, params \\ %{})

Lists all public_holiday_calendars.

Types

list_response()

@type list_response() ::
  {:ok,
   [
     %Humaans.Resources.PublicHolidayCalendar{
       company_id: term(),
       created_at: term(),
       id: term(),
       name: 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.PublicHolidayCalendar.t()]}
  | {:error, Humaans.Error.t()}

Lists all public_holiday_calendars.

Returns a list of public_holiday_calendars 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, public_holiday_calendars} = Humaans.PublicHolidayCalendars.list(client)
{:ok, public_holiday_calendars} = Humaans.PublicHolidayCalendars.list(client, %{})