# BamboohrEx

[![Build Status](](
[![Coverage Status](](
[![Hex Version](](
[![ downloads](](
[![Hex docs](](
[![Incline docs](](
[![MIT licensed](](

  This is a Wrapper around [BambooHR API](

  - To use this package, you must have an API key generated in BambooHR.
    The steps to generate API key in Bamboo can be found [here](

  - This package is just a wrapper, so it will only let you see resources that
    correspond to permissions associated with the API key

  This package can be configured with default `api_key` and `subdomain`.
  This package can also be configured with a default `caller`. It should be used
  mainly for testing purposes.

  ## Example Configuration (dev.exs)(Optional):

    config :bamboohr_ex, BamboohrEx,
      caller: BamboohrEx.HTTPClient,
      api_key: "YOUR_BAMBOOHR_API_KEY",
      subdomain: "DEFAULT_SUBDOMAIN"

  ## Example Configuration (test.exs)(Optional):

    config :bamboohr_ex, BamboohrEx,
      caller: BamboohrEx.InMemory,
      api_key: "thuum",
      subdomain: "skyrim"

## Installation

This package is [available in Hex](, the package can be installed
by adding `bamboohr_ex` to your list of dependencies in `mix.exs`:

def deps do
    {:bamboohr_ex, "~> 0.1.0"}