pykazoo.directories

class pykazoo.directories.Directories(rest_request)

2600hz Kazoo Directories API.

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

Create a Directory

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

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

dict
delete_directory(account_id, directory_id)

Deletes a Device

Parameters:
  • account_id (str) – ID of Account to delete Directory from.
  • directory_id (str) – ID of Directory to delete.
Returns:

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

dict
get_directories(account_id, filters=None)

Get all Devices for an Account.

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

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

dict
get_directory(account_id, directory_id, filters=None)

Get a specific Devices for an Account.

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

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

dict
update_directory(account_id, directory_id, data)

Updates a Directory

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

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

dict