bamboohr

package
v0.11.821 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 12, 2026 License: Apache-2.0 Imports: 3 Imported by: 0

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 NewClient

func NewClient(c Config) (*Client, error)

func (*Client) GetIngestrURI

func (c *Client) GetIngestrURI() (string, error)

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

func (c *Config) GetIngestrURI() (string, error)

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>]

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL