Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
func (*Client) GetIngestrURI ¶
type Config ¶
type Config struct {
// CompanyDomain is the part before .bamboohr.com in the company URL. For
// https://acme.bamboohr.com, use "acme". Required.
CompanyDomain string
// APIKey is a BambooHR API key. Optional, but exactly one of APIKey or
// AccessToken must be provided; the two are mutually exclusive.
APIKey string
// AccessToken is an OAuth bearer token. Optional, but exactly one of APIKey or
// AccessToken must be provided; the two are mutually exclusive.
AccessToken string
// Timezone is the company's IANA timezone, such as America/Denver. Optional,
// but required for the timesheet_entries table, whose date boundaries BambooHR
// interprets in the company timezone.
Timezone string
}
Config holds the settings required to connect to BambooHR, an HR platform for employee records, time off, and time tracking.
func (*Config) GetIngestrURI ¶
GetIngestrURI builds the ingestr source URI for BambooHR. Format: bamboohr://<company-domain>?api_key=<api-key>[&timezone=<tz>]
bamboohr://<company-domain>?access_token=<token>[&timezone=<tz>]
Click to show internal directories.
Click to hide internal directories.