# ConnectWebSocketRequest

## Example Usage

```typescript
import { ConnectWebSocketRequest } from "@lukehagar/plexjs/sdk/models/operations";

let value: ConnectWebSocketRequest = {};
```

## Fields

| Field                                                                                                                                                                                                                                                                                                                                                                                                  | Type                                                                                                                                                                                                                                                                                                                                                                                                   | Required                                                                                                                                                                                                                                                                                                                                                                                               | Description                                                                                                                                                                                                                                                                                                                                                                                            | Example                                                                                                                                                                                                                                                                                                                                                                                                |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `xPlexClientIdentifier`                                                                                                                                                                                                                                                                                                                                                                                | *string*                                                                                                                                                                                                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                     | An opaque identifier unique to the client                                                                                                                                                                                                                                                                                                                                                              | abc123                                                                                                                                                                                                                                                                                                                                                                                                 |
| `xPlexProduct`                                                                                                                                                                                                                                                                                                                                                                                         | *string*                                                                                                                                                                                                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                     | The name of the client product                                                                                                                                                                                                                                                                                                                                                                         | Plex for Roku                                                                                                                                                                                                                                                                                                                                                                                          |
| `xPlexVersion`                                                                                                                                                                                                                                                                                                                                                                                         | *string*                                                                                                                                                                                                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                     | The version of the client application                                                                                                                                                                                                                                                                                                                                                                  | 2.4.1                                                                                                                                                                                                                                                                                                                                                                                                  |
| `xPlexPlatform`                                                                                                                                                                                                                                                                                                                                                                                        | *string*                                                                                                                                                                                                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                     | The platform of the client                                                                                                                                                                                                                                                                                                                                                                             | Roku                                                                                                                                                                                                                                                                                                                                                                                                   |
| `xPlexPlatformVersion`                                                                                                                                                                                                                                                                                                                                                                                 | *string*                                                                                                                                                                                                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                     | The version of the platform                                                                                                                                                                                                                                                                                                                                                                            | 4.3 build 1057                                                                                                                                                                                                                                                                                                                                                                                         |
| `xPlexDevice`                                                                                                                                                                                                                                                                                                                                                                                          | *string*                                                                                                                                                                                                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                     | A relatively friendly name for the client device                                                                                                                                                                                                                                                                                                                                                       | Roku 3                                                                                                                                                                                                                                                                                                                                                                                                 |
| `xPlexModel`                                                                                                                                                                                                                                                                                                                                                                                           | *string*                                                                                                                                                                                                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                     | A potentially less friendly identifier for the device model                                                                                                                                                                                                                                                                                                                                            | 4200X                                                                                                                                                                                                                                                                                                                                                                                                  |
| `xPlexDeviceVendor`                                                                                                                                                                                                                                                                                                                                                                                    | *string*                                                                                                                                                                                                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                     | The device vendor                                                                                                                                                                                                                                                                                                                                                                                      | Roku                                                                                                                                                                                                                                                                                                                                                                                                   |
| `xPlexDeviceName`                                                                                                                                                                                                                                                                                                                                                                                      | *string*                                                                                                                                                                                                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                     | A friendly name for the client                                                                                                                                                                                                                                                                                                                                                                         | Living Room TV                                                                                                                                                                                                                                                                                                                                                                                         |
| `xPlexMarketplace`                                                                                                                                                                                                                                                                                                                                                                                     | *string*                                                                                                                                                                                                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                     | The marketplace on which the client application is distributed                                                                                                                                                                                                                                                                                                                                         | googlePlay                                                                                                                                                                                                                                                                                                                                                                                             |
| `filter`                                                                                                                                                                                                                                                                                                                                                                                               | *string*[]                                                                                                                                                                                                                                                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                     | By default, all events except logs are sent. A rich filtering mechanism is provided to allow clients to opt into or out of each event type using the `filters` parameter. For example:<br/><br/>- `filters=-log`: All event types except logs (the default).<br/>- `filters=foo,bar`: Only the foo and bar event types.<br/>- `filters=`: All events types.<br/>- `filters=-foo,bar`: All event types except foo and bar.<br/> |                                                                                                                                                                                                                                                                                                                                                                                                        |