Module Expr Str ImportFrom alias alias Import alias Import alias Import alias Import alias identifier ImportFrom alias identifier Assign NameStore Call AttributeLoad NameLoad attr NameLoad FunctionDef arguments args defaults body Expr Str If Call NameLoad body Return NameLoad Return TupleLoad NameLoad Str decorator_list FunctionDef arguments args defaults body Expr Str Return Call AttributeLoad Call AttributeLoad NameLoad attr Str Dict attr Str NameLoad decorator_list FunctionDef arguments args NameParam defaults Str body Expr Str Assign NameStore Dict Assign TupleStore NameStore NameStore Call NameLoad keyword Str keyword Str Assign NameStore Call AttributeLoad NameLoad attr NameLoad Assign NameStore Call AttributeLoad NameLoad attr For NameStore NameLoad body If CompareNotEq AttributeLoad NameLoad attr Str body Continue For NameStore NameLoad body Assign NameStore SubscriptLoad SubscriptLoad Call AttributeLoad NameLoad attr Index Num Index Num Assign NameStore Dict Str NameLoad For NameStore Call AttributeLoad NameLoad attr body Assign SubscriptStore NameLoad Index SubscriptLoad SubscriptLoad Call AttributeLoad NameLoad attr Index Num Index Num AttributeLoad NameLoad attr Assign SubscriptStore NameLoad Index SubscriptLoad NameLoad Index NameLoad NameLoad Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults NameLoad body Expr Str Assign NameStore Dict If CompareIs NameLoad NameLoad body Assign NameStore Call AttributeLoad Str attr TupleLoad Str Str Str Str Str Str Str Str Str Str Str Str Str Str Str Assign TupleStore NameStore NameStore Call NameLoad keyword Str keyword NameLoad keyword Dict Str NameLoad Assign NameStore Call AttributeLoad NameLoad attr NameLoad Assign NameStore Call AttributeLoad NameLoad attr Assign NameStore Dict Str NameLoad For NameStore NameLoad body Assign SubscriptStore NameLoad Index SubscriptLoad SubscriptLoad Call AttributeLoad NameLoad attr Index Num Index Num AttributeLoad NameLoad attr Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam defaults NameLoad NameLoad NameLoad body Expr Str If CompareIs NameLoad NameLoad body If BoolOpOr CompareIs NameLoad NameLoad CompareIs NameLoad NameLoad body Return Dict Str Str Assign NameStore Dict NameLoad NameLoad orelse If Call NameLoad NameLoad AttributeLoad NameLoad attr body Assign NameStore Call AttributeLoad NameLoad attr NameLoad Assign NameStore Str For NameStore Call AttributeLoad NameLoad attr body AugAssignAdd NameStore Call AttributeLoad Str attr NameLoad SubscriptLoad NameLoad Index NameLoad Assign NameStore Call AttributeLoad Str attr NameLoad Assign TupleStore NameStore NameStore Call NameLoad keyword Str keyword NameLoad keyword NameLoad keyword Str Return Call NameLoad NameLoad Call AttributeLoad Str attr Call AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam defaults Str body Expr Str Assign NameStore Dict Assign TupleStore NameStore NameStore Call NameLoad keyword Str keyword Str Assign NameStore Call AttributeLoad NameLoad attr NameLoad Assign NameStore Call AttributeLoad NameLoad attr For NameStore NameLoad body Assign NameStore NameLoad Assign NameStore Dict For NameStore Call AttributeLoad NameLoad attr body Assign SubscriptStore NameLoad Index SubscriptLoad NameLoad Index Num SubscriptLoad NameLoad Index Num If CompareEq SubscriptLoad NameLoad Index Num Str body Assign NameStore SubscriptLoad NameLoad Index Num For NameStore Call AttributeLoad NameLoad attr body Assign SubscriptStore NameLoad Index AttributeLoad NameLoad attr AttributeLoad NameLoad attr Assign SubscriptStore NameLoad Index SubscriptLoad NameLoad Index NameLoad NameLoad Return NameLoad decorator_list FunctionDef arguments args defaults body Expr Str Assign NameStore Dict Assign TupleStore NameStore NameStore Call NameLoad keyword Str keyword Str Assign NameStore Call AttributeLoad NameLoad attr NameLoad Assign NameStore Call AttributeLoad NameLoad attr For NameStore NameLoad body Assign NameStore NameLoad Assign NameStore Dict Str AttributeLoad NameLoad attr For NameStore Call AttributeLoad NameLoad attr body Assign SubscriptStore NameLoad Index SubscriptLoad NameLoad Index Num SubscriptLoad NameLoad Index Num If CompareEq SubscriptLoad NameLoad Index Num Str body Assign NameStore SubscriptLoad NameLoad Index Num Assign SubscriptStore NameLoad Index NameLoad NameLoad Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam defaults NameLoad NameLoad NameLoad Str NameLoad body Expr Str Assign NameStore Call AttributeLoad Call AttributeLoad NameLoad attr Str Dict attr Str NameLoad Assign NameStore Call AttributeLoad Str attr NameLoad If NameLoad body AugAssignAdd NameStore NameLoad If NameLoad body AugAssignAdd NameStore Call AttributeLoad Str attr NameLoad Expr Call AttributeLoad NameLoad attr Call AttributeLoad Str attr NameLoad If UnaryOpNot Call NameLoad NameLoad NameLoad body Assign NameStore Dict Assign NameStore NameLoad Assign NameStore Call AttributeLoad AttributeLoad AttributeLoad NameLoad attr attr attr NameLoad NameLoad keyword Call NameLoad keyword Str keyword NameLoad keyword NameLoad keyword NameLoad keyword NameLoad keyword NameLoad keyword NameLoad Expr Call AttributeLoad NameLoad attr Call AttributeLoad Str attr SubscriptLoad NameLoad Index Str Return ListLoad SubscriptLoad NameLoad Index Str SubscriptLoad NameLoad Index Str decorator_list
N/A N/A 
Support for BambooHR

.. versionadded:: 2015.8.0

Requires a ``subdomain`` and an ``apikey`` in ``/etc/salt/minion``:

.. code-block: yaml

    bamboohr:
      apikey: 012345678901234567890
      subdomain: mycompany
 __future__ absolute_import print_function N/A yaml N/A logging N/A salt.utils.http N/A salt.ext.six six salt._compat ElementTree ET N/A log N/A N/A logging getLogger __name__ __virtual__ N/A N/A N/A N/A N/A 
    Only load the module if apache is installed
     N/A N/A _apikey N/A N/A True N/A N/A False The API key was not specified. Please specify it using the "apikey" config. N/A _apikey N/A N/A N/A N/A N/A 
    Get the API key
     N/A N/A N/A N/A N/A __opts__ get bamboohr N/A get apikey None N/A list_employees N/A N/A order_by N/A id N/A N/A 
    Show all employees for this company.

    CLI Example:

        salt myminion bamboohr.list_employees

    By default, the return data will be keyed by ID. However, it can be ordered
    by any other field. Keep in mind that if the field that is chosen contains
    duplicate values (i.e., location is used, for a company which only has one
    location), then each duplicate value will be overwritten by the previous.
    Therefore, it is advisable to only sort by fields that are guaranteed to be
    unique.

    CLI Examples:

        salt myminion bamboohr.list_employees order_by=id
        salt myminion bamboohr.list_employees order_by=displayName
        salt myminion bamboohr.list_employees order_by=workEmail
     N/A ret N/A N/A N/A status result N/A _query action employees command directory N/A root N/A N/A ET fromstring result N/A directory N/A N/A root getchildren N/A cat directory N/A N/A N/A N/A cat tag employees N/A N/A N/A item cat N/A N/A emp_id N/A N/A N/A N/A item items N/A 0 N/A 1 N/A emp_ret N/A id emp_id N/A details N/A N/A item getchildren N/A N/A N/A emp_ret N/A N/A N/A N/A N/A details items N/A 0 N/A 1 N/A details text N/A N/A ret N/A N/A emp_ret N/A order_by emp_ret N/A ret N/A show_employee N/A N/A emp_id fields N/A None N/A N/A 
    Show all employees for this company.

    CLI Example:

        salt myminion bamboohr.show_employee 1138

    By default, the fields normally returned from bamboohr.list_employees are
    returned. These fields are:

        - canUploadPhoto
        - department
        - displayName
        - firstName
        - id
        - jobTitle
        - lastName
        - location
        - mobilePhone
        - nickname
        - photoUploaded
        - photoUrl
        - workEmail
        - workPhone
        - workPhoneExtension

    If needed, a different set of fields may be specified, separated by commas:

    CLI Example:

        salt myminion bamboohr.show_employee 1138 displayName,dateOfBirth

    A list of available fields can be found at
    http://www.bamboohr.com/api/documentation/employees.php
     N/A ret N/A N/A N/A fields None N/A N/A fields N/A N/A , join N/A canUploadPhoto department displayName firstName id jobTitle lastName location mobilePhone nickname photoUploaded photoUrl workEmail workPhone workPhoneExtension N/A N/A status result N/A _query action employees command emp_id args N/A fields fields N/A root N/A N/A ET fromstring result N/A items N/A N/A root getchildren N/A ret N/A id emp_id N/A item items N/A N/A N/A ret N/A N/A N/A N/A N/A item items N/A 0 N/A 1 N/A item text N/A ret N/A update_employee N/A N/A emp_id key value items N/A None None None N/A N/A 
    Update one or more items for this employee. Specifying an empty value will
    clear it for that employee.

    CLI Examples:

        salt myminion bamboohr.update_employee 1138 nickname Curly
        salt myminion bamboohr.update_employee 1138 nickname ''
        salt myminion bamboohr.update_employee 1138 items='{"nickname": "Curly"}
        salt myminion bamboohr.update_employee 1138 items='{"nickname": ""}
     N/A N/A items None N/A N/A N/A N/A key None N/A value None N/A N/A N/A Error At least one key/value pair is required N/A items N/A key value N/A N/A N/A isinstance items N/A six string_types N/A N/A items N/A N/A yaml safe_load items N/A xml_items N/A pair N/A N/A items keys N/A N/A xml_items N/A N/A <field id="{0}">{1}</field> format pair N/A items N/A pair N/A xml_items N/A N/A <employee>{0}</employee> format xml_items N/A N/A status result N/A _query action employees command emp_id data xml_items method POST N/A N/A show_employee emp_id N/A N/A , join N/A N/A items keys N/A list_users N/A N/A order_by N/A id N/A N/A 
    Show all users for this company.

    CLI Example:

        salt myminion bamboohr.list_users

    By default, the return data will be keyed by ID. However, it can be ordered
    by any other field. Keep in mind that if the field that is chosen contains
    duplicate values (i.e., location is used, for a company which only has one
    location), then each duplicate value will be overwritten by the previous.
    Therefore, it is advisable to only sort by fields that are guaranteed to be
    unique.

    CLI Examples:

        salt myminion bamboohr.list_users order_by=id
        salt myminion bamboohr.list_users order_by=email
     N/A ret N/A N/A N/A status result N/A _query action meta command users N/A root N/A N/A ET fromstring result N/A users N/A N/A root getchildren N/A user users N/A N/A user_id None N/A user_ret N/A N/A item N/A N/A user items N/A N/A N/A user_ret N/A N/A item N/A 0 N/A item N/A 1 N/A N/A N/A item N/A 0 id N/A N/A user_id N/A item N/A 1 N/A item N/A N/A user getchildren N/A N/A N/A user_ret N/A N/A item tag N/A item text N/A N/A ret N/A N/A user_ret N/A order_by user_ret N/A ret N/A list_meta_fields N/A N/A N/A N/A N/A 
    Show all meta data fields for this company.

    CLI Example:

        salt myminion bamboohr.list_meta_fields
     N/A ret N/A N/A N/A status result N/A _query action meta command fields N/A root N/A N/A ET fromstring result N/A fields N/A N/A root getchildren N/A field fields N/A N/A field_id None N/A field_ret N/A name N/A field text N/A item N/A N/A field items N/A N/A N/A field_ret N/A N/A item N/A 0 N/A item N/A 1 N/A N/A N/A item N/A 0 id N/A N/A field_id N/A item N/A 1 N/A N/A ret N/A field_id field_ret N/A ret N/A _query N/A N/A action command args method data N/A None None None GET None N/A N/A 
    Make a web call to BambooHR

    The password can be any random text, so we chose Salty text.
     N/A subdomain N/A N/A N/A N/A __opts__ get bamboohr N/A get subdomain None N/A path N/A N/A https://api.bamboohr.com/api/gateway.php/{0}/v1/ format subdomain N/A action N/A N/A path action N/A command N/A N/A path N/A N/A /{0} format command N/A N/A N/A log debug N/A N/A BambooHR URL: {0} format path N/A N/A N/A isinstance args dict N/A N/A args N/A N/A return_content None N/A result N/A N/A N/A N/A salt utils http query path method username N/A _apikey password saltypork params args data data decode False text True status True opts __opts__ N/A N/A N/A log debug N/A N/A BambooHR Response Status Code: {0} format N/A result N/A status N/A N/A N/A result N/A status N/A result N/A text N/A