# ovok_sdk.resources.signals

Canonical page: https://docs.ovok.com/python-sdk/reference/resources/signals

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

## UndeliverableResource [#undeliverableresource]

```python
UndeliverableResource(http: HttpClient)
```

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

### list() [#list]

```python
list() -> Any
```

List the Signals configurations that could not be delivered.

**Returns**

- `Any`: The API's JSON response.

### repair() [#repair]

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

Retry delivering undeliverable Signals configurations.

**Parameters**

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `request` | `JsonObject \| None` | `None` | Optional repair options, sent as JSON. |

**Returns**

- `Any`: The API's JSON response.

## SignalsGatewayResource [#signalsgatewayresource]

```python
SignalsGatewayResource(http: HttpClient)
```

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

### request() [#request]

```python
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**

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `method` | `Literal['GET', 'POST', 'PUT', 'PATCH', 'DELETE']` |  | HTTP method. |
| `path` | `list[str]` |  | Path segments under the Signals API, such as `["patient"]`. |
| `query` | `QueryParams \| None` | `None` | Query parameters; a list value repeats its parameter. |
| `body` | `Any` | `None` | JSON request body. |

**Returns**

- `Any`: The decoded JSON response.

**Raises**

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

**Examples**

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

## SignalsResource [#signalsresource]

```python
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() [#enable]

```python
enable(patient_id: str) -> Any
```

Enable Signals monitoring for a patient.

**Parameters**

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `patient_id` | `str` |  | The Patient's ID. |

**Returns**

- `Any`: The API's JSON response.