# Humaans v0.6.0 - Table of Contents

> HTTP client for the Humaans API.

## Pages

- [Humaans](readme.md)
- [Changelog](changelog.md)
- [LICENSE](license.md)

## Modules

- [Humaans](Humaans.md): A HTTP client for the Humaans API.
- [Humaans.AuditEvents](Humaans.AuditEvents.md): This module provides functions for retrieving audit event resources in the
Humaans API.  Audit events are retrieve-only via the API; there is no
list endpoint.

- [Humaans.BankAccounts](Humaans.BankAccounts.md): This module provides functions for managing bank account resources in the
Humaans API.

- [Humaans.CaseConvert](Humaans.CaseConvert.md): Internal helper that converts snake_case keys to camelCase before sending
request bodies to the Humaans API.
- [Humaans.Client](Humaans.Client.md): Internal module for making HTTP requests to the Humaans API.
- [Humaans.Companies](Humaans.Companies.md): This module provides functions for managing company resources in the Humaans
API.  Note that unlike other resources, companies can only be listed,
retrieved, and updated, but not created or deleted through the API.

- [Humaans.CompensationTypes](Humaans.CompensationTypes.md): 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.

- [Humaans.Compensations](Humaans.Compensations.md): This module provides functions for managing compensation resources in the
Humaans API. Compensations represent the actual monetary values assigned to a
person under a specific compensation type (e.g., a specific person's salary or
bonus).
- [Humaans.CustomFields](Humaans.CustomFields.md): This module provides functions for managing custom field resources in the
Humaans API.

- [Humaans.CustomValues](Humaans.CustomValues.md): This module provides functions for managing custom value resources in the
Humaans API.

- [Humaans.DocumentFolders](Humaans.DocumentFolders.md): This module provides functions for managing document folder resources in the
Humaans API.

- [Humaans.DocumentTypes](Humaans.DocumentTypes.md): This module provides functions for managing document type resources in the
Humaans API.  Note that document types do not support deletion.

- [Humaans.Documents](Humaans.Documents.md): This module provides functions for managing document resources in the
Humaans API.

- [Humaans.EmergencyContacts](Humaans.EmergencyContacts.md): This module provides functions for managing emergency contact resources in
the Humaans API.

- [Humaans.Equipment](Humaans.Equipment.md): This module provides functions for managing equipment resources in the
Humaans API.

- [Humaans.EquipmentNames](Humaans.EquipmentNames.md): This module provides functions for listing equipment name resources in the
Humaans API.  Equipment names are read-only via the API.

- [Humaans.EquipmentTypes](Humaans.EquipmentTypes.md): This module provides functions for listing equipment type resources in the
Humaans API.  Equipment types are read-only via the API.

- [Humaans.EsignBulkRecipients](Humaans.EsignBulkRecipients.md): This module provides functions for listing and retrieving e-signature
bulk recipient resources in the Humaans API.  Esign bulk recipients are
read-only via the API.

- [Humaans.EsignBulkTokens](Humaans.EsignBulkTokens.md): This module provides functions for listing and retrieving e-signature
bulk token resources in the Humaans API.  Esign bulk tokens are
read-only via the API.

- [Humaans.EsignBulks](Humaans.EsignBulks.md): This module provides functions for listing and retrieving e-signature
bulk resources in the Humaans API.  Esign bulks are read-only via the
API.

- [Humaans.EsignInstances](Humaans.EsignInstances.md): This module provides functions for listing and retrieving e-signature
instance resources in the Humaans API.  Esign instances are read-only
via the API.

- [Humaans.EsignTemplates](Humaans.EsignTemplates.md): This module provides functions for listing and retrieving e-signature
template resources in the Humaans API.  Esign templates are read-only
via the API.

- [Humaans.HTTPClient.Behaviour](Humaans.HTTPClient.Behaviour.md): Behaviour for Humaans HTTP clients.
- [Humaans.HTTPClient.Req](Humaans.HTTPClient.Req.md): Default HTTP client implementation using `Req`.
- [Humaans.IdentityDocumentTypes](Humaans.IdentityDocumentTypes.md): This module provides functions for listing identity document type resources
in the Humaans API.  Identity document types are read-only via the API.

- [Humaans.IdentityDocuments](Humaans.IdentityDocuments.md): This module provides functions for managing identity document resources in
the Humaans API.

- [Humaans.JobRoles](Humaans.JobRoles.md): This module provides functions for managing job role resources in the
Humaans API.

- [Humaans.Locations](Humaans.Locations.md): This module provides functions for managing location resources in the
Humaans API.

- [Humaans.Me](Humaans.Me.md): Singleton helper for the `/me` endpoint.
- [Humaans.OKRs](Humaans.OKRs.md): This module provides functions for listing and retrieving OKR resources in
the Humaans API.  OKRs are read-only via the API.

- [Humaans.Pagination](Humaans.Pagination.md): Helpers for paginating through Humaans API list endpoints.
- [Humaans.People](Humaans.People.md): This module provides functions for managing people resources in the Humaans
API.

- [Humaans.PerformanceCyclePeerNominations](Humaans.PerformanceCyclePeerNominations.md): This module provides functions for retrieving performance cycle peer
nomination resources in the Humaans API.  Peer nominations are
retrieve-only via the API.

- [Humaans.PerformanceCycles](Humaans.PerformanceCycles.md): This module provides functions for listing and retrieving performance
cycle resources in the Humaans API.  Performance cycles are read-only
via the API.

- [Humaans.PerformanceInstances](Humaans.PerformanceInstances.md): This module provides functions for listing and retrieving performance
instance resources in the Humaans API.  Performance instances are
read-only via the API.

- [Humaans.PerformanceRatings](Humaans.PerformanceRatings.md): This module provides functions for retrieving performance rating
resources in the Humaans API.  Performance ratings are retrieve-only via
the API.

- [Humaans.PerformanceReviews](Humaans.PerformanceReviews.md): This module provides functions for listing and retrieving performance
review resources in the Humaans API.  Performance reviews are read-only
via the API.

- [Humaans.PerformanceSummaries](Humaans.PerformanceSummaries.md): This module provides functions for retrieving performance summary
resources in the Humaans API.  Performance summaries are retrieve-only
via the API.

- [Humaans.PerformanceTemplates](Humaans.PerformanceTemplates.md): This module provides functions for listing and retrieving performance
template resources in the Humaans API.  Performance templates are
read-only via the API.

- [Humaans.PublicHolidayCalendarDays](Humaans.PublicHolidayCalendarDays.md): This module provides functions for managing public holiday calendar day
resources in the Humaans API.  Note that the API does not support
deletion.

- [Humaans.PublicHolidayCalendars](Humaans.PublicHolidayCalendars.md): This module provides functions for listing public holiday calendar
resources in the Humaans API.  Public holiday calendars are read-only via
the API.

- [Humaans.PublicHolidays](Humaans.PublicHolidays.md): This module provides functions for listing public holiday resources in the
Humaans API.  Public holidays are read-only via the API.

- [Humaans.Query](Humaans.Query.md): Builder for Humaans API filter query parameters.
- [Humaans.RequestActivityLogs](Humaans.RequestActivityLogs.md): This module provides functions for listing and retrieving request activity
log resources in the Humaans API.  Request activity logs are read-only
via the API.

- [Humaans.RequestComments](Humaans.RequestComments.md): This module provides functions for listing and retrieving request comment
resources in the Humaans API.  Request comments are read-only via the API.

- [Humaans.RequestReviews](Humaans.RequestReviews.md): This module provides functions for listing and retrieving request review
resources in the Humaans API.  Request reviews are read-only via the API.

- [Humaans.RequestTypes](Humaans.RequestTypes.md): This module provides functions for listing and retrieving request type
resources in the Humaans API.  Request types are read-only via the API.

- [Humaans.Requests](Humaans.Requests.md): This module provides functions for listing and retrieving request
resources in the Humaans API.  Requests are read-only via the API.

- [Humaans.Resource](Humaans.Resource.md): Macro for generating standard CRUD operations for Humaans API resources.
- [Humaans.Resources.AuditEvent](Humaans.Resources.AuditEvent.md): Representation of an Audit Event resource.

- [Humaans.Resources.BankAccount](Humaans.Resources.BankAccount.md): Representation of a Bank Account resource.

- [Humaans.Resources.Company](Humaans.Resources.Company.md): Representation of a Company resource.

- [Humaans.Resources.Compensation](Humaans.Resources.Compensation.md): Representation of a Compensation resource.

- [Humaans.Resources.CompensationType](Humaans.Resources.CompensationType.md): Representation of a Compensation Type resource.

- [Humaans.Resources.CustomField](Humaans.Resources.CustomField.md): Representation of a Custom Field resource.

- [Humaans.Resources.CustomValue](Humaans.Resources.CustomValue.md): Representation of a Custom Value resource.

- [Humaans.Resources.Document](Humaans.Resources.Document.md): Representation of a Document resource.

- [Humaans.Resources.DocumentFolder](Humaans.Resources.DocumentFolder.md): Representation of a Document Folder resource.

- [Humaans.Resources.DocumentType](Humaans.Resources.DocumentType.md): Representation of a Document Type resource.

- [Humaans.Resources.EmergencyContact](Humaans.Resources.EmergencyContact.md): Representation of an Emergency Contact resource.

- [Humaans.Resources.Equipment](Humaans.Resources.Equipment.md): Representation of an Equipment resource.

- [Humaans.Resources.EquipmentName](Humaans.Resources.EquipmentName.md): Representation of an Equipment Name resource.

- [Humaans.Resources.EquipmentType](Humaans.Resources.EquipmentType.md): Representation of an Equipment Type resource.

- [Humaans.Resources.EsignBulk](Humaans.Resources.EsignBulk.md): Representation of an Esign Bulk resource.

- [Humaans.Resources.EsignBulkRecipient](Humaans.Resources.EsignBulkRecipient.md): Representation of an Esign Bulk Recipient resource.

- [Humaans.Resources.EsignBulkToken](Humaans.Resources.EsignBulkToken.md): Representation of an Esign Bulk Token resource.

- [Humaans.Resources.EsignInstance](Humaans.Resources.EsignInstance.md): Representation of an Esign Instance resource.

- [Humaans.Resources.EsignTemplate](Humaans.Resources.EsignTemplate.md): Representation of an Esign Template resource.

- [Humaans.Resources.IdentityDocument](Humaans.Resources.IdentityDocument.md): Representation of an Identity Document resource.

- [Humaans.Resources.IdentityDocumentType](Humaans.Resources.IdentityDocumentType.md): Representation of an Identity Document Type resource.

- [Humaans.Resources.JobRole](Humaans.Resources.JobRole.md): Representation of a Job Role resource.

- [Humaans.Resources.Location](Humaans.Resources.Location.md): Representation of a Location resource.

- [Humaans.Resources.OKR](Humaans.Resources.OKR.md): Representation of an OKR resource.

- [Humaans.Resources.PerformanceCycle](Humaans.Resources.PerformanceCycle.md): Representation of a Performance Cycle resource.

- [Humaans.Resources.PerformanceCyclePeerNomination](Humaans.Resources.PerformanceCyclePeerNomination.md): Representation of a Performance Cycle Peer Nomination resource.

- [Humaans.Resources.PerformanceInstance](Humaans.Resources.PerformanceInstance.md): Representation of a Performance Instance resource.

- [Humaans.Resources.PerformanceRating](Humaans.Resources.PerformanceRating.md): Representation of a Performance Rating resource.

- [Humaans.Resources.PerformanceReview](Humaans.Resources.PerformanceReview.md): Representation of a Performance Review resource.

- [Humaans.Resources.PerformanceSummary](Humaans.Resources.PerformanceSummary.md): Representation of a Performance Summary resource.

- [Humaans.Resources.PerformanceTemplate](Humaans.Resources.PerformanceTemplate.md): Representation of a Performance Template resource.

- [Humaans.Resources.Person](Humaans.Resources.Person.md): Representation of a Person resource.

- [Humaans.Resources.PublicHoliday](Humaans.Resources.PublicHoliday.md): Representation of a Public Holiday resource.

- [Humaans.Resources.PublicHolidayCalendar](Humaans.Resources.PublicHolidayCalendar.md): Representation of a Public Holiday Calendar resource.

- [Humaans.Resources.PublicHolidayCalendarDay](Humaans.Resources.PublicHolidayCalendarDay.md): Representation of a Public Holiday Calendar Day resource.

- [Humaans.Resources.Request](Humaans.Resources.Request.md): Representation of a Request resource.

- [Humaans.Resources.RequestActivityLog](Humaans.Resources.RequestActivityLog.md): Representation of a Request Activity Log resource.

- [Humaans.Resources.RequestComment](Humaans.Resources.RequestComment.md): Representation of a Request Comment resource.

- [Humaans.Resources.RequestReview](Humaans.Resources.RequestReview.md): Representation of a Request Review resource.

- [Humaans.Resources.RequestType](Humaans.Resources.RequestType.md): Representation of a Request Type resource.

- [Humaans.Resources.Role](Humaans.Resources.Role.md): Representation of a Role resource.

- [Humaans.Resources.RoleMember](Humaans.Resources.RoleMember.md): Representation of a Role Member resource.

- [Humaans.Resources.RolePermission](Humaans.Resources.RolePermission.md): Representation of a Role Permission resource.

- [Humaans.Resources.Space](Humaans.Resources.Space.md): Representation of a Space (team/department) resource.

- [Humaans.Resources.Task](Humaans.Resources.Task.md): Representation of a Task resource.

- [Humaans.Resources.TimeAway](Humaans.Resources.TimeAway.md): Representation of a Time Away resource.

- [Humaans.Resources.TimeAwayAdjustment](Humaans.Resources.TimeAwayAdjustment.md): Representation of a Time Away Adjustment resource.

- [Humaans.Resources.TimeAwayAllocation](Humaans.Resources.TimeAwayAllocation.md): Representation of a Time Away Allocation resource.

- [Humaans.Resources.TimeAwayPolicy](Humaans.Resources.TimeAwayPolicy.md): Representation of a Time Away Policy resource.

- [Humaans.Resources.TimeAwayType](Humaans.Resources.TimeAwayType.md): Representation of a Time Away Type resource.

- [Humaans.Resources.TimesheetEntry](Humaans.Resources.TimesheetEntry.md): Representation of a Timesheet Entry resource.

- [Humaans.Resources.TimesheetSubmission](Humaans.Resources.TimesheetSubmission.md): Representation of a Timesheet Submission resource.

- [Humaans.Resources.Webhook](Humaans.Resources.Webhook.md): Representation of a Webhook resource.

- [Humaans.Resources.WebhookEvent](Humaans.Resources.WebhookEvent.md): Representation of a Webhook Event resource.

- [Humaans.Resources.WorkflowDependency](Humaans.Resources.WorkflowDependency.md): Representation of a Workflow Dependency resource.

- [Humaans.Resources.WorkflowFormResponse](Humaans.Resources.WorkflowFormResponse.md): Representation of a Workflow Form Response resource.

- [Humaans.Resources.WorkflowPublication](Humaans.Resources.WorkflowPublication.md): Representation of a Workflow Publication resource.

- [Humaans.Resources.WorkflowSlackAction](Humaans.Resources.WorkflowSlackAction.md): Representation of a Workflow Slack Action resource.

- [Humaans.Resources.WorkflowStat](Humaans.Resources.WorkflowStat.md): Representation of a Workflow Stat resource.

- [Humaans.Resources.WorkingPattern](Humaans.Resources.WorkingPattern.md): Representation of a Working Pattern resource.

- [Humaans.Resources.WorkingPatternAllocation](Humaans.Resources.WorkingPatternAllocation.md): Representation of a Working Pattern Allocation resource.

- [Humaans.ResponseHandler](Humaans.ResponseHandler.md): This module provides helper functions for handling API responses consistently
across all Humaans API resource modules.

- [Humaans.RoleMembers](Humaans.RoleMembers.md): This module provides functions for listing and retrieving role member
resources in the Humaans API.  Role members are read-only via the API.

- [Humaans.RolePermissions](Humaans.RolePermissions.md): This module provides functions for listing and retrieving role permission
resources in the Humaans API.  Role permissions are read-only via the API.

- [Humaans.Roles](Humaans.Roles.md): This module provides functions for listing and retrieving role resources
in the Humaans API.  Roles are read-only via the API.

- [Humaans.Spaces](Humaans.Spaces.md): This module provides functions for managing space (team/department)
resources in the Humaans API.

- [Humaans.Tasks](Humaans.Tasks.md): This module provides functions for listing and retrieving task resources
in the Humaans API.  Tasks are read-only via the API.

- [Humaans.Telemetry](Humaans.Telemetry.md): Telemetry integration for the Humaans client.
- [Humaans.TimeAway](Humaans.TimeAway.md): This module provides functions for managing time away resources in the
Humaans API.

- [Humaans.TimeAwayAdjustments](Humaans.TimeAwayAdjustments.md): This module provides functions for managing time away adjustment resources
in the Humaans API.

- [Humaans.TimeAwayAllocations](Humaans.TimeAwayAllocations.md): This module provides functions for managing time away allocation resources
in the Humaans API.

- [Humaans.TimeAwayPolicies](Humaans.TimeAwayPolicies.md): This module provides functions for managing time away policy resources in
the Humaans API.

- [Humaans.TimeAwayTypes](Humaans.TimeAwayTypes.md): This module provides functions for managing time away type resources in the
Humaans API.

- [Humaans.TimesheetEntries](Humaans.TimesheetEntries.md): This module provides functions for managing timesheet entry resources in the
Humaans API. Timesheet entries represent individual time records for a person,
such as hours worked on a specific date.

- [Humaans.TimesheetSubmissions](Humaans.TimesheetSubmissions.md): This module provides functions for managing timesheet submission resources in
the Humaans API. Timesheet submissions represent a collection of timesheet
entries for a specific time period that has been submitted for review and
approval.

- [Humaans.TokenInfo](Humaans.TokenInfo.md): Singleton helper for the `/token-info` endpoint.
- [Humaans.WebhookEvents](Humaans.WebhookEvents.md): This module provides functions for listing and retrieving webhook event
resources in the Humaans API.  Webhook events are read-only via the API.

- [Humaans.Webhooks](Humaans.Webhooks.md): Functions for managing Humaans webhook subscriptions and verifying
incoming webhook deliveries.
- [Humaans.WorkflowDependencies](Humaans.WorkflowDependencies.md): This module provides functions for retrieving workflow dependency resources
in the Humaans API.  Workflow dependencies are retrieve-only via the API.

- [Humaans.WorkflowFormResponses](Humaans.WorkflowFormResponses.md): This module provides functions for retrieving workflow form response
resources in the Humaans API.  Workflow form responses are retrieve-only
via the API.

- [Humaans.WorkflowPublications](Humaans.WorkflowPublications.md): This module provides functions for retrieving workflow publication
resources in the Humaans API.  Workflow publications are retrieve-only
via the API.

- [Humaans.WorkflowSlackActions](Humaans.WorkflowSlackActions.md): This module provides functions for retrieving workflow Slack action
resources in the Humaans API.  Workflow Slack actions are retrieve-only
via the API.

- [Humaans.WorkflowStats](Humaans.WorkflowStats.md): This module provides functions for retrieving workflow stat resources in
the Humaans API.  Workflow stats are retrieve-only via the API.

- [Humaans.WorkingPatternAllocations](Humaans.WorkingPatternAllocations.md): This module provides functions for managing working pattern allocation
resources in the Humaans API.

- [Humaans.WorkingPatterns](Humaans.WorkingPatterns.md): This module provides functions for managing working pattern resources in
the Humaans API.

- Exceptions
  - [Humaans.Error](Humaans.Error.md): Represents an error returned by the Humaans API or HTTP layer.

