from collections.abc import Generator
from typing import Optional
from wxc_sdk.api_child import ApiChild
from wxc_sdk.base import ApiModel
from wxc_sdk.base import SafeEnum as Enum
__all__ = ['TranslationPatternsApi', 'TranslationPattern', 'TranslationPatternLevel']
from wxc_sdk.common import IdAndName
[docs]
class TranslationPatternLevel(str, Enum):
organization = 'Organization'
location = 'Location'
[docs]
class TranslationPattern(ApiModel):
#: Unique identifier for a translation pattern.
id: Optional[str] = None
#: Name given to a translation pattern for an organization.
name: Optional[str] = None
#: Matching pattern given to a translation pattern for an organization.
matching_pattern: Optional[str] = None
#: Replacement pattern given to a translation pattern for an organization.
replacement_pattern: Optional[str] = None
level: Optional[TranslationPatternLevel] = None
location: Optional[IdAndName] = None
def create_update(self) -> dict:
"""
Data for create() and update()
:meta private:
"""
return self.model_dump(mode='json', exclude={'id', 'level', 'location'}, by_alias=True)
[docs]
class TranslationPatternsApi(ApiChild, base='telephony/config/callRouting/translationPatterns'):
"""
Translation Patterns
A translation pattern lets you manipulate dialed digits before routing a call and applies to outbound calls only.
Call routing supports translation patterns at the organization level.
Viewing these translation patterns for an organization requires a full or read-only administrator auth token with a
scope of `spark-admin:telephony_config_read`.
Modifying these translation patterns for an organization requires a full administrator auth token with a scope
of `spark-admin:telephony_config_write`.
"""
def ep(self, path: str = None, location_id: str = None):
"""
Get ep with optional location_id
:meta private:
:param path:
:param location_id:
:return:
"""
if location_id is None:
return super().ep(path)
path = path and f'/{path}' or ''
base = 'telephony/config/locations'
return self.session.ep(f'{base}/{location_id}/callRouting/translationPatterns{path}')
[docs]
def create(self, pattern: TranslationPattern, location_id: str = None,
org_id: str = None) -> str:
"""
Create a Translation Pattern
A translation pattern lets you manipulate dialed digits before routing a call and applies to outbound calls
only.
Create a translation pattern for a given organization.
Requires a full administrator auth token with the `spark-admin:telephony_config_write` scope.
:param pattern: Translation pattern to create
:type pattern: TranslationPattern
:param location_id: Unique identifier for the location. Only used when creating location level translation
:type location_id: str
:param org_id: ID of the organization containing the translation pattern
:type org_id: str
:rtype: str
"""
params = org_id and {'orgId': org_id} or None
body = pattern.create_update()
url = self.ep(location_id=location_id)
data = super().post(url, params=params, json=body)
r = data['id']
return r
[docs]
def list(self, limit_to_location_id: str = None,
limit_to_org_level_enabled: bool = None, name: str = None,
matching_pattern: str = None, org_id: str = None,
**params) -> Generator[TranslationPattern, None, None]:
"""
Retrieve a list of Translation Patterns
A translation pattern lets you manipulate dialed digits before routing a call and applies to outbound calls
only.
Retrieve a list of translation patterns for a given organization.
Requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.
:param limit_to_location_id: When a location ID is passed, then return only the corresponding location level
translation patterns.
:type limit_to_location_id: str
:param limit_to_org_level_enabled: When set to be `true`, then return only the organization-level translation
patterns.
:type limit_to_org_level_enabled: bool
:param name: Only return translation patterns with the matching `name`.
:type name: str
:param matching_pattern: Only return translation patterns with the matching `matchingPattern`.
:type matching_pattern: str
:param org_id: ID of the organization containing the translation patterns.
:type org_id: str
:return: Generator yielding :class:`TranslationPatternGet` instances
"""
if org_id:
params['orgId'] = org_id
if limit_to_location_id is not None:
params['limitToLocationId'] = limit_to_location_id
if limit_to_org_level_enabled is not None:
params['limitToOrgLevelEnabled'] = str(limit_to_org_level_enabled).lower()
if name is not None:
params['name'] = name
if matching_pattern is not None:
params['matchingPattern'] = matching_pattern
url = self.ep()
return self.session.follow_pagination(url=url, model=TranslationPattern, item_key='translationPatterns',
params=params)
[docs]
def details(self, translation_id: str,
location_id: str = None,
org_id: str = None) -> TranslationPattern:
"""
Retrieve the details of a Translation Pattern
A translation pattern lets you manipulate dialed digits before routing a call and applies to outbound calls
only.
Retrieve the details of a translation pattern for a given organization.
Requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.
:param translation_id: Retrieve the translation pattern with the matching ID.
:type translation_id: str
:param location_id: Unique identifier for the location. Only used when getting details for location level
translation patterns
:type location_id: str
:param org_id: ID of the organization containing the translation pattern.
:type org_id: str
:rtype: :class:`TranslationPattern`
"""
params = org_id and {'orgId': org_id} or None
url = self.ep(path=translation_id, location_id=location_id)
data = super().get(url, params=params)
r = TranslationPattern.model_validate(data)
return r
[docs]
def update(self, pattern: TranslationPattern, location_id: str = None, org_id: str = None):
"""
Modify a Translation Pattern
A translation pattern lets you manipulate dialed digits before routing a call and applies to outbound calls
only.
Modify a translation pattern for a given organization. To update a location level translation pattern the
location.id attribute of the pattern has to be set
Requires a full administrator auth token with the `spark-admin:telephony_config_write` scope.
:param pattern: Translation pattern to be updated
:type pattern: TranslationPattern
:param location_id: Unique identifier for the location. Only used when updating location level translation
pattern
:type location_id: str
:param org_id: ID of the organization containing the translation pattern.
:type org_id: str
:rtype: None
"""
params = org_id and {'orgId': org_id} or None
body = pattern.create_update()
url = self.ep(location_id=location_id, path=pattern.id)
super().put(url, params=params, json=body)
[docs]
def delete(self, translation_id: str, location_id: str = None, org_id: str = None):
"""
Delete a Translation Pattern
A translation pattern lets you manipulate dialed digits before routing a call and applies to outbound calls
only.
Delete a translation pattern for a given organization.
Requires a full administrator auth token with the `spark-admin:telephony_config_write` scope.
:param translation_id: Delete a translation pattern with the matching ID.
:type translation_id: str
:param location_id: Unique identifier for the location. Only used when deleting location level translation
patterns
:param org_id: ID of the organization containing the translation pattern.
:type org_id: str
:rtype: None
"""
params = org_id and {'orgId': org_id} or None
url = self.ep(location_id=location_id, path=translation_id)
super().delete(url, params=params)