wxc_sdk.locations package

Locations

Locations are used to organize Webex Calling (BroadCloud) features within physical locations. Webex Control Hub may be used to define new locations.

Searching and viewing locations in your organization requires an administrator auth token with the spark-admin:people_read and spark-admin:people_write or spark-admin:device_read AND spark-admin:device_writescope combinations.

class wxc_sdk.locations.LocationAddress(*, address1: str = None, address2: str = None, city: str = None, state: str = None, postalCode: str = None, country: str = None)[source]

Bases: ApiModel

Address of a Location

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

address1: Optional[str]: address line 1

address2: Optional[str]: address line 2

city: Optional[str]: city

state: Optional[str]: state

postal_code: Optional[str]: ZIP/Postal code

country: Optional[str]: country

class wxc_sdk.locations.Location(*, id: str, name: str, orgId: str, address: LocationAddress)[source]

Bases: ApiModel

Webex location

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

location_id: str: A unique identifier for the location.

name: str: The name of the location.

org_id: str: The ID of the organization to which this location belongs.

address: LocationAddress: The address of the location, LocationAddress

property location_id_uuid: str: location id as UUID

property org_id_uuid: str: org id as UUID

class wxc_sdk.locations.LocationsApi(*, session: RestSession, base: Optional[str] = None)[source]

Bases: ApiChild

Location API

Locations are used to organize Webex Calling (BroadCloud) features within physical locations. Webex Control Hub may be used to define new locations.

Searching and viewing locations in your organization requires an administrator auth token with the spark-admin:people_read and spark-admin:people_write or spark-admin:device_read AND spark-admin:device_write scope combinations.

list(name: Optional[str] = None, location_id: Optional[str] = None, org_id: Optional[str] = None, **params) → Generator[Location, None, None][source]

List locations for an organization.

Parameters

name (str) – List locations whose name contains this string (case-insensitive).
location_id (str) – List locations by ID.
org_id (str) – List locations in this organization. Only admin users of another organization (such as partners) may use this parameter.

Returns

generator of Location instances

by_name(name: str, org_id: Optional[str] = None) → Optional[Location][source]

Get a location by name

Parameters

name (str) – name of the location to search
org_id (str) – search in list of locations in this organization. Only admin users of another organization (such as partners) may use this parameter.

Returns

locations

Return type

Location

details(location_id) → Location[source]

Shows details for a location, by ID.

This API only works for Customer administrators and for Partner administrators to query their own organization. Partner administrators looking to query customer organizations should use the List Locations endpoint to retrieve information about locations.

Parameters: location_id (str) – A unique identifier for the location.
Returns: location details
Return type: Location

base = 'locations'

session: RestSession: REST session