Humaans (Humaans v0.3.0)

A HTTP client for the Humaans API.

Examples

# Create a client
client = Humaans.new(access_token: "some-access-token")

# Make API calls
{:ok, people} = Humaans.People.list(client)
{:ok, person} = Humaans.People.retrieve(client, "123")

Summary

Functions

bank_accounts()

Access the Bank Accounts API.

companies()

Access the Companies API.

compensation_types()

Access the Compensation Types API.

compensations()

Access the Compensations API.

new(opts)

Creates a new client with the given access token and optional parameters.

people()

Access the People API.

timesheet_entries()

Access the Timesheet Entries API.

timesheet_submissions()

Access the Timesheet Submissions API.

Functions

bank_accounts()

Access the Bank Accounts API.

Returns the module that contains functions for working with bank account resources.

companies()

Access the Companies API.

Returns the module that contains functions for working with company resources.

compensation_types()

Access the Compensation Types API.

Returns the module that contains functions for working with compensation type resources.

compensations()

Access the Compensations API.

Returns the module that contains functions for working with compensation resources.

new(opts)

@spec new(opts :: keyword()) :: map()

Creates a new client with the given access token and optional parameters.

Options

:access_token - The access token to use for authentication (required)
:base_url - The base URL for API requests (defaults to https://app.humaans.io/api)