ovok_sdk.resources.signals

Signals enablement, the proxied Signals API and undeliverable-config repair.

UndeliverableResourceCopy Anchor Link

UndeliverableResource(http: HttpClient)

Signals configurations that could not be delivered; access it as ovok.signals.undeliverable.

list()Copy Anchor Link

list() -> Any

List the Signals configurations that could not be delivered.

Returns

• Any: The API's JSON response.

repair()Copy Anchor Link

repair(request: JsonObject | None = None) -> Any

Retry delivering undeliverable Signals configurations.

Parameters

Returns

• Any: The API's JSON response.

SignalsGatewayResourceCopy Anchor Link

SignalsGatewayResource(http: HttpClient)

Proxies requests to the Signals API through Ovok; access it as ovok.signals.gateway.

request()Copy Anchor Link

request(
    method: Literal['GET', 'POST', 'PUT', 'PATCH', 'DELETE'],
    path: list[str],
    *,
    query: QueryParams | None = None,
    body: Any = None,
) -> Any

Send a request to the Signals API through the Ovok gateway.

Parameters

Returns

• Any: The decoded JSON response.

Raises

• OvokValidationError: A path segment is empty, . or .., or holds a slash or control character.

Examples

patients = ovok.signals.gateway.request("GET", ["patient"], query={"limit": 5})

SignalsResourceCopy Anchor Link

SignalsResource(http: HttpClient)

Signals monitoring for patients; created by Ovok, access it as ovok.signals.

Attributes gateway and undeliverable hold the proxied Signals API and repair routes.

enable()Copy Anchor Link

enable(patient_id: str) -> Any

Enable Signals monitoring for a patient.

Parameters

Returns

• Any: The API's JSON response.