webex_byova.resources

webex_byova.resources

API resources.

__all__ module-attribute

__all__ = ['DataSourceResource', 'SchemaResource', 'OrgClient']

DataSourceResource

Async CRUD operations for /dataSources endpoints.

Automatically refreshes Service App tokens on 401 responses.

__init__

__init__(org_id: str, service_app: ServiceAppTokenManager, http: HttpClient) -> None

Initialize the data source resource.

Parameters:

Name	Type	Description	Default
org_id	str	Organization UUID for token scoping.	required
service_app	ServiceAppTokenManager	Service App token manager.	required
http	HttpClient	Shared HTTP client.	required

alist async

alist() -> list[DataSourceListItem]

List all data sources for the organization.

Returns:

Type	Description
list[DataSourceListItem]	List of data source summary items.

aget async

aget(data_source_id: str) -> DataSource

Get a data source by ID.

Parameters:

Name	Type	Description	Default
data_source_id	str	Unique data source identifier.	required

Returns:

Type	Description
DataSource	Full data source resource.

acreate async

acreate(payload: DataSourceCreate | dict[str, Any]) -> DataSource

Create a new data source.

Parameters:

Name	Type	Description	Default
payload	DataSourceCreate | dict[str, Any]	Create payload as a model or dict with camelCase keys.	required

Returns:

Type	Description
DataSource	Created data source resource.

aupdate async

aupdate(data_source_id: str, payload: DataSourceUpdate | dict[str, Any]) -> DataSource

Update an existing data source.

Parameters:

Name	Type	Description	Default
data_source_id	str	Unique data source identifier.	required
payload	DataSourceUpdate | dict[str, Any]	Update payload as a model or dict.	required

Returns:

Type	Description
DataSource	Updated data source resource.

adelete async

adelete(data_source_id: str) -> None

Delete a data source.

Parameters:

Name	Type	Description	Default
data_source_id	str	Unique data source identifier.	required

OrgClient

Per-organization API client with DataSource and Schema resources.

Attributes:

Name	Type	Description
org_id		Organization UUID this client is scoped to.
data_sources		Data source CRUD operations.
schemas		Schema discovery operations.

__init__

__init__(org_id: str, service_app: ServiceAppTokenManager, http: HttpClient) -> None

Initialize an org-scoped client.

Parameters:

Name	Type	Description	Default
org_id	str	Organization UUID.	required
service_app	ServiceAppTokenManager	Service App token manager.	required
http	HttpClient	Shared HTTP client.	required

SchemaResource

List and retrieve BYODS data source schemas for an organization.

__init__

__init__(service_app: ServiceAppTokenManager, http: HttpClient, org_id: str) -> None

Initialize the schema resource.

Parameters:

Name	Type	Description	Default
service_app	ServiceAppTokenManager	Service App token manager.	required
http	HttpClient	Shared HTTP client.	required
org_id	str	Organization UUID for token scoping.	required

alist async

alist() -> list[Schema]

List available BYODS schemas for the organization.

Returns:

Type	Description
list[Schema]	List of schema definitions.

aget async

aget(schema_id: str) -> Schema

Get a schema by ID.

Parameters:

Name	Type	Description	Default
schema_id	str	Unique schema UUID.	required

Returns:

Type	Description
Schema	Schema definition.

datasource

DataSource CRUD resource.

DataSourceResource

Async CRUD operations for /dataSources endpoints.

Automatically refreshes Service App tokens on 401 responses.

__init__

__init__(org_id: str, service_app: ServiceAppTokenManager, http: HttpClient) -> None

Initialize the data source resource.

Parameters:

Name	Type	Description	Default
org_id	str	Organization UUID for token scoping.	required
service_app	ServiceAppTokenManager	Service App token manager.	required
http	HttpClient	Shared HTTP client.	required

alist async

alist() -> list[DataSourceListItem]

List all data sources for the organization.

Returns:

Type	Description
list[DataSourceListItem]	List of data source summary items.

aget async

aget(data_source_id: str) -> DataSource

Get a data source by ID.

Parameters:

Name	Type	Description	Default
data_source_id	str	Unique data source identifier.	required

Returns:

Type	Description
DataSource	Full data source resource.

acreate async

acreate(payload: DataSourceCreate | dict[str, Any]) -> DataSource

Create a new data source.

Parameters:

Name	Type	Description	Default
payload	DataSourceCreate | dict[str, Any]	Create payload as a model or dict with camelCase keys.	required

Returns:

Type	Description
DataSource	Created data source resource.

aupdate async

aupdate(data_source_id: str, payload: DataSourceUpdate | dict[str, Any]) -> DataSource

Update an existing data source.

Parameters:

Name	Type	Description	Default
data_source_id	str	Unique data source identifier.	required
payload	DataSourceUpdate | dict[str, Any]	Update payload as a model or dict.	required

Returns:

Type	Description
DataSource	Updated data source resource.

adelete async

adelete(data_source_id: str) -> None

Delete a data source.

Parameters:

Name	Type	Description	Default
data_source_id	str	Unique data source identifier.	required

OrgClient

Per-organization API client with DataSource and Schema resources.

Attributes:

Name	Type	Description
org_id		Organization UUID this client is scoped to.
data_sources		Data source CRUD operations.
schemas		Schema discovery operations.

__init__

__init__(org_id: str, service_app: ServiceAppTokenManager, http: HttpClient) -> None

Initialize an org-scoped client.

Parameters:

Name	Type	Description	Default
org_id	str	Organization UUID.	required
service_app	ServiceAppTokenManager	Service App token manager.	required
http	HttpClient	Shared HTTP client.	required

schemas

DataSource schema resource.

SchemaResource

List and retrieve BYODS data source schemas for an organization.

__init__

__init__(service_app: ServiceAppTokenManager, http: HttpClient, org_id: str) -> None

Initialize the schema resource.

Parameters:

Name	Type	Description	Default
service_app	ServiceAppTokenManager	Service App token manager.	required
http	HttpClient	Shared HTTP client.	required
org_id	str	Organization UUID for token scoping.	required

alist async

alist() -> list[Schema]

List available BYODS schemas for the organization.

Returns:

Type	Description
list[Schema]	List of schema definitions.

aget async

aget(schema_id: str) -> Schema

Get a schema by ID.

Parameters:

Name	Type	Description	Default
schema_id	str	Unique schema UUID.	required

Returns:

Type	Description
Schema	Schema definition.

webex_byova.resources.datasource.OrgClient

Per-organization API client with DataSource and Schema resources.

Attributes:

Name	Type	Description
org_id		Organization UUID this client is scoped to.
data_sources		Data source CRUD operations.
schemas		Schema discovery operations.

__init__

__init__(org_id: str, service_app: ServiceAppTokenManager, http: HttpClient) -> None

Initialize an org-scoped client.

Parameters:

Name	Type	Description	Default
org_id	str	Organization UUID.	required
service_app	ServiceAppTokenManager	Service App token manager.	required
http	HttpClient	Shared HTTP client.	required

webex_byova.resources.datasource.DataSourceResource

Async CRUD operations for /dataSources endpoints.

Automatically refreshes Service App tokens on 401 responses.

_org_id instance-attribute

_org_id = org_id

_service_app instance-attribute

_service_app = service_app

_http instance-attribute

_http = http

__init__

__init__(org_id: str, service_app: ServiceAppTokenManager, http: HttpClient) -> None

Initialize the data source resource.

Parameters:

Name	Type	Description	Default
org_id	str	Organization UUID for token scoping.	required
service_app	ServiceAppTokenManager	Service App token manager.	required
http	HttpClient	Shared HTTP client.	required

_bearer async

_bearer() -> str

_with_retry async

_with_retry(method: str, path: str, **kwargs: Any) -> Any

alist async

alist() -> list[DataSourceListItem]

List all data sources for the organization.

Returns:

Type	Description
list[DataSourceListItem]	List of data source summary items.

aget async

aget(data_source_id: str) -> DataSource

Get a data source by ID.

Parameters:

Name	Type	Description	Default
data_source_id	str	Unique data source identifier.	required

Returns:

Type	Description
DataSource	Full data source resource.

acreate async

acreate(payload: DataSourceCreate | dict[str, Any]) -> DataSource

Create a new data source.

Parameters:

Name	Type	Description	Default
payload	DataSourceCreate | dict[str, Any]	Create payload as a model or dict with camelCase keys.	required

Returns:

Type	Description
DataSource	Created data source resource.

aupdate async

aupdate(data_source_id: str, payload: DataSourceUpdate | dict[str, Any]) -> DataSource

Update an existing data source.

Parameters:

Name	Type	Description	Default
data_source_id	str	Unique data source identifier.	required
payload	DataSourceUpdate | dict[str, Any]	Update payload as a model or dict.	required

Returns:

Type	Description
DataSource	Updated data source resource.

adelete async

adelete(data_source_id: str) -> None

Delete a data source.

Parameters:

Name	Type	Description	Default
data_source_id	str	Unique data source identifier.	required

webex_byova.resources.schemas.SchemaResource

List and retrieve BYODS data source schemas for an organization.

_service_app instance-attribute

_service_app = service_app

_http instance-attribute

_http = http

_org_id instance-attribute

_org_id = org_id

__init__

__init__(service_app: ServiceAppTokenManager, http: HttpClient, org_id: str) -> None

Initialize the schema resource.

Parameters:

Name	Type	Description	Default
service_app	ServiceAppTokenManager	Service App token manager.	required
http	HttpClient	Shared HTTP client.	required
org_id	str	Organization UUID for token scoping.	required

alist async

alist() -> list[Schema]

List available BYODS schemas for the organization.

Returns:

Type	Description
list[Schema]	List of schema definitions.

aget async

aget(schema_id: str) -> Schema

Get a schema by ID.

Parameters:

Name	Type	Description	Default
schema_id	str	Unique schema UUID.	required

Returns:

Type	Description
Schema	Schema definition.