bamboohr

package

v0.0.4 Latest Latest Go to latest Published: Jun 2, 2018 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/fredwangwang/wtf

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func ParseBody(resp *http.Response) ([]byte, error)
func Request(apiKey string, apiURL string) ([]byte, error)
type Calendar
type Client
- func NewClient(url string) *Client
- func (client *Client) Away(itemType, startDate, endDate string) []Item
type Employee
type Item
type Widget
- func NewWidget() *Widget
- func (widget *Widget) Refresh()

Constants ¶

This section is empty.

Variables ¶

View Source

var Config *config.Config

Config is a pointer to the global config object

Functions ¶

func ParseBody ¶

func ParseBody(resp *http.Response) ([]byte, error)

func Request ¶

func Request(apiKey string, apiURL string) ([]byte, error)

Types ¶

type Calendar ¶

type Calendar struct {
	Items []Item `xml:"item"`
}

func (*Calendar) Holidays ¶

func (calendar *Calendar) Holidays() []Item

func (*Calendar) ItemsByType ¶

func (calendar *Calendar) ItemsByType(itemType string) []Item

func (*Calendar) TimeOffs ¶

func (calendar *Calendar) TimeOffs() []Item

type Client ¶

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

A Client represents the data required to connect to the BambooHR API

func NewClient ¶

func NewClient(url string) *Client

NewClient creates and returns a new BambooHR client

func (*Client) Away ¶

func (client *Client) Away(itemType, startDate, endDate string) []Item

Away returns a string representation of the people who are out of the office during the defined period

type Employee ¶

type Employee struct {
	ID   int    `xml:"id,attr"`
	Name string `xml:",chardata"`
}

* Note: this currently implements the minimum number of fields to fulfill the Away functionality. * Undoubtedly there are more fields than this to an employee

type Item ¶

type Item struct {
	Employee Employee `xml:"employee"`
	End      string   `xml:"end"`
	Holiday  string   `xml:"holiday"`
	Start    string   `xml:"start"`
	Type     string   `xml:"type,attr"`
}

func (*Item) IsOneDay ¶

func (item *Item) IsOneDay() bool

func (*Item) Name ¶

func (item *Item) Name() string

func (*Item) PrettyEnd ¶

func (item *Item) PrettyEnd() string

func (*Item) PrettyStart ¶

func (item *Item) PrettyStart() string

func (*Item) String ¶

func (item *Item) String() string

type Widget ¶

type Widget struct {
	wtf.TextWidget
}

func NewWidget ¶

func NewWidget() *Widget

func (widget *Widget) Refresh()

Source Files ¶

View all Source files

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