from datetime import datetime
from typing import Optional, List
from pydantic import TypeAdapter
from wxc_sdk.api_child import ApiChild
from wxc_sdk.base import ApiModel
from wxc_sdk.common import IdAndName
__all__ = ['PlaylistAnnouncement', 'PlayListApi', 'PlayList']
[docs]
class PlaylistAnnouncement(ApiModel):
#: Unique identifier of the announcement.
id: Optional[str] = None
#: Name of the announcement.
name: Optional[str] = None
#: File name of the uploaded binary announcement greeting.
file_name: Optional[str] = None
#: Size of the file in kilobytes.
file_size: Optional[int] = None
#: Media file type of the announcement file.
media_file_type: Optional[str] = None
#: Last updated timestamp (in UTC format) of the announcement.
last_updated: Optional[datetime] = None
#: The level at which this playlist exists.
level: Optional[str] = None
[docs]
class PlayList(ApiModel):
#: Unique identifier of the playlist.
id: Optional[str] = None
#: Unique name for the announcement playlist.
name: Optional[str] = None
#: Size of the files in kilobytes.
file_size: Optional[int] = None
#: Count of the announcements associated with playlist.
file_count: Optional[int] = None
#: Indicates if the playlist has been used or not.
is_in_use: Optional[bool] = None
#: Last updated timestamp (in UTC format) of the playlist.
last_updated: Optional[datetime] = None
#: The level at which this playlist exists.
level: Optional[str] = None
#: Count of the location this playlist is assigned to.
location_count: Optional[int] = None
#: List of announcement details associated with playlist.
announcements: Optional[list[PlaylistAnnouncement]] = None
[docs]
class PlayListApi(ApiChild, base='telephony/config/announcements/playlists'):
"""
Features: Announcement PlayList
Features: Announcement PlayList support reading and writing of Webex Calling Announcement PlayList settings for a
specific organization. The playlist has multiple announcement files which will be played where the announcement
playlist is selected.
Viewing these read-only organization settings requires a full or read-only administrator auth token with a scope
of `spark-admin:telephony_config_read`.
Modifying these organization settings requires a full administrator auth token with a scope
of `spark-admin:telephony_config_write`.
A partner administrator can retrieve or change settings in a customer's organization using the optional `orgId`
query parameter.
"""
[docs]
def list(self, org_id: str = None) -> list[PlayList]:
"""
Fetch list of announcement playlist on organization level
Fetch a list of announcement playlist at an organization.
This API requires a full or read-only administrator or location administrator auth token with a scope of
`spark-admin:telephony_config_read`.
:param org_id: Get announcements playlist in this organization.
:type org_id: str
:rtype: list[:class:`PlayList`]
"""
params = {}
if org_id is not None:
params['orgId'] = org_id
url = self.ep()
data = super().get(url, params=params)
r = TypeAdapter(list[PlayList]).validate_python(data['playlists'])
return r
[docs]
def create(self, name: str, announcement_ids: List[str], org_id: str = None) -> str:
"""
Create announcement Playlist at organization level
Create announcement Playlist at an organization level. A maximum of 25 announcement files can be included in a
single playlist.
This API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.
:param name: Unique name for the announcement playlist.
:type name: str
:param announcement_ids: Array of `announcementIds` associated with the playlist.
:type announcement_ids: list[str]
:param org_id: Create an announcement playlist in this organization.
:type org_id: str
:rtype: str
"""
params = {}
if org_id is not None:
params['orgId'] = org_id
body = dict()
body['name'] = name
body['announcementIds'] = announcement_ids
url = self.ep()
data = super().post(url, params=params, json=body)
r = data['id']
return r
[docs]
def details(self, play_list_id: str, org_id: str = None) -> PlayList:
"""
Fetch details of announcement playlist at the organization level
Fetch details of announcement playlist by its ID at an organization level.
This API requires a full or read-only administrator auth token with a scope of
`spark-admin:telephony_config_read`.
:param play_list_id: Unique identifier of an announcement playlist.
:type play_list_id: str
:param org_id: Get an announcement playlist in this organization.
:type org_id: str
:rtype: :class:`PlayList`
"""
params = {}
if org_id is not None:
params['orgId'] = org_id
url = self.ep(f'{play_list_id}')
data = super().get(url, params=params)
r = PlayList.model_validate(data)
return r
[docs]
def modify(self, play_list_id: str, name: str = None, announcement_ids: List[str] = None, org_id: str = None):
"""
Modify announcement playlist at organization level
Modify an existing announcement playlist at an organization level.
This API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.
:param play_list_id: Unique identifier of an announcement playlist.
:type play_list_id: str
:param name: Unique name for the announcement playlist.
:type name: str
:param announcement_ids: Array of `announcementIds` associated with the playlist.
:type announcement_ids: list[str]
:param org_id: Modify an announcement playlist in this organization.
:type org_id: str
:rtype: None
"""
params = {}
if org_id is not None:
params['orgId'] = org_id
body = dict()
if name is not None:
body['name'] = name
if announcement_ids is not None:
body['announcementIds'] = announcement_ids
url = self.ep(f'{play_list_id}')
super().put(url, params=params, json=body)
[docs]
def delete(self, play_list_id: str, org_id: str = None):
"""
Delete an announcement playlist for an organization.
This API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.
:param play_list_id: Unique identifier of an announcement playlist.
:type play_list_id: str
:param org_id: Delete an announcement playlist in this organization.
:type org_id: str
:rtype: None
"""
params = {}
if org_id is not None:
params['orgId'] = org_id
url = self.ep(f'{play_list_id}')
super().delete(url, params=params)
[docs]
def assigned_locations(self, play_list_id: str, org_id: str = None) -> List[IdAndName]:
"""
Fetch list of locations which are assigned to the announcement playlist
Fetch list of locations which are assigned to the given announcement playlist
This API requires a full or read-only administrator or location administrator auth token with a scope of
`spark-admin:telephony_config_read`.
:param play_list_id: Unique identifier of playlist.
:type play_list_id: str
:param org_id: Get location associated to a playlist in this organization.
:type org_id: str
:rtype: :class:`PlayListAssignedLocations`
"""
params = {}
if org_id is not None:
params['orgId'] = org_id
url = self.ep(f'{play_list_id}/locations')
data = super().get(url, params=params)
r = TypeAdapter(list[IdAndName]).validate_python(data['locations'])
return r
[docs]
def modify_assigned_locations(self, play_list_id: str, location_ids: List[str], org_id: str = None):
"""
Modify list of assigned locations to the announcement playlist
Modify list of assigned locations or add new locations to the announcement playlist. This will assing the
playlist to the location's music on hold.
This API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.
:param play_list_id: Unique identifier of an announcement playlist.
:type play_list_id: str
:param location_ids: Array of location IDs with which the playlist is associated.
:type location_ids: list[str]
:param org_id: Modify an assign location for announcement playlist for organization.
:type org_id: str
:rtype: None
"""
params = {}
if org_id is not None:
params['orgId'] = org_id
body = dict()
body['locationIds'] = location_ids
url = self.ep(f'{play_list_id}/locations')
super().put(url, params=params, json=body)