wxc_sdk.telephony.data_policies package

class wxc_sdk.telephony.data_policies.CustomerDataPolicies(*, orgDataRegion: str | None = None, allowEditEnabled: bool | None = None, **extra_data: Any)[source]

Bases: ApiModel

org_data_region: str | None: (ISO 3166-1 alpha-2) Country Code configured as the storage region for the data policy of the Organization.

allow_edit_enabled: bool | None: If true, the storage region for the data policy of the Organization can be modified.

class wxc_sdk.telephony.data_policies.DataPolicyRegion(*, code: str | None = None, name: str | None = None, isVoicemailStorageRestrictionEnabled: bool | None = None, **extra_data: Any)[source]

Bases: ApiModel

code: str | None: (ISO 3166-1 alpha-2) Country Code.

name: str | None: Name of the country corresponding to the (ISO 3166-1 alpha-2) Country Code.

is_voicemail_storage_restriction_enabled: bool | None: Indicates whether voicemail storage restriction is enabled for this region.

class wxc_sdk.telephony.data_policies.DataPoliciesApi(*, session: RestSession, base: str = None)[source]

Bases: ApiChild

Features Data Policies

The APIs allow a person to read or modify settings related to data (storage) policy region for an organization or organization’s location.

Viewing settings requires a user auth token with a scope of spark-admin:telephony_config_read.

Configuring settings requires a user auth token with a scope of spark-admin:telephony_config_write.

read_data_policy_settings(org_id: str = None) → CustomerDataPolicies[source]

Get the Data (Storage) Policy Settings for the Organization

Retrieve the settings for data (storage) policy region of the organization.

Data policies allow administrators to configure the storage region for organization data at the organization or location level.

Retrieving data policy settings requires a user auth token with a scope of spark-admin:telephony_config_read.

Parameters:: org_id (str) – Retrieve data policy settings from this organization.
Return type:: CustomerDataPolicies

modify_data_policy_settings(org_data_region: str = None, org_id: str = None) → None[source]

Update the Data (Storage) Policy Settings for the Organization

Modify the configurations for data (storage) policy region of the organization.

Data policies allow administrators to configure the storage region for organization data at the organization or location level.

Configuring data policy settings requires a user auth token with a scope of spark-admin:telephony_config_write.

Parameters:

org_data_region (str) – (ISO 3166-1 alpha-2) Country Code to be configured as the storage region for the data policy of the Organization.
org_id (str) – Modify data policy settings for this organization.

Return type:

None

get_available_data_policy_regions(org_id: str = None) → list[DataPolicyRegion][source]

Get All the Storage Regions Available for Configuring as Data Policy Region

Retrieve all the storage regions available for configuring data (storage) policy of an organization or organization’s location.

Data policies allow administrators to configure the storage region for organization data at the organization or location level.

Retrieving available data policy regions requires a user auth token with a scope of spark-admin:telephony_config_read.

Parameters:: org_id (str) – Retrieve available data policy regions for this organization.
Return type:: list[DataPolicyRegion]

get_location_data_policy_settings(location_id: str, org_id: str = None) → LocationDataPolicies[source]

Get the Data (Storage) Policy Settings for the Organization’s Location

Retrieve the settings for data (storage) policy region of the organization’s location.

Data policies allow administrators to configure the storage region for organization data at the organization or location level.

Retrieving location data policy settings requires a user auth token with a scope of spark-admin:telephony_config_read.

Parameters:

location_id (str) – Fetch the data policy for this location.
org_id (str) – Retrieve location data policy settings from this organization.

Return type:

LocationDataPolicies

modify_location_data_policy_settings(location_id: str, location_data_region: str = None, use_org_data_region_enabled: bool = None, org_id: str = None) → None[source]

Update the Data (Storage) Policy Settings for the Organization’s Location

Modify the configurations for data (storage) policy region of the organization’s location.

Data policies allow administrators to configure the storage region for organization data at the organization or location level.

Configuring location data policy settings requires a user auth token with a scope of spark-admin:telephony_config_write.

Parameters:

location_id (str) – Modify the data policy for this location.
location_data_region (str) – (ISO 3166-1 alpha-2) Country Code to be configured as the data policy region for the location.
use_org_data_region_enabled (bool) – Whether location’s data (storage) policy region to be used same as the one configured at the Organization’s level.
org_id (str) – Modify location data policy settings for this organization.

Return type:

None

base = 'telephony/config'

class wxc_sdk.telephony.data_policies.LocationDataPolicies(*, orgDataRegion: str | None = None, locationDataRegion: str | None = None, useOrgDataRegionEnabled: bool | None = None, allowEditEnabled: bool | None = None, **extra_data: Any)[source]

Bases: ApiModel

org_data_region: str | None: (ISO 3166-1 alpha-2) Country Code indicating the data policy region configured for the organization to which the location belongs to.

location_data_region: str | None: (ISO 3166-1 alpha-2) Country Code indicating the data policy region configured for the location.

use_org_data_region_enabled: bool | None: Indicates whether the location is configured to use configuration same as the Organization’s configuration for data (storage) policy region settings.

allow_edit_enabled: bool | None: If true, the storage region for the data policy of the Location can be modified.