pykazoo.accounts

class pykazoo.accounts.Accounts(rest_request)

2600hz Kazoo Accounts API.

Parameters:rest_request (pykazoo.restrequest.RestRequest) – The request client to use. (optional, default: pykazoo.RestRequest())
create_sub_account(parent_account_id, data)

Create an Account

Parameters:
  • parent_account_id (str) – ID of Account parent.
  • data (dict) – Kazoo Account data (see official API Docs).
Returns:

Kazoo Data (see official API docs).
Return type:

dict
delete_account(account_id)

Deletes an Account

Parameters:account_id (str) – ID of Account.
Returns:Kazoo Data (see official API docs).
Return type:dict
get_account(account_id, filters=None)

Get an Account

Parameters:
  • account_id (str) – ID of Account to get.
  • filters (dict, None) – Kazoo Filter Parameters (see official API docs).
Returns:

Kazoo Data (see official API docs).
Return type:

dict
get_account_children(account_id, filters=None)

Get the Children of an Account

Parameters:
  • account_id (str) – ID of Account to get.
  • filters (dict, None) – Kazoo Filter Parameters (see official API docs).
Returns:

Kazoo Data (see official API docs).
Return type:

dict
get_account_descendants(account_id, filters=None)

Get the Descendants of an Account

Parameters:
  • account_id (str) – ID of Account to get.
  • filters (dict, None) – Kazoo Filter Parameters (see official API docs).
Returns:

Kazoo Data (see official API docs).
Return type:

dict
get_account_siblings(account_id, filters=None)

Get the Siblings of an Account

Parameters:
  • account_id (str) – ID of Account to get.
  • filters (dict, None) – Kazoo Filter Parameters (see official API docs).
Returns:

Kazoo Data (see official API docs).
Return type:

dict
update_account(account_id, data)

Updates an Account

Parameters:
  • account_id (str) – ID of Account.
  • data (dict) – Kazoo Account data (see official API Docs).
Returns:

Kazoo Data (see official API docs).
Return type:

dict