bamboohr

README

bamboohr.go

Go implementation of BambooHR API client

Documentation

Find documentation with of examples at GoDoc

Documentation

Overview

Example (EstimateFutureTimeOffBalances)

package main

import (
	bamboohr "github.com/AkihikoITOH/bamboohr.go"
)

func main() {
	conf := bamboohr.NewConfig("api-domain", "api-key")
	api := bamboohr.NewAPI(conf)
	api.EstimateFutureTimeOffBalances("12345", "2019-03-30")
}

Example (GetADirectoryOfEmployees)

package main

import (
	bamboohr "github.com/AkihikoITOH/bamboohr.go"
)

func main() {
	conf := bamboohr.NewConfig("api-domain", "api-key")
	api := bamboohr.NewAPI(conf)
	api.GetADirectoryOfEmployees()
}

Example (GetAnEmployee)

package main

import (
	bamboohr "github.com/AkihikoITOH/bamboohr.go"
)

func main() {
	conf := bamboohr.NewConfig("api-domain", "api-key")
	api := bamboohr.NewAPI(conf)
	api.GetAnEmployee("99999", []string{"firstName", "lastName"})
}

Example (GetTimeOffRequests)

package main

import (
	bamboohr "github.com/AkihikoITOH/bamboohr.go"
)

func main() {
	conf := bamboohr.NewConfig("api-domain", "api-key")
	api := bamboohr.NewAPI(conf)
	filters := map[string]string{
		"start":  "2018-01-01",
		"end":    "2018-01-02",
		"status": "approved",
	}
	api.GetTimeOffRequests(filters)
}

Example (WhosOut)

package main

import (
	bamboohr "github.com/AkihikoITOH/bamboohr.go"
)

func main() {
	conf := bamboohr.NewConfig("api-domain", "api-key")
	api := bamboohr.NewAPI(conf)
	api.WhosOut("2018-01-01", "2019-03-31")
}

Index

• Constants
• type API
  • func NewAPI(config *Config) *API
  • func (api *API) EstimateFutureTimeOffBalances(employeeID, endDate string) ([]*types.TimeOffBalance, error)
  • func (api *API) GetADirectoryOfEmployees() (*types.EmployeeDirectory, error)
  • func (api *API) GetAnEmployee(number string, fieldList []string) (*types.Employee, error)
  • func (api *API) GetTimeOffRequests(filters map[string]string) ([]*types.TimeOffRequest, error)
  • func (api *API) WhosOut(start, end string) ([]*types.TimeOff, error)
• type Config
  • func NewConfig(apiDomain, apiKey string) *Config
  • func (c *Config) APIDomain() string
  • func (c *Config) APIKey() string

Examples

• Package (EstimateFutureTimeOffBalances)
• Package (GetADirectoryOfEmployees)
• Package (GetAnEmployee)
• Package (GetTimeOffRequests)
• Package (WhosOut)

Constants

const (
	// BambooHRAPIHost is the API host name.
	BambooHRAPIHost = "api.bamboohr.com"
	// BambooHRAPIRootPath is the API root path.
	BambooHRAPIRootPath = "api/gateway.php"
	// BambooHRAPIVersion is the API version number.
	BambooHRAPIVersion = "v1"
	// DefaultTimeout is the duration for which it waits for the API to respond.
	DefaultTimeout = 10 * time.Second
)

Types

type API

type API struct {
	Config     *Config
	HTTPClient httpcmw.Doer
}

API object contains the API configuration and has methods to communicate with the API.

func NewAPI

func NewAPI(config *Config) *API

NewAPI creates and returns a new API object based on the given Config.

func (*API) EstimateFutureTimeOffBalances

func (api *API) EstimateFutureTimeOffBalances(employeeID, endDate string) ([]*types.TimeOffBalance, error)

EstimateFutureTimeOffBalances fetches a list of balances of various time offs for the employee at the given date. For more details, refer to https://www.bamboohr.com/api/documentation/time_off.php

func (*API) GetADirectoryOfEmployees

func (api *API) GetADirectoryOfEmployees() (*types.EmployeeDirectory, error)

GetADirectoryOfEmployees fetches a list of employees. For more details, refer to https://www.bamboohr.com/api/documentation/employees.php

func (*API) GetAnEmployee

func (api *API) GetAnEmployee(number string, fieldList []string) (*types.Employee, error)

GetAnEmployee fetches an employee with the given employee number from the BambooHR API. For more details, refer to https://www.bamboohr.com/api/documentation/employees.php

func (*API) GetTimeOffRequests

func (api *API) GetTimeOffRequests(filters map[string]string) ([]*types.TimeOffRequest, error)

GetTimeOffRequests fetches time off requests from the BambooHR API. For more details, refer to https://www.bamboohr.com/api/documentation/time_off.php

func (*API) WhosOut

func (api *API) WhosOut(start, end string) ([]*types.TimeOff, error)

WhosOut fetches a list of time offs, including holidays between the given dates. For more details, refer to https://www.bamboohr.com/api/documentation/time_off.php

type Config

type Config struct {
	// contains filtered or unexported fields
}

Config contains configuration parameters of the BambooHR API.

func NewConfig

func NewConfig(apiDomain, apiKey string) *Config

NewConfig creates and returns a new Config object based on the given api domain and api key.

func (*Config) APIDomain

func (c *Config) APIDomain() string

APIDomain returns the api domain.

func (*Config) APIKey

func (c *Config) APIKey() string

APIKey returns the api key.