jellyfin/jellyfin-sdk-typescript
1
0
Fork 0
mirror of https://github.com/jellyfin/jellyfin-sdk-typescript.git synced 2024-11-23 05:59:44 +00:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

Remove markdown docs

Browse Source
This commit is contained in:
Bill Thornton 2022-09-15 11:08:18 -04:00
parent 8268d64e04
commit a9e03e3edb
721 changed files with 0 additions and 106427 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/.nojekyll
View File

@ -1 +0,0 @@
TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

126
docs/README.md
View File

@ -1,126 +0,0 @@
@thornbill/jellyfin-sdk / [Modules](modules.md)
<h1 align="center">jellyfin-sdk-typescript</h1>
<h3 align="center">Part of the <a href="https://jellyfin.org">Jellyfin Project</a></h3>
---
<p align="center">
<img alt="Logo Banner" src="https://raw.githubusercontent.com/jellyfin/jellyfin-ux/master/branding/SVG/banner-logo-solid.svg?sanitize=true"/>
<br/>
<br/>
<a href="https://github.com/jellyfin/jellyfin-sdk-typescript/blob/master/LICENSE"><img alt="MPL-2.0 license" src="https://img.shields.io/github/license/jellyfin/jellyfin-sdk-typescript"></a>
<a href="https://github.com/jellyfin/jellyfin-sdk-typescript/releases"><img alt="Current Release" src="https://img.shields.io/github/release/jellyfin/jellyfin-sdk-typescript.svg"/></a>
<a href="https://www.npmjs.com/package/@thornbill/jellyfin-sdk"><img alt="npm" src="https://img.shields.io/npm/v/@thornbill/jellyfin-sdk"></a>
<a href="https://codecov.io/gh/jellyfin/jellyfin-sdk-typescript">
<img alt="Codecov" src="https://img.shields.io/codecov/c/github/jellyfin/jellyfin-sdk-typescript?token=eFF0jvWiyq">
</a>
</p>
A TypeScript SDK for Jellyfin.
> Warning: This project is under active development, so API changes may occur.
## Install
```sh
npm i --save @thornbill/jellyfin-sdk
```
or
```sh
yarn add @thornbill/jellyfin-sdk
```
### Supported Jellyfin Versions
| SDK Version | Jellyfin Version |
|:-:|:-:|
| 0.5.0 | 10.8.x |
| <0.5.0 | 10.7.x |
### React Native
The generated Axios client used in this library depends on `URL` and `URLSearchParams` to be available on the global scope.
React Native only includes incomplete implementations for these classes, so a polyfill is required.
[React Native URL Polyfill](https://github.com/charpeni/react-native-url-polyfill) seems like a good solution for this.
## Usage
```js
// Create a new instance of the SDK
const jellyfin = new Jellyfin({
clientInfo: {
name: 'My Client Application',
version: '1.0.0'
},
deviceInfo: {
name: 'Device Name',
id: 'unique-device-id'
}
});
// Find a valid server by trying to connect using common protocols and ports.
// Each server receives a score based on security, speed, and other criteria.
const servers = await jellyfin.discovery.getRecommendedServerCandidates('demo.jellyfin.org/stable');
// A utility function for finding the best result is available.
// If there is no "best" server, an error message should be displayed.
const best = jellyfin.discovery.findBestServer(servers);
// Create an API instance
const api = jellyfin.createApi(best.address);
// Each API endpoint is exposed via a getter on the SDK instance using
// a shared Configuration and Axios instance. For example the /System APIs
// are available as api.systemApi.
// Fetch the public system info
const info = await getSystemApi(api).getPublicSystemInfo();
console.log('Info =>', info.data);
// Fetch the list of public users
const users = await getUserApi(api).getPublicUsers();
console.log('Users =>', users.data);
// A helper method for authentication has been added to the SDK because
// the default method exposed in the generated Axios client is rather
// cumbersome to use.
const auth = await api.authenticateUserByName('demo', '');
console.log('Auth =>', auth.data);
// Authentication state is stored internally in the Api class, so now
// requests that require authentication can be made normally
const libraries = await getLibraryApi(api).getMediaFolders();
console.log('Libraries =>', libraries.data);
// A helper method for logging out the current user has been added to the
// SDK so the internal state is updated correctly.
await api.logout();
```
## Breaking Changes
### v0.5.0
* Build directory is now `lib` instead of `dist`.
Any imports used that were previously in `dist` will need updated.
[#147](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/147)
* Duplicated exports were removed.
Any imports may need updated if you referenced one of the duplicates.
[#148](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/148)
* API classes are no longer exposed via getters.
Instead you need to call a function passing the `Api` instance as a parameter.
For example: `getSystemApi(api)`.
While I do feel this is a slightly worse developer experience, it was a necessary change to support tree-shaking.
[#149](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/149)
* `BaseItemKind` is now included in the generated client.
Imports will need updated.
[#187](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/187)
## Roadmap to 1.0
* [ ] More complete device profile generation utilities
* [ ] Use custom generator templates for API versions
* [ ] Automate OpenAPI spec updates using GitHub
* [ ] Create branch tracking unstable Jellyfin builds

114
docs/classes/generated_client.ActivityLogApi.md
View File

@ -1,114 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ActivityLogApi
# Class: ActivityLogApi
[generated-client](../modules/generated_client.md).ActivityLogApi
ActivityLogApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`ActivityLogApi`**
## Table of contents
### Constructors
- [constructor](generated_client.ActivityLogApi.md#constructor)
### Properties
- [axios](generated_client.ActivityLogApi.md#axios)
- [basePath](generated_client.ActivityLogApi.md#basepath)
- [configuration](generated_client.ActivityLogApi.md#configuration)
### Methods
- [getLogEntries](generated_client.ActivityLogApi.md#getlogentries)
## Constructors
### constructor
• **new ActivityLogApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### getLogEntries
▸ **getLogEntries**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`ActivityLogEntryQueryResult`](../interfaces/generated_client.ActivityLogEntryQueryResult.md), `any`\>\>
**`summary`** Gets activity log entries.
**`throws`** {RequiredError}
**`memberof`** ActivityLogApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`ActivityLogApiGetLogEntriesRequest`](../interfaces/generated_client.ActivityLogApiGetLogEntriesRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`ActivityLogEntryQueryResult`](../interfaces/generated_client.ActivityLogEntryQueryResult.md), `any`\>\>
#### Defined in
[generated-client/api/activity-log-api.ts:186](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/activity-log-api.ts#L186)

169
docs/classes/generated_client.ApiKeyApi.md
View File

@ -1,169 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ApiKeyApi
# Class: ApiKeyApi
[generated-client](../modules/generated_client.md).ApiKeyApi
ApiKeyApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`ApiKeyApi`**
## Table of contents
### Constructors
- [constructor](generated_client.ApiKeyApi.md#constructor)
### Properties
- [axios](generated_client.ApiKeyApi.md#axios)
- [basePath](generated_client.ApiKeyApi.md#basepath)
- [configuration](generated_client.ApiKeyApi.md#configuration)
### Methods
- [createKey](generated_client.ApiKeyApi.md#createkey)
- [getKeys](generated_client.ApiKeyApi.md#getkeys)
- [revokeKey](generated_client.ApiKeyApi.md#revokekey)
## Constructors
### constructor
• **new ApiKeyApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### createKey
▸ **createKey**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Create a new api key.
**`throws`** {RequiredError}
**`memberof`** ApiKeyApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`ApiKeyApiCreateKeyRequest`](../interfaces/generated_client.ApiKeyApiCreateKeyRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/api-key-api.ts:268](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/api-key-api.ts#L268)
___
### getKeys
▸ **getKeys**(`options?`): `Promise`<`AxiosResponse`<[`AuthenticationInfoQueryResult`](../interfaces/generated_client.AuthenticationInfoQueryResult.md), `any`\>\>
**`summary`** Get all keys.
**`throws`** {RequiredError}
**`memberof`** ApiKeyApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<[`AuthenticationInfoQueryResult`](../interfaces/generated_client.AuthenticationInfoQueryResult.md), `any`\>\>
#### Defined in
[generated-client/api/api-key-api.ts:279](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/api-key-api.ts#L279)
___
### revokeKey
▸ **revokeKey**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Remove an api key.
**`throws`** {RequiredError}
**`memberof`** ApiKeyApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`ApiKeyApiRevokeKeyRequest`](../interfaces/generated_client.ApiKeyApiRevokeKeyRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/api-key-api.ts:291](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/api-key-api.ts#L291)

170
docs/classes/generated_client.ArtistsApi.md
View File

@ -1,170 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ArtistsApi
# Class: ArtistsApi
[generated-client](../modules/generated_client.md).ArtistsApi
ArtistsApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`ArtistsApi`**
## Table of contents
### Constructors
- [constructor](generated_client.ArtistsApi.md#constructor)
### Properties
- [axios](generated_client.ArtistsApi.md#axios)
- [basePath](generated_client.ArtistsApi.md#basepath)
- [configuration](generated_client.ArtistsApi.md#configuration)
### Methods
- [getAlbumArtists](generated_client.ArtistsApi.md#getalbumartists)
- [getArtistByName](generated_client.ArtistsApi.md#getartistbyname)
- [getArtists](generated_client.ArtistsApi.md#getartists)
## Constructors
### constructor
• **new ArtistsApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### getAlbumArtists
▸ **getAlbumArtists**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
**`summary`** Gets all album artists from a given item, folder, or the entire library.
**`throws`** {RequiredError}
**`memberof`** ArtistsApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`ArtistsApiGetAlbumArtistsRequest`](../interfaces/generated_client.ArtistsApiGetAlbumArtistsRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
#### Defined in
[generated-client/api/artists-api.ts:1181](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L1181)
___
### getArtistByName
▸ **getArtistByName**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md), `any`\>\>
**`summary`** Gets an artist by name.
**`throws`** {RequiredError}
**`memberof`** ArtistsApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`ArtistsApiGetArtistByNameRequest`](../interfaces/generated_client.ArtistsApiGetArtistByNameRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md), `any`\>\>
#### Defined in
[generated-client/api/artists-api.ts:1193](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L1193)
___
### getArtists
▸ **getArtists**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
**`summary`** Gets all artists from a given item, folder, or the entire library.
**`throws`** {RequiredError}
**`memberof`** ArtistsApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`ArtistsApiGetArtistsRequest`](../interfaces/generated_client.ArtistsApiGetArtistsRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
#### Defined in
[generated-client/api/artists-api.ts:1205](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L1205)

198
docs/classes/generated_client.AudioApi.md
View File

@ -1,198 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / AudioApi
# Class: AudioApi
[generated-client](../modules/generated_client.md).AudioApi
AudioApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`AudioApi`**
## Table of contents
### Constructors
- [constructor](generated_client.AudioApi.md#constructor)
### Properties
- [axios](generated_client.AudioApi.md#axios)
- [basePath](generated_client.AudioApi.md#basepath)
- [configuration](generated_client.AudioApi.md#configuration)
### Methods
- [getAudioStream](generated_client.AudioApi.md#getaudiostream)
- [getAudioStreamByContainer](generated_client.AudioApi.md#getaudiostreambycontainer)
- [headAudioStream](generated_client.AudioApi.md#headaudiostream)
- [headAudioStreamByContainer](generated_client.AudioApi.md#headaudiostreambycontainer)
## Constructors
### constructor
• **new AudioApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### getAudioStream
▸ **getAudioStream**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Gets an audio stream.
**`throws`** {RequiredError}
**`memberof`** AudioApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`AudioApiGetAudioStreamRequest`](../interfaces/generated_client.AudioApiGetAudioStreamRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/audio-api.ts:3033](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L3033)
___
### getAudioStreamByContainer
▸ **getAudioStreamByContainer**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Gets an audio stream.
**`throws`** {RequiredError}
**`memberof`** AudioApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`AudioApiGetAudioStreamByContainerRequest`](../interfaces/generated_client.AudioApiGetAudioStreamByContainerRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/audio-api.ts:3045](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L3045)
___
### headAudioStream
▸ **headAudioStream**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Gets an audio stream.
**`throws`** {RequiredError}
**`memberof`** AudioApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`AudioApiHeadAudioStreamRequest`](../interfaces/generated_client.AudioApiHeadAudioStreamRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/audio-api.ts:3057](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L3057)
___
### headAudioStreamByContainer
▸ **headAudioStreamByContainer**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Gets an audio stream.
**`throws`** {RequiredError}
**`memberof`** AudioApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`AudioApiHeadAudioStreamByContainerRequest`](../interfaces/generated_client.AudioApiHeadAudioStreamByContainerRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/audio-api.ts:3069](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L3069)

167
docs/classes/generated_client.BrandingApi.md
View File

@ -1,167 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / BrandingApi
# Class: BrandingApi
[generated-client](../modules/generated_client.md).BrandingApi
BrandingApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`BrandingApi`**
## Table of contents
### Constructors
- [constructor](generated_client.BrandingApi.md#constructor)
### Properties
- [axios](generated_client.BrandingApi.md#axios)
- [basePath](generated_client.BrandingApi.md#basepath)
- [configuration](generated_client.BrandingApi.md#configuration)
### Methods
- [getBrandingCss](generated_client.BrandingApi.md#getbrandingcss)
- [getBrandingCss2](generated_client.BrandingApi.md#getbrandingcss2)
- [getBrandingOptions](generated_client.BrandingApi.md#getbrandingoptions)
## Constructors
### constructor
• **new BrandingApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### getBrandingCss
▸ **getBrandingCss**(`options?`): `Promise`<`AxiosResponse`<`string`, `any`\>\>
**`summary`** Gets branding css.
**`throws`** {RequiredError}
**`memberof`** BrandingApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<`string`, `any`\>\>
#### Defined in
[generated-client/api/branding-api.ts:215](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/branding-api.ts#L215)
___
### getBrandingCss2
▸ **getBrandingCss2**(`options?`): `Promise`<`AxiosResponse`<`string`, `any`\>\>
**`summary`** Gets branding css.
**`throws`** {RequiredError}
**`memberof`** BrandingApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<`string`, `any`\>\>
#### Defined in
[generated-client/api/branding-api.ts:226](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/branding-api.ts#L226)
___
### getBrandingOptions
▸ **getBrandingOptions**(`options?`): `Promise`<`AxiosResponse`<[`BrandingOptions`](../interfaces/generated_client.BrandingOptions.md), `any`\>\>
**`summary`** Gets branding configuration.
**`throws`** {RequiredError}
**`memberof`** BrandingApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<[`BrandingOptions`](../interfaces/generated_client.BrandingOptions.md), `any`\>\>
#### Defined in
[generated-client/api/branding-api.ts:237](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/branding-api.ts#L237)

225
docs/classes/generated_client.ChannelsApi.md
View File

@ -1,225 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ChannelsApi
# Class: ChannelsApi
[generated-client](../modules/generated_client.md).ChannelsApi
ChannelsApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`ChannelsApi`**
## Table of contents
### Constructors
- [constructor](generated_client.ChannelsApi.md#constructor)
### Properties
- [axios](generated_client.ChannelsApi.md#axios)
- [basePath](generated_client.ChannelsApi.md#basepath)
- [configuration](generated_client.ChannelsApi.md#configuration)
### Methods
- [getAllChannelFeatures](generated_client.ChannelsApi.md#getallchannelfeatures)
- [getChannelFeatures](generated_client.ChannelsApi.md#getchannelfeatures)
- [getChannelItems](generated_client.ChannelsApi.md#getchannelitems)
- [getChannels](generated_client.ChannelsApi.md#getchannels)
- [getLatestChannelItems](generated_client.ChannelsApi.md#getlatestchannelitems)
## Constructors
### constructor
• **new ChannelsApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### getAllChannelFeatures
▸ **getAllChannelFeatures**(`options?`): `Promise`<`AxiosResponse`<[`ChannelFeatures`](../interfaces/generated_client.ChannelFeatures.md)[], `any`\>\>
**`summary`** Get all channel features.
**`throws`** {RequiredError}
**`memberof`** ChannelsApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<[`ChannelFeatures`](../interfaces/generated_client.ChannelFeatures.md)[], `any`\>\>
#### Defined in
[generated-client/api/channels-api.ts:670](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/channels-api.ts#L670)
___
### getChannelFeatures
▸ **getChannelFeatures**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`ChannelFeatures`](../interfaces/generated_client.ChannelFeatures.md), `any`\>\>
**`summary`** Get channel features.
**`throws`** {RequiredError}
**`memberof`** ChannelsApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`ChannelsApiGetChannelFeaturesRequest`](../interfaces/generated_client.ChannelsApiGetChannelFeaturesRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`ChannelFeatures`](../interfaces/generated_client.ChannelFeatures.md), `any`\>\>
#### Defined in
[generated-client/api/channels-api.ts:682](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/channels-api.ts#L682)
___
### getChannelItems
▸ **getChannelItems**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
**`summary`** Get channel items.
**`throws`** {RequiredError}
**`memberof`** ChannelsApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`ChannelsApiGetChannelItemsRequest`](../interfaces/generated_client.ChannelsApiGetChannelItemsRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
#### Defined in
[generated-client/api/channels-api.ts:694](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/channels-api.ts#L694)
___
### getChannels
▸ **getChannels**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
**`summary`** Gets available channels.
**`throws`** {RequiredError}
**`memberof`** ChannelsApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`ChannelsApiGetChannelsRequest`](../interfaces/generated_client.ChannelsApiGetChannelsRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
#### Defined in
[generated-client/api/channels-api.ts:706](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/channels-api.ts#L706)
___
### getLatestChannelItems
▸ **getLatestChannelItems**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
**`summary`** Gets latest channel items.
**`throws`** {RequiredError}
**`memberof`** ChannelsApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`ChannelsApiGetLatestChannelItemsRequest`](../interfaces/generated_client.ChannelsApiGetLatestChannelItemsRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
#### Defined in
[generated-client/api/channels-api.ts:718](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/channels-api.ts#L718)

114
docs/classes/generated_client.ClientLogApi.md
View File

@ -1,114 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ClientLogApi
# Class: ClientLogApi
[generated-client](../modules/generated_client.md).ClientLogApi
ClientLogApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`ClientLogApi`**
## Table of contents
### Constructors
- [constructor](generated_client.ClientLogApi.md#constructor)
### Properties
- [axios](generated_client.ClientLogApi.md#axios)
- [basePath](generated_client.ClientLogApi.md#basepath)
- [configuration](generated_client.ClientLogApi.md#configuration)
### Methods
- [logFile](generated_client.ClientLogApi.md#logfile)
## Constructors
### constructor
• **new ClientLogApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### logFile
▸ **logFile**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`ClientLogDocumentResponseDto`](../interfaces/generated_client.ClientLogDocumentResponseDto.md), `any`\>\>
**`summary`** Upload a document.
**`throws`** {RequiredError}
**`memberof`** ClientLogApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`ClientLogApiLogFileRequest`](../interfaces/generated_client.ClientLogApiLogFileRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`ClientLogDocumentResponseDto`](../interfaces/generated_client.ClientLogDocumentResponseDto.md), `any`\>\>
#### Defined in
[generated-client/api/client-log-api.ts:143](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/client-log-api.ts#L143)

170
docs/classes/generated_client.CollectionApi.md
View File

@ -1,170 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / CollectionApi
# Class: CollectionApi
[generated-client](../modules/generated_client.md).CollectionApi
CollectionApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`CollectionApi`**
## Table of contents
### Constructors
- [constructor](generated_client.CollectionApi.md#constructor)
### Properties
- [axios](generated_client.CollectionApi.md#axios)
- [basePath](generated_client.CollectionApi.md#basepath)
- [configuration](generated_client.CollectionApi.md#configuration)
### Methods
- [addToCollection](generated_client.CollectionApi.md#addtocollection)
- [createCollection](generated_client.CollectionApi.md#createcollection)
- [removeFromCollection](generated_client.CollectionApi.md#removefromcollection)
## Constructors
### constructor
• **new CollectionApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### addToCollection
▸ **addToCollection**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Adds items to a collection.
**`throws`** {RequiredError}
**`memberof`** CollectionApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`CollectionApiAddToCollectionRequest`](../interfaces/generated_client.CollectionApiAddToCollectionRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/collection-api.ts:360](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/collection-api.ts#L360)
___
### createCollection
▸ **createCollection**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`CollectionCreationResult`](../interfaces/generated_client.CollectionCreationResult.md), `any`\>\>
**`summary`** Creates a new collection.
**`throws`** {RequiredError}
**`memberof`** CollectionApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`CollectionApiCreateCollectionRequest`](../interfaces/generated_client.CollectionApiCreateCollectionRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`CollectionCreationResult`](../interfaces/generated_client.CollectionCreationResult.md), `any`\>\>
#### Defined in
[generated-client/api/collection-api.ts:372](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/collection-api.ts#L372)
___
### removeFromCollection
▸ **removeFromCollection**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Removes items from a collection.
**`throws`** {RequiredError}
**`memberof`** CollectionApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`CollectionApiRemoveFromCollectionRequest`](../interfaces/generated_client.CollectionApiRemoveFromCollectionRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/collection-api.ts:384](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/collection-api.ts#L384)

178
docs/classes/generated_client.Configuration.md
View File

@ -1,178 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / Configuration
# Class: Configuration
[generated-client](../modules/generated_client.md).Configuration
## Table of contents
### Constructors
- [constructor](generated_client.Configuration.md#constructor)
### Properties
- [accessToken](generated_client.Configuration.md#accesstoken)
- [apiKey](generated_client.Configuration.md#apikey)
- [baseOptions](generated_client.Configuration.md#baseoptions)
- [basePath](generated_client.Configuration.md#basepath)
- [formDataCtor](generated_client.Configuration.md#formdatactor)
- [password](generated_client.Configuration.md#password)
- [username](generated_client.Configuration.md#username)
### Methods
- [isJsonMime](generated_client.Configuration.md#isjsonmime)
## Constructors
### constructor
• **new Configuration**(`param?`)
#### Parameters
| Name | Type |
| :------ | :------ |
| `param` | [`ConfigurationParameters`](../interfaces/generated_client.ConfigurationParameters.md) |
#### Defined in
[generated-client/configuration.ts:77](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/configuration.ts#L77)
## Properties
### accessToken
• `Optional` **accessToken**: `string` \| `Promise`<`string`\> \| (`name?`: `string`, `scopes?`: `string`[]) => `string` \| (`name?`: `string`, `scopes?`: `string`[]) => `Promise`<`string`\>
parameter for oauth2 security
**`param`** security name
**`param`** oauth2 scope
**`memberof`** Configuration
#### Defined in
[generated-client/configuration.ts:53](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/configuration.ts#L53)
___
### apiKey
• `Optional` **apiKey**: `string` \| `Promise`<`string`\> \| (`name`: `string`) => `string` \| (`name`: `string`) => `Promise`<`string`\>
parameter for apiKey security
**`param`** security name
**`memberof`** Configuration
#### Defined in
[generated-client/configuration.ts:32](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/configuration.ts#L32)
___
### baseOptions
• `Optional` **baseOptions**: `any`
base options for axios calls
**`memberof`** Configuration
#### Defined in
[generated-client/configuration.ts:67](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/configuration.ts#L67)
___
### basePath
• `Optional` **basePath**: `string`
override base path
**`memberof`** Configuration
#### Defined in
[generated-client/configuration.ts:60](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/configuration.ts#L60)
___
### formDataCtor
• `Optional` **formDataCtor**: () => `any`
#### Type declaration
• **new Configuration**()
The FormData constructor that will be used to create multipart form data
requests. You can inject this here so that execution environments that
do not support the FormData class can still run the generated client.
#### Defined in
[generated-client/configuration.ts:75](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/configuration.ts#L75)
___
### password
• `Optional` **password**: `string`
parameter for basic security
**`memberof`** Configuration
#### Defined in
[generated-client/configuration.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/configuration.ts#L46)
___
### username
• `Optional` **username**: `string`
parameter for basic security
**`memberof`** Configuration
#### Defined in
[generated-client/configuration.ts:39](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/configuration.ts#L39)
## Methods
### isJsonMime
▸ **isJsonMime**(`mime`): `boolean`
Check if the given MIME is a JSON MIME.
JSON MIME examples:
application/json
application/json; charset=UTF8
APPLICATION/JSON
application/vnd.company+json
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `mime` | `string` | MIME (Multipurpose Internet Mail Extensions) |
#### Returns
`boolean`
True if the given MIME is JSON, false otherwise.
#### Defined in
[generated-client/configuration.ts:97](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/configuration.ts#L97)

252
docs/classes/generated_client.ConfigurationApi.md
View File

@ -1,252 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ConfigurationApi
# Class: ConfigurationApi
[generated-client](../modules/generated_client.md).ConfigurationApi
ConfigurationApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`ConfigurationApi`**
## Table of contents
### Constructors
- [constructor](generated_client.ConfigurationApi.md#constructor)
### Properties
- [axios](generated_client.ConfigurationApi.md#axios)
- [basePath](generated_client.ConfigurationApi.md#basepath)
- [configuration](generated_client.ConfigurationApi.md#configuration)
### Methods
- [getConfiguration](generated_client.ConfigurationApi.md#getconfiguration)
- [getDefaultMetadataOptions](generated_client.ConfigurationApi.md#getdefaultmetadataoptions)
- [getNamedConfiguration](generated_client.ConfigurationApi.md#getnamedconfiguration)
- [updateConfiguration](generated_client.ConfigurationApi.md#updateconfiguration)
- [updateMediaEncoderPath](generated_client.ConfigurationApi.md#updatemediaencoderpath)
- [updateNamedConfiguration](generated_client.ConfigurationApi.md#updatenamedconfiguration)
## Constructors
### constructor
• **new ConfigurationApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### getConfiguration
▸ **getConfiguration**(`options?`): `Promise`<`AxiosResponse`<[`ServerConfiguration`](../interfaces/generated_client.ServerConfiguration.md), `any`\>\>
**`summary`** Gets application configuration.
**`throws`** {RequiredError}
**`memberof`** ConfigurationApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<[`ServerConfiguration`](../interfaces/generated_client.ServerConfiguration.md), `any`\>\>
#### Defined in
[generated-client/api/configuration-api.ts:483](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/configuration-api.ts#L483)
___
### getDefaultMetadataOptions
▸ **getDefaultMetadataOptions**(`options?`): `Promise`<`AxiosResponse`<[`MetadataOptions`](../interfaces/generated_client.MetadataOptions.md), `any`\>\>
**`summary`** Gets a default MetadataOptions object.
**`throws`** {RequiredError}
**`memberof`** ConfigurationApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<[`MetadataOptions`](../interfaces/generated_client.MetadataOptions.md), `any`\>\>
#### Defined in
[generated-client/api/configuration-api.ts:494](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/configuration-api.ts#L494)
___
### getNamedConfiguration
▸ **getNamedConfiguration**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Gets a named configuration.
**`throws`** {RequiredError}
**`memberof`** ConfigurationApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`ConfigurationApiGetNamedConfigurationRequest`](../interfaces/generated_client.ConfigurationApiGetNamedConfigurationRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/configuration-api.ts:506](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/configuration-api.ts#L506)
___
### updateConfiguration
▸ **updateConfiguration**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Updates application configuration.
**`throws`** {RequiredError}
**`memberof`** ConfigurationApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`ConfigurationApiUpdateConfigurationRequest`](../interfaces/generated_client.ConfigurationApiUpdateConfigurationRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/configuration-api.ts:518](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/configuration-api.ts#L518)
___
### updateMediaEncoderPath
▸ **updateMediaEncoderPath**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Updates the path to the media encoder.
**`throws`** {RequiredError}
**`memberof`** ConfigurationApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`ConfigurationApiUpdateMediaEncoderPathRequest`](../interfaces/generated_client.ConfigurationApiUpdateMediaEncoderPathRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/configuration-api.ts:530](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/configuration-api.ts#L530)
___
### updateNamedConfiguration
▸ **updateNamedConfiguration**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Updates named configuration.
**`throws`** {RequiredError}
**`memberof`** ConfigurationApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`ConfigurationApiUpdateNamedConfigurationRequest`](../interfaces/generated_client.ConfigurationApiUpdateNamedConfigurationRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/configuration-api.ts:542](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/configuration-api.ts#L542)

142
docs/classes/generated_client.DashboardApi.md
View File

@ -1,142 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DashboardApi
# Class: DashboardApi
[generated-client](../modules/generated_client.md).DashboardApi
DashboardApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`DashboardApi`**
## Table of contents
### Constructors
- [constructor](generated_client.DashboardApi.md#constructor)
### Properties
- [axios](generated_client.DashboardApi.md#axios)
- [basePath](generated_client.DashboardApi.md#basepath)
- [configuration](generated_client.DashboardApi.md#configuration)
### Methods
- [getConfigurationPages](generated_client.DashboardApi.md#getconfigurationpages)
- [getDashboardConfigurationPage](generated_client.DashboardApi.md#getdashboardconfigurationpage)
## Constructors
### constructor
• **new DashboardApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### getConfigurationPages
▸ **getConfigurationPages**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`ConfigurationPageInfo`](../interfaces/generated_client.ConfigurationPageInfo.md)[], `any`\>\>
**`summary`** Gets the configuration pages.
**`throws`** {RequiredError}
**`memberof`** DashboardApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`DashboardApiGetConfigurationPagesRequest`](../interfaces/generated_client.DashboardApiGetConfigurationPagesRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`ConfigurationPageInfo`](../interfaces/generated_client.ConfigurationPageInfo.md)[], `any`\>\>
#### Defined in
[generated-client/api/dashboard-api.ts:214](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dashboard-api.ts#L214)
___
### getDashboardConfigurationPage
▸ **getDashboardConfigurationPage**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Gets a dashboard configuration page.
**`throws`** {RequiredError}
**`memberof`** DashboardApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`DashboardApiGetDashboardConfigurationPageRequest`](../interfaces/generated_client.DashboardApiGetDashboardConfigurationPageRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/dashboard-api.ts:226](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dashboard-api.ts#L226)

226
docs/classes/generated_client.DevicesApi.md
View File

@ -1,226 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DevicesApi
# Class: DevicesApi
[generated-client](../modules/generated_client.md).DevicesApi
DevicesApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`DevicesApi`**
## Table of contents
### Constructors
- [constructor](generated_client.DevicesApi.md#constructor)
### Properties
- [axios](generated_client.DevicesApi.md#axios)
- [basePath](generated_client.DevicesApi.md#basepath)
- [configuration](generated_client.DevicesApi.md#configuration)
### Methods
- [deleteDevice](generated_client.DevicesApi.md#deletedevice)
- [getDeviceInfo](generated_client.DevicesApi.md#getdeviceinfo)
- [getDeviceOptions](generated_client.DevicesApi.md#getdeviceoptions)
- [getDevices](generated_client.DevicesApi.md#getdevices)
- [updateDeviceOptions](generated_client.DevicesApi.md#updatedeviceoptions)
## Constructors
### constructor
• **new DevicesApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### deleteDevice
▸ **deleteDevice**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Deletes a device.
**`throws`** {RequiredError}
**`memberof`** DevicesApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`DevicesApiDeleteDeviceRequest`](../interfaces/generated_client.DevicesApiDeleteDeviceRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/devices-api.ts:479](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/devices-api.ts#L479)
___
### getDeviceInfo
▸ **getDeviceInfo**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`DeviceInfo`](../interfaces/generated_client.DeviceInfo.md), `any`\>\>
**`summary`** Get info for a device.
**`throws`** {RequiredError}
**`memberof`** DevicesApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`DevicesApiGetDeviceInfoRequest`](../interfaces/generated_client.DevicesApiGetDeviceInfoRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`DeviceInfo`](../interfaces/generated_client.DeviceInfo.md), `any`\>\>
#### Defined in
[generated-client/api/devices-api.ts:491](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/devices-api.ts#L491)
___
### getDeviceOptions
▸ **getDeviceOptions**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`DeviceOptions`](../interfaces/generated_client.DeviceOptions.md), `any`\>\>
**`summary`** Get options for a device.
**`throws`** {RequiredError}
**`memberof`** DevicesApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`DevicesApiGetDeviceOptionsRequest`](../interfaces/generated_client.DevicesApiGetDeviceOptionsRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`DeviceOptions`](../interfaces/generated_client.DeviceOptions.md), `any`\>\>
#### Defined in
[generated-client/api/devices-api.ts:503](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/devices-api.ts#L503)
___
### getDevices
▸ **getDevices**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`DeviceInfoQueryResult`](../interfaces/generated_client.DeviceInfoQueryResult.md), `any`\>\>
**`summary`** Get Devices.
**`throws`** {RequiredError}
**`memberof`** DevicesApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`DevicesApiGetDevicesRequest`](../interfaces/generated_client.DevicesApiGetDevicesRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`DeviceInfoQueryResult`](../interfaces/generated_client.DeviceInfoQueryResult.md), `any`\>\>
#### Defined in
[generated-client/api/devices-api.ts:515](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/devices-api.ts#L515)
___
### updateDeviceOptions
▸ **updateDeviceOptions**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Update device options.
**`throws`** {RequiredError}
**`memberof`** DevicesApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`DevicesApiUpdateDeviceOptionsRequest`](../interfaces/generated_client.DevicesApiUpdateDeviceOptionsRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/devices-api.ts:527](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/devices-api.ts#L527)

142
docs/classes/generated_client.DisplayPreferencesApi.md
View File

@ -1,142 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DisplayPreferencesApi
# Class: DisplayPreferencesApi
[generated-client](../modules/generated_client.md).DisplayPreferencesApi
DisplayPreferencesApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`DisplayPreferencesApi`**
## Table of contents
### Constructors
- [constructor](generated_client.DisplayPreferencesApi.md#constructor)
### Properties
- [axios](generated_client.DisplayPreferencesApi.md#axios)
- [basePath](generated_client.DisplayPreferencesApi.md#basepath)
- [configuration](generated_client.DisplayPreferencesApi.md#configuration)
### Methods
- [getDisplayPreferences](generated_client.DisplayPreferencesApi.md#getdisplaypreferences)
- [updateDisplayPreferences](generated_client.DisplayPreferencesApi.md#updatedisplaypreferences)
## Constructors
### constructor
• **new DisplayPreferencesApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### getDisplayPreferences
▸ **getDisplayPreferences**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`DisplayPreferencesDto`](../interfaces/generated_client.DisplayPreferencesDto.md), `any`\>\>
**`summary`** Get Display Preferences.
**`throws`** {RequiredError}
**`memberof`** DisplayPreferencesApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`DisplayPreferencesApiGetDisplayPreferencesRequest`](../interfaces/generated_client.DisplayPreferencesApiGetDisplayPreferencesRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`DisplayPreferencesDto`](../interfaces/generated_client.DisplayPreferencesDto.md), `any`\>\>
#### Defined in
[generated-client/api/display-preferences-api.ts:292](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/display-preferences-api.ts#L292)
___
### updateDisplayPreferences
▸ **updateDisplayPreferences**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Update Display Preferences.
**`throws`** {RequiredError}
**`memberof`** DisplayPreferencesApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`DisplayPreferencesApiUpdateDisplayPreferencesRequest`](../interfaces/generated_client.DisplayPreferencesApiUpdateDisplayPreferencesRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/display-preferences-api.ts:304](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/display-preferences-api.ts#L304)

252
docs/classes/generated_client.DlnaApi.md
View File

@ -1,252 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DlnaApi
# Class: DlnaApi
[generated-client](../modules/generated_client.md).DlnaApi
DlnaApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`DlnaApi`**
## Table of contents
### Constructors
- [constructor](generated_client.DlnaApi.md#constructor)
### Properties
- [axios](generated_client.DlnaApi.md#axios)
- [basePath](generated_client.DlnaApi.md#basepath)
- [configuration](generated_client.DlnaApi.md#configuration)
### Methods
- [createProfile](generated_client.DlnaApi.md#createprofile)
- [deleteProfile](generated_client.DlnaApi.md#deleteprofile)
- [getDefaultProfile](generated_client.DlnaApi.md#getdefaultprofile)
- [getProfile](generated_client.DlnaApi.md#getprofile)
- [getProfileInfos](generated_client.DlnaApi.md#getprofileinfos)
- [updateProfile](generated_client.DlnaApi.md#updateprofile)
## Constructors
### constructor
• **new DlnaApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### createProfile
▸ **createProfile**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Creates a profile.
**`throws`** {RequiredError}
**`memberof`** DlnaApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`DlnaApiCreateProfileRequest`](../interfaces/generated_client.DlnaApiCreateProfileRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/dlna-api.ts:478](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-api.ts#L478)
___
### deleteProfile
▸ **deleteProfile**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Deletes a profile.
**`throws`** {RequiredError}
**`memberof`** DlnaApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`DlnaApiDeleteProfileRequest`](../interfaces/generated_client.DlnaApiDeleteProfileRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/dlna-api.ts:490](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-api.ts#L490)
___
### getDefaultProfile
▸ **getDefaultProfile**(`options?`): `Promise`<`AxiosResponse`<[`DeviceProfile`](../interfaces/generated_client.DeviceProfile.md), `any`\>\>
**`summary`** Gets the default profile.
**`throws`** {RequiredError}
**`memberof`** DlnaApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<[`DeviceProfile`](../interfaces/generated_client.DeviceProfile.md), `any`\>\>
#### Defined in
[generated-client/api/dlna-api.ts:501](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-api.ts#L501)
___
### getProfile
▸ **getProfile**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`DeviceProfile`](../interfaces/generated_client.DeviceProfile.md), `any`\>\>
**`summary`** Gets a single profile.
**`throws`** {RequiredError}
**`memberof`** DlnaApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`DlnaApiGetProfileRequest`](../interfaces/generated_client.DlnaApiGetProfileRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`DeviceProfile`](../interfaces/generated_client.DeviceProfile.md), `any`\>\>
#### Defined in
[generated-client/api/dlna-api.ts:513](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-api.ts#L513)
___
### getProfileInfos
▸ **getProfileInfos**(`options?`): `Promise`<`AxiosResponse`<[`DeviceProfileInfo`](../interfaces/generated_client.DeviceProfileInfo.md)[], `any`\>\>
**`summary`** Get profile infos.
**`throws`** {RequiredError}
**`memberof`** DlnaApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<[`DeviceProfileInfo`](../interfaces/generated_client.DeviceProfileInfo.md)[], `any`\>\>
#### Defined in
[generated-client/api/dlna-api.ts:524](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-api.ts#L524)
___
### updateProfile
▸ **updateProfile**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Updates a profile.
**`throws`** {RequiredError}
**`memberof`** DlnaApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`DlnaApiUpdateProfileRequest`](../interfaces/generated_client.DlnaApiUpdateProfileRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/dlna-api.ts:536](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-api.ts#L536)

534
docs/classes/generated_client.DlnaServerApi.md
View File

@ -1,534 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DlnaServerApi
# Class: DlnaServerApi
[generated-client](../modules/generated_client.md).DlnaServerApi
DlnaServerApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`DlnaServerApi`**
## Table of contents
### Constructors
- [constructor](generated_client.DlnaServerApi.md#constructor)
### Properties
- [axios](generated_client.DlnaServerApi.md#axios)
- [basePath](generated_client.DlnaServerApi.md#basepath)
- [configuration](generated_client.DlnaServerApi.md#configuration)
### Methods
- [getConnectionManager](generated_client.DlnaServerApi.md#getconnectionmanager)
- [getConnectionManager2](generated_client.DlnaServerApi.md#getconnectionmanager2)
- [getConnectionManager3](generated_client.DlnaServerApi.md#getconnectionmanager3)
- [getContentDirectory](generated_client.DlnaServerApi.md#getcontentdirectory)
- [getContentDirectory2](generated_client.DlnaServerApi.md#getcontentdirectory2)
- [getContentDirectory3](generated_client.DlnaServerApi.md#getcontentdirectory3)
- [getDescriptionXml](generated_client.DlnaServerApi.md#getdescriptionxml)
- [getDescriptionXml2](generated_client.DlnaServerApi.md#getdescriptionxml2)
- [getIcon](generated_client.DlnaServerApi.md#geticon)
- [getIconId](generated_client.DlnaServerApi.md#geticonid)
- [getMediaReceiverRegistrar](generated_client.DlnaServerApi.md#getmediareceiverregistrar)
- [getMediaReceiverRegistrar2](generated_client.DlnaServerApi.md#getmediareceiverregistrar2)
- [getMediaReceiverRegistrar3](generated_client.DlnaServerApi.md#getmediareceiverregistrar3)
- [processConnectionManagerControlRequest](generated_client.DlnaServerApi.md#processconnectionmanagercontrolrequest)
- [processContentDirectoryControlRequest](generated_client.DlnaServerApi.md#processcontentdirectorycontrolrequest)
- [processMediaReceiverRegistrarControlRequest](generated_client.DlnaServerApi.md#processmediareceiverregistrarcontrolrequest)
## Constructors
### constructor
• **new DlnaServerApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### getConnectionManager
▸ **getConnectionManager**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Gets Dlna media receiver registrar xml.
**`throws`** {RequiredError}
**`memberof`** DlnaServerApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`DlnaServerApiGetConnectionManagerRequest`](../interfaces/generated_client.DlnaServerApiGetConnectionManagerRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/dlna-server-api.ts:1234](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L1234)
___
### getConnectionManager2
▸ **getConnectionManager2**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Gets Dlna media receiver registrar xml.
**`throws`** {RequiredError}
**`memberof`** DlnaServerApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`DlnaServerApiGetConnectionManager2Request`](../interfaces/generated_client.DlnaServerApiGetConnectionManager2Request.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/dlna-server-api.ts:1246](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L1246)
___
### getConnectionManager3
▸ **getConnectionManager3**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Gets Dlna media receiver registrar xml.
**`throws`** {RequiredError}
**`memberof`** DlnaServerApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`DlnaServerApiGetConnectionManager3Request`](../interfaces/generated_client.DlnaServerApiGetConnectionManager3Request.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/dlna-server-api.ts:1258](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L1258)
___
### getContentDirectory
▸ **getContentDirectory**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Gets Dlna content directory xml.
**`throws`** {RequiredError}
**`memberof`** DlnaServerApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`DlnaServerApiGetContentDirectoryRequest`](../interfaces/generated_client.DlnaServerApiGetContentDirectoryRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/dlna-server-api.ts:1270](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L1270)
___
### getContentDirectory2
▸ **getContentDirectory2**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Gets Dlna content directory xml.
**`throws`** {RequiredError}
**`memberof`** DlnaServerApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`DlnaServerApiGetContentDirectory2Request`](../interfaces/generated_client.DlnaServerApiGetContentDirectory2Request.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/dlna-server-api.ts:1282](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L1282)
___
### getContentDirectory3
▸ **getContentDirectory3**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Gets Dlna content directory xml.
**`throws`** {RequiredError}
**`memberof`** DlnaServerApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`DlnaServerApiGetContentDirectory3Request`](../interfaces/generated_client.DlnaServerApiGetContentDirectory3Request.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/dlna-server-api.ts:1294](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L1294)
___
### getDescriptionXml
▸ **getDescriptionXml**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Get Description Xml.
**`throws`** {RequiredError}
**`memberof`** DlnaServerApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`DlnaServerApiGetDescriptionXmlRequest`](../interfaces/generated_client.DlnaServerApiGetDescriptionXmlRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/dlna-server-api.ts:1306](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L1306)
___
### getDescriptionXml2
▸ **getDescriptionXml2**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Get Description Xml.
**`throws`** {RequiredError}
**`memberof`** DlnaServerApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`DlnaServerApiGetDescriptionXml2Request`](../interfaces/generated_client.DlnaServerApiGetDescriptionXml2Request.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/dlna-server-api.ts:1318](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L1318)
___
### getIcon
▸ **getIcon**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Gets a server icon.
**`throws`** {RequiredError}
**`memberof`** DlnaServerApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`DlnaServerApiGetIconRequest`](../interfaces/generated_client.DlnaServerApiGetIconRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/dlna-server-api.ts:1330](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L1330)
___
### getIconId
▸ **getIconId**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Gets a server icon.
**`throws`** {RequiredError}
**`memberof`** DlnaServerApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`DlnaServerApiGetIconIdRequest`](../interfaces/generated_client.DlnaServerApiGetIconIdRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/dlna-server-api.ts:1342](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L1342)
___
### getMediaReceiverRegistrar
▸ **getMediaReceiverRegistrar**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Gets Dlna media receiver registrar xml.
**`throws`** {RequiredError}
**`memberof`** DlnaServerApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`DlnaServerApiGetMediaReceiverRegistrarRequest`](../interfaces/generated_client.DlnaServerApiGetMediaReceiverRegistrarRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/dlna-server-api.ts:1354](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L1354)
___
### getMediaReceiverRegistrar2
▸ **getMediaReceiverRegistrar2**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Gets Dlna media receiver registrar xml.
**`throws`** {RequiredError}
**`memberof`** DlnaServerApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`DlnaServerApiGetMediaReceiverRegistrar2Request`](../interfaces/generated_client.DlnaServerApiGetMediaReceiverRegistrar2Request.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/dlna-server-api.ts:1366](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L1366)
___
### getMediaReceiverRegistrar3
▸ **getMediaReceiverRegistrar3**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Gets Dlna media receiver registrar xml.
**`throws`** {RequiredError}
**`memberof`** DlnaServerApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`DlnaServerApiGetMediaReceiverRegistrar3Request`](../interfaces/generated_client.DlnaServerApiGetMediaReceiverRegistrar3Request.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/dlna-server-api.ts:1378](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L1378)
___
### processConnectionManagerControlRequest
▸ **processConnectionManagerControlRequest**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Process a connection manager control request.
**`throws`** {RequiredError}
**`memberof`** DlnaServerApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`DlnaServerApiProcessConnectionManagerControlRequestRequest`](../interfaces/generated_client.DlnaServerApiProcessConnectionManagerControlRequestRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/dlna-server-api.ts:1390](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L1390)
___
### processContentDirectoryControlRequest
▸ **processContentDirectoryControlRequest**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Process a content directory control request.
**`throws`** {RequiredError}
**`memberof`** DlnaServerApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`DlnaServerApiProcessContentDirectoryControlRequestRequest`](../interfaces/generated_client.DlnaServerApiProcessContentDirectoryControlRequestRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/dlna-server-api.ts:1402](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L1402)
___
### processMediaReceiverRegistrarControlRequest
▸ **processMediaReceiverRegistrarControlRequest**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Process a media receiver registrar control request.
**`throws`** {RequiredError}
**`memberof`** DlnaServerApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`DlnaServerApiProcessMediaReceiverRegistrarControlRequestRequest`](../interfaces/generated_client.DlnaServerApiProcessMediaReceiverRegistrarControlRequestRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/dlna-server-api.ts:1414](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dlna-server-api.ts#L1414)

338
docs/classes/generated_client.DynamicHlsApi.md
View File

@ -1,338 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DynamicHlsApi
# Class: DynamicHlsApi
[generated-client](../modules/generated_client.md).DynamicHlsApi
DynamicHlsApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`DynamicHlsApi`**
## Table of contents
### Constructors
- [constructor](generated_client.DynamicHlsApi.md#constructor)
### Properties
- [axios](generated_client.DynamicHlsApi.md#axios)
- [basePath](generated_client.DynamicHlsApi.md#basepath)
- [configuration](generated_client.DynamicHlsApi.md#configuration)
### Methods
- [getHlsAudioSegment](generated_client.DynamicHlsApi.md#gethlsaudiosegment)
- [getHlsVideoSegment](generated_client.DynamicHlsApi.md#gethlsvideosegment)
- [getLiveHlsStream](generated_client.DynamicHlsApi.md#getlivehlsstream)
- [getMasterHlsAudioPlaylist](generated_client.DynamicHlsApi.md#getmasterhlsaudioplaylist)
- [getMasterHlsVideoPlaylist](generated_client.DynamicHlsApi.md#getmasterhlsvideoplaylist)
- [getVariantHlsAudioPlaylist](generated_client.DynamicHlsApi.md#getvarianthlsaudioplaylist)
- [getVariantHlsVideoPlaylist](generated_client.DynamicHlsApi.md#getvarianthlsvideoplaylist)
- [headMasterHlsAudioPlaylist](generated_client.DynamicHlsApi.md#headmasterhlsaudioplaylist)
- [headMasterHlsVideoPlaylist](generated_client.DynamicHlsApi.md#headmasterhlsvideoplaylist)
## Constructors
### constructor
• **new DynamicHlsApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### getHlsAudioSegment
▸ **getHlsAudioSegment**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Gets a video stream using HTTP live streaming.
**`throws`** {RequiredError}
**`memberof`** DynamicHlsApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`DynamicHlsApiGetHlsAudioSegmentRequest`](../interfaces/generated_client.DynamicHlsApiGetHlsAudioSegmentRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/dynamic-hls-api.ts:7071](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L7071)
___
### getHlsVideoSegment
▸ **getHlsVideoSegment**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Gets a video stream using HTTP live streaming.
**`throws`** {RequiredError}
**`memberof`** DynamicHlsApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`DynamicHlsApiGetHlsVideoSegmentRequest`](../interfaces/generated_client.DynamicHlsApiGetHlsVideoSegmentRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/dynamic-hls-api.ts:7083](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L7083)
___
### getLiveHlsStream
▸ **getLiveHlsStream**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Gets a hls live stream.
**`throws`** {RequiredError}
**`memberof`** DynamicHlsApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`DynamicHlsApiGetLiveHlsStreamRequest`](../interfaces/generated_client.DynamicHlsApiGetLiveHlsStreamRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/dynamic-hls-api.ts:7095](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L7095)
___
### getMasterHlsAudioPlaylist
▸ **getMasterHlsAudioPlaylist**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Gets an audio hls playlist stream.
**`throws`** {RequiredError}
**`memberof`** DynamicHlsApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`DynamicHlsApiGetMasterHlsAudioPlaylistRequest`](../interfaces/generated_client.DynamicHlsApiGetMasterHlsAudioPlaylistRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/dynamic-hls-api.ts:7107](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L7107)
___
### getMasterHlsVideoPlaylist
▸ **getMasterHlsVideoPlaylist**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Gets a video hls playlist stream.
**`throws`** {RequiredError}
**`memberof`** DynamicHlsApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`DynamicHlsApiGetMasterHlsVideoPlaylistRequest`](../interfaces/generated_client.DynamicHlsApiGetMasterHlsVideoPlaylistRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/dynamic-hls-api.ts:7119](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L7119)
___
### getVariantHlsAudioPlaylist
▸ **getVariantHlsAudioPlaylist**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Gets an audio stream using HTTP live streaming.
**`throws`** {RequiredError}
**`memberof`** DynamicHlsApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`DynamicHlsApiGetVariantHlsAudioPlaylistRequest`](../interfaces/generated_client.DynamicHlsApiGetVariantHlsAudioPlaylistRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/dynamic-hls-api.ts:7131](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L7131)
___
### getVariantHlsVideoPlaylist
▸ **getVariantHlsVideoPlaylist**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Gets a video stream using HTTP live streaming.
**`throws`** {RequiredError}
**`memberof`** DynamicHlsApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`DynamicHlsApiGetVariantHlsVideoPlaylistRequest`](../interfaces/generated_client.DynamicHlsApiGetVariantHlsVideoPlaylistRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/dynamic-hls-api.ts:7143](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L7143)
___
### headMasterHlsAudioPlaylist
▸ **headMasterHlsAudioPlaylist**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Gets an audio hls playlist stream.
**`throws`** {RequiredError}
**`memberof`** DynamicHlsApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`DynamicHlsApiHeadMasterHlsAudioPlaylistRequest`](../interfaces/generated_client.DynamicHlsApiHeadMasterHlsAudioPlaylistRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/dynamic-hls-api.ts:7155](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L7155)
___
### headMasterHlsVideoPlaylist
▸ **headMasterHlsVideoPlaylist**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Gets a video hls playlist stream.
**`throws`** {RequiredError}
**`memberof`** DynamicHlsApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`DynamicHlsApiHeadMasterHlsVideoPlaylistRequest`](../interfaces/generated_client.DynamicHlsApiHeadMasterHlsVideoPlaylistRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/dynamic-hls-api.ts:7167](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/dynamic-hls-api.ts#L7167)

253
docs/classes/generated_client.EnvironmentApi.md
View File

@ -1,253 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / EnvironmentApi
# Class: EnvironmentApi
[generated-client](../modules/generated_client.md).EnvironmentApi
EnvironmentApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`EnvironmentApi`**
## Table of contents
### Constructors
- [constructor](generated_client.EnvironmentApi.md#constructor)
### Properties
- [axios](generated_client.EnvironmentApi.md#axios)
- [basePath](generated_client.EnvironmentApi.md#basepath)
- [configuration](generated_client.EnvironmentApi.md#configuration)
### Methods
- [getDefaultDirectoryBrowser](generated_client.EnvironmentApi.md#getdefaultdirectorybrowser)
- [getDirectoryContents](generated_client.EnvironmentApi.md#getdirectorycontents)
- [getDrives](generated_client.EnvironmentApi.md#getdrives)
- [getNetworkShares](generated_client.EnvironmentApi.md#getnetworkshares)
- [getParentPath](generated_client.EnvironmentApi.md#getparentpath)
- [validatePath](generated_client.EnvironmentApi.md#validatepath)
## Constructors
### constructor
• **new EnvironmentApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### getDefaultDirectoryBrowser
▸ **getDefaultDirectoryBrowser**(`options?`): `Promise`<`AxiosResponse`<[`DefaultDirectoryBrowserInfoDto`](../interfaces/generated_client.DefaultDirectoryBrowserInfoDto.md), `any`\>\>
**`summary`** Get Default directory browser.
**`throws`** {RequiredError}
**`memberof`** EnvironmentApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<[`DefaultDirectoryBrowserInfoDto`](../interfaces/generated_client.DefaultDirectoryBrowserInfoDto.md), `any`\>\>
#### Defined in
[generated-client/api/environment-api.ts:485](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/environment-api.ts#L485)
___
### getDirectoryContents
▸ **getDirectoryContents**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`FileSystemEntryInfo`](../interfaces/generated_client.FileSystemEntryInfo.md)[], `any`\>\>
**`summary`** Gets the contents of a given directory in the file system.
**`throws`** {RequiredError}
**`memberof`** EnvironmentApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`EnvironmentApiGetDirectoryContentsRequest`](../interfaces/generated_client.EnvironmentApiGetDirectoryContentsRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`FileSystemEntryInfo`](../interfaces/generated_client.FileSystemEntryInfo.md)[], `any`\>\>
#### Defined in
[generated-client/api/environment-api.ts:497](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/environment-api.ts#L497)
___
### getDrives
▸ **getDrives**(`options?`): `Promise`<`AxiosResponse`<[`FileSystemEntryInfo`](../interfaces/generated_client.FileSystemEntryInfo.md)[], `any`\>\>
**`summary`** Gets available drives from the server\'s file system.
**`throws`** {RequiredError}
**`memberof`** EnvironmentApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<[`FileSystemEntryInfo`](../interfaces/generated_client.FileSystemEntryInfo.md)[], `any`\>\>
#### Defined in
[generated-client/api/environment-api.ts:508](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/environment-api.ts#L508)
___
### getNetworkShares
▸ **getNetworkShares**(`options?`): `Promise`<`AxiosResponse`<[`FileSystemEntryInfo`](../interfaces/generated_client.FileSystemEntryInfo.md)[], `any`\>\>
**`summary`** Gets network paths.
**`deprecated`**
**`throws`** {RequiredError}
**`memberof`** EnvironmentApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<[`FileSystemEntryInfo`](../interfaces/generated_client.FileSystemEntryInfo.md)[], `any`\>\>
#### Defined in
[generated-client/api/environment-api.ts:520](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/environment-api.ts#L520)
___
### getParentPath
▸ **getParentPath**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`string`, `any`\>\>
**`summary`** Gets the parent path of a given path.
**`throws`** {RequiredError}
**`memberof`** EnvironmentApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`EnvironmentApiGetParentPathRequest`](../interfaces/generated_client.EnvironmentApiGetParentPathRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`string`, `any`\>\>
#### Defined in
[generated-client/api/environment-api.ts:532](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/environment-api.ts#L532)
___
### validatePath
▸ **validatePath**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Validates path.
**`throws`** {RequiredError}
**`memberof`** EnvironmentApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`EnvironmentApiValidatePathRequest`](../interfaces/generated_client.EnvironmentApiValidatePathRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/environment-api.ts:544](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/environment-api.ts#L544)

142
docs/classes/generated_client.FilterApi.md
View File

@ -1,142 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / FilterApi
# Class: FilterApi
[generated-client](../modules/generated_client.md).FilterApi
FilterApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`FilterApi`**
## Table of contents
### Constructors
- [constructor](generated_client.FilterApi.md#constructor)
### Properties
- [axios](generated_client.FilterApi.md#axios)
- [basePath](generated_client.FilterApi.md#basepath)
- [configuration](generated_client.FilterApi.md#configuration)
### Methods
- [getQueryFilters](generated_client.FilterApi.md#getqueryfilters)
- [getQueryFiltersLegacy](generated_client.FilterApi.md#getqueryfilterslegacy)
## Constructors
### constructor
• **new FilterApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### getQueryFilters
▸ **getQueryFilters**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`QueryFilters`](../interfaces/generated_client.QueryFilters.md), `any`\>\>
**`summary`** Gets query filters.
**`throws`** {RequiredError}
**`memberof`** FilterApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`FilterApiGetQueryFiltersRequest`](../interfaces/generated_client.FilterApiGetQueryFiltersRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`QueryFilters`](../interfaces/generated_client.QueryFilters.md), `any`\>\>
#### Defined in
[generated-client/api/filter-api.ts:387](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/filter-api.ts#L387)
___
### getQueryFiltersLegacy
▸ **getQueryFiltersLegacy**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`QueryFiltersLegacy`](../interfaces/generated_client.QueryFiltersLegacy.md), `any`\>\>
**`summary`** Gets legacy query filters.
**`throws`** {RequiredError}
**`memberof`** FilterApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`FilterApiGetQueryFiltersLegacyRequest`](../interfaces/generated_client.FilterApiGetQueryFiltersLegacyRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`QueryFiltersLegacy`](../interfaces/generated_client.QueryFiltersLegacy.md), `any`\>\>
#### Defined in
[generated-client/api/filter-api.ts:399](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/filter-api.ts#L399)

142
docs/classes/generated_client.GenresApi.md
View File

@ -1,142 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / GenresApi
# Class: GenresApi
[generated-client](../modules/generated_client.md).GenresApi
GenresApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`GenresApi`**
## Table of contents
### Constructors
- [constructor](generated_client.GenresApi.md#constructor)
### Properties
- [axios](generated_client.GenresApi.md#axios)
- [basePath](generated_client.GenresApi.md#basepath)
- [configuration](generated_client.GenresApi.md#configuration)
### Methods
- [getGenre](generated_client.GenresApi.md#getgenre)
- [getGenres](generated_client.GenresApi.md#getgenres)
## Constructors
### constructor
• **new GenresApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### getGenre
▸ **getGenre**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md), `any`\>\>
**`summary`** Gets a genre, by name.
**`throws`** {RequiredError}
**`memberof`** GenresApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`GenresApiGetGenreRequest`](../interfaces/generated_client.GenresApiGetGenreRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md), `any`\>\>
#### Defined in
[generated-client/api/genres-api.ts:476](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/genres-api.ts#L476)
___
### getGenres
▸ **getGenres**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
**`summary`** Gets all genres from a given item, folder, or the entire library.
**`throws`** {RequiredError}
**`memberof`** GenresApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`GenresApiGetGenresRequest`](../interfaces/generated_client.GenresApiGetGenresRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
#### Defined in
[generated-client/api/genres-api.ts:488](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/genres-api.ts#L488)

226
docs/classes/generated_client.HlsSegmentApi.md
View File

@ -1,226 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / HlsSegmentApi
# Class: HlsSegmentApi
[generated-client](../modules/generated_client.md).HlsSegmentApi
HlsSegmentApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`HlsSegmentApi`**
## Table of contents
### Constructors
- [constructor](generated_client.HlsSegmentApi.md#constructor)
### Properties
- [axios](generated_client.HlsSegmentApi.md#axios)
- [basePath](generated_client.HlsSegmentApi.md#basepath)
- [configuration](generated_client.HlsSegmentApi.md#configuration)
### Methods
- [getHlsAudioSegmentLegacyAac](generated_client.HlsSegmentApi.md#gethlsaudiosegmentlegacyaac)
- [getHlsAudioSegmentLegacyMp3](generated_client.HlsSegmentApi.md#gethlsaudiosegmentlegacymp3)
- [getHlsPlaylistLegacy](generated_client.HlsSegmentApi.md#gethlsplaylistlegacy)
- [getHlsVideoSegmentLegacy](generated_client.HlsSegmentApi.md#gethlsvideosegmentlegacy)
- [stopEncodingProcess](generated_client.HlsSegmentApi.md#stopencodingprocess)
## Constructors
### constructor
• **new HlsSegmentApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### getHlsAudioSegmentLegacyAac
▸ **getHlsAudioSegmentLegacyAac**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Gets the specified audio segment for an audio item.
**`throws`** {RequiredError}
**`memberof`** HlsSegmentApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`HlsSegmentApiGetHlsAudioSegmentLegacyAacRequest`](../interfaces/generated_client.HlsSegmentApiGetHlsAudioSegmentLegacyAacRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/hls-segment-api.ts:517](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/hls-segment-api.ts#L517)
___
### getHlsAudioSegmentLegacyMp3
▸ **getHlsAudioSegmentLegacyMp3**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Gets the specified audio segment for an audio item.
**`throws`** {RequiredError}
**`memberof`** HlsSegmentApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`HlsSegmentApiGetHlsAudioSegmentLegacyMp3Request`](../interfaces/generated_client.HlsSegmentApiGetHlsAudioSegmentLegacyMp3Request.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/hls-segment-api.ts:529](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/hls-segment-api.ts#L529)
___
### getHlsPlaylistLegacy
▸ **getHlsPlaylistLegacy**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Gets a hls video playlist.
**`throws`** {RequiredError}
**`memberof`** HlsSegmentApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`HlsSegmentApiGetHlsPlaylistLegacyRequest`](../interfaces/generated_client.HlsSegmentApiGetHlsPlaylistLegacyRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/hls-segment-api.ts:541](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/hls-segment-api.ts#L541)
___
### getHlsVideoSegmentLegacy
▸ **getHlsVideoSegmentLegacy**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Gets a hls video segment.
**`throws`** {RequiredError}
**`memberof`** HlsSegmentApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`HlsSegmentApiGetHlsVideoSegmentLegacyRequest`](../interfaces/generated_client.HlsSegmentApiGetHlsVideoSegmentLegacyRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/hls-segment-api.ts:553](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/hls-segment-api.ts#L553)
___
### stopEncodingProcess
▸ **stopEncodingProcess**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Stops an active encoding.
**`throws`** {RequiredError}
**`memberof`** HlsSegmentApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`HlsSegmentApiStopEncodingProcessRequest`](../interfaces/generated_client.HlsSegmentApiStopEncodingProcessRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/hls-segment-api.ts:565](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/hls-segment-api.ts#L565)

1233
docs/classes/generated_client.ImageApi.md
View File

File diff suppressed because it is too large Load Diff

251
docs/classes/generated_client.ImageByNameApi.md
View File

@ -1,251 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ImageByNameApi
# Class: ImageByNameApi
[generated-client](../modules/generated_client.md).ImageByNameApi
ImageByNameApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`ImageByNameApi`**
## Table of contents
### Constructors
- [constructor](generated_client.ImageByNameApi.md#constructor)
### Properties
- [axios](generated_client.ImageByNameApi.md#axios)
- [basePath](generated_client.ImageByNameApi.md#basepath)
- [configuration](generated_client.ImageByNameApi.md#configuration)
### Methods
- [getGeneralImage](generated_client.ImageByNameApi.md#getgeneralimage)
- [getGeneralImages](generated_client.ImageByNameApi.md#getgeneralimages)
- [getMediaInfoImage](generated_client.ImageByNameApi.md#getmediainfoimage)
- [getMediaInfoImages](generated_client.ImageByNameApi.md#getmediainfoimages)
- [getRatingImage](generated_client.ImageByNameApi.md#getratingimage)
- [getRatingImages](generated_client.ImageByNameApi.md#getratingimages)
## Constructors
### constructor
• **new ImageByNameApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### getGeneralImage
▸ **getGeneralImage**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Get General Image.
**`throws`** {RequiredError}
**`memberof`** ImageByNameApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`ImageByNameApiGetGeneralImageRequest`](../interfaces/generated_client.ImageByNameApiGetGeneralImageRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/image-by-name-api.ts:473](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-by-name-api.ts#L473)
___
### getGeneralImages
▸ **getGeneralImages**(`options?`): `Promise`<`AxiosResponse`<[`ImageByNameInfo`](../interfaces/generated_client.ImageByNameInfo.md)[], `any`\>\>
**`summary`** Get all general images.
**`throws`** {RequiredError}
**`memberof`** ImageByNameApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<[`ImageByNameInfo`](../interfaces/generated_client.ImageByNameInfo.md)[], `any`\>\>
#### Defined in
[generated-client/api/image-by-name-api.ts:484](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-by-name-api.ts#L484)
___
### getMediaInfoImage
▸ **getMediaInfoImage**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Get media info image.
**`throws`** {RequiredError}
**`memberof`** ImageByNameApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`ImageByNameApiGetMediaInfoImageRequest`](../interfaces/generated_client.ImageByNameApiGetMediaInfoImageRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/image-by-name-api.ts:496](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-by-name-api.ts#L496)
___
### getMediaInfoImages
▸ **getMediaInfoImages**(`options?`): `Promise`<`AxiosResponse`<[`ImageByNameInfo`](../interfaces/generated_client.ImageByNameInfo.md)[], `any`\>\>
**`summary`** Get all media info images.
**`throws`** {RequiredError}
**`memberof`** ImageByNameApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<[`ImageByNameInfo`](../interfaces/generated_client.ImageByNameInfo.md)[], `any`\>\>
#### Defined in
[generated-client/api/image-by-name-api.ts:507](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-by-name-api.ts#L507)
___
### getRatingImage
▸ **getRatingImage**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Get rating image.
**`throws`** {RequiredError}
**`memberof`** ImageByNameApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`ImageByNameApiGetRatingImageRequest`](../interfaces/generated_client.ImageByNameApiGetRatingImageRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/image-by-name-api.ts:519](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-by-name-api.ts#L519)
___
### getRatingImages
▸ **getRatingImages**(`options?`): `Promise`<`AxiosResponse`<[`ImageByNameInfo`](../interfaces/generated_client.ImageByNameInfo.md)[], `any`\>\>
**`summary`** Get all general images.
**`throws`** {RequiredError}
**`memberof`** ImageByNameApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<[`ImageByNameInfo`](../interfaces/generated_client.ImageByNameInfo.md)[], `any`\>\>
#### Defined in
[generated-client/api/image-by-name-api.ts:530](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/image-by-name-api.ts#L530)

312
docs/classes/generated_client.InstantMixApi.md
View File

@ -1,312 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / InstantMixApi
# Class: InstantMixApi
[generated-client](../modules/generated_client.md).InstantMixApi
InstantMixApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`InstantMixApi`**
## Table of contents
### Constructors
- [constructor](generated_client.InstantMixApi.md#constructor)
### Properties
- [axios](generated_client.InstantMixApi.md#axios)
- [basePath](generated_client.InstantMixApi.md#basepath)
- [configuration](generated_client.InstantMixApi.md#configuration)
### Methods
- [getInstantMixFromAlbum](generated_client.InstantMixApi.md#getinstantmixfromalbum)
- [getInstantMixFromArtists](generated_client.InstantMixApi.md#getinstantmixfromartists)
- [getInstantMixFromArtists2](generated_client.InstantMixApi.md#getinstantmixfromartists2)
- [getInstantMixFromItem](generated_client.InstantMixApi.md#getinstantmixfromitem)
- [getInstantMixFromMusicGenreById](generated_client.InstantMixApi.md#getinstantmixfrommusicgenrebyid)
- [getInstantMixFromMusicGenreByName](generated_client.InstantMixApi.md#getinstantmixfrommusicgenrebyname)
- [getInstantMixFromPlaylist](generated_client.InstantMixApi.md#getinstantmixfromplaylist)
- [getInstantMixFromSong](generated_client.InstantMixApi.md#getinstantmixfromsong)
## Constructors
### constructor
• **new InstantMixApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### getInstantMixFromAlbum
▸ **getInstantMixFromAlbum**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
**`summary`** Creates an instant playlist based on a given album.
**`throws`** {RequiredError}
**`memberof`** InstantMixApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`InstantMixApiGetInstantMixFromAlbumRequest`](../interfaces/generated_client.InstantMixApiGetInstantMixFromAlbumRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
#### Defined in
[generated-client/api/instant-mix-api.ts:1442](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1442)
___
### getInstantMixFromArtists
▸ **getInstantMixFromArtists**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
**`summary`** Creates an instant playlist based on a given artist.
**`throws`** {RequiredError}
**`memberof`** InstantMixApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`InstantMixApiGetInstantMixFromArtistsRequest`](../interfaces/generated_client.InstantMixApiGetInstantMixFromArtistsRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
#### Defined in
[generated-client/api/instant-mix-api.ts:1454](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1454)
___
### getInstantMixFromArtists2
▸ **getInstantMixFromArtists2**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
**`summary`** Creates an instant playlist based on a given artist.
**`deprecated`**
**`throws`** {RequiredError}
**`memberof`** InstantMixApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`InstantMixApiGetInstantMixFromArtists2Request`](../interfaces/generated_client.InstantMixApiGetInstantMixFromArtists2Request.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
#### Defined in
[generated-client/api/instant-mix-api.ts:1467](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1467)
___
### getInstantMixFromItem
▸ **getInstantMixFromItem**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
**`summary`** Creates an instant playlist based on a given item.
**`throws`** {RequiredError}
**`memberof`** InstantMixApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`InstantMixApiGetInstantMixFromItemRequest`](../interfaces/generated_client.InstantMixApiGetInstantMixFromItemRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
#### Defined in
[generated-client/api/instant-mix-api.ts:1479](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1479)
___
### getInstantMixFromMusicGenreById
▸ **getInstantMixFromMusicGenreById**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
**`summary`** Creates an instant playlist based on a given genre.
**`throws`** {RequiredError}
**`memberof`** InstantMixApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`InstantMixApiGetInstantMixFromMusicGenreByIdRequest`](../interfaces/generated_client.InstantMixApiGetInstantMixFromMusicGenreByIdRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
#### Defined in
[generated-client/api/instant-mix-api.ts:1491](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1491)
___
### getInstantMixFromMusicGenreByName
▸ **getInstantMixFromMusicGenreByName**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
**`summary`** Creates an instant playlist based on a given genre.
**`throws`** {RequiredError}
**`memberof`** InstantMixApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`InstantMixApiGetInstantMixFromMusicGenreByNameRequest`](../interfaces/generated_client.InstantMixApiGetInstantMixFromMusicGenreByNameRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
#### Defined in
[generated-client/api/instant-mix-api.ts:1503](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1503)
___
### getInstantMixFromPlaylist
▸ **getInstantMixFromPlaylist**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
**`summary`** Creates an instant playlist based on a given playlist.
**`throws`** {RequiredError}
**`memberof`** InstantMixApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`InstantMixApiGetInstantMixFromPlaylistRequest`](../interfaces/generated_client.InstantMixApiGetInstantMixFromPlaylistRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
#### Defined in
[generated-client/api/instant-mix-api.ts:1515](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1515)
___
### getInstantMixFromSong
▸ **getInstantMixFromSong**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
**`summary`** Creates an instant playlist based on a given song.
**`throws`** {RequiredError}
**`memberof`** InstantMixApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`InstantMixApiGetInstantMixFromSongRequest`](../interfaces/generated_client.InstantMixApiGetInstantMixFromSongRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
#### Defined in
[generated-client/api/instant-mix-api.ts:1527](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/instant-mix-api.ts#L1527)

394
docs/classes/generated_client.ItemLookupApi.md
View File

@ -1,394 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ItemLookupApi
# Class: ItemLookupApi
[generated-client](../modules/generated_client.md).ItemLookupApi
ItemLookupApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`ItemLookupApi`**
## Table of contents
### Constructors
- [constructor](generated_client.ItemLookupApi.md#constructor)
### Properties
- [axios](generated_client.ItemLookupApi.md#axios)
- [basePath](generated_client.ItemLookupApi.md#basepath)
- [configuration](generated_client.ItemLookupApi.md#configuration)
### Methods
- [applySearchCriteria](generated_client.ItemLookupApi.md#applysearchcriteria)
- [getBookRemoteSearchResults](generated_client.ItemLookupApi.md#getbookremotesearchresults)
- [getBoxSetRemoteSearchResults](generated_client.ItemLookupApi.md#getboxsetremotesearchresults)
- [getExternalIdInfos](generated_client.ItemLookupApi.md#getexternalidinfos)
- [getMovieRemoteSearchResults](generated_client.ItemLookupApi.md#getmovieremotesearchresults)
- [getMusicAlbumRemoteSearchResults](generated_client.ItemLookupApi.md#getmusicalbumremotesearchresults)
- [getMusicArtistRemoteSearchResults](generated_client.ItemLookupApi.md#getmusicartistremotesearchresults)
- [getMusicVideoRemoteSearchResults](generated_client.ItemLookupApi.md#getmusicvideoremotesearchresults)
- [getPersonRemoteSearchResults](generated_client.ItemLookupApi.md#getpersonremotesearchresults)
- [getSeriesRemoteSearchResults](generated_client.ItemLookupApi.md#getseriesremotesearchresults)
- [getTrailerRemoteSearchResults](generated_client.ItemLookupApi.md#gettrailerremotesearchresults)
## Constructors
### constructor
• **new ItemLookupApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### applySearchCriteria
▸ **applySearchCriteria**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Applies search criteria to an item and refreshes metadata.
**`throws`** {RequiredError}
**`memberof`** ItemLookupApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`ItemLookupApiApplySearchCriteriaRequest`](../interfaces/generated_client.ItemLookupApiApplySearchCriteriaRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/item-lookup-api.ts:930](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-lookup-api.ts#L930)
___
### getBookRemoteSearchResults
▸ **getBookRemoteSearchResults**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[], `any`\>\>
**`summary`** Get book remote search.
**`throws`** {RequiredError}
**`memberof`** ItemLookupApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`ItemLookupApiGetBookRemoteSearchResultsRequest`](../interfaces/generated_client.ItemLookupApiGetBookRemoteSearchResultsRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[], `any`\>\>
#### Defined in
[generated-client/api/item-lookup-api.ts:942](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-lookup-api.ts#L942)
___
### getBoxSetRemoteSearchResults
▸ **getBoxSetRemoteSearchResults**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[], `any`\>\>
**`summary`** Get box set remote search.
**`throws`** {RequiredError}
**`memberof`** ItemLookupApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`ItemLookupApiGetBoxSetRemoteSearchResultsRequest`](../interfaces/generated_client.ItemLookupApiGetBoxSetRemoteSearchResultsRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[], `any`\>\>
#### Defined in
[generated-client/api/item-lookup-api.ts:954](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-lookup-api.ts#L954)
___
### getExternalIdInfos
▸ **getExternalIdInfos**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`ExternalIdInfo`](../interfaces/generated_client.ExternalIdInfo.md)[], `any`\>\>
**`summary`** Get the item\'s external id info.
**`throws`** {RequiredError}
**`memberof`** ItemLookupApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`ItemLookupApiGetExternalIdInfosRequest`](../interfaces/generated_client.ItemLookupApiGetExternalIdInfosRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`ExternalIdInfo`](../interfaces/generated_client.ExternalIdInfo.md)[], `any`\>\>
#### Defined in
[generated-client/api/item-lookup-api.ts:966](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-lookup-api.ts#L966)
___
### getMovieRemoteSearchResults
▸ **getMovieRemoteSearchResults**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[], `any`\>\>
**`summary`** Get movie remote search.
**`throws`** {RequiredError}
**`memberof`** ItemLookupApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`ItemLookupApiGetMovieRemoteSearchResultsRequest`](../interfaces/generated_client.ItemLookupApiGetMovieRemoteSearchResultsRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[], `any`\>\>
#### Defined in
[generated-client/api/item-lookup-api.ts:978](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-lookup-api.ts#L978)
___
### getMusicAlbumRemoteSearchResults
▸ **getMusicAlbumRemoteSearchResults**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[], `any`\>\>
**`summary`** Get music album remote search.
**`throws`** {RequiredError}
**`memberof`** ItemLookupApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`ItemLookupApiGetMusicAlbumRemoteSearchResultsRequest`](../interfaces/generated_client.ItemLookupApiGetMusicAlbumRemoteSearchResultsRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[], `any`\>\>
#### Defined in
[generated-client/api/item-lookup-api.ts:990](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-lookup-api.ts#L990)
___
### getMusicArtistRemoteSearchResults
▸ **getMusicArtistRemoteSearchResults**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[], `any`\>\>
**`summary`** Get music artist remote search.
**`throws`** {RequiredError}
**`memberof`** ItemLookupApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`ItemLookupApiGetMusicArtistRemoteSearchResultsRequest`](../interfaces/generated_client.ItemLookupApiGetMusicArtistRemoteSearchResultsRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[], `any`\>\>
#### Defined in
[generated-client/api/item-lookup-api.ts:1002](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-lookup-api.ts#L1002)
___
### getMusicVideoRemoteSearchResults
▸ **getMusicVideoRemoteSearchResults**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[], `any`\>\>
**`summary`** Get music video remote search.
**`throws`** {RequiredError}
**`memberof`** ItemLookupApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`ItemLookupApiGetMusicVideoRemoteSearchResultsRequest`](../interfaces/generated_client.ItemLookupApiGetMusicVideoRemoteSearchResultsRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[], `any`\>\>
#### Defined in
[generated-client/api/item-lookup-api.ts:1014](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-lookup-api.ts#L1014)
___
### getPersonRemoteSearchResults
▸ **getPersonRemoteSearchResults**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[], `any`\>\>
**`summary`** Get person remote search.
**`throws`** {RequiredError}
**`memberof`** ItemLookupApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`ItemLookupApiGetPersonRemoteSearchResultsRequest`](../interfaces/generated_client.ItemLookupApiGetPersonRemoteSearchResultsRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[], `any`\>\>
#### Defined in
[generated-client/api/item-lookup-api.ts:1026](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-lookup-api.ts#L1026)
___
### getSeriesRemoteSearchResults
▸ **getSeriesRemoteSearchResults**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[], `any`\>\>
**`summary`** Get series remote search.
**`throws`** {RequiredError}
**`memberof`** ItemLookupApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`ItemLookupApiGetSeriesRemoteSearchResultsRequest`](../interfaces/generated_client.ItemLookupApiGetSeriesRemoteSearchResultsRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[], `any`\>\>
#### Defined in
[generated-client/api/item-lookup-api.ts:1038](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-lookup-api.ts#L1038)
___
### getTrailerRemoteSearchResults
▸ **getTrailerRemoteSearchResults**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[], `any`\>\>
**`summary`** Get trailer remote search.
**`throws`** {RequiredError}
**`memberof`** ItemLookupApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`ItemLookupApiGetTrailerRemoteSearchResultsRequest`](../interfaces/generated_client.ItemLookupApiGetTrailerRemoteSearchResultsRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[], `any`\>\>
#### Defined in
[generated-client/api/item-lookup-api.ts:1050](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-lookup-api.ts#L1050)

114
docs/classes/generated_client.ItemRefreshApi.md
View File

@ -1,114 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ItemRefreshApi
# Class: ItemRefreshApi
[generated-client](../modules/generated_client.md).ItemRefreshApi
ItemRefreshApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`ItemRefreshApi`**
## Table of contents
### Constructors
- [constructor](generated_client.ItemRefreshApi.md#constructor)
### Properties
- [axios](generated_client.ItemRefreshApi.md#axios)
- [basePath](generated_client.ItemRefreshApi.md#basepath)
- [configuration](generated_client.ItemRefreshApi.md#configuration)
### Methods
- [refreshItem](generated_client.ItemRefreshApi.md#refreshitem)
## Constructors
### constructor
• **new ItemRefreshApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### refreshItem
▸ **refreshItem**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Refreshes metadata for an item.
**`throws`** {RequiredError}
**`memberof`** ItemRefreshApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`ItemRefreshApiRefreshItemRequest`](../interfaces/generated_client.ItemRefreshApiRefreshItemRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/item-refresh-api.ts:199](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-refresh-api.ts#L199)

170
docs/classes/generated_client.ItemUpdateApi.md
View File

@ -1,170 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ItemUpdateApi
# Class: ItemUpdateApi
[generated-client](../modules/generated_client.md).ItemUpdateApi
ItemUpdateApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`ItemUpdateApi`**
## Table of contents
### Constructors
- [constructor](generated_client.ItemUpdateApi.md#constructor)
### Properties
- [axios](generated_client.ItemUpdateApi.md#axios)
- [basePath](generated_client.ItemUpdateApi.md#basepath)
- [configuration](generated_client.ItemUpdateApi.md#configuration)
### Methods
- [getMetadataEditorInfo](generated_client.ItemUpdateApi.md#getmetadataeditorinfo)
- [updateItem](generated_client.ItemUpdateApi.md#updateitem)
- [updateItemContentType](generated_client.ItemUpdateApi.md#updateitemcontenttype)
## Constructors
### constructor
• **new ItemUpdateApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### getMetadataEditorInfo
▸ **getMetadataEditorInfo**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`MetadataEditorInfo`](../interfaces/generated_client.MetadataEditorInfo.md), `any`\>\>
**`summary`** Gets metadata editor info for an item.
**`throws`** {RequiredError}
**`memberof`** ItemUpdateApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`ItemUpdateApiGetMetadataEditorInfoRequest`](../interfaces/generated_client.ItemUpdateApiGetMetadataEditorInfoRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`MetadataEditorInfo`](../interfaces/generated_client.MetadataEditorInfo.md), `any`\>\>
#### Defined in
[generated-client/api/item-update-api.ts:318](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-update-api.ts#L318)
___
### updateItem
▸ **updateItem**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Updates an item.
**`throws`** {RequiredError}
**`memberof`** ItemUpdateApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`ItemUpdateApiUpdateItemRequest`](../interfaces/generated_client.ItemUpdateApiUpdateItemRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/item-update-api.ts:330](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-update-api.ts#L330)
___
### updateItemContentType
▸ **updateItemContentType**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Updates an item\'s content type.
**`throws`** {RequiredError}
**`memberof`** ItemUpdateApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`ItemUpdateApiUpdateItemContentTypeRequest`](../interfaces/generated_client.ItemUpdateApiUpdateItemContentTypeRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/item-update-api.ts:342](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/item-update-api.ts#L342)

170
docs/classes/generated_client.ItemsApi.md
View File

@ -1,170 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ItemsApi
# Class: ItemsApi
[generated-client](../modules/generated_client.md).ItemsApi
ItemsApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`ItemsApi`**
## Table of contents
### Constructors
- [constructor](generated_client.ItemsApi.md#constructor)
### Properties
- [axios](generated_client.ItemsApi.md#axios)
- [basePath](generated_client.ItemsApi.md#basepath)
- [configuration](generated_client.ItemsApi.md#configuration)
### Methods
- [getItems](generated_client.ItemsApi.md#getitems)
- [getItemsByUserId](generated_client.ItemsApi.md#getitemsbyuserid)
- [getResumeItems](generated_client.ItemsApi.md#getresumeitems)
## Constructors
### constructor
• **new ItemsApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### getItems
▸ **getItems**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
**`summary`** Gets items based on a query.
**`throws`** {RequiredError}
**`memberof`** ItemsApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`ItemsApiGetItemsRequest`](../interfaces/generated_client.ItemsApiGetItemsRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
#### Defined in
[generated-client/api/items-api.ts:2866](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2866)
___
### getItemsByUserId
▸ **getItemsByUserId**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
**`summary`** Gets items based on a query.
**`throws`** {RequiredError}
**`memberof`** ItemsApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`ItemsApiGetItemsByUserIdRequest`](../interfaces/generated_client.ItemsApiGetItemsByUserIdRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
#### Defined in
[generated-client/api/items-api.ts:2878](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2878)
___
### getResumeItems
▸ **getResumeItems**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
**`summary`** Gets items based on a query.
**`throws`** {RequiredError}
**`memberof`** ItemsApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`ItemsApiGetResumeItemsRequest`](../interfaces/generated_client.ItemsApiGetResumeItemsRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
#### Defined in
[generated-client/api/items-api.ts:2890](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/items-api.ts#L2890)

786
docs/classes/generated_client.LibraryApi.md
View File

@ -1,786 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LibraryApi
# Class: LibraryApi
[generated-client](../modules/generated_client.md).LibraryApi
LibraryApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`LibraryApi`**
## Table of contents
### Constructors
- [constructor](generated_client.LibraryApi.md#constructor)
### Properties
- [axios](generated_client.LibraryApi.md#axios)
- [basePath](generated_client.LibraryApi.md#basepath)
- [configuration](generated_client.LibraryApi.md#configuration)
### Methods
- [deleteItem](generated_client.LibraryApi.md#deleteitem)
- [deleteItems](generated_client.LibraryApi.md#deleteitems)
- [getAncestors](generated_client.LibraryApi.md#getancestors)
- [getCriticReviews](generated_client.LibraryApi.md#getcriticreviews)
- [getDownload](generated_client.LibraryApi.md#getdownload)
- [getFile](generated_client.LibraryApi.md#getfile)
- [getItemCounts](generated_client.LibraryApi.md#getitemcounts)
- [getLibraryOptionsInfo](generated_client.LibraryApi.md#getlibraryoptionsinfo)
- [getMediaFolders](generated_client.LibraryApi.md#getmediafolders)
- [getPhysicalPaths](generated_client.LibraryApi.md#getphysicalpaths)
- [getSimilarAlbums](generated_client.LibraryApi.md#getsimilaralbums)
- [getSimilarArtists](generated_client.LibraryApi.md#getsimilarartists)
- [getSimilarItems](generated_client.LibraryApi.md#getsimilaritems)
- [getSimilarMovies](generated_client.LibraryApi.md#getsimilarmovies)
- [getSimilarShows](generated_client.LibraryApi.md#getsimilarshows)
- [getSimilarTrailers](generated_client.LibraryApi.md#getsimilartrailers)
- [getThemeMedia](generated_client.LibraryApi.md#getthememedia)
- [getThemeSongs](generated_client.LibraryApi.md#getthemesongs)
- [getThemeVideos](generated_client.LibraryApi.md#getthemevideos)
- [postAddedMovies](generated_client.LibraryApi.md#postaddedmovies)
- [postAddedSeries](generated_client.LibraryApi.md#postaddedseries)
- [postUpdatedMedia](generated_client.LibraryApi.md#postupdatedmedia)
- [postUpdatedMovies](generated_client.LibraryApi.md#postupdatedmovies)
- [postUpdatedSeries](generated_client.LibraryApi.md#postupdatedseries)
- [refreshLibrary](generated_client.LibraryApi.md#refreshlibrary)
## Constructors
### constructor
• **new LibraryApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### deleteItem
▸ **deleteItem**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Deletes an item from the library and filesystem.
**`throws`** {RequiredError}
**`memberof`** LibraryApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`LibraryApiDeleteItemRequest`](../interfaces/generated_client.LibraryApiDeleteItemRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/library-api.ts:2348](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2348)
___
### deleteItems
▸ **deleteItems**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Deletes items from the library and filesystem.
**`throws`** {RequiredError}
**`memberof`** LibraryApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`LibraryApiDeleteItemsRequest`](../interfaces/generated_client.LibraryApiDeleteItemsRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/library-api.ts:2360](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2360)
___
### getAncestors
▸ **getAncestors**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)[], `any`\>\>
**`summary`** Gets all parents of an item.
**`throws`** {RequiredError}
**`memberof`** LibraryApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`LibraryApiGetAncestorsRequest`](../interfaces/generated_client.LibraryApiGetAncestorsRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)[], `any`\>\>
#### Defined in
[generated-client/api/library-api.ts:2372](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2372)
___
### getCriticReviews
▸ **getCriticReviews**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
**`summary`** Gets critic review for an item.
**`deprecated`**
**`throws`** {RequiredError}
**`memberof`** LibraryApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`LibraryApiGetCriticReviewsRequest`](../interfaces/generated_client.LibraryApiGetCriticReviewsRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
#### Defined in
[generated-client/api/library-api.ts:2385](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2385)
___
### getDownload
▸ **getDownload**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Downloads item media.
**`throws`** {RequiredError}
**`memberof`** LibraryApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`LibraryApiGetDownloadRequest`](../interfaces/generated_client.LibraryApiGetDownloadRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/library-api.ts:2397](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2397)
___
### getFile
▸ **getFile**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Get the original file of an item.
**`throws`** {RequiredError}
**`memberof`** LibraryApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`LibraryApiGetFileRequest`](../interfaces/generated_client.LibraryApiGetFileRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/library-api.ts:2409](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2409)
___
### getItemCounts
▸ **getItemCounts**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`ItemCounts`](../interfaces/generated_client.ItemCounts.md), `any`\>\>
**`summary`** Get item counts.
**`throws`** {RequiredError}
**`memberof`** LibraryApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`LibraryApiGetItemCountsRequest`](../interfaces/generated_client.LibraryApiGetItemCountsRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`ItemCounts`](../interfaces/generated_client.ItemCounts.md), `any`\>\>
#### Defined in
[generated-client/api/library-api.ts:2421](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2421)
___
### getLibraryOptionsInfo
▸ **getLibraryOptionsInfo**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`LibraryOptionsResultDto`](../interfaces/generated_client.LibraryOptionsResultDto.md), `any`\>\>
**`summary`** Gets the library options info.
**`throws`** {RequiredError}
**`memberof`** LibraryApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`LibraryApiGetLibraryOptionsInfoRequest`](../interfaces/generated_client.LibraryApiGetLibraryOptionsInfoRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`LibraryOptionsResultDto`](../interfaces/generated_client.LibraryOptionsResultDto.md), `any`\>\>
#### Defined in
[generated-client/api/library-api.ts:2433](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2433)
___
### getMediaFolders
▸ **getMediaFolders**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
**`summary`** Gets all user media folders.
**`throws`** {RequiredError}
**`memberof`** LibraryApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`LibraryApiGetMediaFoldersRequest`](../interfaces/generated_client.LibraryApiGetMediaFoldersRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
#### Defined in
[generated-client/api/library-api.ts:2445](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2445)
___
### getPhysicalPaths
▸ **getPhysicalPaths**(`options?`): `Promise`<`AxiosResponse`<`string`[], `any`\>\>
**`summary`** Gets a list of physical paths from virtual folders.
**`throws`** {RequiredError}
**`memberof`** LibraryApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<`string`[], `any`\>\>
#### Defined in
[generated-client/api/library-api.ts:2456](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2456)
___
### getSimilarAlbums
▸ **getSimilarAlbums**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
**`summary`** Gets similar items.
**`throws`** {RequiredError}
**`memberof`** LibraryApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`LibraryApiGetSimilarAlbumsRequest`](../interfaces/generated_client.LibraryApiGetSimilarAlbumsRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
#### Defined in
[generated-client/api/library-api.ts:2468](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2468)
___
### getSimilarArtists
▸ **getSimilarArtists**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
**`summary`** Gets similar items.
**`throws`** {RequiredError}
**`memberof`** LibraryApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`LibraryApiGetSimilarArtistsRequest`](../interfaces/generated_client.LibraryApiGetSimilarArtistsRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
#### Defined in
[generated-client/api/library-api.ts:2480](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2480)
___
### getSimilarItems
▸ **getSimilarItems**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
**`summary`** Gets similar items.
**`throws`** {RequiredError}
**`memberof`** LibraryApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`LibraryApiGetSimilarItemsRequest`](../interfaces/generated_client.LibraryApiGetSimilarItemsRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
#### Defined in
[generated-client/api/library-api.ts:2492](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2492)
___
### getSimilarMovies
▸ **getSimilarMovies**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
**`summary`** Gets similar items.
**`throws`** {RequiredError}
**`memberof`** LibraryApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`LibraryApiGetSimilarMoviesRequest`](../interfaces/generated_client.LibraryApiGetSimilarMoviesRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
#### Defined in
[generated-client/api/library-api.ts:2504](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2504)
___
### getSimilarShows
▸ **getSimilarShows**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
**`summary`** Gets similar items.
**`throws`** {RequiredError}
**`memberof`** LibraryApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`LibraryApiGetSimilarShowsRequest`](../interfaces/generated_client.LibraryApiGetSimilarShowsRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
#### Defined in
[generated-client/api/library-api.ts:2516](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2516)
___
### getSimilarTrailers
▸ **getSimilarTrailers**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
**`summary`** Gets similar items.
**`throws`** {RequiredError}
**`memberof`** LibraryApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`LibraryApiGetSimilarTrailersRequest`](../interfaces/generated_client.LibraryApiGetSimilarTrailersRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
#### Defined in
[generated-client/api/library-api.ts:2528](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2528)
___
### getThemeMedia
▸ **getThemeMedia**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`AllThemeMediaResult`](../interfaces/generated_client.AllThemeMediaResult.md), `any`\>\>
**`summary`** Get theme songs and videos for an item.
**`throws`** {RequiredError}
**`memberof`** LibraryApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`LibraryApiGetThemeMediaRequest`](../interfaces/generated_client.LibraryApiGetThemeMediaRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`AllThemeMediaResult`](../interfaces/generated_client.AllThemeMediaResult.md), `any`\>\>
#### Defined in
[generated-client/api/library-api.ts:2540](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2540)
___
### getThemeSongs
▸ **getThemeSongs**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`ThemeMediaResult`](../interfaces/generated_client.ThemeMediaResult.md), `any`\>\>
**`summary`** Get theme songs for an item.
**`throws`** {RequiredError}
**`memberof`** LibraryApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`LibraryApiGetThemeSongsRequest`](../interfaces/generated_client.LibraryApiGetThemeSongsRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`ThemeMediaResult`](../interfaces/generated_client.ThemeMediaResult.md), `any`\>\>
#### Defined in
[generated-client/api/library-api.ts:2552](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2552)
___
### getThemeVideos
▸ **getThemeVideos**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`ThemeMediaResult`](../interfaces/generated_client.ThemeMediaResult.md), `any`\>\>
**`summary`** Get theme videos for an item.
**`throws`** {RequiredError}
**`memberof`** LibraryApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`LibraryApiGetThemeVideosRequest`](../interfaces/generated_client.LibraryApiGetThemeVideosRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`ThemeMediaResult`](../interfaces/generated_client.ThemeMediaResult.md), `any`\>\>
#### Defined in
[generated-client/api/library-api.ts:2564](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2564)
___
### postAddedMovies
▸ **postAddedMovies**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Reports that new movies have been added by an external source.
**`throws`** {RequiredError}
**`memberof`** LibraryApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`LibraryApiPostAddedMoviesRequest`](../interfaces/generated_client.LibraryApiPostAddedMoviesRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/library-api.ts:2576](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2576)
___
### postAddedSeries
▸ **postAddedSeries**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Reports that new episodes of a series have been added by an external source.
**`throws`** {RequiredError}
**`memberof`** LibraryApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`LibraryApiPostAddedSeriesRequest`](../interfaces/generated_client.LibraryApiPostAddedSeriesRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/library-api.ts:2588](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2588)
___
### postUpdatedMedia
▸ **postUpdatedMedia**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Reports that new movies have been added by an external source.
**`throws`** {RequiredError}
**`memberof`** LibraryApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`LibraryApiPostUpdatedMediaRequest`](../interfaces/generated_client.LibraryApiPostUpdatedMediaRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/library-api.ts:2600](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2600)
___
### postUpdatedMovies
▸ **postUpdatedMovies**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Reports that new movies have been added by an external source.
**`throws`** {RequiredError}
**`memberof`** LibraryApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`LibraryApiPostUpdatedMoviesRequest`](../interfaces/generated_client.LibraryApiPostUpdatedMoviesRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/library-api.ts:2612](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2612)
___
### postUpdatedSeries
▸ **postUpdatedSeries**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Reports that new episodes of a series have been added by an external source.
**`throws`** {RequiredError}
**`memberof`** LibraryApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`LibraryApiPostUpdatedSeriesRequest`](../interfaces/generated_client.LibraryApiPostUpdatedSeriesRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/library-api.ts:2624](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2624)
___
### refreshLibrary
▸ **refreshLibrary**(`options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Starts a library scan.
**`throws`** {RequiredError}
**`memberof`** LibraryApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/library-api.ts:2635](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-api.ts#L2635)

309
docs/classes/generated_client.LibraryStructureApi.md
View File

@ -1,309 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LibraryStructureApi
# Class: LibraryStructureApi
[generated-client](../modules/generated_client.md).LibraryStructureApi
LibraryStructureApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`LibraryStructureApi`**
## Table of contents
### Constructors
- [constructor](generated_client.LibraryStructureApi.md#constructor)
### Properties
- [axios](generated_client.LibraryStructureApi.md#axios)
- [basePath](generated_client.LibraryStructureApi.md#basepath)
- [configuration](generated_client.LibraryStructureApi.md#configuration)
### Methods
- [addMediaPath](generated_client.LibraryStructureApi.md#addmediapath)
- [addVirtualFolder](generated_client.LibraryStructureApi.md#addvirtualfolder)
- [getVirtualFolders](generated_client.LibraryStructureApi.md#getvirtualfolders)
- [removeMediaPath](generated_client.LibraryStructureApi.md#removemediapath)
- [removeVirtualFolder](generated_client.LibraryStructureApi.md#removevirtualfolder)
- [renameVirtualFolder](generated_client.LibraryStructureApi.md#renamevirtualfolder)
- [updateLibraryOptions](generated_client.LibraryStructureApi.md#updatelibraryoptions)
- [updateMediaPath](generated_client.LibraryStructureApi.md#updatemediapath)
## Constructors
### constructor
• **new LibraryStructureApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### addMediaPath
▸ **addMediaPath**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Add a media path to a library.
**`throws`** {RequiredError}
**`memberof`** LibraryStructureApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`LibraryStructureApiAddMediaPathRequest`](../interfaces/generated_client.LibraryStructureApiAddMediaPathRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/library-structure-api.ts:784](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-structure-api.ts#L784)
___
### addVirtualFolder
▸ **addVirtualFolder**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Adds a virtual folder.
**`throws`** {RequiredError}
**`memberof`** LibraryStructureApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`LibraryStructureApiAddVirtualFolderRequest`](../interfaces/generated_client.LibraryStructureApiAddVirtualFolderRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/library-structure-api.ts:796](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-structure-api.ts#L796)
___
### getVirtualFolders
▸ **getVirtualFolders**(`options?`): `Promise`<`AxiosResponse`<[`VirtualFolderInfo`](../interfaces/generated_client.VirtualFolderInfo.md)[], `any`\>\>
**`summary`** Gets all virtual folders.
**`throws`** {RequiredError}
**`memberof`** LibraryStructureApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<[`VirtualFolderInfo`](../interfaces/generated_client.VirtualFolderInfo.md)[], `any`\>\>
#### Defined in
[generated-client/api/library-structure-api.ts:807](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-structure-api.ts#L807)
___
### removeMediaPath
▸ **removeMediaPath**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Remove a media path.
**`throws`** {RequiredError}
**`memberof`** LibraryStructureApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`LibraryStructureApiRemoveMediaPathRequest`](../interfaces/generated_client.LibraryStructureApiRemoveMediaPathRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/library-structure-api.ts:819](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-structure-api.ts#L819)
___
### removeVirtualFolder
▸ **removeVirtualFolder**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Removes a virtual folder.
**`throws`** {RequiredError}
**`memberof`** LibraryStructureApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`LibraryStructureApiRemoveVirtualFolderRequest`](../interfaces/generated_client.LibraryStructureApiRemoveVirtualFolderRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/library-structure-api.ts:831](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-structure-api.ts#L831)
___
### renameVirtualFolder
▸ **renameVirtualFolder**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Renames a virtual folder.
**`throws`** {RequiredError}
**`memberof`** LibraryStructureApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`LibraryStructureApiRenameVirtualFolderRequest`](../interfaces/generated_client.LibraryStructureApiRenameVirtualFolderRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/library-structure-api.ts:843](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-structure-api.ts#L843)
___
### updateLibraryOptions
▸ **updateLibraryOptions**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Update library options.
**`throws`** {RequiredError}
**`memberof`** LibraryStructureApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`LibraryStructureApiUpdateLibraryOptionsRequest`](../interfaces/generated_client.LibraryStructureApiUpdateLibraryOptionsRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/library-structure-api.ts:855](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-structure-api.ts#L855)
___
### updateMediaPath
▸ **updateMediaPath**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Updates a media path.
**`throws`** {RequiredError}
**`memberof`** LibraryStructureApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`LibraryStructureApiUpdateMediaPathRequest`](../interfaces/generated_client.LibraryStructureApiUpdateMediaPathRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/library-structure-api.ts:867](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/library-structure-api.ts#L867)

1235
docs/classes/generated_client.LiveTvApi.md
View File

File diff suppressed because it is too large Load Diff

194
docs/classes/generated_client.LocalizationApi.md
View File

@ -1,194 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / LocalizationApi
# Class: LocalizationApi
[generated-client](../modules/generated_client.md).LocalizationApi
LocalizationApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`LocalizationApi`**
## Table of contents
### Constructors
- [constructor](generated_client.LocalizationApi.md#constructor)
### Properties
- [axios](generated_client.LocalizationApi.md#axios)
- [basePath](generated_client.LocalizationApi.md#basepath)
- [configuration](generated_client.LocalizationApi.md#configuration)
### Methods
- [getCountries](generated_client.LocalizationApi.md#getcountries)
- [getCultures](generated_client.LocalizationApi.md#getcultures)
- [getLocalizationOptions](generated_client.LocalizationApi.md#getlocalizationoptions)
- [getParentalRatings](generated_client.LocalizationApi.md#getparentalratings)
## Constructors
### constructor
• **new LocalizationApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### getCountries
▸ **getCountries**(`options?`): `Promise`<`AxiosResponse`<[`CountryInfo`](../interfaces/generated_client.CountryInfo.md)[], `any`\>\>
**`summary`** Gets known countries.
**`throws`** {RequiredError}
**`memberof`** LocalizationApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<[`CountryInfo`](../interfaces/generated_client.CountryInfo.md)[], `any`\>\>
#### Defined in
[generated-client/api/localization-api.ts:282](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/localization-api.ts#L282)
___
### getCultures
▸ **getCultures**(`options?`): `Promise`<`AxiosResponse`<[`CultureDto`](../interfaces/generated_client.CultureDto.md)[], `any`\>\>
**`summary`** Gets known cultures.
**`throws`** {RequiredError}
**`memberof`** LocalizationApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<[`CultureDto`](../interfaces/generated_client.CultureDto.md)[], `any`\>\>
#### Defined in
[generated-client/api/localization-api.ts:293](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/localization-api.ts#L293)
___
### getLocalizationOptions
▸ **getLocalizationOptions**(`options?`): `Promise`<`AxiosResponse`<[`LocalizationOption`](../interfaces/generated_client.LocalizationOption.md)[], `any`\>\>
**`summary`** Gets localization options.
**`throws`** {RequiredError}
**`memberof`** LocalizationApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<[`LocalizationOption`](../interfaces/generated_client.LocalizationOption.md)[], `any`\>\>
#### Defined in
[generated-client/api/localization-api.ts:304](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/localization-api.ts#L304)
___
### getParentalRatings
▸ **getParentalRatings**(`options?`): `Promise`<`AxiosResponse`<[`ParentalRating`](../interfaces/generated_client.ParentalRating.md)[], `any`\>\>
**`summary`** Gets known parental ratings.
**`throws`** {RequiredError}
**`memberof`** LocalizationApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<[`ParentalRating`](../interfaces/generated_client.ParentalRating.md)[], `any`\>\>
#### Defined in
[generated-client/api/localization-api.ts:315](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/localization-api.ts#L315)

228
docs/classes/generated_client.MediaInfoApi.md
View File

@ -1,228 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / MediaInfoApi
# Class: MediaInfoApi
[generated-client](../modules/generated_client.md).MediaInfoApi
MediaInfoApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`MediaInfoApi`**
## Table of contents
### Constructors
- [constructor](generated_client.MediaInfoApi.md#constructor)
### Properties
- [axios](generated_client.MediaInfoApi.md#axios)
- [basePath](generated_client.MediaInfoApi.md#basepath)
- [configuration](generated_client.MediaInfoApi.md#configuration)
### Methods
- [closeLiveStream](generated_client.MediaInfoApi.md#closelivestream)
- [getBitrateTestBytes](generated_client.MediaInfoApi.md#getbitratetestbytes)
- [getPlaybackInfo](generated_client.MediaInfoApi.md#getplaybackinfo)
- [getPostedPlaybackInfo](generated_client.MediaInfoApi.md#getpostedplaybackinfo)
- [openLiveStream](generated_client.MediaInfoApi.md#openlivestream)
## Constructors
### constructor
• **new MediaInfoApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### closeLiveStream
▸ **closeLiveStream**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Closes a media source.
**`throws`** {RequiredError}
**`memberof`** MediaInfoApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`MediaInfoApiCloseLiveStreamRequest`](../interfaces/generated_client.MediaInfoApiCloseLiveStreamRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/media-info-api.ts:818](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/media-info-api.ts#L818)
___
### getBitrateTestBytes
▸ **getBitrateTestBytes**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Tests the network with a request with the size of the bitrate.
**`throws`** {RequiredError}
**`memberof`** MediaInfoApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`MediaInfoApiGetBitrateTestBytesRequest`](../interfaces/generated_client.MediaInfoApiGetBitrateTestBytesRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/media-info-api.ts:830](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/media-info-api.ts#L830)
___
### getPlaybackInfo
▸ **getPlaybackInfo**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`PlaybackInfoResponse`](../interfaces/generated_client.PlaybackInfoResponse.md), `any`\>\>
**`summary`** Gets live playback media info for an item.
**`throws`** {RequiredError}
**`memberof`** MediaInfoApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`MediaInfoApiGetPlaybackInfoRequest`](../interfaces/generated_client.MediaInfoApiGetPlaybackInfoRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`PlaybackInfoResponse`](../interfaces/generated_client.PlaybackInfoResponse.md), `any`\>\>
#### Defined in
[generated-client/api/media-info-api.ts:842](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/media-info-api.ts#L842)
___
### getPostedPlaybackInfo
▸ **getPostedPlaybackInfo**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`PlaybackInfoResponse`](../interfaces/generated_client.PlaybackInfoResponse.md), `any`\>\>
For backwards compatibility parameters can be sent via Query or Body, with Query having higher precedence. Query parameters are obsolete.
**`summary`** Gets live playback media info for an item.
**`throws`** {RequiredError}
**`memberof`** MediaInfoApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`MediaInfoApiGetPostedPlaybackInfoRequest`](../interfaces/generated_client.MediaInfoApiGetPostedPlaybackInfoRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`PlaybackInfoResponse`](../interfaces/generated_client.PlaybackInfoResponse.md), `any`\>\>
#### Defined in
[generated-client/api/media-info-api.ts:854](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/media-info-api.ts#L854)
___
### openLiveStream
▸ **openLiveStream**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`LiveStreamResponse`](../interfaces/generated_client.LiveStreamResponse.md), `any`\>\>
**`summary`** Opens a media source.
**`throws`** {RequiredError}
**`memberof`** MediaInfoApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`MediaInfoApiOpenLiveStreamRequest`](../interfaces/generated_client.MediaInfoApiOpenLiveStreamRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`LiveStreamResponse`](../interfaces/generated_client.LiveStreamResponse.md), `any`\>\>
#### Defined in
[generated-client/api/media-info-api.ts:866](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/media-info-api.ts#L866)

114
docs/classes/generated_client.MoviesApi.md
View File

@ -1,114 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / MoviesApi
# Class: MoviesApi
[generated-client](../modules/generated_client.md).MoviesApi
MoviesApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`MoviesApi`**
## Table of contents
### Constructors
- [constructor](generated_client.MoviesApi.md#constructor)
### Properties
- [axios](generated_client.MoviesApi.md#axios)
- [basePath](generated_client.MoviesApi.md#basepath)
- [configuration](generated_client.MoviesApi.md#configuration)
### Methods
- [getMovieRecommendations](generated_client.MoviesApi.md#getmovierecommendations)
## Constructors
### constructor
• **new MoviesApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### getMovieRecommendations
▸ **getMovieRecommendations**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`RecommendationDto`](../interfaces/generated_client.RecommendationDto.md)[], `any`\>\>
**`summary`** Gets movie recommendations.
**`throws`** {RequiredError}
**`memberof`** MoviesApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`MoviesApiGetMovieRecommendationsRequest`](../interfaces/generated_client.MoviesApiGetMovieRecommendationsRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`RecommendationDto`](../interfaces/generated_client.RecommendationDto.md)[], `any`\>\>
#### Defined in
[generated-client/api/movies-api.ts:200](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/movies-api.ts#L200)

144
docs/classes/generated_client.MusicGenresApi.md
View File

@ -1,144 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / MusicGenresApi
# Class: MusicGenresApi
[generated-client](../modules/generated_client.md).MusicGenresApi
MusicGenresApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`MusicGenresApi`**
## Table of contents
### Constructors
- [constructor](generated_client.MusicGenresApi.md#constructor)
### Properties
- [axios](generated_client.MusicGenresApi.md#axios)
- [basePath](generated_client.MusicGenresApi.md#basepath)
- [configuration](generated_client.MusicGenresApi.md#configuration)
### Methods
- [getMusicGenre](generated_client.MusicGenresApi.md#getmusicgenre)
- [getMusicGenres](generated_client.MusicGenresApi.md#getmusicgenres)
## Constructors
### constructor
• **new MusicGenresApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### getMusicGenre
▸ **getMusicGenre**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md), `any`\>\>
**`summary`** Gets a music genre, by name.
**`throws`** {RequiredError}
**`memberof`** MusicGenresApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`MusicGenresApiGetMusicGenreRequest`](../interfaces/generated_client.MusicGenresApiGetMusicGenreRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md), `any`\>\>
#### Defined in
[generated-client/api/music-genres-api.ts:479](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/music-genres-api.ts#L479)
___
### getMusicGenres
▸ **getMusicGenres**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
**`summary`** Gets all music genres from a given item, folder, or the entire library.
**`deprecated`**
**`throws`** {RequiredError}
**`memberof`** MusicGenresApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`MusicGenresApiGetMusicGenresRequest`](../interfaces/generated_client.MusicGenresApiGetMusicGenresRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
#### Defined in
[generated-client/api/music-genres-api.ts:492](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/music-genres-api.ts#L492)

280
docs/classes/generated_client.NotificationsApi.md
View File

@ -1,280 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / NotificationsApi
# Class: NotificationsApi
[generated-client](../modules/generated_client.md).NotificationsApi
NotificationsApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`NotificationsApi`**
## Table of contents
### Constructors
- [constructor](generated_client.NotificationsApi.md#constructor)
### Properties
- [axios](generated_client.NotificationsApi.md#axios)
- [basePath](generated_client.NotificationsApi.md#basepath)
- [configuration](generated_client.NotificationsApi.md#configuration)
### Methods
- [createAdminNotification](generated_client.NotificationsApi.md#createadminnotification)
- [getNotificationServices](generated_client.NotificationsApi.md#getnotificationservices)
- [getNotificationTypes](generated_client.NotificationsApi.md#getnotificationtypes)
- [getNotifications](generated_client.NotificationsApi.md#getnotifications)
- [getNotificationsSummary](generated_client.NotificationsApi.md#getnotificationssummary)
- [setRead](generated_client.NotificationsApi.md#setread)
- [setUnread](generated_client.NotificationsApi.md#setunread)
## Constructors
### constructor
• **new NotificationsApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### createAdminNotification
▸ **createAdminNotification**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Sends a notification to all admins.
**`throws`** {RequiredError}
**`memberof`** NotificationsApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`NotificationsApiCreateAdminNotificationRequest`](../interfaces/generated_client.NotificationsApiCreateAdminNotificationRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/notifications-api.ts:543](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/notifications-api.ts#L543)
___
### getNotificationServices
▸ **getNotificationServices**(`options?`): `Promise`<`AxiosResponse`<[`NameIdPair`](../interfaces/generated_client.NameIdPair.md)[], `any`\>\>
**`summary`** Gets notification services.
**`throws`** {RequiredError}
**`memberof`** NotificationsApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<[`NameIdPair`](../interfaces/generated_client.NameIdPair.md)[], `any`\>\>
#### Defined in
[generated-client/api/notifications-api.ts:554](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/notifications-api.ts#L554)
___
### getNotificationTypes
▸ **getNotificationTypes**(`options?`): `Promise`<`AxiosResponse`<[`NotificationTypeInfo`](../interfaces/generated_client.NotificationTypeInfo.md)[], `any`\>\>
**`summary`** Gets notification types.
**`throws`** {RequiredError}
**`memberof`** NotificationsApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<[`NotificationTypeInfo`](../interfaces/generated_client.NotificationTypeInfo.md)[], `any`\>\>
#### Defined in
[generated-client/api/notifications-api.ts:565](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/notifications-api.ts#L565)
___
### getNotifications
▸ **getNotifications**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`NotificationResultDto`](../interfaces/generated_client.NotificationResultDto.md), `any`\>\>
**`summary`** Gets a user\'s notifications.
**`throws`** {RequiredError}
**`memberof`** NotificationsApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`NotificationsApiGetNotificationsRequest`](../interfaces/generated_client.NotificationsApiGetNotificationsRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`NotificationResultDto`](../interfaces/generated_client.NotificationResultDto.md), `any`\>\>
#### Defined in
[generated-client/api/notifications-api.ts:577](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/notifications-api.ts#L577)
___
### getNotificationsSummary
▸ **getNotificationsSummary**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`NotificationsSummaryDto`](../interfaces/generated_client.NotificationsSummaryDto.md), `any`\>\>
**`summary`** Gets a user\'s notification summary.
**`throws`** {RequiredError}
**`memberof`** NotificationsApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`NotificationsApiGetNotificationsSummaryRequest`](../interfaces/generated_client.NotificationsApiGetNotificationsSummaryRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`NotificationsSummaryDto`](../interfaces/generated_client.NotificationsSummaryDto.md), `any`\>\>
#### Defined in
[generated-client/api/notifications-api.ts:589](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/notifications-api.ts#L589)
___
### setRead
▸ **setRead**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Sets notifications as read.
**`throws`** {RequiredError}
**`memberof`** NotificationsApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`NotificationsApiSetReadRequest`](../interfaces/generated_client.NotificationsApiSetReadRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/notifications-api.ts:601](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/notifications-api.ts#L601)
___
### setUnread
▸ **setUnread**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Sets notifications as unread.
**`throws`** {RequiredError}
**`memberof`** NotificationsApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`NotificationsApiSetUnreadRequest`](../interfaces/generated_client.NotificationsApiSetUnreadRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/notifications-api.ts:613](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/notifications-api.ts#L613)

252
docs/classes/generated_client.PackageApi.md
View File

@ -1,252 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PackageApi
# Class: PackageApi
[generated-client](../modules/generated_client.md).PackageApi
PackageApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`PackageApi`**
## Table of contents
### Constructors
- [constructor](generated_client.PackageApi.md#constructor)
### Properties
- [axios](generated_client.PackageApi.md#axios)
- [basePath](generated_client.PackageApi.md#basepath)
- [configuration](generated_client.PackageApi.md#configuration)
### Methods
- [cancelPackageInstallation](generated_client.PackageApi.md#cancelpackageinstallation)
- [getPackageInfo](generated_client.PackageApi.md#getpackageinfo)
- [getPackages](generated_client.PackageApi.md#getpackages)
- [getRepositories](generated_client.PackageApi.md#getrepositories)
- [installPackage](generated_client.PackageApi.md#installpackage)
- [setRepositories](generated_client.PackageApi.md#setrepositories)
## Constructors
### constructor
• **new PackageApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### cancelPackageInstallation
▸ **cancelPackageInstallation**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Cancels a package installation.
**`throws`** {RequiredError}
**`memberof`** PackageApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`PackageApiCancelPackageInstallationRequest`](../interfaces/generated_client.PackageApiCancelPackageInstallationRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/package-api.ts:523](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/package-api.ts#L523)
___
### getPackageInfo
▸ **getPackageInfo**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`PackageInfo`](../interfaces/generated_client.PackageInfo.md), `any`\>\>
**`summary`** Gets a package by name or assembly GUID.
**`throws`** {RequiredError}
**`memberof`** PackageApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`PackageApiGetPackageInfoRequest`](../interfaces/generated_client.PackageApiGetPackageInfoRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`PackageInfo`](../interfaces/generated_client.PackageInfo.md), `any`\>\>
#### Defined in
[generated-client/api/package-api.ts:535](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/package-api.ts#L535)
___
### getPackages
▸ **getPackages**(`options?`): `Promise`<`AxiosResponse`<[`PackageInfo`](../interfaces/generated_client.PackageInfo.md)[], `any`\>\>
**`summary`** Gets available packages.
**`throws`** {RequiredError}
**`memberof`** PackageApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<[`PackageInfo`](../interfaces/generated_client.PackageInfo.md)[], `any`\>\>
#### Defined in
[generated-client/api/package-api.ts:546](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/package-api.ts#L546)
___
### getRepositories
▸ **getRepositories**(`options?`): `Promise`<`AxiosResponse`<[`RepositoryInfo`](../interfaces/generated_client.RepositoryInfo.md)[], `any`\>\>
**`summary`** Gets all package repositories.
**`throws`** {RequiredError}
**`memberof`** PackageApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<[`RepositoryInfo`](../interfaces/generated_client.RepositoryInfo.md)[], `any`\>\>
#### Defined in
[generated-client/api/package-api.ts:557](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/package-api.ts#L557)
___
### installPackage
▸ **installPackage**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Installs a package.
**`throws`** {RequiredError}
**`memberof`** PackageApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`PackageApiInstallPackageRequest`](../interfaces/generated_client.PackageApiInstallPackageRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/package-api.ts:569](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/package-api.ts#L569)
___
### setRepositories
▸ **setRepositories**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Sets the enabled and existing package repositories.
**`throws`** {RequiredError}
**`memberof`** PackageApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`PackageApiSetRepositoriesRequest`](../interfaces/generated_client.PackageApiSetRepositoriesRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/package-api.ts:581](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/package-api.ts#L581)

142
docs/classes/generated_client.PersonsApi.md
View File

@ -1,142 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PersonsApi
# Class: PersonsApi
[generated-client](../modules/generated_client.md).PersonsApi
PersonsApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`PersonsApi`**
## Table of contents
### Constructors
- [constructor](generated_client.PersonsApi.md#constructor)
### Properties
- [axios](generated_client.PersonsApi.md#axios)
- [basePath](generated_client.PersonsApi.md#basepath)
- [configuration](generated_client.PersonsApi.md#configuration)
### Methods
- [getPerson](generated_client.PersonsApi.md#getperson)
- [getPersons](generated_client.PersonsApi.md#getpersons)
## Constructors
### constructor
• **new PersonsApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### getPerson
▸ **getPerson**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md), `any`\>\>
**`summary`** Get person by name.
**`throws`** {RequiredError}
**`memberof`** PersonsApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`PersonsApiGetPersonRequest`](../interfaces/generated_client.PersonsApiGetPersonRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md), `any`\>\>
#### Defined in
[generated-client/api/persons-api.ts:406](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/persons-api.ts#L406)
___
### getPersons
▸ **getPersons**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
**`summary`** Gets all persons.
**`throws`** {RequiredError}
**`memberof`** PersonsApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`PersonsApiGetPersonsRequest`](../interfaces/generated_client.PersonsApiGetPersonsRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
#### Defined in
[generated-client/api/persons-api.ts:418](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/persons-api.ts#L418)

228
docs/classes/generated_client.PlaylistsApi.md
View File

@ -1,228 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PlaylistsApi
# Class: PlaylistsApi
[generated-client](../modules/generated_client.md).PlaylistsApi
PlaylistsApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`PlaylistsApi`**
## Table of contents
### Constructors
- [constructor](generated_client.PlaylistsApi.md#constructor)
### Properties
- [axios](generated_client.PlaylistsApi.md#axios)
- [basePath](generated_client.PlaylistsApi.md#basepath)
- [configuration](generated_client.PlaylistsApi.md#configuration)
### Methods
- [addToPlaylist](generated_client.PlaylistsApi.md#addtoplaylist)
- [createPlaylist](generated_client.PlaylistsApi.md#createplaylist)
- [getPlaylistItems](generated_client.PlaylistsApi.md#getplaylistitems)
- [moveItem](generated_client.PlaylistsApi.md#moveitem)
- [removeFromPlaylist](generated_client.PlaylistsApi.md#removefromplaylist)
## Constructors
### constructor
• **new PlaylistsApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### addToPlaylist
▸ **addToPlaylist**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Adds items to a playlist.
**`throws`** {RequiredError}
**`memberof`** PlaylistsApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`PlaylistsApiAddToPlaylistRequest`](../interfaces/generated_client.PlaylistsApiAddToPlaylistRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/playlists-api.ts:675](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playlists-api.ts#L675)
___
### createPlaylist
▸ **createPlaylist**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`PlaylistCreationResult`](../interfaces/generated_client.PlaylistCreationResult.md), `any`\>\>
For backwards compatibility parameters can be sent via Query or Body, with Query having higher precedence. Query parameters are obsolete.
**`summary`** Creates a new playlist.
**`throws`** {RequiredError}
**`memberof`** PlaylistsApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`PlaylistsApiCreatePlaylistRequest`](../interfaces/generated_client.PlaylistsApiCreatePlaylistRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`PlaylistCreationResult`](../interfaces/generated_client.PlaylistCreationResult.md), `any`\>\>
#### Defined in
[generated-client/api/playlists-api.ts:687](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playlists-api.ts#L687)
___
### getPlaylistItems
▸ **getPlaylistItems**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
**`summary`** Gets the original items of a playlist.
**`throws`** {RequiredError}
**`memberof`** PlaylistsApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`PlaylistsApiGetPlaylistItemsRequest`](../interfaces/generated_client.PlaylistsApiGetPlaylistItemsRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
#### Defined in
[generated-client/api/playlists-api.ts:699](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playlists-api.ts#L699)
___
### moveItem
▸ **moveItem**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Moves a playlist item.
**`throws`** {RequiredError}
**`memberof`** PlaylistsApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`PlaylistsApiMoveItemRequest`](../interfaces/generated_client.PlaylistsApiMoveItemRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/playlists-api.ts:711](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playlists-api.ts#L711)
___
### removeFromPlaylist
▸ **removeFromPlaylist**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Removes items from a playlist.
**`throws`** {RequiredError}
**`memberof`** PlaylistsApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`PlaylistsApiRemoveFromPlaylistRequest`](../interfaces/generated_client.PlaylistsApiRemoveFromPlaylistRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/playlists-api.ts:723](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playlists-api.ts#L723)

338
docs/classes/generated_client.PlaystateApi.md
View File

@ -1,338 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PlaystateApi
# Class: PlaystateApi
[generated-client](../modules/generated_client.md).PlaystateApi
PlaystateApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`PlaystateApi`**
## Table of contents
### Constructors
- [constructor](generated_client.PlaystateApi.md#constructor)
### Properties
- [axios](generated_client.PlaystateApi.md#axios)
- [basePath](generated_client.PlaystateApi.md#basepath)
- [configuration](generated_client.PlaystateApi.md#configuration)
### Methods
- [markPlayedItem](generated_client.PlaystateApi.md#markplayeditem)
- [markUnplayedItem](generated_client.PlaystateApi.md#markunplayeditem)
- [onPlaybackProgress](generated_client.PlaystateApi.md#onplaybackprogress)
- [onPlaybackStart](generated_client.PlaystateApi.md#onplaybackstart)
- [onPlaybackStopped](generated_client.PlaystateApi.md#onplaybackstopped)
- [pingPlaybackSession](generated_client.PlaystateApi.md#pingplaybacksession)
- [reportPlaybackProgress](generated_client.PlaystateApi.md#reportplaybackprogress)
- [reportPlaybackStart](generated_client.PlaystateApi.md#reportplaybackstart)
- [reportPlaybackStopped](generated_client.PlaystateApi.md#reportplaybackstopped)
## Constructors
### constructor
• **new PlaystateApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### markPlayedItem
▸ **markPlayedItem**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`UserItemDataDto`](../interfaces/generated_client.UserItemDataDto.md), `any`\>\>
**`summary`** Marks an item as played for user.
**`throws`** {RequiredError}
**`memberof`** PlaystateApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`PlaystateApiMarkPlayedItemRequest`](../interfaces/generated_client.PlaystateApiMarkPlayedItemRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`UserItemDataDto`](../interfaces/generated_client.UserItemDataDto.md), `any`\>\>
#### Defined in
[generated-client/api/playstate-api.ts:1133](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L1133)
___
### markUnplayedItem
▸ **markUnplayedItem**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`UserItemDataDto`](../interfaces/generated_client.UserItemDataDto.md), `any`\>\>
**`summary`** Marks an item as unplayed for user.
**`throws`** {RequiredError}
**`memberof`** PlaystateApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`PlaystateApiMarkUnplayedItemRequest`](../interfaces/generated_client.PlaystateApiMarkUnplayedItemRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`UserItemDataDto`](../interfaces/generated_client.UserItemDataDto.md), `any`\>\>
#### Defined in
[generated-client/api/playstate-api.ts:1145](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L1145)
___
### onPlaybackProgress
▸ **onPlaybackProgress**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Reports a user\'s playback progress.
**`throws`** {RequiredError}
**`memberof`** PlaystateApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`PlaystateApiOnPlaybackProgressRequest`](../interfaces/generated_client.PlaystateApiOnPlaybackProgressRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/playstate-api.ts:1157](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L1157)
___
### onPlaybackStart
▸ **onPlaybackStart**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Reports that a user has begun playing an item.
**`throws`** {RequiredError}
**`memberof`** PlaystateApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`PlaystateApiOnPlaybackStartRequest`](../interfaces/generated_client.PlaystateApiOnPlaybackStartRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/playstate-api.ts:1169](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L1169)
___
### onPlaybackStopped
▸ **onPlaybackStopped**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Reports that a user has stopped playing an item.
**`throws`** {RequiredError}
**`memberof`** PlaystateApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`PlaystateApiOnPlaybackStoppedRequest`](../interfaces/generated_client.PlaystateApiOnPlaybackStoppedRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/playstate-api.ts:1181](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L1181)
___
### pingPlaybackSession
▸ **pingPlaybackSession**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Pings a playback session.
**`throws`** {RequiredError}
**`memberof`** PlaystateApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`PlaystateApiPingPlaybackSessionRequest`](../interfaces/generated_client.PlaystateApiPingPlaybackSessionRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/playstate-api.ts:1193](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L1193)
___
### reportPlaybackProgress
▸ **reportPlaybackProgress**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Reports playback progress within a session.
**`throws`** {RequiredError}
**`memberof`** PlaystateApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`PlaystateApiReportPlaybackProgressRequest`](../interfaces/generated_client.PlaystateApiReportPlaybackProgressRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/playstate-api.ts:1205](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L1205)
___
### reportPlaybackStart
▸ **reportPlaybackStart**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Reports playback has started within a session.
**`throws`** {RequiredError}
**`memberof`** PlaystateApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`PlaystateApiReportPlaybackStartRequest`](../interfaces/generated_client.PlaystateApiReportPlaybackStartRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/playstate-api.ts:1217](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L1217)
___
### reportPlaybackStopped
▸ **reportPlaybackStopped**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Reports playback has stopped within a session.
**`throws`** {RequiredError}
**`memberof`** PlaystateApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`PlaystateApiReportPlaybackStoppedRequest`](../interfaces/generated_client.PlaystateApiReportPlaybackStoppedRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/playstate-api.ts:1229](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/playstate-api.ts#L1229)

341
docs/classes/generated_client.PluginsApi.md
View File

@ -1,341 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / PluginsApi
# Class: PluginsApi
[generated-client](../modules/generated_client.md).PluginsApi
PluginsApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`PluginsApi`**
## Table of contents
### Constructors
- [constructor](generated_client.PluginsApi.md#constructor)
### Properties
- [axios](generated_client.PluginsApi.md#axios)
- [basePath](generated_client.PluginsApi.md#basepath)
- [configuration](generated_client.PluginsApi.md#configuration)
### Methods
- [disablePlugin](generated_client.PluginsApi.md#disableplugin)
- [enablePlugin](generated_client.PluginsApi.md#enableplugin)
- [getPluginConfiguration](generated_client.PluginsApi.md#getpluginconfiguration)
- [getPluginImage](generated_client.PluginsApi.md#getpluginimage)
- [getPluginManifest](generated_client.PluginsApi.md#getpluginmanifest)
- [getPlugins](generated_client.PluginsApi.md#getplugins)
- [uninstallPlugin](generated_client.PluginsApi.md#uninstallplugin)
- [uninstallPluginByVersion](generated_client.PluginsApi.md#uninstallpluginbyversion)
- [updatePluginConfiguration](generated_client.PluginsApi.md#updatepluginconfiguration)
## Constructors
### constructor
• **new PluginsApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### disablePlugin
▸ **disablePlugin**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Disable a plugin.
**`throws`** {RequiredError}
**`memberof`** PluginsApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`PluginsApiDisablePluginRequest`](../interfaces/generated_client.PluginsApiDisablePluginRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/plugins-api.ts:754](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/plugins-api.ts#L754)
___
### enablePlugin
▸ **enablePlugin**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Enables a disabled plugin.
**`throws`** {RequiredError}
**`memberof`** PluginsApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`PluginsApiEnablePluginRequest`](../interfaces/generated_client.PluginsApiEnablePluginRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/plugins-api.ts:766](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/plugins-api.ts#L766)
___
### getPluginConfiguration
▸ **getPluginConfiguration**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`object`, `any`\>\>
**`summary`** Gets plugin configuration.
**`throws`** {RequiredError}
**`memberof`** PluginsApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`PluginsApiGetPluginConfigurationRequest`](../interfaces/generated_client.PluginsApiGetPluginConfigurationRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`object`, `any`\>\>
#### Defined in
[generated-client/api/plugins-api.ts:778](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/plugins-api.ts#L778)
___
### getPluginImage
▸ **getPluginImage**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Gets a plugin\'s image.
**`throws`** {RequiredError}
**`memberof`** PluginsApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`PluginsApiGetPluginImageRequest`](../interfaces/generated_client.PluginsApiGetPluginImageRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/plugins-api.ts:790](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/plugins-api.ts#L790)
___
### getPluginManifest
▸ **getPluginManifest**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Gets a plugin\'s manifest.
**`throws`** {RequiredError}
**`memberof`** PluginsApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`PluginsApiGetPluginManifestRequest`](../interfaces/generated_client.PluginsApiGetPluginManifestRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/plugins-api.ts:802](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/plugins-api.ts#L802)
___
### getPlugins
▸ **getPlugins**(`options?`): `Promise`<`AxiosResponse`<[`PluginInfo`](../interfaces/generated_client.PluginInfo.md)[], `any`\>\>
**`summary`** Gets a list of currently installed plugins.
**`throws`** {RequiredError}
**`memberof`** PluginsApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<[`PluginInfo`](../interfaces/generated_client.PluginInfo.md)[], `any`\>\>
#### Defined in
[generated-client/api/plugins-api.ts:813](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/plugins-api.ts#L813)
___
### uninstallPlugin
▸ **uninstallPlugin**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Uninstalls a plugin.
**`deprecated`**
**`throws`** {RequiredError}
**`memberof`** PluginsApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`PluginsApiUninstallPluginRequest`](../interfaces/generated_client.PluginsApiUninstallPluginRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/plugins-api.ts:826](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/plugins-api.ts#L826)
___
### uninstallPluginByVersion
▸ **uninstallPluginByVersion**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Uninstalls a plugin by version.
**`throws`** {RequiredError}
**`memberof`** PluginsApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`PluginsApiUninstallPluginByVersionRequest`](../interfaces/generated_client.PluginsApiUninstallPluginByVersionRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/plugins-api.ts:838](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/plugins-api.ts#L838)
___
### updatePluginConfiguration
▸ **updatePluginConfiguration**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
Accepts plugin configuration as JSON body.
**`summary`** Updates plugin configuration.
**`throws`** {RequiredError}
**`memberof`** PluginsApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`PluginsApiUpdatePluginConfigurationRequest`](../interfaces/generated_client.PluginsApiUpdatePluginConfigurationRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/plugins-api.ts:850](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/plugins-api.ts#L850)

196
docs/classes/generated_client.QuickConnectApi.md
View File

@ -1,196 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / QuickConnectApi
# Class: QuickConnectApi
[generated-client](../modules/generated_client.md).QuickConnectApi
QuickConnectApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`QuickConnectApi`**
## Table of contents
### Constructors
- [constructor](generated_client.QuickConnectApi.md#constructor)
### Properties
- [axios](generated_client.QuickConnectApi.md#axios)
- [basePath](generated_client.QuickConnectApi.md#basepath)
- [configuration](generated_client.QuickConnectApi.md#configuration)
### Methods
- [authorize](generated_client.QuickConnectApi.md#authorize)
- [connect](generated_client.QuickConnectApi.md#connect)
- [getEnabled](generated_client.QuickConnectApi.md#getenabled)
- [initiate](generated_client.QuickConnectApi.md#initiate)
## Constructors
### constructor
• **new QuickConnectApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### authorize
▸ **authorize**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`boolean`, `any`\>\>
**`summary`** Authorizes a pending quick connect request.
**`throws`** {RequiredError}
**`memberof`** QuickConnectApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`QuickConnectApiAuthorizeRequest`](../interfaces/generated_client.QuickConnectApiAuthorizeRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`boolean`, `any`\>\>
#### Defined in
[generated-client/api/quick-connect-api.ts:316](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/quick-connect-api.ts#L316)
___
### connect
▸ **connect**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`QuickConnectResult`](../interfaces/generated_client.QuickConnectResult.md), `any`\>\>
**`summary`** Attempts to retrieve authentication information.
**`throws`** {RequiredError}
**`memberof`** QuickConnectApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`QuickConnectApiConnectRequest`](../interfaces/generated_client.QuickConnectApiConnectRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`QuickConnectResult`](../interfaces/generated_client.QuickConnectResult.md), `any`\>\>
#### Defined in
[generated-client/api/quick-connect-api.ts:328](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/quick-connect-api.ts#L328)
___
### getEnabled
▸ **getEnabled**(`options?`): `Promise`<`AxiosResponse`<`boolean`, `any`\>\>
**`summary`** Gets the current quick connect state.
**`throws`** {RequiredError}
**`memberof`** QuickConnectApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<`boolean`, `any`\>\>
#### Defined in
[generated-client/api/quick-connect-api.ts:339](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/quick-connect-api.ts#L339)
___
### initiate
▸ **initiate**(`options?`): `Promise`<`AxiosResponse`<[`QuickConnectResult`](../interfaces/generated_client.QuickConnectResult.md), `any`\>\>
**`summary`** Initiate a new quick connect request.
**`throws`** {RequiredError}
**`memberof`** QuickConnectApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<[`QuickConnectResult`](../interfaces/generated_client.QuickConnectResult.md), `any`\>\>
#### Defined in
[generated-client/api/quick-connect-api.ts:350](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/quick-connect-api.ts#L350)

170
docs/classes/generated_client.RemoteImageApi.md
View File

@ -1,170 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / RemoteImageApi
# Class: RemoteImageApi
[generated-client](../modules/generated_client.md).RemoteImageApi
RemoteImageApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`RemoteImageApi`**
## Table of contents
### Constructors
- [constructor](generated_client.RemoteImageApi.md#constructor)
### Properties
- [axios](generated_client.RemoteImageApi.md#axios)
- [basePath](generated_client.RemoteImageApi.md#basepath)
- [configuration](generated_client.RemoteImageApi.md#configuration)
### Methods
- [downloadRemoteImage](generated_client.RemoteImageApi.md#downloadremoteimage)
- [getRemoteImageProviders](generated_client.RemoteImageApi.md#getremoteimageproviders)
- [getRemoteImages](generated_client.RemoteImageApi.md#getremoteimages)
## Constructors
### constructor
• **new RemoteImageApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### downloadRemoteImage
▸ **downloadRemoteImage**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Downloads a remote image for an item.
**`throws`** {RequiredError}
**`memberof`** RemoteImageApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`RemoteImageApiDownloadRemoteImageRequest`](../interfaces/generated_client.RemoteImageApiDownloadRemoteImageRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/remote-image-api.ts:391](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/remote-image-api.ts#L391)
___
### getRemoteImageProviders
▸ **getRemoteImageProviders**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`ImageProviderInfo`](../interfaces/generated_client.ImageProviderInfo.md)[], `any`\>\>
**`summary`** Gets available remote image providers for an item.
**`throws`** {RequiredError}
**`memberof`** RemoteImageApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`RemoteImageApiGetRemoteImageProvidersRequest`](../interfaces/generated_client.RemoteImageApiGetRemoteImageProvidersRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`ImageProviderInfo`](../interfaces/generated_client.ImageProviderInfo.md)[], `any`\>\>
#### Defined in
[generated-client/api/remote-image-api.ts:403](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/remote-image-api.ts#L403)
___
### getRemoteImages
▸ **getRemoteImages**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`RemoteImageResult`](../interfaces/generated_client.RemoteImageResult.md), `any`\>\>
**`summary`** Gets available remote images for an item.
**`throws`** {RequiredError}
**`memberof`** RemoteImageApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`RemoteImageApiGetRemoteImagesRequest`](../interfaces/generated_client.RemoteImageApiGetRemoteImagesRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`RemoteImageResult`](../interfaces/generated_client.RemoteImageResult.md), `any`\>\>
#### Defined in
[generated-client/api/remote-image-api.ts:415](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/remote-image-api.ts#L415)

226
docs/classes/generated_client.ScheduledTasksApi.md
View File

@ -1,226 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ScheduledTasksApi
# Class: ScheduledTasksApi
[generated-client](../modules/generated_client.md).ScheduledTasksApi
ScheduledTasksApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`ScheduledTasksApi`**
## Table of contents
### Constructors
- [constructor](generated_client.ScheduledTasksApi.md#constructor)
### Properties
- [axios](generated_client.ScheduledTasksApi.md#axios)
- [basePath](generated_client.ScheduledTasksApi.md#basepath)
- [configuration](generated_client.ScheduledTasksApi.md#configuration)
### Methods
- [getTask](generated_client.ScheduledTasksApi.md#gettask)
- [getTasks](generated_client.ScheduledTasksApi.md#gettasks)
- [startTask](generated_client.ScheduledTasksApi.md#starttask)
- [stopTask](generated_client.ScheduledTasksApi.md#stoptask)
- [updateTask](generated_client.ScheduledTasksApi.md#updatetask)
## Constructors
### constructor
• **new ScheduledTasksApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### getTask
▸ **getTask**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`TaskInfo`](../interfaces/generated_client.TaskInfo.md), `any`\>\>
**`summary`** Get task by id.
**`throws`** {RequiredError}
**`memberof`** ScheduledTasksApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`ScheduledTasksApiGetTaskRequest`](../interfaces/generated_client.ScheduledTasksApiGetTaskRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`TaskInfo`](../interfaces/generated_client.TaskInfo.md), `any`\>\>
#### Defined in
[generated-client/api/scheduled-tasks-api.ts:463](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/scheduled-tasks-api.ts#L463)
___
### getTasks
▸ **getTasks**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`TaskInfo`](../interfaces/generated_client.TaskInfo.md)[], `any`\>\>
**`summary`** Get tasks.
**`throws`** {RequiredError}
**`memberof`** ScheduledTasksApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`ScheduledTasksApiGetTasksRequest`](../interfaces/generated_client.ScheduledTasksApiGetTasksRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`TaskInfo`](../interfaces/generated_client.TaskInfo.md)[], `any`\>\>
#### Defined in
[generated-client/api/scheduled-tasks-api.ts:475](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/scheduled-tasks-api.ts#L475)
___
### startTask
▸ **startTask**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Start specified task.
**`throws`** {RequiredError}
**`memberof`** ScheduledTasksApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`ScheduledTasksApiStartTaskRequest`](../interfaces/generated_client.ScheduledTasksApiStartTaskRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/scheduled-tasks-api.ts:487](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/scheduled-tasks-api.ts#L487)
___
### stopTask
▸ **stopTask**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Stop specified task.
**`throws`** {RequiredError}
**`memberof`** ScheduledTasksApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`ScheduledTasksApiStopTaskRequest`](../interfaces/generated_client.ScheduledTasksApiStopTaskRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/scheduled-tasks-api.ts:499](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/scheduled-tasks-api.ts#L499)
___
### updateTask
▸ **updateTask**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Update specified task triggers.
**`throws`** {RequiredError}
**`memberof`** ScheduledTasksApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`ScheduledTasksApiUpdateTaskRequest`](../interfaces/generated_client.ScheduledTasksApiUpdateTaskRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/scheduled-tasks-api.ts:511](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/scheduled-tasks-api.ts#L511)

114
docs/classes/generated_client.SearchApi.md
View File

@ -1,114 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SearchApi
# Class: SearchApi
[generated-client](../modules/generated_client.md).SearchApi
SearchApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`SearchApi`**
## Table of contents
### Constructors
- [constructor](generated_client.SearchApi.md#constructor)
### Properties
- [axios](generated_client.SearchApi.md#axios)
- [basePath](generated_client.SearchApi.md#basepath)
- [configuration](generated_client.SearchApi.md#configuration)
### Methods
- [get](generated_client.SearchApi.md#get)
## Constructors
### constructor
• **new SearchApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### get
▸ **get**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`SearchHintResult`](../interfaces/generated_client.SearchHintResult.md), `any`\>\>
**`summary`** Gets the search hint result.
**`throws`** {RequiredError}
**`memberof`** SearchApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`SearchApiGetRequest`](../interfaces/generated_client.SearchApiGetRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`SearchHintResult`](../interfaces/generated_client.SearchHintResult.md), `any`\>\>
#### Defined in
[generated-client/api/search-api.ts:384](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/search-api.ts#L384)

531
docs/classes/generated_client.SessionApi.md
View File

@ -1,531 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SessionApi
# Class: SessionApi
[generated-client](../modules/generated_client.md).SessionApi
SessionApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`SessionApi`**
## Table of contents
### Constructors
- [constructor](generated_client.SessionApi.md#constructor)
### Properties
- [axios](generated_client.SessionApi.md#axios)
- [basePath](generated_client.SessionApi.md#basepath)
- [configuration](generated_client.SessionApi.md#configuration)
### Methods
- [addUserToSession](generated_client.SessionApi.md#addusertosession)
- [displayContent](generated_client.SessionApi.md#displaycontent)
- [getAuthProviders](generated_client.SessionApi.md#getauthproviders)
- [getPasswordResetProviders](generated_client.SessionApi.md#getpasswordresetproviders)
- [getSessions](generated_client.SessionApi.md#getsessions)
- [play](generated_client.SessionApi.md#play)
- [postCapabilities](generated_client.SessionApi.md#postcapabilities)
- [postFullCapabilities](generated_client.SessionApi.md#postfullcapabilities)
- [removeUserFromSession](generated_client.SessionApi.md#removeuserfromsession)
- [reportSessionEnded](generated_client.SessionApi.md#reportsessionended)
- [reportViewing](generated_client.SessionApi.md#reportviewing)
- [sendFullGeneralCommand](generated_client.SessionApi.md#sendfullgeneralcommand)
- [sendGeneralCommand](generated_client.SessionApi.md#sendgeneralcommand)
- [sendMessageCommand](generated_client.SessionApi.md#sendmessagecommand)
- [sendPlaystateCommand](generated_client.SessionApi.md#sendplaystatecommand)
- [sendSystemCommand](generated_client.SessionApi.md#sendsystemcommand)
## Constructors
### constructor
• **new SessionApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### addUserToSession
▸ **addUserToSession**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Adds an additional user to a session.
**`throws`** {RequiredError}
**`memberof`** SessionApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`SessionApiAddUserToSessionRequest`](../interfaces/generated_client.SessionApiAddUserToSessionRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/session-api.ts:1583](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1583)
___
### displayContent
▸ **displayContent**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Instructs a session to browse to an item or view.
**`throws`** {RequiredError}
**`memberof`** SessionApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`SessionApiDisplayContentRequest`](../interfaces/generated_client.SessionApiDisplayContentRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/session-api.ts:1595](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1595)
___
### getAuthProviders
▸ **getAuthProviders**(`options?`): `Promise`<`AxiosResponse`<[`NameIdPair`](../interfaces/generated_client.NameIdPair.md)[], `any`\>\>
**`summary`** Get all auth providers.
**`throws`** {RequiredError}
**`memberof`** SessionApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<[`NameIdPair`](../interfaces/generated_client.NameIdPair.md)[], `any`\>\>
#### Defined in
[generated-client/api/session-api.ts:1606](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1606)
___
### getPasswordResetProviders
▸ **getPasswordResetProviders**(`options?`): `Promise`<`AxiosResponse`<[`NameIdPair`](../interfaces/generated_client.NameIdPair.md)[], `any`\>\>
**`summary`** Get all password reset providers.
**`throws`** {RequiredError}
**`memberof`** SessionApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<[`NameIdPair`](../interfaces/generated_client.NameIdPair.md)[], `any`\>\>
#### Defined in
[generated-client/api/session-api.ts:1617](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1617)
___
### getSessions
▸ **getSessions**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`SessionInfo`](../interfaces/generated_client.SessionInfo.md)[], `any`\>\>
**`summary`** Gets a list of sessions.
**`throws`** {RequiredError}
**`memberof`** SessionApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`SessionApiGetSessionsRequest`](../interfaces/generated_client.SessionApiGetSessionsRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`SessionInfo`](../interfaces/generated_client.SessionInfo.md)[], `any`\>\>
#### Defined in
[generated-client/api/session-api.ts:1629](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1629)
___
### play
▸ **play**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Instructs a session to play an item.
**`throws`** {RequiredError}
**`memberof`** SessionApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`SessionApiPlayRequest`](../interfaces/generated_client.SessionApiPlayRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/session-api.ts:1641](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1641)
___
### postCapabilities
▸ **postCapabilities**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Updates capabilities for a device.
**`throws`** {RequiredError}
**`memberof`** SessionApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`SessionApiPostCapabilitiesRequest`](../interfaces/generated_client.SessionApiPostCapabilitiesRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/session-api.ts:1653](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1653)
___
### postFullCapabilities
▸ **postFullCapabilities**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Updates capabilities for a device.
**`throws`** {RequiredError}
**`memberof`** SessionApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`SessionApiPostFullCapabilitiesRequest`](../interfaces/generated_client.SessionApiPostFullCapabilitiesRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/session-api.ts:1665](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1665)
___
### removeUserFromSession
▸ **removeUserFromSession**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Removes an additional user from a session.
**`throws`** {RequiredError}
**`memberof`** SessionApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`SessionApiRemoveUserFromSessionRequest`](../interfaces/generated_client.SessionApiRemoveUserFromSessionRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/session-api.ts:1677](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1677)
___
### reportSessionEnded
▸ **reportSessionEnded**(`options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Reports that a session has ended.
**`throws`** {RequiredError}
**`memberof`** SessionApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/session-api.ts:1688](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1688)
___
### reportViewing
▸ **reportViewing**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Reports that a session is viewing an item.
**`throws`** {RequiredError}
**`memberof`** SessionApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`SessionApiReportViewingRequest`](../interfaces/generated_client.SessionApiReportViewingRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/session-api.ts:1700](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1700)
___
### sendFullGeneralCommand
▸ **sendFullGeneralCommand**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Issues a full general command to a client.
**`throws`** {RequiredError}
**`memberof`** SessionApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`SessionApiSendFullGeneralCommandRequest`](../interfaces/generated_client.SessionApiSendFullGeneralCommandRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/session-api.ts:1712](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1712)
___
### sendGeneralCommand
▸ **sendGeneralCommand**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Issues a general command to a client.
**`throws`** {RequiredError}
**`memberof`** SessionApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`SessionApiSendGeneralCommandRequest`](../interfaces/generated_client.SessionApiSendGeneralCommandRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/session-api.ts:1724](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1724)
___
### sendMessageCommand
▸ **sendMessageCommand**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Issues a command to a client to display a message to the user.
**`throws`** {RequiredError}
**`memberof`** SessionApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`SessionApiSendMessageCommandRequest`](../interfaces/generated_client.SessionApiSendMessageCommandRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/session-api.ts:1736](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1736)
___
### sendPlaystateCommand
▸ **sendPlaystateCommand**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Issues a playstate command to a client.
**`throws`** {RequiredError}
**`memberof`** SessionApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`SessionApiSendPlaystateCommandRequest`](../interfaces/generated_client.SessionApiSendPlaystateCommandRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/session-api.ts:1748](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1748)
___
### sendSystemCommand
▸ **sendSystemCommand**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Issues a system command to a client.
**`throws`** {RequiredError}
**`memberof`** SessionApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`SessionApiSendSystemCommandRequest`](../interfaces/generated_client.SessionApiSendSystemCommandRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/session-api.ts:1760](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/session-api.ts#L1760)

278
docs/classes/generated_client.StartupApi.md
View File

@ -1,278 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / StartupApi
# Class: StartupApi
[generated-client](../modules/generated_client.md).StartupApi
StartupApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`StartupApi`**
## Table of contents
### Constructors
- [constructor](generated_client.StartupApi.md#constructor)
### Properties
- [axios](generated_client.StartupApi.md#axios)
- [basePath](generated_client.StartupApi.md#basepath)
- [configuration](generated_client.StartupApi.md#configuration)
### Methods
- [completeWizard](generated_client.StartupApi.md#completewizard)
- [getFirstUser](generated_client.StartupApi.md#getfirstuser)
- [getFirstUser2](generated_client.StartupApi.md#getfirstuser2)
- [getStartupConfiguration](generated_client.StartupApi.md#getstartupconfiguration)
- [setRemoteAccess](generated_client.StartupApi.md#setremoteaccess)
- [updateInitialConfiguration](generated_client.StartupApi.md#updateinitialconfiguration)
- [updateStartupUser](generated_client.StartupApi.md#updatestartupuser)
## Constructors
### constructor
• **new StartupApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### completeWizard
▸ **completeWizard**(`options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Completes the startup wizard.
**`throws`** {RequiredError}
**`memberof`** StartupApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/startup-api.ts:500](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/startup-api.ts#L500)
___
### getFirstUser
▸ **getFirstUser**(`options?`): `Promise`<`AxiosResponse`<[`StartupUserDto`](../interfaces/generated_client.StartupUserDto.md), `any`\>\>
**`summary`** Gets the first user.
**`throws`** {RequiredError}
**`memberof`** StartupApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<[`StartupUserDto`](../interfaces/generated_client.StartupUserDto.md), `any`\>\>
#### Defined in
[generated-client/api/startup-api.ts:511](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/startup-api.ts#L511)
___
### getFirstUser2
▸ **getFirstUser2**(`options?`): `Promise`<`AxiosResponse`<[`StartupUserDto`](../interfaces/generated_client.StartupUserDto.md), `any`\>\>
**`summary`** Gets the first user.
**`throws`** {RequiredError}
**`memberof`** StartupApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<[`StartupUserDto`](../interfaces/generated_client.StartupUserDto.md), `any`\>\>
#### Defined in
[generated-client/api/startup-api.ts:522](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/startup-api.ts#L522)
___
### getStartupConfiguration
▸ **getStartupConfiguration**(`options?`): `Promise`<`AxiosResponse`<[`StartupConfigurationDto`](../interfaces/generated_client.StartupConfigurationDto.md), `any`\>\>
**`summary`** Gets the initial startup wizard configuration.
**`throws`** {RequiredError}
**`memberof`** StartupApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<[`StartupConfigurationDto`](../interfaces/generated_client.StartupConfigurationDto.md), `any`\>\>
#### Defined in
[generated-client/api/startup-api.ts:533](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/startup-api.ts#L533)
___
### setRemoteAccess
▸ **setRemoteAccess**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Sets remote access and UPnP.
**`throws`** {RequiredError}
**`memberof`** StartupApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`StartupApiSetRemoteAccessRequest`](../interfaces/generated_client.StartupApiSetRemoteAccessRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/startup-api.ts:545](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/startup-api.ts#L545)
___
### updateInitialConfiguration
▸ **updateInitialConfiguration**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Sets the initial startup wizard configuration.
**`throws`** {RequiredError}
**`memberof`** StartupApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`StartupApiUpdateInitialConfigurationRequest`](../interfaces/generated_client.StartupApiUpdateInitialConfigurationRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/startup-api.ts:557](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/startup-api.ts#L557)
___
### updateStartupUser
▸ **updateStartupUser**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Sets the user name and password.
**`throws`** {RequiredError}
**`memberof`** StartupApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`StartupApiUpdateStartupUserRequest`](../interfaces/generated_client.StartupApiUpdateStartupUserRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/startup-api.ts:569](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/startup-api.ts#L569)

142
docs/classes/generated_client.StudiosApi.md
View File

@ -1,142 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / StudiosApi
# Class: StudiosApi
[generated-client](../modules/generated_client.md).StudiosApi
StudiosApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`StudiosApi`**
## Table of contents
### Constructors
- [constructor](generated_client.StudiosApi.md#constructor)
### Properties
- [axios](generated_client.StudiosApi.md#axios)
- [basePath](generated_client.StudiosApi.md#basepath)
- [configuration](generated_client.StudiosApi.md#configuration)
### Methods
- [getStudio](generated_client.StudiosApi.md#getstudio)
- [getStudios](generated_client.StudiosApi.md#getstudios)
## Constructors
### constructor
• **new StudiosApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### getStudio
▸ **getStudio**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md), `any`\>\>
**`summary`** Gets a studio by name.
**`throws`** {RequiredError}
**`memberof`** StudiosApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`StudiosApiGetStudioRequest`](../interfaces/generated_client.StudiosApiGetStudioRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md), `any`\>\>
#### Defined in
[generated-client/api/studios-api.ts:460](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/studios-api.ts#L460)
___
### getStudios
▸ **getStudios**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
**`summary`** Gets all studios from a given item, folder, or the entire library.
**`throws`** {RequiredError}
**`memberof`** StudiosApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`StudiosApiGetStudiosRequest`](../interfaces/generated_client.StudiosApiGetStudiosRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
#### Defined in
[generated-client/api/studios-api.ts:472](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/studios-api.ts#L472)

365
docs/classes/generated_client.SubtitleApi.md
View File

@ -1,365 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SubtitleApi
# Class: SubtitleApi
[generated-client](../modules/generated_client.md).SubtitleApi
SubtitleApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`SubtitleApi`**
## Table of contents
### Constructors
- [constructor](generated_client.SubtitleApi.md#constructor)
### Properties
- [axios](generated_client.SubtitleApi.md#axios)
- [basePath](generated_client.SubtitleApi.md#basepath)
- [configuration](generated_client.SubtitleApi.md#configuration)
### Methods
- [deleteSubtitle](generated_client.SubtitleApi.md#deletesubtitle)
- [downloadRemoteSubtitles](generated_client.SubtitleApi.md#downloadremotesubtitles)
- [getFallbackFont](generated_client.SubtitleApi.md#getfallbackfont)
- [getFallbackFontList](generated_client.SubtitleApi.md#getfallbackfontlist)
- [getRemoteSubtitles](generated_client.SubtitleApi.md#getremotesubtitles)
- [getSubtitle](generated_client.SubtitleApi.md#getsubtitle)
- [getSubtitlePlaylist](generated_client.SubtitleApi.md#getsubtitleplaylist)
- [getSubtitleWithTicks](generated_client.SubtitleApi.md#getsubtitlewithticks)
- [searchRemoteSubtitles](generated_client.SubtitleApi.md#searchremotesubtitles)
- [uploadSubtitle](generated_client.SubtitleApi.md#uploadsubtitle)
## Constructors
### constructor
• **new SubtitleApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### deleteSubtitle
▸ **deleteSubtitle**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Deletes an external subtitle file.
**`throws`** {RequiredError}
**`memberof`** SubtitleApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`SubtitleApiDeleteSubtitleRequest`](../interfaces/generated_client.SubtitleApiDeleteSubtitleRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/subtitle-api.ts:1194](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L1194)
___
### downloadRemoteSubtitles
▸ **downloadRemoteSubtitles**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Downloads a remote subtitle.
**`throws`** {RequiredError}
**`memberof`** SubtitleApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`SubtitleApiDownloadRemoteSubtitlesRequest`](../interfaces/generated_client.SubtitleApiDownloadRemoteSubtitlesRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/subtitle-api.ts:1206](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L1206)
___
### getFallbackFont
▸ **getFallbackFont**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Gets a fallback font file.
**`throws`** {RequiredError}
**`memberof`** SubtitleApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`SubtitleApiGetFallbackFontRequest`](../interfaces/generated_client.SubtitleApiGetFallbackFontRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/subtitle-api.ts:1218](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L1218)
___
### getFallbackFontList
▸ **getFallbackFontList**(`options?`): `Promise`<`AxiosResponse`<[`FontFile`](../interfaces/generated_client.FontFile.md)[], `any`\>\>
**`summary`** Gets a list of available fallback font files.
**`throws`** {RequiredError}
**`memberof`** SubtitleApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<[`FontFile`](../interfaces/generated_client.FontFile.md)[], `any`\>\>
#### Defined in
[generated-client/api/subtitle-api.ts:1229](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L1229)
___
### getRemoteSubtitles
▸ **getRemoteSubtitles**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Gets the remote subtitles.
**`throws`** {RequiredError}
**`memberof`** SubtitleApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`SubtitleApiGetRemoteSubtitlesRequest`](../interfaces/generated_client.SubtitleApiGetRemoteSubtitlesRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/subtitle-api.ts:1241](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L1241)
___
### getSubtitle
▸ **getSubtitle**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Gets subtitles in a specified format.
**`throws`** {RequiredError}
**`memberof`** SubtitleApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`SubtitleApiGetSubtitleRequest`](../interfaces/generated_client.SubtitleApiGetSubtitleRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/subtitle-api.ts:1253](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L1253)
___
### getSubtitlePlaylist
▸ **getSubtitlePlaylist**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Gets an HLS subtitle playlist.
**`throws`** {RequiredError}
**`memberof`** SubtitleApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`SubtitleApiGetSubtitlePlaylistRequest`](../interfaces/generated_client.SubtitleApiGetSubtitlePlaylistRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/subtitle-api.ts:1265](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L1265)
___
### getSubtitleWithTicks
▸ **getSubtitleWithTicks**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Gets subtitles in a specified format.
**`throws`** {RequiredError}
**`memberof`** SubtitleApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`SubtitleApiGetSubtitleWithTicksRequest`](../interfaces/generated_client.SubtitleApiGetSubtitleWithTicksRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/subtitle-api.ts:1277](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L1277)
___
### searchRemoteSubtitles
▸ **searchRemoteSubtitles**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`RemoteSubtitleInfo`](../interfaces/generated_client.RemoteSubtitleInfo.md)[], `any`\>\>
**`summary`** Search remote subtitles.
**`throws`** {RequiredError}
**`memberof`** SubtitleApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`SubtitleApiSearchRemoteSubtitlesRequest`](../interfaces/generated_client.SubtitleApiSearchRemoteSubtitlesRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`RemoteSubtitleInfo`](../interfaces/generated_client.RemoteSubtitleInfo.md)[], `any`\>\>
#### Defined in
[generated-client/api/subtitle-api.ts:1289](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L1289)
___
### uploadSubtitle
▸ **uploadSubtitle**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Upload an external subtitle file.
**`throws`** {RequiredError}
**`memberof`** SubtitleApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`SubtitleApiUploadSubtitleRequest`](../interfaces/generated_client.SubtitleApiUploadSubtitleRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/subtitle-api.ts:1301](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/subtitle-api.ts#L1301)

114
docs/classes/generated_client.SuggestionsApi.md
View File

@ -1,114 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SuggestionsApi
# Class: SuggestionsApi
[generated-client](../modules/generated_client.md).SuggestionsApi
SuggestionsApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`SuggestionsApi`**
## Table of contents
### Constructors
- [constructor](generated_client.SuggestionsApi.md#constructor)
### Properties
- [axios](generated_client.SuggestionsApi.md#axios)
- [basePath](generated_client.SuggestionsApi.md#basepath)
- [configuration](generated_client.SuggestionsApi.md#configuration)
### Methods
- [getSuggestions](generated_client.SuggestionsApi.md#getsuggestions)
## Constructors
### constructor
• **new SuggestionsApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### getSuggestions
▸ **getSuggestions**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
**`summary`** Gets suggestions.
**`throws`** {RequiredError}
**`memberof`** SuggestionsApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`SuggestionsApiGetSuggestionsRequest`](../interfaces/generated_client.SuggestionsApiGetSuggestionsRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
#### Defined in
[generated-client/api/suggestions-api.ts:213](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/suggestions-api.ts#L213)

669
docs/classes/generated_client.SyncPlayApi.md
View File

@ -1,669 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SyncPlayApi
# Class: SyncPlayApi
[generated-client](../modules/generated_client.md).SyncPlayApi
SyncPlayApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`SyncPlayApi`**
## Table of contents
### Constructors
- [constructor](generated_client.SyncPlayApi.md#constructor)
### Properties
- [axios](generated_client.SyncPlayApi.md#axios)
- [basePath](generated_client.SyncPlayApi.md#basepath)
- [configuration](generated_client.SyncPlayApi.md#configuration)
### Methods
- [syncPlayBuffering](generated_client.SyncPlayApi.md#syncplaybuffering)
- [syncPlayCreateGroup](generated_client.SyncPlayApi.md#syncplaycreategroup)
- [syncPlayGetGroups](generated_client.SyncPlayApi.md#syncplaygetgroups)
- [syncPlayJoinGroup](generated_client.SyncPlayApi.md#syncplayjoingroup)
- [syncPlayLeaveGroup](generated_client.SyncPlayApi.md#syncplayleavegroup)
- [syncPlayMovePlaylistItem](generated_client.SyncPlayApi.md#syncplaymoveplaylistitem)
- [syncPlayNextItem](generated_client.SyncPlayApi.md#syncplaynextitem)
- [syncPlayPause](generated_client.SyncPlayApi.md#syncplaypause)
- [syncPlayPing](generated_client.SyncPlayApi.md#syncplayping)
- [syncPlayPreviousItem](generated_client.SyncPlayApi.md#syncplaypreviousitem)
- [syncPlayQueue](generated_client.SyncPlayApi.md#syncplayqueue)
- [syncPlayReady](generated_client.SyncPlayApi.md#syncplayready)
- [syncPlayRemoveFromPlaylist](generated_client.SyncPlayApi.md#syncplayremovefromplaylist)
- [syncPlaySeek](generated_client.SyncPlayApi.md#syncplayseek)
- [syncPlaySetIgnoreWait](generated_client.SyncPlayApi.md#syncplaysetignorewait)
- [syncPlaySetNewQueue](generated_client.SyncPlayApi.md#syncplaysetnewqueue)
- [syncPlaySetPlaylistItem](generated_client.SyncPlayApi.md#syncplaysetplaylistitem)
- [syncPlaySetRepeatMode](generated_client.SyncPlayApi.md#syncplaysetrepeatmode)
- [syncPlaySetShuffleMode](generated_client.SyncPlayApi.md#syncplaysetshufflemode)
- [syncPlayStop](generated_client.SyncPlayApi.md#syncplaystop)
- [syncPlayUnpause](generated_client.SyncPlayApi.md#syncplayunpause)
## Constructors
### constructor
• **new SyncPlayApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### syncPlayBuffering
▸ **syncPlayBuffering**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Notify SyncPlay group that member is buffering.
**`throws`** {RequiredError}
**`memberof`** SyncPlayApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`SyncPlayApiSyncPlayBufferingRequest`](../interfaces/generated_client.SyncPlayApiSyncPlayBufferingRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/sync-play-api.ts:1545](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1545)
___
### syncPlayCreateGroup
▸ **syncPlayCreateGroup**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Create a new SyncPlay group.
**`throws`** {RequiredError}
**`memberof`** SyncPlayApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`SyncPlayApiSyncPlayCreateGroupRequest`](../interfaces/generated_client.SyncPlayApiSyncPlayCreateGroupRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/sync-play-api.ts:1557](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1557)
___
### syncPlayGetGroups
▸ **syncPlayGetGroups**(`options?`): `Promise`<`AxiosResponse`<[`GroupInfoDto`](../interfaces/generated_client.GroupInfoDto.md)[], `any`\>\>
**`summary`** Gets all SyncPlay groups.
**`throws`** {RequiredError}
**`memberof`** SyncPlayApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<[`GroupInfoDto`](../interfaces/generated_client.GroupInfoDto.md)[], `any`\>\>
#### Defined in
[generated-client/api/sync-play-api.ts:1568](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1568)
___
### syncPlayJoinGroup
▸ **syncPlayJoinGroup**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Join an existing SyncPlay group.
**`throws`** {RequiredError}
**`memberof`** SyncPlayApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`SyncPlayApiSyncPlayJoinGroupRequest`](../interfaces/generated_client.SyncPlayApiSyncPlayJoinGroupRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/sync-play-api.ts:1580](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1580)
___
### syncPlayLeaveGroup
▸ **syncPlayLeaveGroup**(`options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Leave the joined SyncPlay group.
**`throws`** {RequiredError}
**`memberof`** SyncPlayApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/sync-play-api.ts:1591](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1591)
___
### syncPlayMovePlaylistItem
▸ **syncPlayMovePlaylistItem**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Request to move an item in the playlist in SyncPlay group.
**`throws`** {RequiredError}
**`memberof`** SyncPlayApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`SyncPlayApiSyncPlayMovePlaylistItemRequest`](../interfaces/generated_client.SyncPlayApiSyncPlayMovePlaylistItemRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/sync-play-api.ts:1603](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1603)
___
### syncPlayNextItem
▸ **syncPlayNextItem**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Request next item in SyncPlay group.
**`throws`** {RequiredError}
**`memberof`** SyncPlayApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`SyncPlayApiSyncPlayNextItemRequest`](../interfaces/generated_client.SyncPlayApiSyncPlayNextItemRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/sync-play-api.ts:1615](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1615)
___
### syncPlayPause
▸ **syncPlayPause**(`options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Request pause in SyncPlay group.
**`throws`** {RequiredError}
**`memberof`** SyncPlayApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/sync-play-api.ts:1626](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1626)
___
### syncPlayPing
▸ **syncPlayPing**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Update session ping.
**`throws`** {RequiredError}
**`memberof`** SyncPlayApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`SyncPlayApiSyncPlayPingRequest`](../interfaces/generated_client.SyncPlayApiSyncPlayPingRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/sync-play-api.ts:1638](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1638)
___
### syncPlayPreviousItem
▸ **syncPlayPreviousItem**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Request previous item in SyncPlay group.
**`throws`** {RequiredError}
**`memberof`** SyncPlayApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`SyncPlayApiSyncPlayPreviousItemRequest`](../interfaces/generated_client.SyncPlayApiSyncPlayPreviousItemRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/sync-play-api.ts:1650](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1650)
___
### syncPlayQueue
▸ **syncPlayQueue**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Request to queue items to the playlist of a SyncPlay group.
**`throws`** {RequiredError}
**`memberof`** SyncPlayApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`SyncPlayApiSyncPlayQueueRequest`](../interfaces/generated_client.SyncPlayApiSyncPlayQueueRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/sync-play-api.ts:1662](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1662)
___
### syncPlayReady
▸ **syncPlayReady**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Notify SyncPlay group that member is ready for playback.
**`throws`** {RequiredError}
**`memberof`** SyncPlayApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`SyncPlayApiSyncPlayReadyRequest`](../interfaces/generated_client.SyncPlayApiSyncPlayReadyRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/sync-play-api.ts:1674](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1674)
___
### syncPlayRemoveFromPlaylist
▸ **syncPlayRemoveFromPlaylist**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Request to remove items from the playlist in SyncPlay group.
**`throws`** {RequiredError}
**`memberof`** SyncPlayApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`SyncPlayApiSyncPlayRemoveFromPlaylistRequest`](../interfaces/generated_client.SyncPlayApiSyncPlayRemoveFromPlaylistRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/sync-play-api.ts:1686](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1686)
___
### syncPlaySeek
▸ **syncPlaySeek**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Request seek in SyncPlay group.
**`throws`** {RequiredError}
**`memberof`** SyncPlayApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`SyncPlayApiSyncPlaySeekRequest`](../interfaces/generated_client.SyncPlayApiSyncPlaySeekRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/sync-play-api.ts:1698](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1698)
___
### syncPlaySetIgnoreWait
▸ **syncPlaySetIgnoreWait**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Request SyncPlay group to ignore member during group-wait.
**`throws`** {RequiredError}
**`memberof`** SyncPlayApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`SyncPlayApiSyncPlaySetIgnoreWaitRequest`](../interfaces/generated_client.SyncPlayApiSyncPlaySetIgnoreWaitRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/sync-play-api.ts:1710](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1710)
___
### syncPlaySetNewQueue
▸ **syncPlaySetNewQueue**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Request to set new playlist in SyncPlay group.
**`throws`** {RequiredError}
**`memberof`** SyncPlayApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`SyncPlayApiSyncPlaySetNewQueueRequest`](../interfaces/generated_client.SyncPlayApiSyncPlaySetNewQueueRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/sync-play-api.ts:1722](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1722)
___
### syncPlaySetPlaylistItem
▸ **syncPlaySetPlaylistItem**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Request to change playlist item in SyncPlay group.
**`throws`** {RequiredError}
**`memberof`** SyncPlayApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`SyncPlayApiSyncPlaySetPlaylistItemRequest`](../interfaces/generated_client.SyncPlayApiSyncPlaySetPlaylistItemRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/sync-play-api.ts:1734](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1734)
___
### syncPlaySetRepeatMode
▸ **syncPlaySetRepeatMode**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Request to set repeat mode in SyncPlay group.
**`throws`** {RequiredError}
**`memberof`** SyncPlayApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`SyncPlayApiSyncPlaySetRepeatModeRequest`](../interfaces/generated_client.SyncPlayApiSyncPlaySetRepeatModeRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/sync-play-api.ts:1746](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1746)
___
### syncPlaySetShuffleMode
▸ **syncPlaySetShuffleMode**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Request to set shuffle mode in SyncPlay group.
**`throws`** {RequiredError}
**`memberof`** SyncPlayApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`SyncPlayApiSyncPlaySetShuffleModeRequest`](../interfaces/generated_client.SyncPlayApiSyncPlaySetShuffleModeRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/sync-play-api.ts:1758](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1758)
___
### syncPlayStop
▸ **syncPlayStop**(`options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Request stop in SyncPlay group.
**`throws`** {RequiredError}
**`memberof`** SyncPlayApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/sync-play-api.ts:1769](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1769)
___
### syncPlayUnpause
▸ **syncPlayUnpause**(`options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Request unpause in SyncPlay group.
**`throws`** {RequiredError}
**`memberof`** SyncPlayApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/sync-play-api.ts:1780](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/sync-play-api.ts#L1780)

359
docs/classes/generated_client.SystemApi.md
View File

@ -1,359 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / SystemApi
# Class: SystemApi
[generated-client](../modules/generated_client.md).SystemApi
SystemApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`SystemApi`**
## Table of contents
### Constructors
- [constructor](generated_client.SystemApi.md#constructor)
### Properties
- [axios](generated_client.SystemApi.md#axios)
- [basePath](generated_client.SystemApi.md#basepath)
- [configuration](generated_client.SystemApi.md#configuration)
### Methods
- [getEndpointInfo](generated_client.SystemApi.md#getendpointinfo)
- [getLogFile](generated_client.SystemApi.md#getlogfile)
- [getPingSystem](generated_client.SystemApi.md#getpingsystem)
- [getPublicSystemInfo](generated_client.SystemApi.md#getpublicsysteminfo)
- [getServerLogs](generated_client.SystemApi.md#getserverlogs)
- [getSystemInfo](generated_client.SystemApi.md#getsysteminfo)
- [getWakeOnLanInfo](generated_client.SystemApi.md#getwakeonlaninfo)
- [postPingSystem](generated_client.SystemApi.md#postpingsystem)
- [restartApplication](generated_client.SystemApi.md#restartapplication)
- [shutdownApplication](generated_client.SystemApi.md#shutdownapplication)
## Constructors
### constructor
• **new SystemApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### getEndpointInfo
▸ **getEndpointInfo**(`options?`): `Promise`<`AxiosResponse`<[`EndPointInfo`](../interfaces/generated_client.EndPointInfo.md), `any`\>\>
**`summary`** Gets information about the request endpoint.
**`throws`** {RequiredError}
**`memberof`** SystemApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<[`EndPointInfo`](../interfaces/generated_client.EndPointInfo.md), `any`\>\>
#### Defined in
[generated-client/api/system-api.ts:613](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/system-api.ts#L613)
___
### getLogFile
▸ **getLogFile**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Gets a log file.
**`throws`** {RequiredError}
**`memberof`** SystemApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`SystemApiGetLogFileRequest`](../interfaces/generated_client.SystemApiGetLogFileRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/system-api.ts:625](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/system-api.ts#L625)
___
### getPingSystem
▸ **getPingSystem**(`options?`): `Promise`<`AxiosResponse`<`string`, `any`\>\>
**`summary`** Pings the system.
**`throws`** {RequiredError}
**`memberof`** SystemApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<`string`, `any`\>\>
#### Defined in
[generated-client/api/system-api.ts:636](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/system-api.ts#L636)
___
### getPublicSystemInfo
▸ **getPublicSystemInfo**(`options?`): `Promise`<`AxiosResponse`<[`PublicSystemInfo`](../interfaces/generated_client.PublicSystemInfo.md), `any`\>\>
**`summary`** Gets public information about the server.
**`throws`** {RequiredError}
**`memberof`** SystemApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<[`PublicSystemInfo`](../interfaces/generated_client.PublicSystemInfo.md), `any`\>\>
#### Defined in
[generated-client/api/system-api.ts:647](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/system-api.ts#L647)
___
### getServerLogs
▸ **getServerLogs**(`options?`): `Promise`<`AxiosResponse`<[`LogFile`](../interfaces/generated_client.LogFile.md)[], `any`\>\>
**`summary`** Gets a list of available server log files.
**`throws`** {RequiredError}
**`memberof`** SystemApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<[`LogFile`](../interfaces/generated_client.LogFile.md)[], `any`\>\>
#### Defined in
[generated-client/api/system-api.ts:658](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/system-api.ts#L658)
___
### getSystemInfo
▸ **getSystemInfo**(`options?`): `Promise`<`AxiosResponse`<[`SystemInfo`](../interfaces/generated_client.SystemInfo.md), `any`\>\>
**`summary`** Gets information about the server.
**`throws`** {RequiredError}
**`memberof`** SystemApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<[`SystemInfo`](../interfaces/generated_client.SystemInfo.md), `any`\>\>
#### Defined in
[generated-client/api/system-api.ts:669](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/system-api.ts#L669)
___
### getWakeOnLanInfo
▸ **getWakeOnLanInfo**(`options?`): `Promise`<`AxiosResponse`<[`WakeOnLanInfo`](../interfaces/generated_client.WakeOnLanInfo.md)[], `any`\>\>
**`summary`** Gets wake on lan information.
**`deprecated`**
**`throws`** {RequiredError}
**`memberof`** SystemApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<[`WakeOnLanInfo`](../interfaces/generated_client.WakeOnLanInfo.md)[], `any`\>\>
#### Defined in
[generated-client/api/system-api.ts:681](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/system-api.ts#L681)
___
### postPingSystem
▸ **postPingSystem**(`options?`): `Promise`<`AxiosResponse`<`string`, `any`\>\>
**`summary`** Pings the system.
**`throws`** {RequiredError}
**`memberof`** SystemApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<`string`, `any`\>\>
#### Defined in
[generated-client/api/system-api.ts:692](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/system-api.ts#L692)
___
### restartApplication
▸ **restartApplication**(`options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Restarts the application.
**`throws`** {RequiredError}
**`memberof`** SystemApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/system-api.ts:703](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/system-api.ts#L703)
___
### shutdownApplication
▸ **shutdownApplication**(`options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Shuts down the application.
**`throws`** {RequiredError}
**`memberof`** SystemApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/system-api.ts:714](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/system-api.ts#L714)

113
docs/classes/generated_client.TimeSyncApi.md
View File

@ -1,113 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / TimeSyncApi
# Class: TimeSyncApi
[generated-client](../modules/generated_client.md).TimeSyncApi
TimeSyncApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`TimeSyncApi`**
## Table of contents
### Constructors
- [constructor](generated_client.TimeSyncApi.md#constructor)
### Properties
- [axios](generated_client.TimeSyncApi.md#axios)
- [basePath](generated_client.TimeSyncApi.md#basepath)
- [configuration](generated_client.TimeSyncApi.md#configuration)
### Methods
- [getUtcTime](generated_client.TimeSyncApi.md#getutctime)
## Constructors
### constructor
• **new TimeSyncApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### getUtcTime
▸ **getUtcTime**(`options?`): `Promise`<`AxiosResponse`<[`UtcTimeResponse`](../interfaces/generated_client.UtcTimeResponse.md), `any`\>\>
**`summary`** Gets the current UTC time.
**`throws`** {RequiredError}
**`memberof`** TimeSyncApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<[`UtcTimeResponse`](../interfaces/generated_client.UtcTimeResponse.md), `any`\>\>
#### Defined in
[generated-client/api/time-sync-api.ts:117](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/time-sync-api.ts#L117)

113
docs/classes/generated_client.TmdbApi.md
View File

@ -1,113 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / TmdbApi
# Class: TmdbApi
[generated-client](../modules/generated_client.md).TmdbApi
TmdbApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`TmdbApi`**
## Table of contents
### Constructors
- [constructor](generated_client.TmdbApi.md#constructor)
### Properties
- [axios](generated_client.TmdbApi.md#axios)
- [basePath](generated_client.TmdbApi.md#basepath)
- [configuration](generated_client.TmdbApi.md#configuration)
### Methods
- [tmdbClientConfiguration](generated_client.TmdbApi.md#tmdbclientconfiguration)
## Constructors
### constructor
• **new TmdbApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### tmdbClientConfiguration
▸ **tmdbClientConfiguration**(`options?`): `Promise`<`AxiosResponse`<[`ConfigImageTypes`](../interfaces/generated_client.ConfigImageTypes.md), `any`\>\>
**`summary`** Gets the TMDb image configuration options.
**`throws`** {RequiredError}
**`memberof`** TmdbApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<[`ConfigImageTypes`](../interfaces/generated_client.ConfigImageTypes.md), `any`\>\>
#### Defined in
[generated-client/api/tmdb-api.ts:120](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tmdb-api.ts#L120)

114
docs/classes/generated_client.TrailersApi.md
View File

@ -1,114 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / TrailersApi
# Class: TrailersApi
[generated-client](../modules/generated_client.md).TrailersApi
TrailersApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`TrailersApi`**
## Table of contents
### Constructors
- [constructor](generated_client.TrailersApi.md#constructor)
### Properties
- [axios](generated_client.TrailersApi.md#axios)
- [basePath](generated_client.TrailersApi.md#basepath)
- [configuration](generated_client.TrailersApi.md#configuration)
### Methods
- [getTrailers](generated_client.TrailersApi.md#gettrailers)
## Constructors
### constructor
• **new TrailersApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### getTrailers
▸ **getTrailers**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
**`summary`** Finds movies and trailers similar to a given trailer.
**`throws`** {RequiredError}
**`memberof`** TrailersApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`TrailersApiGetTrailersRequest`](../interfaces/generated_client.TrailersApiGetTrailersRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
#### Defined in
[generated-client/api/trailers-api.ts:1328](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/trailers-api.ts#L1328)

198
docs/classes/generated_client.TvShowsApi.md
View File

@ -1,198 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / TvShowsApi
# Class: TvShowsApi
[generated-client](../modules/generated_client.md).TvShowsApi
TvShowsApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`TvShowsApi`**
## Table of contents
### Constructors
- [constructor](generated_client.TvShowsApi.md#constructor)
### Properties
- [axios](generated_client.TvShowsApi.md#axios)
- [basePath](generated_client.TvShowsApi.md#basepath)
- [configuration](generated_client.TvShowsApi.md#configuration)
### Methods
- [getEpisodes](generated_client.TvShowsApi.md#getepisodes)
- [getNextUp](generated_client.TvShowsApi.md#getnextup)
- [getSeasons](generated_client.TvShowsApi.md#getseasons)
- [getUpcomingEpisodes](generated_client.TvShowsApi.md#getupcomingepisodes)
## Constructors
### constructor
• **new TvShowsApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### getEpisodes
▸ **getEpisodes**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
**`summary`** Gets episodes for a tv season.
**`throws`** {RequiredError}
**`memberof`** TvShowsApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`TvShowsApiGetEpisodesRequest`](../interfaces/generated_client.TvShowsApiGetEpisodesRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
#### Defined in
[generated-client/api/tv-shows-api.ts:983](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L983)
___
### getNextUp
▸ **getNextUp**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
**`summary`** Gets a list of next up episodes.
**`throws`** {RequiredError}
**`memberof`** TvShowsApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`TvShowsApiGetNextUpRequest`](../interfaces/generated_client.TvShowsApiGetNextUpRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
#### Defined in
[generated-client/api/tv-shows-api.ts:995](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L995)
___
### getSeasons
▸ **getSeasons**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
**`summary`** Gets seasons for a tv series.
**`throws`** {RequiredError}
**`memberof`** TvShowsApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`TvShowsApiGetSeasonsRequest`](../interfaces/generated_client.TvShowsApiGetSeasonsRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
#### Defined in
[generated-client/api/tv-shows-api.ts:1007](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L1007)
___
### getUpcomingEpisodes
▸ **getUpcomingEpisodes**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
**`summary`** Gets a list of upcoming episodes.
**`throws`** {RequiredError}
**`memberof`** TvShowsApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`TvShowsApiGetUpcomingEpisodesRequest`](../interfaces/generated_client.TvShowsApiGetUpcomingEpisodesRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
#### Defined in
[generated-client/api/tv-shows-api.ts:1019](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/tv-shows-api.ts#L1019)

142
docs/classes/generated_client.UniversalAudioApi.md
View File

@ -1,142 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / UniversalAudioApi
# Class: UniversalAudioApi
[generated-client](../modules/generated_client.md).UniversalAudioApi
UniversalAudioApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`UniversalAudioApi`**
## Table of contents
### Constructors
- [constructor](generated_client.UniversalAudioApi.md#constructor)
### Properties
- [axios](generated_client.UniversalAudioApi.md#axios)
- [basePath](generated_client.UniversalAudioApi.md#basepath)
- [configuration](generated_client.UniversalAudioApi.md#configuration)
### Methods
- [getUniversalAudioStream](generated_client.UniversalAudioApi.md#getuniversalaudiostream)
- [headUniversalAudioStream](generated_client.UniversalAudioApi.md#headuniversalaudiostream)
## Constructors
### constructor
• **new UniversalAudioApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### getUniversalAudioStream
▸ **getUniversalAudioStream**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Gets an audio stream.
**`throws`** {RequiredError}
**`memberof`** UniversalAudioApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`UniversalAudioApiGetUniversalAudioStreamRequest`](../interfaces/generated_client.UniversalAudioApiGetUniversalAudioStreamRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/universal-audio-api.ts:687](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/universal-audio-api.ts#L687)
___
### headUniversalAudioStream
▸ **headUniversalAudioStream**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Gets an audio stream.
**`throws`** {RequiredError}
**`memberof`** UniversalAudioApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`UniversalAudioApiHeadUniversalAudioStreamRequest`](../interfaces/generated_client.UniversalAudioApiHeadUniversalAudioStreamRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/universal-audio-api.ts:699](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/universal-audio-api.ts#L699)

532
docs/classes/generated_client.UserApi.md
View File

@ -1,532 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / UserApi
# Class: UserApi
[generated-client](../modules/generated_client.md).UserApi
UserApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`UserApi`**
## Table of contents
### Constructors
- [constructor](generated_client.UserApi.md#constructor)
### Properties
- [axios](generated_client.UserApi.md#axios)
- [basePath](generated_client.UserApi.md#basepath)
- [configuration](generated_client.UserApi.md#configuration)
### Methods
- [authenticateUser](generated_client.UserApi.md#authenticateuser)
- [authenticateUserByName](generated_client.UserApi.md#authenticateuserbyname)
- [authenticateWithQuickConnect](generated_client.UserApi.md#authenticatewithquickconnect)
- [createUserByName](generated_client.UserApi.md#createuserbyname)
- [deleteUser](generated_client.UserApi.md#deleteuser)
- [forgotPassword](generated_client.UserApi.md#forgotpassword)
- [forgotPasswordPin](generated_client.UserApi.md#forgotpasswordpin)
- [getCurrentUser](generated_client.UserApi.md#getcurrentuser)
- [getPublicUsers](generated_client.UserApi.md#getpublicusers)
- [getUserById](generated_client.UserApi.md#getuserbyid)
- [getUsers](generated_client.UserApi.md#getusers)
- [updateUser](generated_client.UserApi.md#updateuser)
- [updateUserConfiguration](generated_client.UserApi.md#updateuserconfiguration)
- [updateUserEasyPassword](generated_client.UserApi.md#updateusereasypassword)
- [updateUserPassword](generated_client.UserApi.md#updateuserpassword)
- [updateUserPolicy](generated_client.UserApi.md#updateuserpolicy)
## Constructors
### constructor
• **new UserApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### authenticateUser
▸ **authenticateUser**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`AuthenticationResult`](../interfaces/generated_client.AuthenticationResult.md), `any`\>\>
**`summary`** Authenticates a user.
**`throws`** {RequiredError}
**`memberof`** UserApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`UserApiAuthenticateUserRequest`](../interfaces/generated_client.UserApiAuthenticateUserRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`AuthenticationResult`](../interfaces/generated_client.AuthenticationResult.md), `any`\>\>
#### Defined in
[generated-client/api/user-api.ts:1319](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1319)
___
### authenticateUserByName
▸ **authenticateUserByName**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`AuthenticationResult`](../interfaces/generated_client.AuthenticationResult.md), `any`\>\>
**`summary`** Authenticates a user by name.
**`throws`** {RequiredError}
**`memberof`** UserApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`UserApiAuthenticateUserByNameRequest`](../interfaces/generated_client.UserApiAuthenticateUserByNameRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`AuthenticationResult`](../interfaces/generated_client.AuthenticationResult.md), `any`\>\>
#### Defined in
[generated-client/api/user-api.ts:1331](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1331)
___
### authenticateWithQuickConnect
▸ **authenticateWithQuickConnect**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`AuthenticationResult`](../interfaces/generated_client.AuthenticationResult.md), `any`\>\>
**`summary`** Authenticates a user with quick connect.
**`throws`** {RequiredError}
**`memberof`** UserApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`UserApiAuthenticateWithQuickConnectRequest`](../interfaces/generated_client.UserApiAuthenticateWithQuickConnectRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`AuthenticationResult`](../interfaces/generated_client.AuthenticationResult.md), `any`\>\>
#### Defined in
[generated-client/api/user-api.ts:1343](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1343)
___
### createUserByName
▸ **createUserByName**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`UserDto`](../interfaces/generated_client.UserDto.md), `any`\>\>
**`summary`** Creates a user.
**`throws`** {RequiredError}
**`memberof`** UserApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`UserApiCreateUserByNameRequest`](../interfaces/generated_client.UserApiCreateUserByNameRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`UserDto`](../interfaces/generated_client.UserDto.md), `any`\>\>
#### Defined in
[generated-client/api/user-api.ts:1355](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1355)
___
### deleteUser
▸ **deleteUser**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Deletes a user.
**`throws`** {RequiredError}
**`memberof`** UserApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`UserApiDeleteUserRequest`](../interfaces/generated_client.UserApiDeleteUserRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/user-api.ts:1367](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1367)
___
### forgotPassword
▸ **forgotPassword**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`ForgotPasswordResult`](../interfaces/generated_client.ForgotPasswordResult.md), `any`\>\>
**`summary`** Initiates the forgot password process for a local user.
**`throws`** {RequiredError}
**`memberof`** UserApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`UserApiForgotPasswordRequest`](../interfaces/generated_client.UserApiForgotPasswordRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`ForgotPasswordResult`](../interfaces/generated_client.ForgotPasswordResult.md), `any`\>\>
#### Defined in
[generated-client/api/user-api.ts:1379](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1379)
___
### forgotPasswordPin
▸ **forgotPasswordPin**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`PinRedeemResult`](../interfaces/generated_client.PinRedeemResult.md), `any`\>\>
**`summary`** Redeems a forgot password pin.
**`throws`** {RequiredError}
**`memberof`** UserApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`UserApiForgotPasswordPinRequest`](../interfaces/generated_client.UserApiForgotPasswordPinRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`PinRedeemResult`](../interfaces/generated_client.PinRedeemResult.md), `any`\>\>
#### Defined in
[generated-client/api/user-api.ts:1391](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1391)
___
### getCurrentUser
▸ **getCurrentUser**(`options?`): `Promise`<`AxiosResponse`<[`UserDto`](../interfaces/generated_client.UserDto.md), `any`\>\>
**`summary`** Gets the user based on auth token.
**`throws`** {RequiredError}
**`memberof`** UserApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<[`UserDto`](../interfaces/generated_client.UserDto.md), `any`\>\>
#### Defined in
[generated-client/api/user-api.ts:1402](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1402)
___
### getPublicUsers
▸ **getPublicUsers**(`options?`): `Promise`<`AxiosResponse`<[`UserDto`](../interfaces/generated_client.UserDto.md)[], `any`\>\>
**`summary`** Gets a list of publicly visible users for display on a login screen.
**`throws`** {RequiredError}
**`memberof`** UserApi
#### Parameters
| Name | Type |
| :------ | :------ |
| `options?` | `any` |
#### Returns
`Promise`<`AxiosResponse`<[`UserDto`](../interfaces/generated_client.UserDto.md)[], `any`\>\>
#### Defined in
[generated-client/api/user-api.ts:1413](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1413)
___
### getUserById
▸ **getUserById**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`UserDto`](../interfaces/generated_client.UserDto.md), `any`\>\>
**`summary`** Gets a user by Id.
**`throws`** {RequiredError}
**`memberof`** UserApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`UserApiGetUserByIdRequest`](../interfaces/generated_client.UserApiGetUserByIdRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`UserDto`](../interfaces/generated_client.UserDto.md), `any`\>\>
#### Defined in
[generated-client/api/user-api.ts:1425](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1425)
___
### getUsers
▸ **getUsers**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`UserDto`](../interfaces/generated_client.UserDto.md)[], `any`\>\>
**`summary`** Gets a list of users.
**`throws`** {RequiredError}
**`memberof`** UserApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`UserApiGetUsersRequest`](../interfaces/generated_client.UserApiGetUsersRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`UserDto`](../interfaces/generated_client.UserDto.md)[], `any`\>\>
#### Defined in
[generated-client/api/user-api.ts:1437](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1437)
___
### updateUser
▸ **updateUser**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Updates a user.
**`throws`** {RequiredError}
**`memberof`** UserApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`UserApiUpdateUserRequest`](../interfaces/generated_client.UserApiUpdateUserRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/user-api.ts:1449](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1449)
___
### updateUserConfiguration
▸ **updateUserConfiguration**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Updates a user configuration.
**`throws`** {RequiredError}
**`memberof`** UserApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`UserApiUpdateUserConfigurationRequest`](../interfaces/generated_client.UserApiUpdateUserConfigurationRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/user-api.ts:1461](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1461)
___
### updateUserEasyPassword
▸ **updateUserEasyPassword**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Updates a user\'s easy password.
**`throws`** {RequiredError}
**`memberof`** UserApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`UserApiUpdateUserEasyPasswordRequest`](../interfaces/generated_client.UserApiUpdateUserEasyPasswordRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/user-api.ts:1473](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1473)
___
### updateUserPassword
▸ **updateUserPassword**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Updates a user\'s password.
**`throws`** {RequiredError}
**`memberof`** UserApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`UserApiUpdateUserPasswordRequest`](../interfaces/generated_client.UserApiUpdateUserPasswordRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/user-api.ts:1485](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1485)
___
### updateUserPolicy
▸ **updateUserPolicy**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Updates a user policy.
**`throws`** {RequiredError}
**`memberof`** UserApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`UserApiUpdateUserPolicyRequest`](../interfaces/generated_client.UserApiUpdateUserPolicyRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/user-api.ts:1497](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-api.ts#L1497)

366
docs/classes/generated_client.UserLibraryApi.md
View File

@ -1,366 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / UserLibraryApi
# Class: UserLibraryApi
[generated-client](../modules/generated_client.md).UserLibraryApi
UserLibraryApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`UserLibraryApi`**
## Table of contents
### Constructors
- [constructor](generated_client.UserLibraryApi.md#constructor)
### Properties
- [axios](generated_client.UserLibraryApi.md#axios)
- [basePath](generated_client.UserLibraryApi.md#basepath)
- [configuration](generated_client.UserLibraryApi.md#configuration)
### Methods
- [deleteUserItemRating](generated_client.UserLibraryApi.md#deleteuseritemrating)
- [getIntros](generated_client.UserLibraryApi.md#getintros)
- [getItem](generated_client.UserLibraryApi.md#getitem)
- [getLatestMedia](generated_client.UserLibraryApi.md#getlatestmedia)
- [getLocalTrailers](generated_client.UserLibraryApi.md#getlocaltrailers)
- [getRootFolder](generated_client.UserLibraryApi.md#getrootfolder)
- [getSpecialFeatures](generated_client.UserLibraryApi.md#getspecialfeatures)
- [markFavoriteItem](generated_client.UserLibraryApi.md#markfavoriteitem)
- [unmarkFavoriteItem](generated_client.UserLibraryApi.md#unmarkfavoriteitem)
- [updateUserItemRating](generated_client.UserLibraryApi.md#updateuseritemrating)
## Constructors
### constructor
• **new UserLibraryApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### deleteUserItemRating
▸ **deleteUserItemRating**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`UserItemDataDto`](../interfaces/generated_client.UserItemDataDto.md), `any`\>\>
**`summary`** Deletes a user\'s saved personal rating for an item.
**`throws`** {RequiredError}
**`memberof`** UserLibraryApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`UserLibraryApiDeleteUserItemRatingRequest`](../interfaces/generated_client.UserLibraryApiDeleteUserItemRatingRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`UserItemDataDto`](../interfaces/generated_client.UserItemDataDto.md), `any`\>\>
#### Defined in
[generated-client/api/user-library-api.ts:1057](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L1057)
___
### getIntros
▸ **getIntros**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
**`summary`** Gets intros to play before the main media item plays.
**`throws`** {RequiredError}
**`memberof`** UserLibraryApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`UserLibraryApiGetIntrosRequest`](../interfaces/generated_client.UserLibraryApiGetIntrosRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
#### Defined in
[generated-client/api/user-library-api.ts:1069](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L1069)
___
### getItem
▸ **getItem**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md), `any`\>\>
**`summary`** Gets an item from a user\'s library.
**`throws`** {RequiredError}
**`memberof`** UserLibraryApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`UserLibraryApiGetItemRequest`](../interfaces/generated_client.UserLibraryApiGetItemRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md), `any`\>\>
#### Defined in
[generated-client/api/user-library-api.ts:1081](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L1081)
___
### getLatestMedia
▸ **getLatestMedia**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)[], `any`\>\>
**`summary`** Gets latest media.
**`throws`** {RequiredError}
**`memberof`** UserLibraryApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`UserLibraryApiGetLatestMediaRequest`](../interfaces/generated_client.UserLibraryApiGetLatestMediaRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)[], `any`\>\>
#### Defined in
[generated-client/api/user-library-api.ts:1093](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L1093)
___
### getLocalTrailers
▸ **getLocalTrailers**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)[], `any`\>\>
**`summary`** Gets local trailers for an item.
**`throws`** {RequiredError}
**`memberof`** UserLibraryApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`UserLibraryApiGetLocalTrailersRequest`](../interfaces/generated_client.UserLibraryApiGetLocalTrailersRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)[], `any`\>\>
#### Defined in
[generated-client/api/user-library-api.ts:1105](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L1105)
___
### getRootFolder
▸ **getRootFolder**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md), `any`\>\>
**`summary`** Gets the root folder from a user\'s library.
**`throws`** {RequiredError}
**`memberof`** UserLibraryApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`UserLibraryApiGetRootFolderRequest`](../interfaces/generated_client.UserLibraryApiGetRootFolderRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md), `any`\>\>
#### Defined in
[generated-client/api/user-library-api.ts:1117](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L1117)
___
### getSpecialFeatures
▸ **getSpecialFeatures**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)[], `any`\>\>
**`summary`** Gets special features for an item.
**`throws`** {RequiredError}
**`memberof`** UserLibraryApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`UserLibraryApiGetSpecialFeaturesRequest`](../interfaces/generated_client.UserLibraryApiGetSpecialFeaturesRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)[], `any`\>\>
#### Defined in
[generated-client/api/user-library-api.ts:1129](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L1129)
___
### markFavoriteItem
▸ **markFavoriteItem**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`UserItemDataDto`](../interfaces/generated_client.UserItemDataDto.md), `any`\>\>
**`summary`** Marks an item as a favorite.
**`throws`** {RequiredError}
**`memberof`** UserLibraryApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`UserLibraryApiMarkFavoriteItemRequest`](../interfaces/generated_client.UserLibraryApiMarkFavoriteItemRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`UserItemDataDto`](../interfaces/generated_client.UserItemDataDto.md), `any`\>\>
#### Defined in
[generated-client/api/user-library-api.ts:1141](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L1141)
___
### unmarkFavoriteItem
▸ **unmarkFavoriteItem**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`UserItemDataDto`](../interfaces/generated_client.UserItemDataDto.md), `any`\>\>
**`summary`** Unmarks item as a favorite.
**`throws`** {RequiredError}
**`memberof`** UserLibraryApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`UserLibraryApiUnmarkFavoriteItemRequest`](../interfaces/generated_client.UserLibraryApiUnmarkFavoriteItemRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`UserItemDataDto`](../interfaces/generated_client.UserItemDataDto.md), `any`\>\>
#### Defined in
[generated-client/api/user-library-api.ts:1153](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L1153)
___
### updateUserItemRating
▸ **updateUserItemRating**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`UserItemDataDto`](../interfaces/generated_client.UserItemDataDto.md), `any`\>\>
**`summary`** Updates a user\'s rating for an item.
**`throws`** {RequiredError}
**`memberof`** UserLibraryApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`UserLibraryApiUpdateUserItemRatingRequest`](../interfaces/generated_client.UserLibraryApiUpdateUserItemRatingRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`UserItemDataDto`](../interfaces/generated_client.UserItemDataDto.md), `any`\>\>
#### Defined in
[generated-client/api/user-library-api.ts:1165](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-library-api.ts#L1165)

142
docs/classes/generated_client.UserViewsApi.md
View File

@ -1,142 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / UserViewsApi
# Class: UserViewsApi
[generated-client](../modules/generated_client.md).UserViewsApi
UserViewsApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`UserViewsApi`**
## Table of contents
### Constructors
- [constructor](generated_client.UserViewsApi.md#constructor)
### Properties
- [axios](generated_client.UserViewsApi.md#axios)
- [basePath](generated_client.UserViewsApi.md#basepath)
- [configuration](generated_client.UserViewsApi.md#configuration)
### Methods
- [getGroupingOptions](generated_client.UserViewsApi.md#getgroupingoptions)
- [getUserViews](generated_client.UserViewsApi.md#getuserviews)
## Constructors
### constructor
• **new UserViewsApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### getGroupingOptions
▸ **getGroupingOptions**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`SpecialViewOptionDto`](../interfaces/generated_client.SpecialViewOptionDto.md)[], `any`\>\>
**`summary`** Get user view grouping options.
**`throws`** {RequiredError}
**`memberof`** UserViewsApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`UserViewsApiGetGroupingOptionsRequest`](../interfaces/generated_client.UserViewsApiGetGroupingOptionsRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`SpecialViewOptionDto`](../interfaces/generated_client.SpecialViewOptionDto.md)[], `any`\>\>
#### Defined in
[generated-client/api/user-views-api.ts:259](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-views-api.ts#L259)
___
### getUserViews
▸ **getUserViews**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
**`summary`** Get user views.
**`throws`** {RequiredError}
**`memberof`** UserViewsApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`UserViewsApiGetUserViewsRequest`](../interfaces/generated_client.UserViewsApiGetUserViewsRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
#### Defined in
[generated-client/api/user-views-api.ts:271](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/user-views-api.ts#L271)

114
docs/classes/generated_client.VideoAttachmentsApi.md
View File

@ -1,114 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / VideoAttachmentsApi
# Class: VideoAttachmentsApi
[generated-client](../modules/generated_client.md).VideoAttachmentsApi
VideoAttachmentsApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`VideoAttachmentsApi`**
## Table of contents
### Constructors
- [constructor](generated_client.VideoAttachmentsApi.md#constructor)
### Properties
- [axios](generated_client.VideoAttachmentsApi.md#axios)
- [basePath](generated_client.VideoAttachmentsApi.md#basepath)
- [configuration](generated_client.VideoAttachmentsApi.md#configuration)
### Methods
- [getAttachment](generated_client.VideoAttachmentsApi.md#getattachment)
## Constructors
### constructor
• **new VideoAttachmentsApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### getAttachment
▸ **getAttachment**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Get video attachment.
**`throws`** {RequiredError}
**`memberof`** VideoAttachmentsApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`VideoAttachmentsApiGetAttachmentRequest`](../interfaces/generated_client.VideoAttachmentsApiGetAttachmentRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/video-attachments-api.ts:164](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/video-attachments-api.ts#L164)

282
docs/classes/generated_client.VideosApi.md
View File

@ -1,282 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / VideosApi
# Class: VideosApi
[generated-client](../modules/generated_client.md).VideosApi
VideosApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`VideosApi`**
## Table of contents
### Constructors
- [constructor](generated_client.VideosApi.md#constructor)
### Properties
- [axios](generated_client.VideosApi.md#axios)
- [basePath](generated_client.VideosApi.md#basepath)
- [configuration](generated_client.VideosApi.md#configuration)
### Methods
- [deleteAlternateSources](generated_client.VideosApi.md#deletealternatesources)
- [getAdditionalPart](generated_client.VideosApi.md#getadditionalpart)
- [getVideoStream](generated_client.VideosApi.md#getvideostream)
- [getVideoStreamByContainer](generated_client.VideosApi.md#getvideostreambycontainer)
- [headVideoStream](generated_client.VideosApi.md#headvideostream)
- [headVideoStreamByContainer](generated_client.VideosApi.md#headvideostreambycontainer)
- [mergeVersions](generated_client.VideosApi.md#mergeversions)
## Constructors
### constructor
• **new VideosApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### deleteAlternateSources
▸ **deleteAlternateSources**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Removes alternate video sources.
**`throws`** {RequiredError}
**`memberof`** VideosApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`VideosApiDeleteAlternateSourcesRequest`](../interfaces/generated_client.VideosApiDeleteAlternateSourcesRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/videos-api.ts:3382](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3382)
___
### getAdditionalPart
▸ **getAdditionalPart**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
**`summary`** Gets additional parts for a video.
**`throws`** {RequiredError}
**`memberof`** VideosApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`VideosApiGetAdditionalPartRequest`](../interfaces/generated_client.VideosApiGetAdditionalPartRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
#### Defined in
[generated-client/api/videos-api.ts:3394](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3394)
___
### getVideoStream
▸ **getVideoStream**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Gets a video stream.
**`throws`** {RequiredError}
**`memberof`** VideosApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`VideosApiGetVideoStreamRequest`](../interfaces/generated_client.VideosApiGetVideoStreamRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/videos-api.ts:3406](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3406)
___
### getVideoStreamByContainer
▸ **getVideoStreamByContainer**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Gets a video stream.
**`throws`** {RequiredError}
**`memberof`** VideosApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`VideosApiGetVideoStreamByContainerRequest`](../interfaces/generated_client.VideosApiGetVideoStreamByContainerRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/videos-api.ts:3418](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3418)
___
### headVideoStream
▸ **headVideoStream**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Gets a video stream.
**`throws`** {RequiredError}
**`memberof`** VideosApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`VideosApiHeadVideoStreamRequest`](../interfaces/generated_client.VideosApiHeadVideoStreamRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/videos-api.ts:3430](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3430)
___
### headVideoStreamByContainer
▸ **headVideoStreamByContainer**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\>
**`summary`** Gets a video stream.
**`throws`** {RequiredError}
**`memberof`** VideosApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`VideosApiHeadVideoStreamByContainerRequest`](../interfaces/generated_client.VideosApiHeadVideoStreamByContainerRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`any`, `any`\>\>
#### Defined in
[generated-client/api/videos-api.ts:3442](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3442)
___
### mergeVersions
▸ **mergeVersions**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\>
**`summary`** Merges videos into a single record.
**`throws`** {RequiredError}
**`memberof`** VideosApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`VideosApiMergeVersionsRequest`](../interfaces/generated_client.VideosApiMergeVersionsRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\>\>
#### Defined in
[generated-client/api/videos-api.ts:3454](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/videos-api.ts#L3454)

142
docs/classes/generated_client.YearsApi.md
View File

@ -1,142 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / YearsApi
# Class: YearsApi
[generated-client](../modules/generated_client.md).YearsApi
YearsApi - object-oriented interface
**`export`**
## Hierarchy
- `BaseAPI`
↳ **`YearsApi`**
## Table of contents
### Constructors
- [constructor](generated_client.YearsApi.md#constructor)
### Properties
- [axios](generated_client.YearsApi.md#axios)
- [basePath](generated_client.YearsApi.md#basepath)
- [configuration](generated_client.YearsApi.md#configuration)
### Methods
- [getYear](generated_client.YearsApi.md#getyear)
- [getYears](generated_client.YearsApi.md#getyears)
## Constructors
### constructor
• **new YearsApi**(`configuration?`, `basePath?`, `axios?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `configuration?` | [`Configuration`](generated_client.Configuration.md) | `undefined` |
| `basePath` | `string` | `BASE_PATH` |
| `axios` | `AxiosInstance` | `globalAxios` |
#### Inherited from
BaseAPI.constructor
#### Defined in
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)
## Properties
### axios
• `Protected` **axios**: `AxiosInstance` = `globalAxios`
#### Inherited from
BaseAPI.axios
___
### basePath
• `Protected` **basePath**: `string` = `BASE_PATH`
#### Inherited from
BaseAPI.basePath
___
### configuration
• `Protected` **configuration**: `undefined` \| [`Configuration`](generated_client.Configuration.md)
#### Inherited from
BaseAPI.configuration
#### Defined in
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)
## Methods
### getYear
▸ **getYear**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md), `any`\>\>
**`summary`** Gets a year.
**`throws`** {RequiredError}
**`memberof`** YearsApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`YearsApiGetYearRequest`](../interfaces/generated_client.YearsApiGetYearRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md), `any`\>\>
#### Defined in
[generated-client/api/years-api.ts:436](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/years-api.ts#L436)
___
### getYears
▸ **getYears**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
**`summary`** Get years.
**`throws`** {RequiredError}
**`memberof`** YearsApi
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requestParameters` | [`YearsApiGetYearsRequest`](../interfaces/generated_client.YearsApiGetYearsRequest.md) | Request parameters. |
| `options?` | `any` | - |
#### Returns
`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md), `any`\>\>
#### Defined in
[generated-client/api/years-api.ts:448](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/years-api.ts#L448)

195
docs/classes/index.Api.md
View File

@ -1,195 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [index](../modules/index.md) / Api
# Class: Api
[index](../modules/index.md).Api
Class representing the Jellyfin API.
## Table of contents
### Constructors
- [constructor](index.Api.md#constructor)
### Properties
- [accessToken](index.Api.md#accesstoken)
- [axiosInstance](index.Api.md#axiosinstance)
- [basePath](index.Api.md#basepath)
- [clientInfo](index.Api.md#clientinfo)
- [deviceInfo](index.Api.md#deviceinfo)
### Accessors
- [authorizationHeader](index.Api.md#authorizationheader)
- [configuration](index.Api.md#configuration)
### Methods
- [authenticateUserByName](index.Api.md#authenticateuserbyname)
- [getItemImageUrl](index.Api.md#getitemimageurl)
- [logout](index.Api.md#logout)
## Constructors
### constructor
• **new Api**(`basePath`, `clientInfo`, `deviceInfo`, `accessToken?`, `axiosInstance?`)
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `basePath` | `string` | `undefined` |
| `clientInfo` | [`ClientInfo`](../interfaces/index.ClientInfo.md) | `undefined` |
| `deviceInfo` | [`DeviceInfo`](../interfaces/index.DeviceInfo.md) | `undefined` |
| `accessToken` | `string` | `''` |
| `axiosInstance` | `AxiosInstance` | `globalInstance` |
#### Defined in
[api.ts:33](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/api.ts#L33)
## Properties
### accessToken
• **accessToken**: `string`
#### Defined in
[api.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/api.ts#L30)
___
### axiosInstance
• **axiosInstance**: `AxiosInstance`
#### Defined in
[api.ts:31](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/api.ts#L31)
___
### basePath
• **basePath**: `string`
#### Defined in
[api.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/api.ts#L27)
___
### clientInfo
• **clientInfo**: [`ClientInfo`](../interfaces/index.ClientInfo.md)
#### Defined in
[api.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/api.ts#L28)
___
### deviceInfo
• **deviceInfo**: [`DeviceInfo`](../interfaces/index.DeviceInfo.md)
#### Defined in
[api.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/api.ts#L29)
## Accessors
### authorizationHeader
• `get` **authorizationHeader**(): `string`
#### Returns
`string`
#### Defined in
[api.ts:100](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/api.ts#L100)
___
### configuration
• `get` **configuration**(): [`Configuration`](generated_client.Configuration.md)
#### Returns
[`Configuration`](generated_client.Configuration.md)
#### Defined in
[api.ts:47](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/api.ts#L47)
## Methods
### authenticateUserByName
▸ **authenticateUserByName**(`username`, `password?`): `Promise`<`AxiosResponse`<[`AuthenticationResult`](../interfaces/generated_client.AuthenticationResult.md), `any`\>\>
Convenience method for authenticating a user by name and updating the internal state.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `username` | `string` | The username. |
| `password?` | `string` | The user password if required. |
#### Returns
`Promise`<`AxiosResponse`<[`AuthenticationResult`](../interfaces/generated_client.AuthenticationResult.md), `any`\>\>
#### Defined in
[api.ts:59](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/api.ts#L59)
___
### getItemImageUrl
▸ **getItemImageUrl**(`itemId`, `imageType?`, `params?`): `undefined` \| `string`
Get an item image URL.
#### Parameters
| Name | Type | Default value | Description |
| :------ | :------ | :------ | :------ |
| `itemId` | `string` | `undefined` | The Item ID. |
| `imageType` | [`ImageType`](../enums/generated_client.ImageType.md) | `ImageType.Primary` | An optional Image Type (Primary by default). |
| `params` | `ImageRequestParameters` | `{}` | Additional request parameters. |
#### Returns
`undefined` \| `string`
The image URL.
#### Defined in
[api.ts:89](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/api.ts#L89)
___
### logout
▸ **logout**(): `Promise`<`AxiosResponse`<`void`, `any`\> \| `AxiosResponse`<`never`, `any`\>\>
Convenience method for logging out and updating the internal state.
#### Returns
`Promise`<`AxiosResponse`<`void`, `any`\> \| `AxiosResponse`<`never`, `any`\>\>
#### Defined in
[api.ts:75](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/api.ts#L75)

95
docs/classes/index.Jellyfin.md
View File

@ -1,95 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [index](../modules/index.md) / Jellyfin
# Class: Jellyfin
[index](../modules/index.md).Jellyfin
Class representing the Jellyfin SDK.
## Table of contents
### Constructors
- [constructor](index.Jellyfin.md#constructor)
### Properties
- [clientInfo](index.Jellyfin.md#clientinfo)
- [deviceInfo](index.Jellyfin.md#deviceinfo)
- [discovery](index.Jellyfin.md#discovery)
### Methods
- [createApi](index.Jellyfin.md#createapi)
## Constructors
### constructor
• **new Jellyfin**(`parameters`)
#### Parameters
| Name | Type |
| :------ | :------ |
| `parameters` | [`JellyfinParameters`](../interfaces/index.JellyfinParameters.md) |
#### Defined in
[jellyfin.ts:32](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/jellyfin.ts#L32)
## Properties
### clientInfo
• **clientInfo**: [`ClientInfo`](../interfaces/index.ClientInfo.md)
#### Defined in
[jellyfin.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/jellyfin.ts#L28)
___
### deviceInfo
• **deviceInfo**: [`DeviceInfo`](../interfaces/index.DeviceInfo.md)
#### Defined in
[jellyfin.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/jellyfin.ts#L29)
___
### discovery
• **discovery**: [`DiscoveryService`](index.discovery.DiscoveryService.md)
#### Defined in
[jellyfin.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/jellyfin.ts#L30)
## Methods
### createApi
▸ **createApi**(`basePath`, `accessToken?`, `axiosInstance?`): [`Api`](index.Api.md)
Creates an Api instance for a given server path.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `basePath` | `string` | A base path of a server. |
| `accessToken?` | `string` | An (optional) access token to use for authentication. |
| `axiosInstance?` | `AxiosInstance` | An (optional) Axios instance for the Api to use. |
#### Returns
[`Api`](index.Api.md)
An Api instance.
#### Defined in
[jellyfin.ts:45](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/jellyfin.ts#L45)

55
docs/classes/index.ProductNameIssue.md
View File

@ -1,55 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [index](../modules/index.md) / ProductNameIssue
# Class: ProductNameIssue
[index](../modules/index.md).ProductNameIssue
Class representing an issue with the returned product name.
## Hierarchy
- [`RecommendedServerIssue`](index.RecommendedServerIssue.md)
↳ **`ProductNameIssue`**
## Table of contents
### Constructors
- [constructor](index.ProductNameIssue.md#constructor)
### Properties
- [productName](index.ProductNameIssue.md#productname)
## Constructors
### constructor
• **new ProductNameIssue**(`productName?`)
#### Parameters
| Name | Type |
| :------ | :------ |
| `productName?` | ``null`` \| `string` |
#### Overrides
[RecommendedServerIssue](index.RecommendedServerIssue.md).[constructor](index.RecommendedServerIssue.md#constructor)
#### Defined in
[models/recommended-server-issue.ts:15](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/models/recommended-server-issue.ts#L15)
## Properties
### productName
• **productName**: `undefined` \| ``null`` \| `string`
The product name returned in the system information.
#### Defined in
[models/recommended-server-issue.ts:13](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/models/recommended-server-issue.ts#L13)

35
docs/classes/index.RecommendedServerIssue.md
View File

@ -1,35 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [index](../modules/index.md) / RecommendedServerIssue
# Class: RecommendedServerIssue
[index](../modules/index.md).RecommendedServerIssue
Class representing an issue encountered with a recommended server.
## Hierarchy
- **`RecommendedServerIssue`**
↳ [`ProductNameIssue`](index.ProductNameIssue.md)
↳ [`SlowResponseIssue`](index.SlowResponseIssue.md)
↳ [`SystemInfoIssue`](index.SystemInfoIssue.md)
↳ [`VersionMissingIssue`](index.VersionMissingIssue.md)
↳ [`VersionOutdatedIssue`](index.VersionOutdatedIssue.md)
↳ [`VersionUnsupportedIssue`](index.VersionUnsupportedIssue.md)
## Table of contents
### Constructors
- [constructor](index.RecommendedServerIssue.md#constructor)
## Constructors
### constructor
• **new RecommendedServerIssue**()

55
docs/classes/index.SlowResponseIssue.md
View File

@ -1,55 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [index](../modules/index.md) / SlowResponseIssue
# Class: SlowResponseIssue
[index](../modules/index.md).SlowResponseIssue
Class representing a slow response from a server.
## Hierarchy
- [`RecommendedServerIssue`](index.RecommendedServerIssue.md)
↳ **`SlowResponseIssue`**
## Table of contents
### Constructors
- [constructor](index.SlowResponseIssue.md#constructor)
### Properties
- [responseTime](index.SlowResponseIssue.md#responsetime)
## Constructors
### constructor
• **new SlowResponseIssue**(`responseTime`)
#### Parameters
| Name | Type |
| :------ | :------ |
| `responseTime` | `number` |
#### Overrides
[RecommendedServerIssue](index.RecommendedServerIssue.md).[constructor](index.RecommendedServerIssue.md#constructor)
#### Defined in
[models/recommended-server-issue.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/models/recommended-server-issue.ts#L26)
## Properties
### responseTime
• **responseTime**: `number`
The response time from the server.
#### Defined in
[models/recommended-server-issue.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/models/recommended-server-issue.ts#L24)

56
docs/classes/index.SystemInfoIssue.md
View File

@ -1,56 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [index](../modules/index.md) / SystemInfoIssue
# Class: SystemInfoIssue
[index](../modules/index.md).SystemInfoIssue
Class representing an issue with the system information.
This could be due to a networking error or invalid address.
## Hierarchy
- [`RecommendedServerIssue`](index.RecommendedServerIssue.md)
↳ **`SystemInfoIssue`**
## Table of contents
### Constructors
- [constructor](index.SystemInfoIssue.md#constructor)
### Properties
- [error](index.SystemInfoIssue.md#error)
## Constructors
### constructor
• **new SystemInfoIssue**(`error?`)
#### Parameters
| Name | Type |
| :------ | :------ |
| `error?` | `Error` |
#### Overrides
[RecommendedServerIssue](index.RecommendedServerIssue.md).[constructor](index.RecommendedServerIssue.md#constructor)
#### Defined in
[models/recommended-server-issue.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/models/recommended-server-issue.ts#L40)
## Properties
### error
• **error**: `undefined` \| `Error`
The error generated by the request.
#### Defined in
[models/recommended-server-issue.ts:38](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/models/recommended-server-issue.ts#L38)

29
docs/classes/index.VersionMissingIssue.md
View File

@ -1,29 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [index](../modules/index.md) / VersionMissingIssue
# Class: VersionMissingIssue
[index](../modules/index.md).VersionMissingIssue
Class representing the version was missing from system information.
## Hierarchy
- [`RecommendedServerIssue`](index.RecommendedServerIssue.md)
↳ **`VersionMissingIssue`**
## Table of contents
### Constructors
- [constructor](index.VersionMissingIssue.md#constructor)
## Constructors
### constructor
• **new VersionMissingIssue**()
#### Inherited from
[RecommendedServerIssue](index.RecommendedServerIssue.md).[constructor](index.RecommendedServerIssue.md#constructor)

54
docs/classes/index.VersionOutdatedIssue.md
View File

@ -1,54 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [index](../modules/index.md) / VersionOutdatedIssue
# Class: VersionOutdatedIssue
[index](../modules/index.md).VersionOutdatedIssue
Class representing the server version is outdated.
(The version is lower than the generated client, but higher than the minimum supported.)
## Hierarchy
- [`RecommendedServerIssue`](index.RecommendedServerIssue.md)
↳ **`VersionOutdatedIssue`**
## Table of contents
### Constructors
- [constructor](index.VersionOutdatedIssue.md#constructor)
### Properties
- [version](index.VersionOutdatedIssue.md#version)
## Constructors
### constructor
• **new VersionOutdatedIssue**(`version`)
#### Parameters
| Name | Type |
| :------ | :------ |
| `version` | `string` |
#### Overrides
[RecommendedServerIssue](index.RecommendedServerIssue.md).[constructor](index.RecommendedServerIssue.md#constructor)
#### Defined in
[models/recommended-server-issue.ts:56](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/models/recommended-server-issue.ts#L56)
## Properties
### version
• **version**: `string`
#### Defined in
[models/recommended-server-issue.ts:54](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/models/recommended-server-issue.ts#L54)

54
docs/classes/index.VersionUnsupportedIssue.md
View File

@ -1,54 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [index](../modules/index.md) / VersionUnsupportedIssue
# Class: VersionUnsupportedIssue
[index](../modules/index.md).VersionUnsupportedIssue
Class representing the server version is unsupported.
(The version is lower than the minimum supported.)
## Hierarchy
- [`RecommendedServerIssue`](index.RecommendedServerIssue.md)
↳ **`VersionUnsupportedIssue`**
## Table of contents
### Constructors
- [constructor](index.VersionUnsupportedIssue.md#constructor)
### Properties
- [version](index.VersionUnsupportedIssue.md#version)
## Constructors
### constructor
• **new VersionUnsupportedIssue**(`version`)
#### Parameters
| Name | Type |
| :------ | :------ |
| `version` | `string` |
#### Overrides
[RecommendedServerIssue](index.RecommendedServerIssue.md).[constructor](index.RecommendedServerIssue.md#constructor)
#### Defined in
[models/recommended-server-issue.ts:69](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/models/recommended-server-issue.ts#L69)
## Properties
### version
• **version**: `string`
#### Defined in
[models/recommended-server-issue.ts:67](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/models/recommended-server-issue.ts#L67)

162
docs/classes/index.discovery.DiscoveryService.md
View File

@ -1,162 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [index](../modules/index.md) / [discovery](../modules/index.discovery.md) / DiscoveryService
# Class: DiscoveryService
[index](../modules/index.md).[discovery](../modules/index.discovery.md).DiscoveryService
Class used for discovering recommended servers.
## Table of contents
### Constructors
- [constructor](index.discovery.DiscoveryService.md#constructor)
### Properties
- [jellyfin](index.discovery.DiscoveryService.md#jellyfin)
- [recommendedServerDiscovery](index.discovery.DiscoveryService.md#recommendedserverdiscovery)
### Methods
- [findBestServer](index.discovery.DiscoveryService.md#findbestserver)
- [getAddressCandidates](index.discovery.DiscoveryService.md#getaddresscandidates)
- [getRecommendedServerCandidates](index.discovery.DiscoveryService.md#getrecommendedservercandidates)
- [getRecommendedServers](index.discovery.DiscoveryService.md#getrecommendedservers)
## Constructors
### constructor
• **new DiscoveryService**(`jellyfin`)
#### Parameters
| Name | Type |
| :------ | :------ |
| `jellyfin` | [`Jellyfin`](index.Jellyfin.md) |
#### Defined in
[discovery/discovery-service.ts:18](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/discovery/discovery-service.ts#L18)
## Properties
### jellyfin
• `Private` **jellyfin**: [`Jellyfin`](index.Jellyfin.md)
#### Defined in
[discovery/discovery-service.ts:15](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/discovery/discovery-service.ts#L15)
___
### recommendedServerDiscovery
• `Private` **recommendedServerDiscovery**: [`RecommendedServerDiscovery`](index.discovery.RecommendedServerDiscovery.md)
#### Defined in
[discovery/discovery-service.ts:16](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/discovery/discovery-service.ts#L16)
## Methods
### findBestServer
▸ **findBestServer**(`servers`): `undefined` \| [`RecommendedServerInfo`](../interfaces/index.RecommendedServerInfo.md)
Finds the best server from a list of recommended servers by score.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `servers` | [`RecommendedServerInfo`](../interfaces/index.RecommendedServerInfo.md)[] | A list of recommended servers. |
#### Returns
`undefined` \| [`RecommendedServerInfo`](../interfaces/index.RecommendedServerInfo.md)
The best scoring recommended server.
#### Defined in
[discovery/discovery-service.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/discovery/discovery-service.ts#L28)
___
### getAddressCandidates
▸ **getAddressCandidates**(`input`): `string`[]
Gets a list of address candidates url strings
from a provided url address string.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `input` | `string` | A server url address string. |
#### Returns
`string`[]
A list of potential server addresses.
#### Defined in
[discovery/discovery-service.ts:49](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/discovery/discovery-service.ts#L49)
___
### getRecommendedServerCandidates
▸ **getRecommendedServerCandidates**(`input`, `minimumScore?`): `Promise`<[`RecommendedServerInfo`](../interfaces/index.RecommendedServerInfo.md)[]\>
Gets a list of recommended server information from the address
candidates of a potential server address.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `input` | `string` | A potential server address. |
| `minimumScore?` | [`RecommendedServerInfoScore`](../enums/index.RecommendedServerInfoScore.md) | The minimum server score to include in the results. |
#### Returns
`Promise`<[`RecommendedServerInfo`](../interfaces/index.RecommendedServerInfo.md)[]\>
A list of RecommendedServerInfo from the address candidates.
#### Defined in
[discovery/discovery-service.ts:74](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/discovery/discovery-service.ts#L74)
___
### getRecommendedServers
▸ **getRecommendedServers**(`servers`, `minimumScore?`): `Promise`<[`RecommendedServerInfo`](../interfaces/index.RecommendedServerInfo.md)[]\>
Gets a list of recommended server information from a provided
list of possible server addresses.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `servers` | `string`[] | A list of possible server addresses. |
| `minimumScore?` | [`RecommendedServerInfoScore`](../enums/index.RecommendedServerInfoScore.md) | The minimum server score to include in the results. |
#### Returns
`Promise`<[`RecommendedServerInfo`](../interfaces/index.RecommendedServerInfo.md)[]\>
A list of RecommendedServerInfo from the possible server addresses.
#### Defined in
[discovery/discovery-service.ts:60](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/discovery/discovery-service.ts#L60)

97
docs/classes/index.discovery.RecommendedServerDiscovery.md
View File

@ -1,97 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [index](../modules/index.md) / [discovery](../modules/index.discovery.md) / RecommendedServerDiscovery
# Class: RecommendedServerDiscovery
[index](../modules/index.md).[discovery](../modules/index.discovery.md).RecommendedServerDiscovery
Class to discover and evaluate potential servers.
## Table of contents
### Constructors
- [constructor](index.discovery.RecommendedServerDiscovery.md#constructor)
### Properties
- [jellyfin](index.discovery.RecommendedServerDiscovery.md#jellyfin)
### Methods
- [discover](index.discovery.RecommendedServerDiscovery.md#discover)
- [fetchRecommendedServerInfo](index.discovery.RecommendedServerDiscovery.md#fetchrecommendedserverinfo)
## Constructors
### constructor
• **new RecommendedServerDiscovery**(`jellyfin`)
#### Parameters
| Name | Type |
| :------ | :------ |
| `jellyfin` | [`Jellyfin`](index.Jellyfin.md) |
#### Defined in
[discovery/recommended-server-discovery.ts:83](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/discovery/recommended-server-discovery.ts#L83)
## Properties
### jellyfin
• `Private` **jellyfin**: [`Jellyfin`](index.Jellyfin.md)
#### Defined in
[discovery/recommended-server-discovery.ts:81](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/discovery/recommended-server-discovery.ts#L81)
## Methods
### discover
▸ **discover**(`servers`, `minimumScore?`): `Promise`<[`RecommendedServerInfo`](../interfaces/index.RecommendedServerInfo.md)[]\>
Fetches the RecommendedServerInfo for multiple server addresses.
#### Parameters
| Name | Type | Default value | Description |
| :------ | :------ | :------ | :------ |
| `servers` | `string`[] | `undefined` | An array of server addresses. |
| `minimumScore` | [`RecommendedServerInfoScore`](../enums/index.RecommendedServerInfoScore.md) | `RecommendedServerInfoScore.BAD` | - |
#### Returns
`Promise`<[`RecommendedServerInfo`](../interfaces/index.RecommendedServerInfo.md)[]\>
The RecommendedServerInfo for each address.
#### Defined in
[discovery/recommended-server-discovery.ts:115](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/discovery/recommended-server-discovery.ts#L115)
___
### fetchRecommendedServerInfo
▸ **fetchRecommendedServerInfo**(`address`): `Promise`<[`RecommendedServerInfo`](../interfaces/index.RecommendedServerInfo.md)\>
Fetches the RecommendedServerInfo for a single server address.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `address` | `string` | The server address. |
#### Returns
`Promise`<[`RecommendedServerInfo`](../interfaces/index.RecommendedServerInfo.md)\>
The resulting RecommendedServerInfo.
#### Defined in
[discovery/recommended-server-discovery.ts:92](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/discovery/recommended-server-discovery.ts#L92)

78
docs/enums/generated_client.Architecture.md
View File

@ -1,78 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / Architecture
# Enumeration: Architecture
[generated-client](../modules/generated_client.md).Architecture
**`export`**
## Table of contents
### Enumeration Members
- [Arm](generated_client.Architecture.md#arm)
- [Arm64](generated_client.Architecture.md#arm64)
- [S390x](generated_client.Architecture.md#s390x)
- [Wasm](generated_client.Architecture.md#wasm)
- [X64](generated_client.Architecture.md#x64)
- [X86](generated_client.Architecture.md#x86)
## Enumeration Members
### Arm
• **Arm**
#### Defined in
[generated-client/models/architecture.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/architecture.ts#L26)
___
### Arm64
• **Arm64**
#### Defined in
[generated-client/models/architecture.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/architecture.ts#L27)
___
### S390x
• **S390x**
#### Defined in
[generated-client/models/architecture.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/architecture.ts#L29)
___
### Wasm
• **Wasm**
#### Defined in
[generated-client/models/architecture.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/architecture.ts#L28)
___
### X64
• **X64**
#### Defined in
[generated-client/models/architecture.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/architecture.ts#L25)
___
### X86
• **X86**
#### Defined in
[generated-client/models/architecture.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/architecture.ts#L24)

421
docs/enums/generated_client.BaseItemKind.md
View File

@ -1,421 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / BaseItemKind
# Enumeration: BaseItemKind
[generated-client](../modules/generated_client.md).BaseItemKind
The base item kind.
**`export`**
## Table of contents
### Enumeration Members
- [AggregateFolder](generated_client.BaseItemKind.md#aggregatefolder)
- [Audio](generated_client.BaseItemKind.md#audio)
- [AudioBook](generated_client.BaseItemKind.md#audiobook)
- [BasePluginFolder](generated_client.BaseItemKind.md#basepluginfolder)
- [Book](generated_client.BaseItemKind.md#book)
- [BoxSet](generated_client.BaseItemKind.md#boxset)
- [Channel](generated_client.BaseItemKind.md#channel)
- [ChannelFolderItem](generated_client.BaseItemKind.md#channelfolderitem)
- [CollectionFolder](generated_client.BaseItemKind.md#collectionfolder)
- [Episode](generated_client.BaseItemKind.md#episode)
- [Folder](generated_client.BaseItemKind.md#folder)
- [Genre](generated_client.BaseItemKind.md#genre)
- [LiveTvChannel](generated_client.BaseItemKind.md#livetvchannel)
- [LiveTvProgram](generated_client.BaseItemKind.md#livetvprogram)
- [ManualPlaylistsFolder](generated_client.BaseItemKind.md#manualplaylistsfolder)
- [Movie](generated_client.BaseItemKind.md#movie)
- [MusicAlbum](generated_client.BaseItemKind.md#musicalbum)
- [MusicArtist](generated_client.BaseItemKind.md#musicartist)
- [MusicGenre](generated_client.BaseItemKind.md#musicgenre)
- [MusicVideo](generated_client.BaseItemKind.md#musicvideo)
- [Person](generated_client.BaseItemKind.md#person)
- [Photo](generated_client.BaseItemKind.md#photo)
- [PhotoAlbum](generated_client.BaseItemKind.md#photoalbum)
- [Playlist](generated_client.BaseItemKind.md#playlist)
- [PlaylistsFolder](generated_client.BaseItemKind.md#playlistsfolder)
- [Program](generated_client.BaseItemKind.md#program)
- [Recording](generated_client.BaseItemKind.md#recording)
- [Season](generated_client.BaseItemKind.md#season)
- [Series](generated_client.BaseItemKind.md#series)
- [Studio](generated_client.BaseItemKind.md#studio)
- [Trailer](generated_client.BaseItemKind.md#trailer)
- [TvChannel](generated_client.BaseItemKind.md#tvchannel)
- [TvProgram](generated_client.BaseItemKind.md#tvprogram)
- [UserRootFolder](generated_client.BaseItemKind.md#userrootfolder)
- [UserView](generated_client.BaseItemKind.md#userview)
- [Video](generated_client.BaseItemKind.md#video)
- [Year](generated_client.BaseItemKind.md#year)
## Enumeration Members
### AggregateFolder
• **AggregateFolder**
#### Defined in
[generated-client/models/base-item-kind.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L24)
___
### Audio
• **Audio**
#### Defined in
[generated-client/models/base-item-kind.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L25)
___
### AudioBook
• **AudioBook**
#### Defined in
[generated-client/models/base-item-kind.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L26)
___
### BasePluginFolder
• **BasePluginFolder**
#### Defined in
[generated-client/models/base-item-kind.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L27)
___
### Book
• **Book**
#### Defined in
[generated-client/models/base-item-kind.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L28)
___
### BoxSet
• **BoxSet**
#### Defined in
[generated-client/models/base-item-kind.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L29)
___
### Channel
• **Channel**
#### Defined in
[generated-client/models/base-item-kind.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L30)
___
### ChannelFolderItem
• **ChannelFolderItem**
#### Defined in
[generated-client/models/base-item-kind.ts:31](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L31)
___
### CollectionFolder
• **CollectionFolder**
#### Defined in
[generated-client/models/base-item-kind.ts:32](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L32)
___
### Episode
• **Episode**
#### Defined in
[generated-client/models/base-item-kind.ts:33](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L33)
___
### Folder
• **Folder**
#### Defined in
[generated-client/models/base-item-kind.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L34)
___
### Genre
• **Genre**
#### Defined in
[generated-client/models/base-item-kind.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L35)
___
### LiveTvChannel
• **LiveTvChannel**
#### Defined in
[generated-client/models/base-item-kind.ts:38](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L38)
___
### LiveTvProgram
• **LiveTvProgram**
#### Defined in
[generated-client/models/base-item-kind.ts:39](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L39)
___
### ManualPlaylistsFolder
• **ManualPlaylistsFolder**
#### Defined in
[generated-client/models/base-item-kind.ts:36](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L36)
___
### Movie
• **Movie**
#### Defined in
[generated-client/models/base-item-kind.ts:37](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L37)
___
### MusicAlbum
• **MusicAlbum**
#### Defined in
[generated-client/models/base-item-kind.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L40)
___
### MusicArtist
• **MusicArtist**
#### Defined in
[generated-client/models/base-item-kind.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L41)
___
### MusicGenre
• **MusicGenre**
#### Defined in
[generated-client/models/base-item-kind.ts:42](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L42)
___
### MusicVideo
• **MusicVideo**
#### Defined in
[generated-client/models/base-item-kind.ts:43](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L43)
___
### Person
• **Person**
#### Defined in
[generated-client/models/base-item-kind.ts:44](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L44)
___
### Photo
• **Photo**
#### Defined in
[generated-client/models/base-item-kind.ts:45](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L45)
___
### PhotoAlbum
• **PhotoAlbum**
#### Defined in
[generated-client/models/base-item-kind.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L46)
___
### Playlist
• **Playlist**
#### Defined in
[generated-client/models/base-item-kind.ts:47](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L47)
___
### PlaylistsFolder
• **PlaylistsFolder**
#### Defined in
[generated-client/models/base-item-kind.ts:48](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L48)
___
### Program
• **Program**
#### Defined in
[generated-client/models/base-item-kind.ts:49](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L49)
___
### Recording
• **Recording**
#### Defined in
[generated-client/models/base-item-kind.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L50)
___
### Season
• **Season**
#### Defined in
[generated-client/models/base-item-kind.ts:51](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L51)
___
### Series
• **Series**
#### Defined in
[generated-client/models/base-item-kind.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L52)
___
### Studio
• **Studio**
#### Defined in
[generated-client/models/base-item-kind.ts:53](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L53)
___
### Trailer
• **Trailer**
#### Defined in
[generated-client/models/base-item-kind.ts:54](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L54)
___
### TvChannel
• **TvChannel**
#### Defined in
[generated-client/models/base-item-kind.ts:55](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L55)
___
### TvProgram
• **TvProgram**
#### Defined in
[generated-client/models/base-item-kind.ts:56](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L56)
___
### UserRootFolder
• **UserRootFolder**
#### Defined in
[generated-client/models/base-item-kind.ts:57](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L57)
___
### UserView
• **UserView**
#### Defined in
[generated-client/models/base-item-kind.ts:58](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L58)
___
### Video
• **Video**
#### Defined in
[generated-client/models/base-item-kind.ts:59](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L59)
___
### Year
• **Year**
#### Defined in
[generated-client/models/base-item-kind.ts:60](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/base-item-kind.ts#L60)

89
docs/enums/generated_client.ChannelItemSortField.md
View File

@ -1,89 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ChannelItemSortField
# Enumeration: ChannelItemSortField
[generated-client](../modules/generated_client.md).ChannelItemSortField
**`export`**
## Table of contents
### Enumeration Members
- [CommunityPlayCount](generated_client.ChannelItemSortField.md#communityplaycount)
- [CommunityRating](generated_client.ChannelItemSortField.md#communityrating)
- [DateCreated](generated_client.ChannelItemSortField.md#datecreated)
- [Name](generated_client.ChannelItemSortField.md#name)
- [PlayCount](generated_client.ChannelItemSortField.md#playcount)
- [PremiereDate](generated_client.ChannelItemSortField.md#premieredate)
- [Runtime](generated_client.ChannelItemSortField.md#runtime)
## Enumeration Members
### CommunityPlayCount
• **CommunityPlayCount**
#### Defined in
[generated-client/models/channel-item-sort-field.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-item-sort-field.ts#L30)
___
### CommunityRating
• **CommunityRating**
#### Defined in
[generated-client/models/channel-item-sort-field.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-item-sort-field.ts#L25)
___
### DateCreated
• **DateCreated**
#### Defined in
[generated-client/models/channel-item-sort-field.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-item-sort-field.ts#L27)
___
### Name
• **Name**
#### Defined in
[generated-client/models/channel-item-sort-field.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-item-sort-field.ts#L24)
___
### PlayCount
• **PlayCount**
#### Defined in
[generated-client/models/channel-item-sort-field.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-item-sort-field.ts#L29)
___
### PremiereDate
• **PremiereDate**
#### Defined in
[generated-client/models/channel-item-sort-field.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-item-sort-field.ts#L26)
___
### Runtime
• **Runtime**
#### Defined in
[generated-client/models/channel-item-sort-field.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-item-sort-field.ts#L28)

100
docs/enums/generated_client.ChannelMediaContentType.md
View File

@ -1,100 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ChannelMediaContentType
# Enumeration: ChannelMediaContentType
[generated-client](../modules/generated_client.md).ChannelMediaContentType
**`export`**
## Table of contents
### Enumeration Members
- [Clip](generated_client.ChannelMediaContentType.md#clip)
- [Episode](generated_client.ChannelMediaContentType.md#episode)
- [Movie](generated_client.ChannelMediaContentType.md#movie)
- [MovieExtra](generated_client.ChannelMediaContentType.md#movieextra)
- [Podcast](generated_client.ChannelMediaContentType.md#podcast)
- [Song](generated_client.ChannelMediaContentType.md#song)
- [Trailer](generated_client.ChannelMediaContentType.md#trailer)
- [TvExtra](generated_client.ChannelMediaContentType.md#tvextra)
## Enumeration Members
### Clip
• **Clip**
#### Defined in
[generated-client/models/channel-media-content-type.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-media-content-type.ts#L24)
___
### Episode
• **Episode**
#### Defined in
[generated-client/models/channel-media-content-type.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-media-content-type.ts#L28)
___
### Movie
• **Movie**
#### Defined in
[generated-client/models/channel-media-content-type.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-media-content-type.ts#L27)
___
### MovieExtra
• **MovieExtra**
#### Defined in
[generated-client/models/channel-media-content-type.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-media-content-type.ts#L30)
___
### Podcast
• **Podcast**
#### Defined in
[generated-client/models/channel-media-content-type.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-media-content-type.ts#L25)
___
### Song
• **Song**
#### Defined in
[generated-client/models/channel-media-content-type.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-media-content-type.ts#L29)
___
### Trailer
• **Trailer**
#### Defined in
[generated-client/models/channel-media-content-type.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-media-content-type.ts#L26)
___
### TvExtra
• **TvExtra**
#### Defined in
[generated-client/models/channel-media-content-type.ts:31](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-media-content-type.ts#L31)

45
docs/enums/generated_client.ChannelMediaType.md
View File

@ -1,45 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ChannelMediaType
# Enumeration: ChannelMediaType
[generated-client](../modules/generated_client.md).ChannelMediaType
**`export`**
## Table of contents
### Enumeration Members
- [Audio](generated_client.ChannelMediaType.md#audio)
- [Photo](generated_client.ChannelMediaType.md#photo)
- [Video](generated_client.ChannelMediaType.md#video)
## Enumeration Members
### Audio
• **Audio**
#### Defined in
[generated-client/models/channel-media-type.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-media-type.ts#L24)
___
### Photo
• **Photo**
#### Defined in
[generated-client/models/channel-media-type.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-media-type.ts#L26)
___
### Video
• **Video**
#### Defined in
[generated-client/models/channel-media-type.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-media-type.ts#L25)

36
docs/enums/generated_client.ChannelType.md
View File

@ -1,36 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ChannelType
# Enumeration: ChannelType
[generated-client](../modules/generated_client.md).ChannelType
Enum ChannelType.
**`export`**
## Table of contents
### Enumeration Members
- [Radio](generated_client.ChannelType.md#radio)
- [Tv](generated_client.ChannelType.md#tv)
## Enumeration Members
### Radio
• **Radio**
#### Defined in
[generated-client/models/channel-type.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-type.ts#L25)
___
### Tv
• **Tv**
#### Defined in
[generated-client/models/channel-type.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/channel-type.ts#L24)

45
docs/enums/generated_client.CodecType.md
View File

@ -1,45 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / CodecType
# Enumeration: CodecType
[generated-client](../modules/generated_client.md).CodecType
**`export`**
## Table of contents
### Enumeration Members
- [Audio](generated_client.CodecType.md#audio)
- [Video](generated_client.CodecType.md#video)
- [VideoAudio](generated_client.CodecType.md#videoaudio)
## Enumeration Members
### Audio
• **Audio**
#### Defined in
[generated-client/models/codec-type.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/codec-type.ts#L26)
___
### Video
• **Video**
#### Defined in
[generated-client/models/codec-type.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/codec-type.ts#L24)
___
### VideoAudio
• **VideoAudio**
#### Defined in
[generated-client/models/codec-type.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/codec-type.ts#L25)

100
docs/enums/generated_client.CollectionTypeOptions.md
View File

@ -1,100 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / CollectionTypeOptions
# Enumeration: CollectionTypeOptions
[generated-client](../modules/generated_client.md).CollectionTypeOptions
**`export`**
## Table of contents
### Enumeration Members
- [Books](generated_client.CollectionTypeOptions.md#books)
- [BoxSets](generated_client.CollectionTypeOptions.md#boxsets)
- [HomeVideos](generated_client.CollectionTypeOptions.md#homevideos)
- [Mixed](generated_client.CollectionTypeOptions.md#mixed)
- [Movies](generated_client.CollectionTypeOptions.md#movies)
- [Music](generated_client.CollectionTypeOptions.md#music)
- [MusicVideos](generated_client.CollectionTypeOptions.md#musicvideos)
- [TvShows](generated_client.CollectionTypeOptions.md#tvshows)
## Enumeration Members
### Books
• **Books**
#### Defined in
[generated-client/models/collection-type-options.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/collection-type-options.ts#L30)
___
### BoxSets
• **BoxSets**
#### Defined in
[generated-client/models/collection-type-options.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/collection-type-options.ts#L29)
___
### HomeVideos
• **HomeVideos**
#### Defined in
[generated-client/models/collection-type-options.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/collection-type-options.ts#L28)
___
### Mixed
• **Mixed**
#### Defined in
[generated-client/models/collection-type-options.ts:31](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/collection-type-options.ts#L31)
___
### Movies
• **Movies**
#### Defined in
[generated-client/models/collection-type-options.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/collection-type-options.ts#L24)
___
### Music
• **Music**
#### Defined in
[generated-client/models/collection-type-options.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/collection-type-options.ts#L26)
___
### MusicVideos
• **MusicVideos**
#### Defined in
[generated-client/models/collection-type-options.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/collection-type-options.ts#L27)
___
### TvShows
• **TvShows**
#### Defined in
[generated-client/models/collection-type-options.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/collection-type-options.ts#L25)

89
docs/enums/generated_client.DayOfWeek.md
View File

@ -1,89 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DayOfWeek
# Enumeration: DayOfWeek
[generated-client](../modules/generated_client.md).DayOfWeek
**`export`**
## Table of contents
### Enumeration Members
- [Friday](generated_client.DayOfWeek.md#friday)
- [Monday](generated_client.DayOfWeek.md#monday)
- [Saturday](generated_client.DayOfWeek.md#saturday)
- [Sunday](generated_client.DayOfWeek.md#sunday)
- [Thursday](generated_client.DayOfWeek.md#thursday)
- [Tuesday](generated_client.DayOfWeek.md#tuesday)
- [Wednesday](generated_client.DayOfWeek.md#wednesday)
## Enumeration Members
### Friday
• **Friday**
#### Defined in
[generated-client/models/day-of-week.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/day-of-week.ts#L29)
___
### Monday
• **Monday**
#### Defined in
[generated-client/models/day-of-week.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/day-of-week.ts#L25)
___
### Saturday
• **Saturday**
#### Defined in
[generated-client/models/day-of-week.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/day-of-week.ts#L30)
___
### Sunday
• **Sunday**
#### Defined in
[generated-client/models/day-of-week.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/day-of-week.ts#L24)
___
### Thursday
• **Thursday**
#### Defined in
[generated-client/models/day-of-week.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/day-of-week.ts#L28)
___
### Tuesday
• **Tuesday**
#### Defined in
[generated-client/models/day-of-week.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/day-of-week.ts#L26)
___
### Wednesday
• **Wednesday**
#### Defined in
[generated-client/models/day-of-week.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/day-of-week.ts#L27)

45
docs/enums/generated_client.DayPattern.md
View File

@ -1,45 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DayPattern
# Enumeration: DayPattern
[generated-client](../modules/generated_client.md).DayPattern
**`export`**
## Table of contents
### Enumeration Members
- [Daily](generated_client.DayPattern.md#daily)
- [Weekdays](generated_client.DayPattern.md#weekdays)
- [Weekends](generated_client.DayPattern.md#weekends)
## Enumeration Members
### Daily
• **Daily**
#### Defined in
[generated-client/models/day-pattern.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/day-pattern.ts#L24)
___
### Weekdays
• **Weekdays**
#### Defined in
[generated-client/models/day-pattern.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/day-pattern.ts#L25)
___
### Weekends
• **Weekends**
#### Defined in
[generated-client/models/day-pattern.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/day-pattern.ts#L26)

34
docs/enums/generated_client.DeviceProfileType.md
View File

@ -1,34 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DeviceProfileType
# Enumeration: DeviceProfileType
[generated-client](../modules/generated_client.md).DeviceProfileType
**`export`**
## Table of contents
### Enumeration Members
- [System](generated_client.DeviceProfileType.md#system)
- [User](generated_client.DeviceProfileType.md#user)
## Enumeration Members
### System
• **System**
#### Defined in
[generated-client/models/device-profile-type.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-profile-type.ts#L24)
___
### User
• **User**
#### Defined in
[generated-client/models/device-profile-type.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/device-profile-type.ts#L25)

56
docs/enums/generated_client.DlnaProfileType.md
View File

@ -1,56 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DlnaProfileType
# Enumeration: DlnaProfileType
[generated-client](../modules/generated_client.md).DlnaProfileType
**`export`**
## Table of contents
### Enumeration Members
- [Audio](generated_client.DlnaProfileType.md#audio)
- [Photo](generated_client.DlnaProfileType.md#photo)
- [Subtitle](generated_client.DlnaProfileType.md#subtitle)
- [Video](generated_client.DlnaProfileType.md#video)
## Enumeration Members
### Audio
• **Audio**
#### Defined in
[generated-client/models/dlna-profile-type.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/dlna-profile-type.ts#L24)
___
### Photo
• **Photo**
#### Defined in
[generated-client/models/dlna-profile-type.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/dlna-profile-type.ts#L26)
___
### Subtitle
• **Subtitle**
#### Defined in
[generated-client/models/dlna-profile-type.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/dlna-profile-type.ts#L27)
___
### Video
• **Video**
#### Defined in
[generated-client/models/dlna-profile-type.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/dlna-profile-type.ts#L25)

124
docs/enums/generated_client.DynamicDayOfWeek.md
View File

@ -1,124 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / DynamicDayOfWeek
# Enumeration: DynamicDayOfWeek
[generated-client](../modules/generated_client.md).DynamicDayOfWeek
An enum that represents a day of the week, weekdays, weekends, or all days.
**`export`**
## Table of contents
### Enumeration Members
- [Everyday](generated_client.DynamicDayOfWeek.md#everyday)
- [Friday](generated_client.DynamicDayOfWeek.md#friday)
- [Monday](generated_client.DynamicDayOfWeek.md#monday)
- [Saturday](generated_client.DynamicDayOfWeek.md#saturday)
- [Sunday](generated_client.DynamicDayOfWeek.md#sunday)
- [Thursday](generated_client.DynamicDayOfWeek.md#thursday)
- [Tuesday](generated_client.DynamicDayOfWeek.md#tuesday)
- [Wednesday](generated_client.DynamicDayOfWeek.md#wednesday)
- [Weekday](generated_client.DynamicDayOfWeek.md#weekday)
- [Weekend](generated_client.DynamicDayOfWeek.md#weekend)
## Enumeration Members
### Everyday
• **Everyday**
#### Defined in
[generated-client/models/dynamic-day-of-week.ts:31](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/dynamic-day-of-week.ts#L31)
___
### Friday
• **Friday**
#### Defined in
[generated-client/models/dynamic-day-of-week.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/dynamic-day-of-week.ts#L29)
___
### Monday
• **Monday**
#### Defined in
[generated-client/models/dynamic-day-of-week.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/dynamic-day-of-week.ts#L25)
___
### Saturday
• **Saturday**
#### Defined in
[generated-client/models/dynamic-day-of-week.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/dynamic-day-of-week.ts#L30)
___
### Sunday
• **Sunday**
#### Defined in
[generated-client/models/dynamic-day-of-week.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/dynamic-day-of-week.ts#L24)
___
### Thursday
• **Thursday**
#### Defined in
[generated-client/models/dynamic-day-of-week.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/dynamic-day-of-week.ts#L28)
___
### Tuesday
• **Tuesday**
#### Defined in
[generated-client/models/dynamic-day-of-week.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/dynamic-day-of-week.ts#L26)
___
### Wednesday
• **Wednesday**
#### Defined in
[generated-client/models/dynamic-day-of-week.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/dynamic-day-of-week.ts#L27)
___
### Weekday
• **Weekday**
#### Defined in
[generated-client/models/dynamic-day-of-week.ts:32](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/dynamic-day-of-week.ts#L32)
___
### Weekend
• **Weekend**
#### Defined in
[generated-client/models/dynamic-day-of-week.ts:33](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/dynamic-day-of-week.ts#L33)

58
docs/enums/generated_client.EmbeddedSubtitleOptions.md
View File

@ -1,58 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / EmbeddedSubtitleOptions
# Enumeration: EmbeddedSubtitleOptions
[generated-client](../modules/generated_client.md).EmbeddedSubtitleOptions
An enum representing the options to disable embedded subs.
**`export`**
## Table of contents
### Enumeration Members
- [AllowAll](generated_client.EmbeddedSubtitleOptions.md#allowall)
- [AllowImage](generated_client.EmbeddedSubtitleOptions.md#allowimage)
- [AllowNone](generated_client.EmbeddedSubtitleOptions.md#allownone)
- [AllowText](generated_client.EmbeddedSubtitleOptions.md#allowtext)
## Enumeration Members
### AllowAll
• **AllowAll**
#### Defined in
[generated-client/models/embedded-subtitle-options.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/embedded-subtitle-options.ts#L24)
___
### AllowImage
• **AllowImage**
#### Defined in
[generated-client/models/embedded-subtitle-options.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/embedded-subtitle-options.ts#L26)
___
### AllowNone
• **AllowNone**
#### Defined in
[generated-client/models/embedded-subtitle-options.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/embedded-subtitle-options.ts#L27)
___
### AllowText
• **AllowText**
#### Defined in
[generated-client/models/embedded-subtitle-options.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/embedded-subtitle-options.ts#L25)

34
docs/enums/generated_client.EncodingContext.md
View File

@ -1,34 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / EncodingContext
# Enumeration: EncodingContext
[generated-client](../modules/generated_client.md).EncodingContext
**`export`**
## Table of contents
### Enumeration Members
- [Static](generated_client.EncodingContext.md#static)
- [Streaming](generated_client.EncodingContext.md#streaming)
## Enumeration Members
### Static
• **Static**
#### Defined in
[generated-client/models/encoding-context.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/encoding-context.ts#L25)
___
### Streaming
• **Streaming**
#### Defined in
[generated-client/models/encoding-context.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/encoding-context.ts#L24)

146
docs/enums/generated_client.ExternalIdMediaType.md
View File

@ -1,146 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ExternalIdMediaType
# Enumeration: ExternalIdMediaType
[generated-client](../modules/generated_client.md).ExternalIdMediaType
The specific media type of an MediaBrowser.Model.Providers.ExternalIdInfo.
**`export`**
## Table of contents
### Enumeration Members
- [Album](generated_client.ExternalIdMediaType.md#album)
- [AlbumArtist](generated_client.ExternalIdMediaType.md#albumartist)
- [Artist](generated_client.ExternalIdMediaType.md#artist)
- [BoxSet](generated_client.ExternalIdMediaType.md#boxset)
- [Episode](generated_client.ExternalIdMediaType.md#episode)
- [Movie](generated_client.ExternalIdMediaType.md#movie)
- [OtherArtist](generated_client.ExternalIdMediaType.md#otherartist)
- [Person](generated_client.ExternalIdMediaType.md#person)
- [ReleaseGroup](generated_client.ExternalIdMediaType.md#releasegroup)
- [Season](generated_client.ExternalIdMediaType.md#season)
- [Series](generated_client.ExternalIdMediaType.md#series)
- [Track](generated_client.ExternalIdMediaType.md#track)
## Enumeration Members
### Album
• **Album**
#### Defined in
[generated-client/models/external-id-media-type.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/external-id-media-type.ts#L24)
___
### AlbumArtist
• **AlbumArtist**
#### Defined in
[generated-client/models/external-id-media-type.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/external-id-media-type.ts#L25)
___
### Artist
• **Artist**
#### Defined in
[generated-client/models/external-id-media-type.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/external-id-media-type.ts#L26)
___
### BoxSet
• **BoxSet**
#### Defined in
[generated-client/models/external-id-media-type.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/external-id-media-type.ts#L27)
___
### Episode
• **Episode**
#### Defined in
[generated-client/models/external-id-media-type.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/external-id-media-type.ts#L28)
___
### Movie
• **Movie**
#### Defined in
[generated-client/models/external-id-media-type.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/external-id-media-type.ts#L29)
___
### OtherArtist
• **OtherArtist**
#### Defined in
[generated-client/models/external-id-media-type.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/external-id-media-type.ts#L30)
___
### Person
• **Person**
#### Defined in
[generated-client/models/external-id-media-type.ts:31](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/external-id-media-type.ts#L31)
___
### ReleaseGroup
• **ReleaseGroup**
#### Defined in
[generated-client/models/external-id-media-type.ts:32](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/external-id-media-type.ts#L32)
___
### Season
• **Season**
#### Defined in
[generated-client/models/external-id-media-type.ts:33](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/external-id-media-type.ts#L33)
___
### Series
• **Series**
#### Defined in
[generated-client/models/external-id-media-type.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/external-id-media-type.ts#L34)
___
### Track
• **Track**
#### Defined in
[generated-client/models/external-id-media-type.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/external-id-media-type.ts#L35)

58
docs/enums/generated_client.FFmpegLocation.md
View File

@ -1,58 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / FFmpegLocation
# Enumeration: FFmpegLocation
[generated-client](../modules/generated_client.md).FFmpegLocation
Enum describing the location of the FFmpeg tool.
**`export`**
## Table of contents
### Enumeration Members
- [Custom](generated_client.FFmpegLocation.md#custom)
- [NotFound](generated_client.FFmpegLocation.md#notfound)
- [SetByArgument](generated_client.FFmpegLocation.md#setbyargument)
- [System](generated_client.FFmpegLocation.md#system)
## Enumeration Members
### Custom
• **Custom**
#### Defined in
[generated-client/models/ffmpeg-location.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/ffmpeg-location.ts#L26)
___
### NotFound
• **NotFound**
#### Defined in
[generated-client/models/ffmpeg-location.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/ffmpeg-location.ts#L24)
___
### SetByArgument
• **SetByArgument**
#### Defined in
[generated-client/models/ffmpeg-location.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/ffmpeg-location.ts#L25)
___
### System
• **System**
#### Defined in
[generated-client/models/ffmpeg-location.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/ffmpeg-location.ts#L27)

58
docs/enums/generated_client.FileSystemEntryType.md
View File

@ -1,58 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / FileSystemEntryType
# Enumeration: FileSystemEntryType
[generated-client](../modules/generated_client.md).FileSystemEntryType
Enum FileSystemEntryType.
**`export`**
## Table of contents
### Enumeration Members
- [Directory](generated_client.FileSystemEntryType.md#directory)
- [File](generated_client.FileSystemEntryType.md#file)
- [NetworkComputer](generated_client.FileSystemEntryType.md#networkcomputer)
- [NetworkShare](generated_client.FileSystemEntryType.md#networkshare)
## Enumeration Members
### Directory
• **Directory**
#### Defined in
[generated-client/models/file-system-entry-type.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/file-system-entry-type.ts#L25)
___
### File
• **File**
#### Defined in
[generated-client/models/file-system-entry-type.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/file-system-entry-type.ts#L24)
___
### NetworkComputer
• **NetworkComputer**
#### Defined in
[generated-client/models/file-system-entry-type.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/file-system-entry-type.ts#L26)
___
### NetworkShare
• **NetworkShare**
#### Defined in
[generated-client/models/file-system-entry-type.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/file-system-entry-type.ts#L27)

45
docs/enums/generated_client.ForgotPasswordAction.md
View File

@ -1,45 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / ForgotPasswordAction
# Enumeration: ForgotPasswordAction
[generated-client](../modules/generated_client.md).ForgotPasswordAction
**`export`**
## Table of contents
### Enumeration Members
- [ContactAdmin](generated_client.ForgotPasswordAction.md#contactadmin)
- [InNetworkRequired](generated_client.ForgotPasswordAction.md#innetworkrequired)
- [PinCode](generated_client.ForgotPasswordAction.md#pincode)
## Enumeration Members
### ContactAdmin
• **ContactAdmin**
#### Defined in
[generated-client/models/forgot-password-action.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/forgot-password-action.ts#L24)
___
### InNetworkRequired
• **InNetworkRequired**
#### Defined in
[generated-client/models/forgot-password-action.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/forgot-password-action.ts#L26)
___
### PinCode
• **PinCode**
#### Defined in
[generated-client/models/forgot-password-action.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/forgot-password-action.ts#L25)

476
docs/enums/generated_client.GeneralCommandType.md
View File

@ -1,476 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / GeneralCommandType
# Enumeration: GeneralCommandType
[generated-client](../modules/generated_client.md).GeneralCommandType
This exists simply to identify a set of known commands.
**`export`**
## Table of contents
### Enumeration Members
- [Back](generated_client.GeneralCommandType.md#back)
- [ChannelDown](generated_client.GeneralCommandType.md#channeldown)
- [ChannelUp](generated_client.GeneralCommandType.md#channelup)
- [DisplayContent](generated_client.GeneralCommandType.md#displaycontent)
- [DisplayMessage](generated_client.GeneralCommandType.md#displaymessage)
- [GoHome](generated_client.GeneralCommandType.md#gohome)
- [GoToSearch](generated_client.GeneralCommandType.md#gotosearch)
- [GoToSettings](generated_client.GeneralCommandType.md#gotosettings)
- [Guide](generated_client.GeneralCommandType.md#guide)
- [MoveDown](generated_client.GeneralCommandType.md#movedown)
- [MoveLeft](generated_client.GeneralCommandType.md#moveleft)
- [MoveRight](generated_client.GeneralCommandType.md#moveright)
- [MoveUp](generated_client.GeneralCommandType.md#moveup)
- [Mute](generated_client.GeneralCommandType.md#mute)
- [NextLetter](generated_client.GeneralCommandType.md#nextletter)
- [PageDown](generated_client.GeneralCommandType.md#pagedown)
- [PageUp](generated_client.GeneralCommandType.md#pageup)
- [Play](generated_client.GeneralCommandType.md#play)
- [PlayMediaSource](generated_client.GeneralCommandType.md#playmediasource)
- [PlayNext](generated_client.GeneralCommandType.md#playnext)
- [PlayState](generated_client.GeneralCommandType.md#playstate)
- [PlayTrailers](generated_client.GeneralCommandType.md#playtrailers)
- [PreviousLetter](generated_client.GeneralCommandType.md#previousletter)
- [Select](generated_client.GeneralCommandType.md#select)
- [SendKey](generated_client.GeneralCommandType.md#sendkey)
- [SendString](generated_client.GeneralCommandType.md#sendstring)
- [SetAudioStreamIndex](generated_client.GeneralCommandType.md#setaudiostreamindex)
- [SetMaxStreamingBitrate](generated_client.GeneralCommandType.md#setmaxstreamingbitrate)
- [SetRepeatMode](generated_client.GeneralCommandType.md#setrepeatmode)
- [SetShuffleQueue](generated_client.GeneralCommandType.md#setshufflequeue)
- [SetSubtitleStreamIndex](generated_client.GeneralCommandType.md#setsubtitlestreamindex)
- [SetVolume](generated_client.GeneralCommandType.md#setvolume)
- [TakeScreenshot](generated_client.GeneralCommandType.md#takescreenshot)
- [ToggleContextMenu](generated_client.GeneralCommandType.md#togglecontextmenu)
- [ToggleFullscreen](generated_client.GeneralCommandType.md#togglefullscreen)
- [ToggleMute](generated_client.GeneralCommandType.md#togglemute)
- [ToggleOsd](generated_client.GeneralCommandType.md#toggleosd)
- [ToggleOsdMenu](generated_client.GeneralCommandType.md#toggleosdmenu)
- [ToggleStats](generated_client.GeneralCommandType.md#togglestats)
- [Unmute](generated_client.GeneralCommandType.md#unmute)
- [VolumeDown](generated_client.GeneralCommandType.md#volumedown)
- [VolumeUp](generated_client.GeneralCommandType.md#volumeup)
## Enumeration Members
### Back
• **Back**
#### Defined in
[generated-client/models/general-command-type.ts:35](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L35)
___
### ChannelDown
• **ChannelDown**
#### Defined in
[generated-client/models/general-command-type.ts:55](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L55)
___
### ChannelUp
• **ChannelUp**
#### Defined in
[generated-client/models/general-command-type.ts:54](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L54)
___
### DisplayContent
• **DisplayContent**
#### Defined in
[generated-client/models/general-command-type.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L50)
___
### DisplayMessage
• **DisplayMessage**
#### Defined in
[generated-client/models/general-command-type.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L52)
___
### GoHome
• **GoHome**
#### Defined in
[generated-client/models/general-command-type.ts:39](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L39)
___
### GoToSearch
• **GoToSearch**
#### Defined in
[generated-client/models/general-command-type.ts:51](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L51)
___
### GoToSettings
• **GoToSettings**
#### Defined in
[generated-client/models/general-command-type.ts:40](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L40)
___
### Guide
• **Guide**
#### Defined in
[generated-client/models/general-command-type.ts:56](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L56)
___
### MoveDown
• **MoveDown**
#### Defined in
[generated-client/models/general-command-type.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L25)
___
### MoveLeft
• **MoveLeft**
#### Defined in
[generated-client/models/general-command-type.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L26)
___
### MoveRight
• **MoveRight**
#### Defined in
[generated-client/models/general-command-type.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L27)
___
### MoveUp
• **MoveUp**
#### Defined in
[generated-client/models/general-command-type.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L24)
___
### Mute
• **Mute**
#### Defined in
[generated-client/models/general-command-type.ts:43](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L43)
___
### NextLetter
• **NextLetter**
#### Defined in
[generated-client/models/general-command-type.ts:31](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L31)
___
### PageDown
• **PageDown**
#### Defined in
[generated-client/models/general-command-type.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L29)
___
### PageUp
• **PageUp**
#### Defined in
[generated-client/models/general-command-type.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L28)
___
### Play
• **Play**
#### Defined in
[generated-client/models/general-command-type.ts:64](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L64)
___
### PlayMediaSource
• **PlayMediaSource**
#### Defined in
[generated-client/models/general-command-type.ts:58](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L58)
___
### PlayNext
• **PlayNext**
#### Defined in
[generated-client/models/general-command-type.ts:62](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L62)
___
### PlayState
• **PlayState**
#### Defined in
[generated-client/models/general-command-type.ts:61](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L61)
___
### PlayTrailers
• **PlayTrailers**
#### Defined in
[generated-client/models/general-command-type.ts:59](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L59)
___
### PreviousLetter
• **PreviousLetter**
#### Defined in
[generated-client/models/general-command-type.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L30)
___
### Select
• **Select**
#### Defined in
[generated-client/models/general-command-type.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L34)
___
### SendKey
• **SendKey**
#### Defined in
[generated-client/models/general-command-type.ts:37](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L37)
___
### SendString
• **SendString**
#### Defined in
[generated-client/models/general-command-type.ts:38](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L38)
___
### SetAudioStreamIndex
• **SetAudioStreamIndex**
#### Defined in
[generated-client/models/general-command-type.ts:47](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L47)
___
### SetMaxStreamingBitrate
• **SetMaxStreamingBitrate**
#### Defined in
[generated-client/models/general-command-type.ts:65](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L65)
___
### SetRepeatMode
• **SetRepeatMode**
#### Defined in
[generated-client/models/general-command-type.ts:53](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L53)
___
### SetShuffleQueue
• **SetShuffleQueue**
#### Defined in
[generated-client/models/general-command-type.ts:60](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L60)
___
### SetSubtitleStreamIndex
• **SetSubtitleStreamIndex**
#### Defined in
[generated-client/models/general-command-type.ts:48](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L48)
___
### SetVolume
• **SetVolume**
#### Defined in
[generated-client/models/general-command-type.ts:46](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L46)
___
### TakeScreenshot
• **TakeScreenshot**
#### Defined in
[generated-client/models/general-command-type.ts:36](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L36)
___
### ToggleContextMenu
• **ToggleContextMenu**
#### Defined in
[generated-client/models/general-command-type.ts:33](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L33)
___
### ToggleFullscreen
• **ToggleFullscreen**
#### Defined in
[generated-client/models/general-command-type.ts:49](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L49)
___
### ToggleMute
• **ToggleMute**
#### Defined in
[generated-client/models/general-command-type.ts:45](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L45)
___
### ToggleOsd
• **ToggleOsd**
#### Defined in
[generated-client/models/general-command-type.ts:32](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L32)
___
### ToggleOsdMenu
• **ToggleOsdMenu**
#### Defined in
[generated-client/models/general-command-type.ts:63](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L63)
___
### ToggleStats
• **ToggleStats**
#### Defined in
[generated-client/models/general-command-type.ts:57](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L57)
___
### Unmute
• **Unmute**
#### Defined in
[generated-client/models/general-command-type.ts:44](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L44)
___
### VolumeDown
• **VolumeDown**
#### Defined in
[generated-client/models/general-command-type.ts:42](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L42)
___
### VolumeUp
• **VolumeUp**
#### Defined in
[generated-client/models/general-command-type.ts:41](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/general-command-type.ts#L41)

36
docs/enums/generated_client.GroupQueueMode.md
View File

@ -1,36 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / GroupQueueMode
# Enumeration: GroupQueueMode
[generated-client](../modules/generated_client.md).GroupQueueMode
Enum GroupQueueMode.
**`export`**
## Table of contents
### Enumeration Members
- [Queue](generated_client.GroupQueueMode.md#queue)
- [QueueNext](generated_client.GroupQueueMode.md#queuenext)
## Enumeration Members
### Queue
• **Queue**
#### Defined in
[generated-client/models/group-queue-mode.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/group-queue-mode.ts#L24)
___
### QueueNext
• **QueueNext**
#### Defined in
[generated-client/models/group-queue-mode.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/group-queue-mode.ts#L25)

47
docs/enums/generated_client.GroupRepeatMode.md
View File

@ -1,47 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / GroupRepeatMode
# Enumeration: GroupRepeatMode
[generated-client](../modules/generated_client.md).GroupRepeatMode
Enum GroupRepeatMode.
**`export`**
## Table of contents
### Enumeration Members
- [RepeatAll](generated_client.GroupRepeatMode.md#repeatall)
- [RepeatNone](generated_client.GroupRepeatMode.md#repeatnone)
- [RepeatOne](generated_client.GroupRepeatMode.md#repeatone)
## Enumeration Members
### RepeatAll
• **RepeatAll**
#### Defined in
[generated-client/models/group-repeat-mode.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/group-repeat-mode.ts#L25)
___
### RepeatNone
• **RepeatNone**
#### Defined in
[generated-client/models/group-repeat-mode.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/group-repeat-mode.ts#L26)
___
### RepeatOne
• **RepeatOne**
#### Defined in
[generated-client/models/group-repeat-mode.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/group-repeat-mode.ts#L24)

36
docs/enums/generated_client.GroupShuffleMode.md
View File

@ -1,36 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / GroupShuffleMode
# Enumeration: GroupShuffleMode
[generated-client](../modules/generated_client.md).GroupShuffleMode
Enum GroupShuffleMode.
**`export`**
## Table of contents
### Enumeration Members
- [Shuffle](generated_client.GroupShuffleMode.md#shuffle)
- [Sorted](generated_client.GroupShuffleMode.md#sorted)
## Enumeration Members
### Shuffle
• **Shuffle**
#### Defined in
[generated-client/models/group-shuffle-mode.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/group-shuffle-mode.ts#L25)
___
### Sorted
• **Sorted**
#### Defined in
[generated-client/models/group-shuffle-mode.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/group-shuffle-mode.ts#L24)

58
docs/enums/generated_client.GroupStateType.md
View File

@ -1,58 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / GroupStateType
# Enumeration: GroupStateType
[generated-client](../modules/generated_client.md).GroupStateType
Enum GroupState.
**`export`**
## Table of contents
### Enumeration Members
- [Idle](generated_client.GroupStateType.md#idle)
- [Paused](generated_client.GroupStateType.md#paused)
- [Playing](generated_client.GroupStateType.md#playing)
- [Waiting](generated_client.GroupStateType.md#waiting)
## Enumeration Members
### Idle
• **Idle**
#### Defined in
[generated-client/models/group-state-type.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/group-state-type.ts#L24)
___
### Paused
• **Paused**
#### Defined in
[generated-client/models/group-state-type.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/group-state-type.ts#L26)
___
### Playing
• **Playing**
#### Defined in
[generated-client/models/group-state-type.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/group-state-type.ts#L27)
___
### Waiting
• **Waiting**
#### Defined in
[generated-client/models/group-state-type.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/group-state-type.ts#L25)

135
docs/enums/generated_client.GroupUpdateType.md
View File

@ -1,135 +0,0 @@
[@thornbill/jellyfin-sdk](../README.md) / [Modules](../modules.md) / [generated-client](../modules/generated_client.md) / GroupUpdateType
# Enumeration: GroupUpdateType
[generated-client](../modules/generated_client.md).GroupUpdateType
Enum GroupUpdateType.
**`export`**
## Table of contents
### Enumeration Members
- [CreateGroupDenied](generated_client.GroupUpdateType.md#creategroupdenied)
- [GroupDoesNotExist](generated_client.GroupUpdateType.md#groupdoesnotexist)
- [GroupJoined](generated_client.GroupUpdateType.md#groupjoined)
- [GroupLeft](generated_client.GroupUpdateType.md#groupleft)
- [JoinGroupDenied](generated_client.GroupUpdateType.md#joingroupdenied)
- [LibraryAccessDenied](generated_client.GroupUpdateType.md#libraryaccessdenied)
- [NotInGroup](generated_client.GroupUpdateType.md#notingroup)
- [PlayQueue](generated_client.GroupUpdateType.md#playqueue)
- [StateUpdate](generated_client.GroupUpdateType.md#stateupdate)
- [UserJoined](generated_client.GroupUpdateType.md#userjoined)
- [UserLeft](generated_client.GroupUpdateType.md#userleft)
## Enumeration Members
### CreateGroupDenied
• **CreateGroupDenied**
#### Defined in
[generated-client/models/group-update-type.ts:32](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/group-update-type.ts#L32)
___
### GroupDoesNotExist
• **GroupDoesNotExist**
#### Defined in
[generated-client/models/group-update-type.ts:31](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/group-update-type.ts#L31)
___
### GroupJoined
• **GroupJoined**
#### Defined in
[generated-client/models/group-update-type.ts:26](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/group-update-type.ts#L26)
___
### GroupLeft
• **GroupLeft**
#### Defined in
[generated-client/models/group-update-type.ts:27](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/group-update-type.ts#L27)
___
### JoinGroupDenied
• **JoinGroupDenied**
#### Defined in
[generated-client/models/group-update-type.ts:33](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/group-update-type.ts#L33)
___
### LibraryAccessDenied
• **LibraryAccessDenied**
#### Defined in
[generated-client/models/group-update-type.ts:34](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/group-update-type.ts#L34)
___
### NotInGroup
• **NotInGroup**
#### Defined in
[generated-client/models/group-update-type.ts:30](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/group-update-type.ts#L30)
___
### PlayQueue
• **PlayQueue**
#### Defined in
[generated-client/models/group-update-type.ts:29](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/group-update-type.ts#L29)
___
### StateUpdate
• **StateUpdate**
#### Defined in
[generated-client/models/group-update-type.ts:28](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/group-update-type.ts#L28)
___
### UserJoined
• **UserJoined**
#### Defined in
[generated-client/models/group-update-type.ts:24](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/group-update-type.ts#L24)
___
### UserLeft
• **UserLeft**
#### Defined in
[generated-client/models/group-update-type.ts:25](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/models/group-update-type.ts#L25)

Some files were not shown because too many files have changed in this diff Show More