wxc_sdk.workspace_personalization package

class wxc_sdk.workspace_personalization.WorkspacePersonalizationApi(*, session: RestSession, base: str | None = None)

Bases: ApiChild

Workspace Personalization

This API collection applies only to Webex Edge registered devices.

The Workspace Personalization API is designed to help administrators enable Personal Mode for Webex Edge registered devices. This one-time operation allows for end users to receive calls and meeting notifications directly on their device, without needing to pair. This API aids with the process of the migration from on-premise to cloud-registered personal mode systems.

For the personalization of a device to be successful, the following requirements must be satisfied:

• The workspace must contain a single, Webex Edge registered, shared mode device.

• The workspace must not have any calendars configured.

• The device belonging to the workspace must be online.

Invoking this API requires the spark-admin:devices_write, spark:xapi_commands, spark:xapi_statuses and Identity:one_time_password scopes.

personalize_a_workspace(workspace_id: str, email: str)

Personalize a Workspace

Initializes the personalization for a given workspace for the user email provided.

The personalization process is asynchronous and thus a background task is created when this endpoint is invoked. After successful invocation of this endpoint a personalization task status URL will be returned in the Location header, which will point to the Get Personalization Task endpoint for this workspace. The task should be completed in approximately 30 seconds.

Parameters:

• workspace_id (str) – A unique identifier for the workspace.

• email (str) – The user that the device will become personalised for.

Return type:

None

get_personalization_task(workspace_id: str) → WorkspacePersonalizationTaskResponse

Get Personalization Task

Returns the status of a personalization task for a given workspace.

Whilst in progress the endpoint will return Accepted and provide a Retry-After header indicating the number of seconds a client should wait before retrying.

Upon completion of the task, the endpoint will return OK with a body detailing if the personalization was successful and an error description if appropriate.

Parameters:

workspace_id (str) – A unique identifier for the workspace.

Return type:

WorkspacePersonalizationTaskResponse

base = 'workspaces'

class wxc_sdk.workspace_personalization.WorkspacePersonalizationTaskResponse(*, success: bool | None = None, errorDescription: str | None = None)

Bases: ApiModel

success: bool | None

Describes if the personalization was successful.

error_description: str | None

A description of the error will be provided if the personalization was not successful. example: Device is offline