pykazoo.menus

class pykazoo.menus.Menus(rest_request)

2600hz Kazoo Menus API.

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

Create a Menu

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

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

dict
delete_menu(account_id, menu_id)

Deletes a Menu

Parameters:
  • account_id (str) – ID of Account to delete device from.
  • menu_id (str) – ID of Menu to delete.
Returns:

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

dict
get_menu(account_id, menu_id, filters=None)

Get a specific Menu for an Account.

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

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

dict
get_menus(account_id, filters=None)

Get all Menus for an Account.

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

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

dict
update_menu(account_id, menu_id, data)

Updates a Menu

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

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

dict