# GetLibraryMatchesRequest

## Example Usage

```typescript
import { GetLibraryMatchesRequest } from "@lukehagar/plexjs/sdk/models/operations";
import { BoolInt, MediaType } from "@lukehagar/plexjs/sdk/models/shared";

let value: GetLibraryMatchesRequest = {
  type: MediaType.TvShow,
  includeFullMetadata: BoolInt.True,
  includeAncestorMetadata: BoolInt.True,
  includeAlternateMetadataSources: BoolInt.True,
};
```

## Fields

| Field                                                                                                                                                                                                                                                   | Type                                                                                                                                                                                                                                                    | Required                                                                                                                                                                                                                                                | Description                                                                                                                                                                                                                                             | Example                                                                                                                                                                                                                                                 |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `accepts`                                                                                                                                                                                                                                               | [shared.Accepts](../../../sdk/models/shared/accepts.md)                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                      | Indicates the client accepts the indicated media types                                                                                                                                                                                                  |                                                                                                                                                                                                                                                         |
| `clientIdentifier`                                                                                                                                                                                                                                      | *string*                                                                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                      | An opaque identifier unique to the client                                                                                                                                                                                                               | abc123                                                                                                                                                                                                                                                  |
| `product`                                                                                                                                                                                                                                               | *string*                                                                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                      | The name of the client product                                                                                                                                                                                                                          | Plex for Roku                                                                                                                                                                                                                                           |
| `version`                                                                                                                                                                                                                                               | *string*                                                                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                      | The version of the client application                                                                                                                                                                                                                   | 2.4.1                                                                                                                                                                                                                                                   |
| `platform`                                                                                                                                                                                                                                              | *string*                                                                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                      | The platform of the client                                                                                                                                                                                                                              | Roku                                                                                                                                                                                                                                                    |
| `platformVersion`                                                                                                                                                                                                                                       | *string*                                                                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                      | The version of the platform                                                                                                                                                                                                                             | 4.3 build 1057                                                                                                                                                                                                                                          |
| `device`                                                                                                                                                                                                                                                | *string*                                                                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                      | A relatively friendly name for the client device                                                                                                                                                                                                        | Roku 3                                                                                                                                                                                                                                                  |
| `model`                                                                                                                                                                                                                                                 | *string*                                                                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                      | A potentially less friendly identifier for the device model                                                                                                                                                                                             | 4200X                                                                                                                                                                                                                                                   |
| `deviceVendor`                                                                                                                                                                                                                                          | *string*                                                                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                      | The device vendor                                                                                                                                                                                                                                       | Roku                                                                                                                                                                                                                                                    |
| `deviceName`                                                                                                                                                                                                                                            | *string*                                                                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                      | A friendly name for the client                                                                                                                                                                                                                          | Living Room TV                                                                                                                                                                                                                                          |
| `marketplace`                                                                                                                                                                                                                                           | *string*                                                                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                      | The marketplace on which the client application is distributed                                                                                                                                                                                          | googlePlay                                                                                                                                                                                                                                              |
| `type`                                                                                                                                                                                                                                                  | [shared.MediaType](../../../sdk/models/shared/mediatype.md)                                                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                                                      | The type of media to retrieve or filter by.<br/><br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>5 = artist<br/>6 = album<br/>7 = track<br/>8 = photo_album<br/>9 = photo<br/><br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2                                                                                                                                                                                                                                                       |
| `includeFullMetadata`                                                                                                                                                                                                                                   | [shared.BoolInt](../../../sdk/models/shared/boolint.md)                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                      | N/A                                                                                                                                                                                                                                                     | 1                                                                                                                                                                                                                                                       |
| `includeAncestorMetadata`                                                                                                                                                                                                                               | [shared.BoolInt](../../../sdk/models/shared/boolint.md)                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                      | N/A                                                                                                                                                                                                                                                     | 1                                                                                                                                                                                                                                                       |
| `includeAlternateMetadataSources`                                                                                                                                                                                                                       | [shared.BoolInt](../../../sdk/models/shared/boolint.md)                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                      | N/A                                                                                                                                                                                                                                                     | 1                                                                                                                                                                                                                                                       |
| `guid`                                                                                                                                                                                                                                                  | *string*                                                                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                      | Used for movies, shows, artists, albums, and tracks.  Allowed for various URI schemes, to be defined.                                                                                                                                                   |                                                                                                                                                                                                                                                         |
| `title`                                                                                                                                                                                                                                                 | *string*                                                                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                      | The title to filter by or assign                                                                                                                                                                                                                        |                                                                                                                                                                                                                                                         |
| `year`                                                                                                                                                                                                                                                  | *number*                                                                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                      | Used for movies shows, and albums.  Optional.                                                                                                                                                                                                           |                                                                                                                                                                                                                                                         |
| `path`                                                                                                                                                                                                                                                  | *string*                                                                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                      | Used for movies, episodes, and tracks.  The full path to the media file, used for "cloud-scanning" an item.                                                                                                                                             |                                                                                                                                                                                                                                                         |
| `grandparentTitle`                                                                                                                                                                                                                                      | *string*                                                                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                      | Used for episodes and tracks.  The title of the show/artist. Required if `path` isn't passed.                                                                                                                                                           |                                                                                                                                                                                                                                                         |
| `grandparentYear`                                                                                                                                                                                                                                       | *number*                                                                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                      | Used for episodes.  The year of the show.                                                                                                                                                                                                               |                                                                                                                                                                                                                                                         |
| `parentIndex`                                                                                                                                                                                                                                           | *number*                                                                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                      | Used for episodes and tracks.  The season/album number.                                                                                                                                                                                                 |                                                                                                                                                                                                                                                         |
| `index`                                                                                                                                                                                                                                                 | *number*                                                                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                      | Used for episodes and tracks.  The episode/tracks number in the season/album.                                                                                                                                                                           |                                                                                                                                                                                                                                                         |
| `originallyAvailableAt`                                                                                                                                                                                                                                 | *string*                                                                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                      | Used for episodes.  In the format `YYYY-MM-DD`.                                                                                                                                                                                                         |                                                                                                                                                                                                                                                         |
| `parentTitle`                                                                                                                                                                                                                                           | *string*                                                                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                      | Used for albums and tracks. The artist name for albums or the album name for tracks.                                                                                                                                                                    |                                                                                                                                                                                                                                                         |