mirror of
https://github.com/jellyfin/jellyfin-sdk-typescript.git
synced 2024-11-23 05:59:44 +00:00
Move documentation to markdown
This commit is contained in:
parent
46678c1d3e
commit
0738a1238e
34
docs/README.md
Normal file
34
docs/README.md
Normal file
@ -0,0 +1,34 @@
|
||||
jellyfin-sdk-typescript / [Modules](modules.md)
|
||||
|
||||
# jellyfin-sdk-typescript
|
||||
|
||||
A TypeScript SDK for Jellyfin.
|
||||
|
||||
> Warning: This project is under active development and is not ready for production use. API changes _will_ occur.
|
||||
|
||||
## Usage
|
||||
|
||||
```js
|
||||
// Create a new instance of the SDK
|
||||
const jellyfin = new Jellyfin(new Configuration({
|
||||
basePath: 'https://demo.jellyfin.org/stable'
|
||||
}));
|
||||
|
||||
// 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 jellyfin.systemApi.
|
||||
|
||||
// Fetch the public system info
|
||||
const info = await jellyfin.systemApi.getPublicSystemInfo();
|
||||
console.log('Info =>', info.data);
|
||||
|
||||
// Fetch the list of public users
|
||||
const users = await jellyfin.userApi.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 jellyfin.authenticateUserByName({ Username: 'demo', Pw: '' });
|
||||
console.log('Auth =>', auth.data);
|
||||
```
|
@ -1,78 +0,0 @@
|
||||
:root {
|
||||
--light-hl-0: #008000;
|
||||
--dark-hl-0: #6A9955;
|
||||
--light-hl-1: #0000FF;
|
||||
--dark-hl-1: #569CD6;
|
||||
--light-hl-2: #000000;
|
||||
--dark-hl-2: #D4D4D4;
|
||||
--light-hl-3: #0070C1;
|
||||
--dark-hl-3: #4FC1FF;
|
||||
--light-hl-4: #795E26;
|
||||
--dark-hl-4: #DCDCAA;
|
||||
--light-hl-5: #001080;
|
||||
--dark-hl-5: #9CDCFE;
|
||||
--light-hl-6: #A31515;
|
||||
--dark-hl-6: #CE9178;
|
||||
--light-hl-7: #AF00DB;
|
||||
--dark-hl-7: #C586C0;
|
||||
--light-code-background: #FFFFFF;
|
||||
--dark-code-background: #1E1E1E;
|
||||
}
|
||||
|
||||
@media (prefers-color-scheme: light) { :root {
|
||||
--hl-0: var(--light-hl-0);
|
||||
--hl-1: var(--light-hl-1);
|
||||
--hl-2: var(--light-hl-2);
|
||||
--hl-3: var(--light-hl-3);
|
||||
--hl-4: var(--light-hl-4);
|
||||
--hl-5: var(--light-hl-5);
|
||||
--hl-6: var(--light-hl-6);
|
||||
--hl-7: var(--light-hl-7);
|
||||
--code-background: var(--light-code-background);
|
||||
} }
|
||||
|
||||
@media (prefers-color-scheme: dark) { :root {
|
||||
--hl-0: var(--dark-hl-0);
|
||||
--hl-1: var(--dark-hl-1);
|
||||
--hl-2: var(--dark-hl-2);
|
||||
--hl-3: var(--dark-hl-3);
|
||||
--hl-4: var(--dark-hl-4);
|
||||
--hl-5: var(--dark-hl-5);
|
||||
--hl-6: var(--dark-hl-6);
|
||||
--hl-7: var(--dark-hl-7);
|
||||
--code-background: var(--dark-code-background);
|
||||
} }
|
||||
|
||||
body.light {
|
||||
--hl-0: var(--light-hl-0);
|
||||
--hl-1: var(--light-hl-1);
|
||||
--hl-2: var(--light-hl-2);
|
||||
--hl-3: var(--light-hl-3);
|
||||
--hl-4: var(--light-hl-4);
|
||||
--hl-5: var(--light-hl-5);
|
||||
--hl-6: var(--light-hl-6);
|
||||
--hl-7: var(--light-hl-7);
|
||||
--code-background: var(--light-code-background);
|
||||
}
|
||||
|
||||
body.dark {
|
||||
--hl-0: var(--dark-hl-0);
|
||||
--hl-1: var(--dark-hl-1);
|
||||
--hl-2: var(--dark-hl-2);
|
||||
--hl-3: var(--dark-hl-3);
|
||||
--hl-4: var(--dark-hl-4);
|
||||
--hl-5: var(--dark-hl-5);
|
||||
--hl-6: var(--dark-hl-6);
|
||||
--hl-7: var(--dark-hl-7);
|
||||
--code-background: var(--dark-code-background);
|
||||
}
|
||||
|
||||
.hl-0 { color: var(--hl-0); }
|
||||
.hl-1 { color: var(--hl-1); }
|
||||
.hl-2 { color: var(--hl-2); }
|
||||
.hl-3 { color: var(--hl-3); }
|
||||
.hl-4 { color: var(--hl-4); }
|
||||
.hl-5 { color: var(--hl-5); }
|
||||
.hl-6 { color: var(--hl-6); }
|
||||
.hl-7 { color: var(--hl-7); }
|
||||
pre, code { background: var(--code-background); }
|
File diff suppressed because it is too large
Load Diff
Binary file not shown.
Before Width: | Height: | Size: 9.4 KiB |
Binary file not shown.
Before Width: | Height: | Size: 28 KiB |
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because it is too large
Load Diff
Binary file not shown.
Before Width: | Height: | Size: 480 B |
Binary file not shown.
Before Width: | Height: | Size: 855 B |
File diff suppressed because one or more lines are too long
114
docs/classes/generated_client.ActivityLogApi.md
Normal file
114
docs/classes/generated_client.ActivityLogApi.md
Normal file
@ -0,0 +1,114 @@
|
||||
[jellyfin-sdk-typescript](../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 |
|
||||
| :------ | :------ |
|
||||
| `configuration?` | [`Configuration`](generated_client.Configuration.md) |
|
||||
| `basePath` | `string` |
|
||||
| `axios` | `AxiosInstance` |
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L52)
|
||||
|
||||
## Properties
|
||||
|
||||
### axios
|
||||
|
||||
• `Protected` **axios**: `AxiosInstance`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.axios
|
||||
|
||||
___
|
||||
|
||||
### basePath
|
||||
|
||||
• `Protected` **basePath**: `string`
|
||||
|
||||
#### 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/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L50)
|
||||
|
||||
## Methods
|
||||
|
||||
### getLogEntries
|
||||
|
||||
▸ **getLogEntries**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`ActivityLogEntryQueryResult`](../interfaces/generated_client.ActivityLogEntryQueryResult.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/activity-log-api.ts:186](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/activity-log-api.ts#L186)
|
File diff suppressed because one or more lines are too long
169
docs/classes/generated_client.ApiKeyApi.md
Normal file
169
docs/classes/generated_client.ApiKeyApi.md
Normal file
@ -0,0 +1,169 @@
|
||||
[jellyfin-sdk-typescript](../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 |
|
||||
| :------ | :------ |
|
||||
| `configuration?` | [`Configuration`](generated_client.Configuration.md) |
|
||||
| `basePath` | `string` |
|
||||
| `axios` | `AxiosInstance` |
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L52)
|
||||
|
||||
## Properties
|
||||
|
||||
### axios
|
||||
|
||||
• `Protected` **axios**: `AxiosInstance`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.axios
|
||||
|
||||
___
|
||||
|
||||
### basePath
|
||||
|
||||
• `Protected` **basePath**: `string`
|
||||
|
||||
#### 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/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L50)
|
||||
|
||||
## Methods
|
||||
|
||||
### createKey
|
||||
|
||||
▸ **createKey**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/api-key-api.ts:268](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/api-key-api.ts#L268)
|
||||
|
||||
___
|
||||
|
||||
### getKeys
|
||||
|
||||
▸ **getKeys**(`options?`): `Promise`<`AxiosResponse`<[`AuthenticationInfoQueryResult`](../interfaces/generated_client.AuthenticationInfoQueryResult.md)\>\>
|
||||
|
||||
**`summary`** Get all keys.
|
||||
|
||||
**`throws`** {RequiredError}
|
||||
|
||||
**`memberof`** ApiKeyApi
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `options?` | `any` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`AxiosResponse`<[`AuthenticationInfoQueryResult`](../interfaces/generated_client.AuthenticationInfoQueryResult.md)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/api-key-api.ts:279](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/api-key-api.ts#L279)
|
||||
|
||||
___
|
||||
|
||||
### revokeKey
|
||||
|
||||
▸ **revokeKey**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/api-key-api.ts:291](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/api-key-api.ts#L291)
|
File diff suppressed because one or more lines are too long
170
docs/classes/generated_client.ArtistsApi.md
Normal file
170
docs/classes/generated_client.ArtistsApi.md
Normal file
@ -0,0 +1,170 @@
|
||||
[jellyfin-sdk-typescript](../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 |
|
||||
| :------ | :------ |
|
||||
| `configuration?` | [`Configuration`](generated_client.Configuration.md) |
|
||||
| `basePath` | `string` |
|
||||
| `axios` | `AxiosInstance` |
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L52)
|
||||
|
||||
## Properties
|
||||
|
||||
### axios
|
||||
|
||||
• `Protected` **axios**: `AxiosInstance`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.axios
|
||||
|
||||
___
|
||||
|
||||
### basePath
|
||||
|
||||
• `Protected` **basePath**: `string`
|
||||
|
||||
#### 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/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L50)
|
||||
|
||||
## Methods
|
||||
|
||||
### getAlbumArtists
|
||||
|
||||
▸ **getAlbumArtists**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/artists-api.ts:1121](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/artists-api.ts#L1121)
|
||||
|
||||
___
|
||||
|
||||
### getArtistByName
|
||||
|
||||
▸ **getArtistByName**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/artists-api.ts:1133](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/artists-api.ts#L1133)
|
||||
|
||||
___
|
||||
|
||||
### getArtists
|
||||
|
||||
▸ **getArtists**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/artists-api.ts:1145](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/artists-api.ts#L1145)
|
File diff suppressed because one or more lines are too long
198
docs/classes/generated_client.AudioApi.md
Normal file
198
docs/classes/generated_client.AudioApi.md
Normal file
@ -0,0 +1,198 @@
|
||||
[jellyfin-sdk-typescript](../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 |
|
||||
| :------ | :------ |
|
||||
| `configuration?` | [`Configuration`](generated_client.Configuration.md) |
|
||||
| `basePath` | `string` |
|
||||
| `axios` | `AxiosInstance` |
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L52)
|
||||
|
||||
## Properties
|
||||
|
||||
### axios
|
||||
|
||||
• `Protected` **axios**: `AxiosInstance`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.axios
|
||||
|
||||
___
|
||||
|
||||
### basePath
|
||||
|
||||
• `Protected` **basePath**: `string`
|
||||
|
||||
#### 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/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L50)
|
||||
|
||||
## Methods
|
||||
|
||||
### getAudioStream
|
||||
|
||||
▸ **getAudioStream**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/audio-api.ts:3033](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/audio-api.ts#L3033)
|
||||
|
||||
___
|
||||
|
||||
### getAudioStreamByContainer
|
||||
|
||||
▸ **getAudioStreamByContainer**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/audio-api.ts:3045](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/audio-api.ts#L3045)
|
||||
|
||||
___
|
||||
|
||||
### headAudioStream
|
||||
|
||||
▸ **headAudioStream**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/audio-api.ts:3057](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/audio-api.ts#L3057)
|
||||
|
||||
___
|
||||
|
||||
### headAudioStreamByContainer
|
||||
|
||||
▸ **headAudioStreamByContainer**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/audio-api.ts:3069](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/audio-api.ts#L3069)
|
File diff suppressed because one or more lines are too long
167
docs/classes/generated_client.BrandingApi.md
Normal file
167
docs/classes/generated_client.BrandingApi.md
Normal file
@ -0,0 +1,167 @@
|
||||
[jellyfin-sdk-typescript](../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 |
|
||||
| :------ | :------ |
|
||||
| `configuration?` | [`Configuration`](generated_client.Configuration.md) |
|
||||
| `basePath` | `string` |
|
||||
| `axios` | `AxiosInstance` |
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L52)
|
||||
|
||||
## Properties
|
||||
|
||||
### axios
|
||||
|
||||
• `Protected` **axios**: `AxiosInstance`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.axios
|
||||
|
||||
___
|
||||
|
||||
### basePath
|
||||
|
||||
• `Protected` **basePath**: `string`
|
||||
|
||||
#### 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/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L50)
|
||||
|
||||
## Methods
|
||||
|
||||
### getBrandingCss
|
||||
|
||||
▸ **getBrandingCss**(`options?`): `Promise`<`AxiosResponse`<`string`\>\>
|
||||
|
||||
**`summary`** Gets branding css.
|
||||
|
||||
**`throws`** {RequiredError}
|
||||
|
||||
**`memberof`** BrandingApi
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `options?` | `any` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`AxiosResponse`<`string`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/branding-api.ts:215](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/branding-api.ts#L215)
|
||||
|
||||
___
|
||||
|
||||
### getBrandingCss2
|
||||
|
||||
▸ **getBrandingCss2**(`options?`): `Promise`<`AxiosResponse`<`string`\>\>
|
||||
|
||||
**`summary`** Gets branding css.
|
||||
|
||||
**`throws`** {RequiredError}
|
||||
|
||||
**`memberof`** BrandingApi
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `options?` | `any` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`AxiosResponse`<`string`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/branding-api.ts:226](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/branding-api.ts#L226)
|
||||
|
||||
___
|
||||
|
||||
### getBrandingOptions
|
||||
|
||||
▸ **getBrandingOptions**(`options?`): `Promise`<`AxiosResponse`<[`BrandingOptions`](../interfaces/generated_client.BrandingOptions.md)\>\>
|
||||
|
||||
**`summary`** Gets branding configuration.
|
||||
|
||||
**`throws`** {RequiredError}
|
||||
|
||||
**`memberof`** BrandingApi
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `options?` | `any` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`AxiosResponse`<[`BrandingOptions`](../interfaces/generated_client.BrandingOptions.md)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/branding-api.ts:237](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/branding-api.ts#L237)
|
File diff suppressed because one or more lines are too long
225
docs/classes/generated_client.ChannelsApi.md
Normal file
225
docs/classes/generated_client.ChannelsApi.md
Normal file
@ -0,0 +1,225 @@
|
||||
[jellyfin-sdk-typescript](../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 |
|
||||
| :------ | :------ |
|
||||
| `configuration?` | [`Configuration`](generated_client.Configuration.md) |
|
||||
| `basePath` | `string` |
|
||||
| `axios` | `AxiosInstance` |
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L52)
|
||||
|
||||
## Properties
|
||||
|
||||
### axios
|
||||
|
||||
• `Protected` **axios**: `AxiosInstance`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.axios
|
||||
|
||||
___
|
||||
|
||||
### basePath
|
||||
|
||||
• `Protected` **basePath**: `string`
|
||||
|
||||
#### 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/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L50)
|
||||
|
||||
## Methods
|
||||
|
||||
### getAllChannelFeatures
|
||||
|
||||
▸ **getAllChannelFeatures**(`options?`): `Promise`<`AxiosResponse`<[`ChannelFeatures`](../interfaces/generated_client.ChannelFeatures.md)[]\>\>
|
||||
|
||||
**`summary`** Get all channel features.
|
||||
|
||||
**`throws`** {RequiredError}
|
||||
|
||||
**`memberof`** ChannelsApi
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `options?` | `any` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`AxiosResponse`<[`ChannelFeatures`](../interfaces/generated_client.ChannelFeatures.md)[]\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/channels-api.ts:670](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/channels-api.ts#L670)
|
||||
|
||||
___
|
||||
|
||||
### getChannelFeatures
|
||||
|
||||
▸ **getChannelFeatures**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`ChannelFeatures`](../interfaces/generated_client.ChannelFeatures.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/channels-api.ts:682](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/channels-api.ts#L682)
|
||||
|
||||
___
|
||||
|
||||
### getChannelItems
|
||||
|
||||
▸ **getChannelItems**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/channels-api.ts:694](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/channels-api.ts#L694)
|
||||
|
||||
___
|
||||
|
||||
### getChannels
|
||||
|
||||
▸ **getChannels**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/channels-api.ts:706](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/channels-api.ts#L706)
|
||||
|
||||
___
|
||||
|
||||
### getLatestChannelItems
|
||||
|
||||
▸ **getLatestChannelItems**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/channels-api.ts:718](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/channels-api.ts#L718)
|
File diff suppressed because one or more lines are too long
170
docs/classes/generated_client.CollectionApi.md
Normal file
170
docs/classes/generated_client.CollectionApi.md
Normal file
@ -0,0 +1,170 @@
|
||||
[jellyfin-sdk-typescript](../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 |
|
||||
| :------ | :------ |
|
||||
| `configuration?` | [`Configuration`](generated_client.Configuration.md) |
|
||||
| `basePath` | `string` |
|
||||
| `axios` | `AxiosInstance` |
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L52)
|
||||
|
||||
## Properties
|
||||
|
||||
### axios
|
||||
|
||||
• `Protected` **axios**: `AxiosInstance`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.axios
|
||||
|
||||
___
|
||||
|
||||
### basePath
|
||||
|
||||
• `Protected` **basePath**: `string`
|
||||
|
||||
#### 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/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L50)
|
||||
|
||||
## Methods
|
||||
|
||||
### addToCollection
|
||||
|
||||
▸ **addToCollection**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/collection-api.ts:360](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/collection-api.ts#L360)
|
||||
|
||||
___
|
||||
|
||||
### createCollection
|
||||
|
||||
▸ **createCollection**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`CollectionCreationResult`](../interfaces/generated_client.CollectionCreationResult.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/collection-api.ts:372](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/collection-api.ts#L372)
|
||||
|
||||
___
|
||||
|
||||
### removeFromCollection
|
||||
|
||||
▸ **removeFromCollection**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/collection-api.ts:384](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/collection-api.ts#L384)
|
File diff suppressed because one or more lines are too long
178
docs/classes/generated_client.Configuration.md
Normal file
178
docs/classes/generated_client.Configuration.md
Normal file
@ -0,0 +1,178 @@
|
||||
[jellyfin-sdk-typescript](../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/thornbill/jellyfin-sdk-typescript/blob/46678c1/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/thornbill/jellyfin-sdk-typescript/blob/46678c1/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/thornbill/jellyfin-sdk-typescript/blob/46678c1/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/thornbill/jellyfin-sdk-typescript/blob/46678c1/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/thornbill/jellyfin-sdk-typescript/blob/46678c1/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/thornbill/jellyfin-sdk-typescript/blob/46678c1/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/thornbill/jellyfin-sdk-typescript/blob/46678c1/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/thornbill/jellyfin-sdk-typescript/blob/46678c1/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/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/configuration.ts#L97)
|
File diff suppressed because one or more lines are too long
252
docs/classes/generated_client.ConfigurationApi.md
Normal file
252
docs/classes/generated_client.ConfigurationApi.md
Normal file
@ -0,0 +1,252 @@
|
||||
[jellyfin-sdk-typescript](../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 |
|
||||
| :------ | :------ |
|
||||
| `configuration?` | [`Configuration`](generated_client.Configuration.md) |
|
||||
| `basePath` | `string` |
|
||||
| `axios` | `AxiosInstance` |
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L52)
|
||||
|
||||
## Properties
|
||||
|
||||
### axios
|
||||
|
||||
• `Protected` **axios**: `AxiosInstance`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.axios
|
||||
|
||||
___
|
||||
|
||||
### basePath
|
||||
|
||||
• `Protected` **basePath**: `string`
|
||||
|
||||
#### 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/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L50)
|
||||
|
||||
## Methods
|
||||
|
||||
### getConfiguration
|
||||
|
||||
▸ **getConfiguration**(`options?`): `Promise`<`AxiosResponse`<[`ServerConfiguration`](../interfaces/generated_client.ServerConfiguration.md)\>\>
|
||||
|
||||
**`summary`** Gets application configuration.
|
||||
|
||||
**`throws`** {RequiredError}
|
||||
|
||||
**`memberof`** ConfigurationApi
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `options?` | `any` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`AxiosResponse`<[`ServerConfiguration`](../interfaces/generated_client.ServerConfiguration.md)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/configuration-api.ts:468](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/configuration-api.ts#L468)
|
||||
|
||||
___
|
||||
|
||||
### getDefaultMetadataOptions
|
||||
|
||||
▸ **getDefaultMetadataOptions**(`options?`): `Promise`<`AxiosResponse`<[`MetadataOptions`](../interfaces/generated_client.MetadataOptions.md)\>\>
|
||||
|
||||
**`summary`** Gets a default MetadataOptions object.
|
||||
|
||||
**`throws`** {RequiredError}
|
||||
|
||||
**`memberof`** ConfigurationApi
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `options?` | `any` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`AxiosResponse`<[`MetadataOptions`](../interfaces/generated_client.MetadataOptions.md)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/configuration-api.ts:479](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/configuration-api.ts#L479)
|
||||
|
||||
___
|
||||
|
||||
### getNamedConfiguration
|
||||
|
||||
▸ **getNamedConfiguration**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/configuration-api.ts:491](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/configuration-api.ts#L491)
|
||||
|
||||
___
|
||||
|
||||
### updateConfiguration
|
||||
|
||||
▸ **updateConfiguration**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/configuration-api.ts:503](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/configuration-api.ts#L503)
|
||||
|
||||
___
|
||||
|
||||
### updateMediaEncoderPath
|
||||
|
||||
▸ **updateMediaEncoderPath**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/configuration-api.ts:515](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/configuration-api.ts#L515)
|
||||
|
||||
___
|
||||
|
||||
### updateNamedConfiguration
|
||||
|
||||
▸ **updateNamedConfiguration**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/configuration-api.ts:527](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/configuration-api.ts#L527)
|
File diff suppressed because one or more lines are too long
142
docs/classes/generated_client.DashboardApi.md
Normal file
142
docs/classes/generated_client.DashboardApi.md
Normal file
@ -0,0 +1,142 @@
|
||||
[jellyfin-sdk-typescript](../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 |
|
||||
| :------ | :------ |
|
||||
| `configuration?` | [`Configuration`](generated_client.Configuration.md) |
|
||||
| `basePath` | `string` |
|
||||
| `axios` | `AxiosInstance` |
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L52)
|
||||
|
||||
## Properties
|
||||
|
||||
### axios
|
||||
|
||||
• `Protected` **axios**: `AxiosInstance`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.axios
|
||||
|
||||
___
|
||||
|
||||
### basePath
|
||||
|
||||
• `Protected` **basePath**: `string`
|
||||
|
||||
#### 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/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L50)
|
||||
|
||||
## Methods
|
||||
|
||||
### getConfigurationPages
|
||||
|
||||
▸ **getConfigurationPages**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`ConfigurationPageInfo`](../interfaces/generated_client.ConfigurationPageInfo.md)[]\>\>
|
||||
|
||||
**`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)[]\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/dashboard-api.ts:227](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/dashboard-api.ts#L227)
|
||||
|
||||
___
|
||||
|
||||
### getDashboardConfigurationPage
|
||||
|
||||
▸ **getDashboardConfigurationPage**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/dashboard-api.ts:239](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/dashboard-api.ts#L239)
|
File diff suppressed because one or more lines are too long
226
docs/classes/generated_client.DevicesApi.md
Normal file
226
docs/classes/generated_client.DevicesApi.md
Normal file
@ -0,0 +1,226 @@
|
||||
[jellyfin-sdk-typescript](../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 |
|
||||
| :------ | :------ |
|
||||
| `configuration?` | [`Configuration`](generated_client.Configuration.md) |
|
||||
| `basePath` | `string` |
|
||||
| `axios` | `AxiosInstance` |
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L52)
|
||||
|
||||
## Properties
|
||||
|
||||
### axios
|
||||
|
||||
• `Protected` **axios**: `AxiosInstance`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.axios
|
||||
|
||||
___
|
||||
|
||||
### basePath
|
||||
|
||||
• `Protected` **basePath**: `string`
|
||||
|
||||
#### 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/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L50)
|
||||
|
||||
## Methods
|
||||
|
||||
### deleteDevice
|
||||
|
||||
▸ **deleteDevice**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/devices-api.ts:477](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/devices-api.ts#L477)
|
||||
|
||||
___
|
||||
|
||||
### getDeviceInfo
|
||||
|
||||
▸ **getDeviceInfo**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`DeviceInfo`](../interfaces/generated_client.DeviceInfo.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/devices-api.ts:489](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/devices-api.ts#L489)
|
||||
|
||||
___
|
||||
|
||||
### getDeviceOptions
|
||||
|
||||
▸ **getDeviceOptions**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`DeviceOptions`](../interfaces/generated_client.DeviceOptions.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/devices-api.ts:501](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/devices-api.ts#L501)
|
||||
|
||||
___
|
||||
|
||||
### getDevices
|
||||
|
||||
▸ **getDevices**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`DeviceInfoQueryResult`](../interfaces/generated_client.DeviceInfoQueryResult.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/devices-api.ts:513](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/devices-api.ts#L513)
|
||||
|
||||
___
|
||||
|
||||
### updateDeviceOptions
|
||||
|
||||
▸ **updateDeviceOptions**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/devices-api.ts:525](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/devices-api.ts#L525)
|
File diff suppressed because one or more lines are too long
142
docs/classes/generated_client.DisplayPreferencesApi.md
Normal file
142
docs/classes/generated_client.DisplayPreferencesApi.md
Normal file
@ -0,0 +1,142 @@
|
||||
[jellyfin-sdk-typescript](../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 |
|
||||
| :------ | :------ |
|
||||
| `configuration?` | [`Configuration`](generated_client.Configuration.md) |
|
||||
| `basePath` | `string` |
|
||||
| `axios` | `AxiosInstance` |
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L52)
|
||||
|
||||
## Properties
|
||||
|
||||
### axios
|
||||
|
||||
• `Protected` **axios**: `AxiosInstance`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.axios
|
||||
|
||||
___
|
||||
|
||||
### basePath
|
||||
|
||||
• `Protected` **basePath**: `string`
|
||||
|
||||
#### 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/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L50)
|
||||
|
||||
## Methods
|
||||
|
||||
### getDisplayPreferences
|
||||
|
||||
▸ **getDisplayPreferences**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`DisplayPreferencesDto`](../interfaces/generated_client.DisplayPreferencesDto.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/display-preferences-api.ts:292](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/display-preferences-api.ts#L292)
|
||||
|
||||
___
|
||||
|
||||
### updateDisplayPreferences
|
||||
|
||||
▸ **updateDisplayPreferences**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/display-preferences-api.ts:304](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/display-preferences-api.ts#L304)
|
File diff suppressed because one or more lines are too long
252
docs/classes/generated_client.DlnaApi.md
Normal file
252
docs/classes/generated_client.DlnaApi.md
Normal file
@ -0,0 +1,252 @@
|
||||
[jellyfin-sdk-typescript](../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 |
|
||||
| :------ | :------ |
|
||||
| `configuration?` | [`Configuration`](generated_client.Configuration.md) |
|
||||
| `basePath` | `string` |
|
||||
| `axios` | `AxiosInstance` |
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L52)
|
||||
|
||||
## Properties
|
||||
|
||||
### axios
|
||||
|
||||
• `Protected` **axios**: `AxiosInstance`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.axios
|
||||
|
||||
___
|
||||
|
||||
### basePath
|
||||
|
||||
• `Protected` **basePath**: `string`
|
||||
|
||||
#### 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/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L50)
|
||||
|
||||
## Methods
|
||||
|
||||
### createProfile
|
||||
|
||||
▸ **createProfile**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/dlna-api.ts:478](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/dlna-api.ts#L478)
|
||||
|
||||
___
|
||||
|
||||
### deleteProfile
|
||||
|
||||
▸ **deleteProfile**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/dlna-api.ts:490](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/dlna-api.ts#L490)
|
||||
|
||||
___
|
||||
|
||||
### getDefaultProfile
|
||||
|
||||
▸ **getDefaultProfile**(`options?`): `Promise`<`AxiosResponse`<[`DeviceProfile`](../interfaces/generated_client.DeviceProfile.md)\>\>
|
||||
|
||||
**`summary`** Gets the default profile.
|
||||
|
||||
**`throws`** {RequiredError}
|
||||
|
||||
**`memberof`** DlnaApi
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `options?` | `any` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`AxiosResponse`<[`DeviceProfile`](../interfaces/generated_client.DeviceProfile.md)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/dlna-api.ts:501](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/dlna-api.ts#L501)
|
||||
|
||||
___
|
||||
|
||||
### getProfile
|
||||
|
||||
▸ **getProfile**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`DeviceProfile`](../interfaces/generated_client.DeviceProfile.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/dlna-api.ts:513](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/dlna-api.ts#L513)
|
||||
|
||||
___
|
||||
|
||||
### getProfileInfos
|
||||
|
||||
▸ **getProfileInfos**(`options?`): `Promise`<`AxiosResponse`<[`DeviceProfileInfo`](../interfaces/generated_client.DeviceProfileInfo.md)[]\>\>
|
||||
|
||||
**`summary`** Get profile infos.
|
||||
|
||||
**`throws`** {RequiredError}
|
||||
|
||||
**`memberof`** DlnaApi
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `options?` | `any` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`AxiosResponse`<[`DeviceProfileInfo`](../interfaces/generated_client.DeviceProfileInfo.md)[]\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/dlna-api.ts:524](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/dlna-api.ts#L524)
|
||||
|
||||
___
|
||||
|
||||
### updateProfile
|
||||
|
||||
▸ **updateProfile**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/dlna-api.ts:536](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/dlna-api.ts#L536)
|
File diff suppressed because one or more lines are too long
534
docs/classes/generated_client.DlnaServerApi.md
Normal file
534
docs/classes/generated_client.DlnaServerApi.md
Normal file
@ -0,0 +1,534 @@
|
||||
[jellyfin-sdk-typescript](../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 |
|
||||
| :------ | :------ |
|
||||
| `configuration?` | [`Configuration`](generated_client.Configuration.md) |
|
||||
| `basePath` | `string` |
|
||||
| `axios` | `AxiosInstance` |
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L52)
|
||||
|
||||
## Properties
|
||||
|
||||
### axios
|
||||
|
||||
• `Protected` **axios**: `AxiosInstance`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.axios
|
||||
|
||||
___
|
||||
|
||||
### basePath
|
||||
|
||||
• `Protected` **basePath**: `string`
|
||||
|
||||
#### 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/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L50)
|
||||
|
||||
## Methods
|
||||
|
||||
### getConnectionManager
|
||||
|
||||
▸ **getConnectionManager**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/dlna-server-api.ts:1186](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/dlna-server-api.ts#L1186)
|
||||
|
||||
___
|
||||
|
||||
### getConnectionManager2
|
||||
|
||||
▸ **getConnectionManager2**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/dlna-server-api.ts:1198](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/dlna-server-api.ts#L1198)
|
||||
|
||||
___
|
||||
|
||||
### getConnectionManager3
|
||||
|
||||
▸ **getConnectionManager3**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/dlna-server-api.ts:1210](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/dlna-server-api.ts#L1210)
|
||||
|
||||
___
|
||||
|
||||
### getContentDirectory
|
||||
|
||||
▸ **getContentDirectory**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/dlna-server-api.ts:1222](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/dlna-server-api.ts#L1222)
|
||||
|
||||
___
|
||||
|
||||
### getContentDirectory2
|
||||
|
||||
▸ **getContentDirectory2**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/dlna-server-api.ts:1234](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/dlna-server-api.ts#L1234)
|
||||
|
||||
___
|
||||
|
||||
### getContentDirectory3
|
||||
|
||||
▸ **getContentDirectory3**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/dlna-server-api.ts:1246](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/dlna-server-api.ts#L1246)
|
||||
|
||||
___
|
||||
|
||||
### getDescriptionXml
|
||||
|
||||
▸ **getDescriptionXml**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/dlna-server-api.ts:1258](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/dlna-server-api.ts#L1258)
|
||||
|
||||
___
|
||||
|
||||
### getDescriptionXml2
|
||||
|
||||
▸ **getDescriptionXml2**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/dlna-server-api.ts:1270](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/dlna-server-api.ts#L1270)
|
||||
|
||||
___
|
||||
|
||||
### getIcon
|
||||
|
||||
▸ **getIcon**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/dlna-server-api.ts:1282](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/dlna-server-api.ts#L1282)
|
||||
|
||||
___
|
||||
|
||||
### getIconId
|
||||
|
||||
▸ **getIconId**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/dlna-server-api.ts:1294](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/dlna-server-api.ts#L1294)
|
||||
|
||||
___
|
||||
|
||||
### getMediaReceiverRegistrar
|
||||
|
||||
▸ **getMediaReceiverRegistrar**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/dlna-server-api.ts:1306](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/dlna-server-api.ts#L1306)
|
||||
|
||||
___
|
||||
|
||||
### getMediaReceiverRegistrar2
|
||||
|
||||
▸ **getMediaReceiverRegistrar2**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/dlna-server-api.ts:1318](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/dlna-server-api.ts#L1318)
|
||||
|
||||
___
|
||||
|
||||
### getMediaReceiverRegistrar3
|
||||
|
||||
▸ **getMediaReceiverRegistrar3**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/dlna-server-api.ts:1330](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/dlna-server-api.ts#L1330)
|
||||
|
||||
___
|
||||
|
||||
### processConnectionManagerControlRequest
|
||||
|
||||
▸ **processConnectionManagerControlRequest**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/dlna-server-api.ts:1342](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/dlna-server-api.ts#L1342)
|
||||
|
||||
___
|
||||
|
||||
### processContentDirectoryControlRequest
|
||||
|
||||
▸ **processContentDirectoryControlRequest**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/dlna-server-api.ts:1354](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/dlna-server-api.ts#L1354)
|
||||
|
||||
___
|
||||
|
||||
### processMediaReceiverRegistrarControlRequest
|
||||
|
||||
▸ **processMediaReceiverRegistrarControlRequest**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/dlna-server-api.ts:1366](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/dlna-server-api.ts#L1366)
|
File diff suppressed because one or more lines are too long
310
docs/classes/generated_client.DynamicHlsApi.md
Normal file
310
docs/classes/generated_client.DynamicHlsApi.md
Normal file
@ -0,0 +1,310 @@
|
||||
[jellyfin-sdk-typescript](../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)
|
||||
- [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 |
|
||||
| :------ | :------ |
|
||||
| `configuration?` | [`Configuration`](generated_client.Configuration.md) |
|
||||
| `basePath` | `string` |
|
||||
| `axios` | `AxiosInstance` |
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L52)
|
||||
|
||||
## Properties
|
||||
|
||||
### axios
|
||||
|
||||
• `Protected` **axios**: `AxiosInstance`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.axios
|
||||
|
||||
___
|
||||
|
||||
### basePath
|
||||
|
||||
• `Protected` **basePath**: `string`
|
||||
|
||||
#### 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/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L50)
|
||||
|
||||
## Methods
|
||||
|
||||
### getHlsAudioSegment
|
||||
|
||||
▸ **getHlsAudioSegment**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/dynamic-hls-api.ts:6109](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/dynamic-hls-api.ts#L6109)
|
||||
|
||||
___
|
||||
|
||||
### getHlsVideoSegment
|
||||
|
||||
▸ **getHlsVideoSegment**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/dynamic-hls-api.ts:6121](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/dynamic-hls-api.ts#L6121)
|
||||
|
||||
___
|
||||
|
||||
### getMasterHlsAudioPlaylist
|
||||
|
||||
▸ **getMasterHlsAudioPlaylist**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/dynamic-hls-api.ts:6133](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/dynamic-hls-api.ts#L6133)
|
||||
|
||||
___
|
||||
|
||||
### getMasterHlsVideoPlaylist
|
||||
|
||||
▸ **getMasterHlsVideoPlaylist**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/dynamic-hls-api.ts:6145](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/dynamic-hls-api.ts#L6145)
|
||||
|
||||
___
|
||||
|
||||
### getVariantHlsAudioPlaylist
|
||||
|
||||
▸ **getVariantHlsAudioPlaylist**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/dynamic-hls-api.ts:6157](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/dynamic-hls-api.ts#L6157)
|
||||
|
||||
___
|
||||
|
||||
### getVariantHlsVideoPlaylist
|
||||
|
||||
▸ **getVariantHlsVideoPlaylist**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/dynamic-hls-api.ts:6169](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/dynamic-hls-api.ts#L6169)
|
||||
|
||||
___
|
||||
|
||||
### headMasterHlsAudioPlaylist
|
||||
|
||||
▸ **headMasterHlsAudioPlaylist**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/dynamic-hls-api.ts:6181](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/dynamic-hls-api.ts#L6181)
|
||||
|
||||
___
|
||||
|
||||
### headMasterHlsVideoPlaylist
|
||||
|
||||
▸ **headMasterHlsVideoPlaylist**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/dynamic-hls-api.ts:6193](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/dynamic-hls-api.ts#L6193)
|
File diff suppressed because one or more lines are too long
253
docs/classes/generated_client.EnvironmentApi.md
Normal file
253
docs/classes/generated_client.EnvironmentApi.md
Normal file
@ -0,0 +1,253 @@
|
||||
[jellyfin-sdk-typescript](../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 |
|
||||
| :------ | :------ |
|
||||
| `configuration?` | [`Configuration`](generated_client.Configuration.md) |
|
||||
| `basePath` | `string` |
|
||||
| `axios` | `AxiosInstance` |
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L52)
|
||||
|
||||
## Properties
|
||||
|
||||
### axios
|
||||
|
||||
• `Protected` **axios**: `AxiosInstance`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.axios
|
||||
|
||||
___
|
||||
|
||||
### basePath
|
||||
|
||||
• `Protected` **basePath**: `string`
|
||||
|
||||
#### 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/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L50)
|
||||
|
||||
## Methods
|
||||
|
||||
### getDefaultDirectoryBrowser
|
||||
|
||||
▸ **getDefaultDirectoryBrowser**(`options?`): `Promise`<`AxiosResponse`<[`DefaultDirectoryBrowserInfoDto`](../interfaces/generated_client.DefaultDirectoryBrowserInfoDto.md)\>\>
|
||||
|
||||
**`summary`** Get Default directory browser.
|
||||
|
||||
**`throws`** {RequiredError}
|
||||
|
||||
**`memberof`** EnvironmentApi
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `options?` | `any` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`AxiosResponse`<[`DefaultDirectoryBrowserInfoDto`](../interfaces/generated_client.DefaultDirectoryBrowserInfoDto.md)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/environment-api.ts:485](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/environment-api.ts#L485)
|
||||
|
||||
___
|
||||
|
||||
### getDirectoryContents
|
||||
|
||||
▸ **getDirectoryContents**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`FileSystemEntryInfo`](../interfaces/generated_client.FileSystemEntryInfo.md)[]\>\>
|
||||
|
||||
**`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)[]\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/environment-api.ts:497](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/environment-api.ts#L497)
|
||||
|
||||
___
|
||||
|
||||
### getDrives
|
||||
|
||||
▸ **getDrives**(`options?`): `Promise`<`AxiosResponse`<[`FileSystemEntryInfo`](../interfaces/generated_client.FileSystemEntryInfo.md)[]\>\>
|
||||
|
||||
**`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)[]\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/environment-api.ts:508](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/environment-api.ts#L508)
|
||||
|
||||
___
|
||||
|
||||
### getNetworkShares
|
||||
|
||||
▸ **getNetworkShares**(`options?`): `Promise`<`AxiosResponse`<[`FileSystemEntryInfo`](../interfaces/generated_client.FileSystemEntryInfo.md)[]\>\>
|
||||
|
||||
**`summary`** Gets network paths.
|
||||
|
||||
**`deprecated`**
|
||||
|
||||
**`throws`** {RequiredError}
|
||||
|
||||
**`memberof`** EnvironmentApi
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `options?` | `any` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`AxiosResponse`<[`FileSystemEntryInfo`](../interfaces/generated_client.FileSystemEntryInfo.md)[]\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/environment-api.ts:520](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/environment-api.ts#L520)
|
||||
|
||||
___
|
||||
|
||||
### getParentPath
|
||||
|
||||
▸ **getParentPath**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`string`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/environment-api.ts:532](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/environment-api.ts#L532)
|
||||
|
||||
___
|
||||
|
||||
### validatePath
|
||||
|
||||
▸ **validatePath**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/environment-api.ts:544](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/environment-api.ts#L544)
|
File diff suppressed because one or more lines are too long
142
docs/classes/generated_client.FilterApi.md
Normal file
142
docs/classes/generated_client.FilterApi.md
Normal file
@ -0,0 +1,142 @@
|
||||
[jellyfin-sdk-typescript](../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 |
|
||||
| :------ | :------ |
|
||||
| `configuration?` | [`Configuration`](generated_client.Configuration.md) |
|
||||
| `basePath` | `string` |
|
||||
| `axios` | `AxiosInstance` |
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L52)
|
||||
|
||||
## Properties
|
||||
|
||||
### axios
|
||||
|
||||
• `Protected` **axios**: `AxiosInstance`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.axios
|
||||
|
||||
___
|
||||
|
||||
### basePath
|
||||
|
||||
• `Protected` **basePath**: `string`
|
||||
|
||||
#### 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/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L50)
|
||||
|
||||
## Methods
|
||||
|
||||
### getQueryFilters
|
||||
|
||||
▸ **getQueryFilters**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`QueryFilters`](../interfaces/generated_client.QueryFilters.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/filter-api.ts:385](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/filter-api.ts#L385)
|
||||
|
||||
___
|
||||
|
||||
### getQueryFiltersLegacy
|
||||
|
||||
▸ **getQueryFiltersLegacy**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`QueryFiltersLegacy`](../interfaces/generated_client.QueryFiltersLegacy.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/filter-api.ts:397](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/filter-api.ts#L397)
|
File diff suppressed because one or more lines are too long
142
docs/classes/generated_client.GenresApi.md
Normal file
142
docs/classes/generated_client.GenresApi.md
Normal file
@ -0,0 +1,142 @@
|
||||
[jellyfin-sdk-typescript](../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 |
|
||||
| :------ | :------ |
|
||||
| `configuration?` | [`Configuration`](generated_client.Configuration.md) |
|
||||
| `basePath` | `string` |
|
||||
| `axios` | `AxiosInstance` |
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L52)
|
||||
|
||||
## Properties
|
||||
|
||||
### axios
|
||||
|
||||
• `Protected` **axios**: `AxiosInstance`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.axios
|
||||
|
||||
___
|
||||
|
||||
### basePath
|
||||
|
||||
• `Protected` **basePath**: `string`
|
||||
|
||||
#### 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/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L50)
|
||||
|
||||
## Methods
|
||||
|
||||
### getGenre
|
||||
|
||||
▸ **getGenre**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/genres-api.ts:444](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/genres-api.ts#L444)
|
||||
|
||||
___
|
||||
|
||||
### getGenres
|
||||
|
||||
▸ **getGenres**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/genres-api.ts:456](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/genres-api.ts#L456)
|
File diff suppressed because one or more lines are too long
226
docs/classes/generated_client.HlsSegmentApi.md
Normal file
226
docs/classes/generated_client.HlsSegmentApi.md
Normal file
@ -0,0 +1,226 @@
|
||||
[jellyfin-sdk-typescript](../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 |
|
||||
| :------ | :------ |
|
||||
| `configuration?` | [`Configuration`](generated_client.Configuration.md) |
|
||||
| `basePath` | `string` |
|
||||
| `axios` | `AxiosInstance` |
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L52)
|
||||
|
||||
## Properties
|
||||
|
||||
### axios
|
||||
|
||||
• `Protected` **axios**: `AxiosInstance`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.axios
|
||||
|
||||
___
|
||||
|
||||
### basePath
|
||||
|
||||
• `Protected` **basePath**: `string`
|
||||
|
||||
#### 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/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L50)
|
||||
|
||||
## Methods
|
||||
|
||||
### getHlsAudioSegmentLegacyAac
|
||||
|
||||
▸ **getHlsAudioSegmentLegacyAac**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/hls-segment-api.ts:517](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/hls-segment-api.ts#L517)
|
||||
|
||||
___
|
||||
|
||||
### getHlsAudioSegmentLegacyMp3
|
||||
|
||||
▸ **getHlsAudioSegmentLegacyMp3**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/hls-segment-api.ts:529](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/hls-segment-api.ts#L529)
|
||||
|
||||
___
|
||||
|
||||
### getHlsPlaylistLegacy
|
||||
|
||||
▸ **getHlsPlaylistLegacy**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/hls-segment-api.ts:541](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/hls-segment-api.ts#L541)
|
||||
|
||||
___
|
||||
|
||||
### getHlsVideoSegmentLegacy
|
||||
|
||||
▸ **getHlsVideoSegmentLegacy**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/hls-segment-api.ts:553](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/hls-segment-api.ts#L553)
|
||||
|
||||
___
|
||||
|
||||
### stopEncodingProcess
|
||||
|
||||
▸ **stopEncodingProcess**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/hls-segment-api.ts:565](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/hls-segment-api.ts#L565)
|
File diff suppressed because one or more lines are too long
1150
docs/classes/generated_client.ImageApi.md
Normal file
1150
docs/classes/generated_client.ImageApi.md
Normal file
File diff suppressed because it is too large
Load Diff
File diff suppressed because one or more lines are too long
251
docs/classes/generated_client.ImageByNameApi.md
Normal file
251
docs/classes/generated_client.ImageByNameApi.md
Normal file
@ -0,0 +1,251 @@
|
||||
[jellyfin-sdk-typescript](../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 |
|
||||
| :------ | :------ |
|
||||
| `configuration?` | [`Configuration`](generated_client.Configuration.md) |
|
||||
| `basePath` | `string` |
|
||||
| `axios` | `AxiosInstance` |
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L52)
|
||||
|
||||
## Properties
|
||||
|
||||
### axios
|
||||
|
||||
• `Protected` **axios**: `AxiosInstance`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.axios
|
||||
|
||||
___
|
||||
|
||||
### basePath
|
||||
|
||||
• `Protected` **basePath**: `string`
|
||||
|
||||
#### 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/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L50)
|
||||
|
||||
## Methods
|
||||
|
||||
### getGeneralImage
|
||||
|
||||
▸ **getGeneralImage**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/image-by-name-api.ts:473](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/image-by-name-api.ts#L473)
|
||||
|
||||
___
|
||||
|
||||
### getGeneralImages
|
||||
|
||||
▸ **getGeneralImages**(`options?`): `Promise`<`AxiosResponse`<[`ImageByNameInfo`](../interfaces/generated_client.ImageByNameInfo.md)[]\>\>
|
||||
|
||||
**`summary`** Get all general images.
|
||||
|
||||
**`throws`** {RequiredError}
|
||||
|
||||
**`memberof`** ImageByNameApi
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `options?` | `any` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`AxiosResponse`<[`ImageByNameInfo`](../interfaces/generated_client.ImageByNameInfo.md)[]\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/image-by-name-api.ts:484](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/image-by-name-api.ts#L484)
|
||||
|
||||
___
|
||||
|
||||
### getMediaInfoImage
|
||||
|
||||
▸ **getMediaInfoImage**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/image-by-name-api.ts:496](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/image-by-name-api.ts#L496)
|
||||
|
||||
___
|
||||
|
||||
### getMediaInfoImages
|
||||
|
||||
▸ **getMediaInfoImages**(`options?`): `Promise`<`AxiosResponse`<[`ImageByNameInfo`](../interfaces/generated_client.ImageByNameInfo.md)[]\>\>
|
||||
|
||||
**`summary`** Get all media info images.
|
||||
|
||||
**`throws`** {RequiredError}
|
||||
|
||||
**`memberof`** ImageByNameApi
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `options?` | `any` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`AxiosResponse`<[`ImageByNameInfo`](../interfaces/generated_client.ImageByNameInfo.md)[]\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/image-by-name-api.ts:507](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/image-by-name-api.ts#L507)
|
||||
|
||||
___
|
||||
|
||||
### getRatingImage
|
||||
|
||||
▸ **getRatingImage**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/image-by-name-api.ts:519](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/image-by-name-api.ts#L519)
|
||||
|
||||
___
|
||||
|
||||
### getRatingImages
|
||||
|
||||
▸ **getRatingImages**(`options?`): `Promise`<`AxiosResponse`<[`ImageByNameInfo`](../interfaces/generated_client.ImageByNameInfo.md)[]\>\>
|
||||
|
||||
**`summary`** Get all general images.
|
||||
|
||||
**`throws`** {RequiredError}
|
||||
|
||||
**`memberof`** ImageByNameApi
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `options?` | `any` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`AxiosResponse`<[`ImageByNameInfo`](../interfaces/generated_client.ImageByNameInfo.md)[]\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/image-by-name-api.ts:530](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/image-by-name-api.ts#L530)
|
File diff suppressed because one or more lines are too long
342
docs/classes/generated_client.InstantMixApi.md
Normal file
342
docs/classes/generated_client.InstantMixApi.md
Normal file
@ -0,0 +1,342 @@
|
||||
[jellyfin-sdk-typescript](../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)
|
||||
- [getInstantMixFromMusicGenreById2](generated_client.InstantMixApi.md#getinstantmixfrommusicgenrebyid2)
|
||||
- [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 |
|
||||
| :------ | :------ |
|
||||
| `configuration?` | [`Configuration`](generated_client.Configuration.md) |
|
||||
| `basePath` | `string` |
|
||||
| `axios` | `AxiosInstance` |
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L52)
|
||||
|
||||
## Properties
|
||||
|
||||
### axios
|
||||
|
||||
• `Protected` **axios**: `AxiosInstance`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.axios
|
||||
|
||||
___
|
||||
|
||||
### basePath
|
||||
|
||||
• `Protected` **basePath**: `string`
|
||||
|
||||
#### 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/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L50)
|
||||
|
||||
## Methods
|
||||
|
||||
### getInstantMixFromAlbum
|
||||
|
||||
▸ **getInstantMixFromAlbum**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/instant-mix-api.ts:1615](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/instant-mix-api.ts#L1615)
|
||||
|
||||
___
|
||||
|
||||
### getInstantMixFromArtists
|
||||
|
||||
▸ **getInstantMixFromArtists**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/instant-mix-api.ts:1627](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/instant-mix-api.ts#L1627)
|
||||
|
||||
___
|
||||
|
||||
### getInstantMixFromArtists2
|
||||
|
||||
▸ **getInstantMixFromArtists2**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/instant-mix-api.ts:1640](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/instant-mix-api.ts#L1640)
|
||||
|
||||
___
|
||||
|
||||
### getInstantMixFromItem
|
||||
|
||||
▸ **getInstantMixFromItem**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/instant-mix-api.ts:1652](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/instant-mix-api.ts#L1652)
|
||||
|
||||
___
|
||||
|
||||
### getInstantMixFromMusicGenreById
|
||||
|
||||
▸ **getInstantMixFromMusicGenreById**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/instant-mix-api.ts:1664](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/instant-mix-api.ts#L1664)
|
||||
|
||||
___
|
||||
|
||||
### getInstantMixFromMusicGenreById2
|
||||
|
||||
▸ **getInstantMixFromMusicGenreById2**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\>
|
||||
|
||||
**`summary`** Creates an instant playlist based on a given genre.
|
||||
|
||||
**`deprecated`**
|
||||
|
||||
**`throws`** {RequiredError}
|
||||
|
||||
**`memberof`** InstantMixApi
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `requestParameters` | [`InstantMixApiGetInstantMixFromMusicGenreById2Request`](../interfaces/generated_client.InstantMixApiGetInstantMixFromMusicGenreById2Request.md) | Request parameters. |
|
||||
| `options?` | `any` | - |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/instant-mix-api.ts:1677](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/instant-mix-api.ts#L1677)
|
||||
|
||||
___
|
||||
|
||||
### getInstantMixFromMusicGenreByName
|
||||
|
||||
▸ **getInstantMixFromMusicGenreByName**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/instant-mix-api.ts:1689](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/instant-mix-api.ts#L1689)
|
||||
|
||||
___
|
||||
|
||||
### getInstantMixFromPlaylist
|
||||
|
||||
▸ **getInstantMixFromPlaylist**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/instant-mix-api.ts:1701](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/instant-mix-api.ts#L1701)
|
||||
|
||||
___
|
||||
|
||||
### getInstantMixFromSong
|
||||
|
||||
▸ **getInstantMixFromSong**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/instant-mix-api.ts:1713](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/instant-mix-api.ts#L1713)
|
File diff suppressed because one or more lines are too long
394
docs/classes/generated_client.ItemLookupApi.md
Normal file
394
docs/classes/generated_client.ItemLookupApi.md
Normal file
@ -0,0 +1,394 @@
|
||||
[jellyfin-sdk-typescript](../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 |
|
||||
| :------ | :------ |
|
||||
| `configuration?` | [`Configuration`](generated_client.Configuration.md) |
|
||||
| `basePath` | `string` |
|
||||
| `axios` | `AxiosInstance` |
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L52)
|
||||
|
||||
## Properties
|
||||
|
||||
### axios
|
||||
|
||||
• `Protected` **axios**: `AxiosInstance`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.axios
|
||||
|
||||
___
|
||||
|
||||
### basePath
|
||||
|
||||
• `Protected` **basePath**: `string`
|
||||
|
||||
#### 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/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L50)
|
||||
|
||||
## Methods
|
||||
|
||||
### applySearchCriteria
|
||||
|
||||
▸ **applySearchCriteria**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/item-lookup-api.ts:930](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/item-lookup-api.ts#L930)
|
||||
|
||||
___
|
||||
|
||||
### getBookRemoteSearchResults
|
||||
|
||||
▸ **getBookRemoteSearchResults**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[]\>\>
|
||||
|
||||
**`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)[]\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/item-lookup-api.ts:942](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/item-lookup-api.ts#L942)
|
||||
|
||||
___
|
||||
|
||||
### getBoxSetRemoteSearchResults
|
||||
|
||||
▸ **getBoxSetRemoteSearchResults**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[]\>\>
|
||||
|
||||
**`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)[]\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/item-lookup-api.ts:954](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/item-lookup-api.ts#L954)
|
||||
|
||||
___
|
||||
|
||||
### getExternalIdInfos
|
||||
|
||||
▸ **getExternalIdInfos**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`ExternalIdInfo`](../interfaces/generated_client.ExternalIdInfo.md)[]\>\>
|
||||
|
||||
**`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)[]\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/item-lookup-api.ts:966](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/item-lookup-api.ts#L966)
|
||||
|
||||
___
|
||||
|
||||
### getMovieRemoteSearchResults
|
||||
|
||||
▸ **getMovieRemoteSearchResults**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[]\>\>
|
||||
|
||||
**`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)[]\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/item-lookup-api.ts:978](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/item-lookup-api.ts#L978)
|
||||
|
||||
___
|
||||
|
||||
### getMusicAlbumRemoteSearchResults
|
||||
|
||||
▸ **getMusicAlbumRemoteSearchResults**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[]\>\>
|
||||
|
||||
**`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)[]\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/item-lookup-api.ts:990](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/item-lookup-api.ts#L990)
|
||||
|
||||
___
|
||||
|
||||
### getMusicArtistRemoteSearchResults
|
||||
|
||||
▸ **getMusicArtistRemoteSearchResults**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[]\>\>
|
||||
|
||||
**`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)[]\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/item-lookup-api.ts:1002](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/item-lookup-api.ts#L1002)
|
||||
|
||||
___
|
||||
|
||||
### getMusicVideoRemoteSearchResults
|
||||
|
||||
▸ **getMusicVideoRemoteSearchResults**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[]\>\>
|
||||
|
||||
**`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)[]\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/item-lookup-api.ts:1014](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/item-lookup-api.ts#L1014)
|
||||
|
||||
___
|
||||
|
||||
### getPersonRemoteSearchResults
|
||||
|
||||
▸ **getPersonRemoteSearchResults**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[]\>\>
|
||||
|
||||
**`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)[]\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/item-lookup-api.ts:1026](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/item-lookup-api.ts#L1026)
|
||||
|
||||
___
|
||||
|
||||
### getSeriesRemoteSearchResults
|
||||
|
||||
▸ **getSeriesRemoteSearchResults**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[]\>\>
|
||||
|
||||
**`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)[]\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/item-lookup-api.ts:1038](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/item-lookup-api.ts#L1038)
|
||||
|
||||
___
|
||||
|
||||
### getTrailerRemoteSearchResults
|
||||
|
||||
▸ **getTrailerRemoteSearchResults**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`RemoteSearchResult`](../interfaces/generated_client.RemoteSearchResult.md)[]\>\>
|
||||
|
||||
**`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)[]\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/item-lookup-api.ts:1050](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/item-lookup-api.ts#L1050)
|
File diff suppressed because one or more lines are too long
114
docs/classes/generated_client.ItemRefreshApi.md
Normal file
114
docs/classes/generated_client.ItemRefreshApi.md
Normal file
@ -0,0 +1,114 @@
|
||||
[jellyfin-sdk-typescript](../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
|
||||
|
||||
- [post](generated_client.ItemRefreshApi.md#post)
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new ItemRefreshApi**(`configuration?`, `basePath?`, `axios?`)
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `configuration?` | [`Configuration`](generated_client.Configuration.md) |
|
||||
| `basePath` | `string` |
|
||||
| `axios` | `AxiosInstance` |
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L52)
|
||||
|
||||
## Properties
|
||||
|
||||
### axios
|
||||
|
||||
• `Protected` **axios**: `AxiosInstance`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.axios
|
||||
|
||||
___
|
||||
|
||||
### basePath
|
||||
|
||||
• `Protected` **basePath**: `string`
|
||||
|
||||
#### 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/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L50)
|
||||
|
||||
## Methods
|
||||
|
||||
### post
|
||||
|
||||
▸ **post**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`summary`** Refreshes metadata for an item.
|
||||
|
||||
**`throws`** {RequiredError}
|
||||
|
||||
**`memberof`** ItemRefreshApi
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `requestParameters` | [`ItemRefreshApiPostRequest`](../interfaces/generated_client.ItemRefreshApiPostRequest.md) | Request parameters. |
|
||||
| `options?` | `any` | - |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/item-refresh-api.ts:199](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/item-refresh-api.ts#L199)
|
File diff suppressed because one or more lines are too long
170
docs/classes/generated_client.ItemUpdateApi.md
Normal file
170
docs/classes/generated_client.ItemUpdateApi.md
Normal file
@ -0,0 +1,170 @@
|
||||
[jellyfin-sdk-typescript](../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 |
|
||||
| :------ | :------ |
|
||||
| `configuration?` | [`Configuration`](generated_client.Configuration.md) |
|
||||
| `basePath` | `string` |
|
||||
| `axios` | `AxiosInstance` |
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L52)
|
||||
|
||||
## Properties
|
||||
|
||||
### axios
|
||||
|
||||
• `Protected` **axios**: `AxiosInstance`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.axios
|
||||
|
||||
___
|
||||
|
||||
### basePath
|
||||
|
||||
• `Protected` **basePath**: `string`
|
||||
|
||||
#### 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/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L50)
|
||||
|
||||
## Methods
|
||||
|
||||
### getMetadataEditorInfo
|
||||
|
||||
▸ **getMetadataEditorInfo**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`MetadataEditorInfo`](../interfaces/generated_client.MetadataEditorInfo.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/item-update-api.ts:318](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/item-update-api.ts#L318)
|
||||
|
||||
___
|
||||
|
||||
### updateItem
|
||||
|
||||
▸ **updateItem**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/item-update-api.ts:330](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/item-update-api.ts#L330)
|
||||
|
||||
___
|
||||
|
||||
### updateItemContentType
|
||||
|
||||
▸ **updateItemContentType**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/item-update-api.ts:342](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/item-update-api.ts#L342)
|
File diff suppressed because one or more lines are too long
170
docs/classes/generated_client.ItemsApi.md
Normal file
170
docs/classes/generated_client.ItemsApi.md
Normal file
@ -0,0 +1,170 @@
|
||||
[jellyfin-sdk-typescript](../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 |
|
||||
| :------ | :------ |
|
||||
| `configuration?` | [`Configuration`](generated_client.Configuration.md) |
|
||||
| `basePath` | `string` |
|
||||
| `axios` | `AxiosInstance` |
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L52)
|
||||
|
||||
## Properties
|
||||
|
||||
### axios
|
||||
|
||||
• `Protected` **axios**: `AxiosInstance`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.axios
|
||||
|
||||
___
|
||||
|
||||
### basePath
|
||||
|
||||
• `Protected` **basePath**: `string`
|
||||
|
||||
#### 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/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L50)
|
||||
|
||||
## Methods
|
||||
|
||||
### getItems
|
||||
|
||||
▸ **getItems**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/items-api.ts:2710](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/items-api.ts#L2710)
|
||||
|
||||
___
|
||||
|
||||
### getItemsByUserId
|
||||
|
||||
▸ **getItemsByUserId**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/items-api.ts:2722](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/items-api.ts#L2722)
|
||||
|
||||
___
|
||||
|
||||
### getResumeItems
|
||||
|
||||
▸ **getResumeItems**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/items-api.ts:2734](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/items-api.ts#L2734)
|
File diff suppressed because one or more lines are too long
786
docs/classes/generated_client.LibraryApi.md
Normal file
786
docs/classes/generated_client.LibraryApi.md
Normal file
@ -0,0 +1,786 @@
|
||||
[jellyfin-sdk-typescript](../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 |
|
||||
| :------ | :------ |
|
||||
| `configuration?` | [`Configuration`](generated_client.Configuration.md) |
|
||||
| `basePath` | `string` |
|
||||
| `axios` | `AxiosInstance` |
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L52)
|
||||
|
||||
## Properties
|
||||
|
||||
### axios
|
||||
|
||||
• `Protected` **axios**: `AxiosInstance`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.axios
|
||||
|
||||
___
|
||||
|
||||
### basePath
|
||||
|
||||
• `Protected` **basePath**: `string`
|
||||
|
||||
#### 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/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L50)
|
||||
|
||||
## Methods
|
||||
|
||||
### deleteItem
|
||||
|
||||
▸ **deleteItem**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/library-api.ts:2348](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/library-api.ts#L2348)
|
||||
|
||||
___
|
||||
|
||||
### deleteItems
|
||||
|
||||
▸ **deleteItems**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/library-api.ts:2360](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/library-api.ts#L2360)
|
||||
|
||||
___
|
||||
|
||||
### getAncestors
|
||||
|
||||
▸ **getAncestors**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)[]\>\>
|
||||
|
||||
**`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)[]\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/library-api.ts:2372](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/library-api.ts#L2372)
|
||||
|
||||
___
|
||||
|
||||
### getCriticReviews
|
||||
|
||||
▸ **getCriticReviews**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/library-api.ts:2385](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/library-api.ts#L2385)
|
||||
|
||||
___
|
||||
|
||||
### getDownload
|
||||
|
||||
▸ **getDownload**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/library-api.ts:2397](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/library-api.ts#L2397)
|
||||
|
||||
___
|
||||
|
||||
### getFile
|
||||
|
||||
▸ **getFile**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/library-api.ts:2409](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/library-api.ts#L2409)
|
||||
|
||||
___
|
||||
|
||||
### getItemCounts
|
||||
|
||||
▸ **getItemCounts**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`ItemCounts`](../interfaces/generated_client.ItemCounts.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/library-api.ts:2421](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/library-api.ts#L2421)
|
||||
|
||||
___
|
||||
|
||||
### getLibraryOptionsInfo
|
||||
|
||||
▸ **getLibraryOptionsInfo**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`LibraryOptionsResultDto`](../interfaces/generated_client.LibraryOptionsResultDto.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/library-api.ts:2433](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/library-api.ts#L2433)
|
||||
|
||||
___
|
||||
|
||||
### getMediaFolders
|
||||
|
||||
▸ **getMediaFolders**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/library-api.ts:2445](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/library-api.ts#L2445)
|
||||
|
||||
___
|
||||
|
||||
### getPhysicalPaths
|
||||
|
||||
▸ **getPhysicalPaths**(`options?`): `Promise`<`AxiosResponse`<`string`[]\>\>
|
||||
|
||||
**`summary`** Gets a list of physical paths from virtual folders.
|
||||
|
||||
**`throws`** {RequiredError}
|
||||
|
||||
**`memberof`** LibraryApi
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `options?` | `any` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`AxiosResponse`<`string`[]\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/library-api.ts:2456](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/library-api.ts#L2456)
|
||||
|
||||
___
|
||||
|
||||
### getSimilarAlbums
|
||||
|
||||
▸ **getSimilarAlbums**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/library-api.ts:2468](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/library-api.ts#L2468)
|
||||
|
||||
___
|
||||
|
||||
### getSimilarArtists
|
||||
|
||||
▸ **getSimilarArtists**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/library-api.ts:2480](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/library-api.ts#L2480)
|
||||
|
||||
___
|
||||
|
||||
### getSimilarItems
|
||||
|
||||
▸ **getSimilarItems**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/library-api.ts:2492](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/library-api.ts#L2492)
|
||||
|
||||
___
|
||||
|
||||
### getSimilarMovies
|
||||
|
||||
▸ **getSimilarMovies**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/library-api.ts:2504](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/library-api.ts#L2504)
|
||||
|
||||
___
|
||||
|
||||
### getSimilarShows
|
||||
|
||||
▸ **getSimilarShows**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/library-api.ts:2516](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/library-api.ts#L2516)
|
||||
|
||||
___
|
||||
|
||||
### getSimilarTrailers
|
||||
|
||||
▸ **getSimilarTrailers**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/library-api.ts:2528](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/library-api.ts#L2528)
|
||||
|
||||
___
|
||||
|
||||
### getThemeMedia
|
||||
|
||||
▸ **getThemeMedia**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`AllThemeMediaResult`](../interfaces/generated_client.AllThemeMediaResult.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/library-api.ts:2540](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/library-api.ts#L2540)
|
||||
|
||||
___
|
||||
|
||||
### getThemeSongs
|
||||
|
||||
▸ **getThemeSongs**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`ThemeMediaResult`](../interfaces/generated_client.ThemeMediaResult.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/library-api.ts:2552](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/library-api.ts#L2552)
|
||||
|
||||
___
|
||||
|
||||
### getThemeVideos
|
||||
|
||||
▸ **getThemeVideos**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`ThemeMediaResult`](../interfaces/generated_client.ThemeMediaResult.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/library-api.ts:2564](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/library-api.ts#L2564)
|
||||
|
||||
___
|
||||
|
||||
### postAddedMovies
|
||||
|
||||
▸ **postAddedMovies**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/library-api.ts:2576](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/library-api.ts#L2576)
|
||||
|
||||
___
|
||||
|
||||
### postAddedSeries
|
||||
|
||||
▸ **postAddedSeries**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/library-api.ts:2588](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/library-api.ts#L2588)
|
||||
|
||||
___
|
||||
|
||||
### postUpdatedMedia
|
||||
|
||||
▸ **postUpdatedMedia**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/library-api.ts:2600](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/library-api.ts#L2600)
|
||||
|
||||
___
|
||||
|
||||
### postUpdatedMovies
|
||||
|
||||
▸ **postUpdatedMovies**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/library-api.ts:2612](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/library-api.ts#L2612)
|
||||
|
||||
___
|
||||
|
||||
### postUpdatedSeries
|
||||
|
||||
▸ **postUpdatedSeries**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/library-api.ts:2624](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/library-api.ts#L2624)
|
||||
|
||||
___
|
||||
|
||||
### refreshLibrary
|
||||
|
||||
▸ **refreshLibrary**(`options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`summary`** Starts a library scan.
|
||||
|
||||
**`throws`** {RequiredError}
|
||||
|
||||
**`memberof`** LibraryApi
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `options?` | `any` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/library-api.ts:2635](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/library-api.ts#L2635)
|
File diff suppressed because one or more lines are too long
309
docs/classes/generated_client.LibraryStructureApi.md
Normal file
309
docs/classes/generated_client.LibraryStructureApi.md
Normal file
@ -0,0 +1,309 @@
|
||||
[jellyfin-sdk-typescript](../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 |
|
||||
| :------ | :------ |
|
||||
| `configuration?` | [`Configuration`](generated_client.Configuration.md) |
|
||||
| `basePath` | `string` |
|
||||
| `axios` | `AxiosInstance` |
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L52)
|
||||
|
||||
## Properties
|
||||
|
||||
### axios
|
||||
|
||||
• `Protected` **axios**: `AxiosInstance`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.axios
|
||||
|
||||
___
|
||||
|
||||
### basePath
|
||||
|
||||
• `Protected` **basePath**: `string`
|
||||
|
||||
#### 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/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L50)
|
||||
|
||||
## Methods
|
||||
|
||||
### addMediaPath
|
||||
|
||||
▸ **addMediaPath**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/library-structure-api.ts:784](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/library-structure-api.ts#L784)
|
||||
|
||||
___
|
||||
|
||||
### addVirtualFolder
|
||||
|
||||
▸ **addVirtualFolder**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/library-structure-api.ts:796](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/library-structure-api.ts#L796)
|
||||
|
||||
___
|
||||
|
||||
### getVirtualFolders
|
||||
|
||||
▸ **getVirtualFolders**(`options?`): `Promise`<`AxiosResponse`<[`VirtualFolderInfo`](../interfaces/generated_client.VirtualFolderInfo.md)[]\>\>
|
||||
|
||||
**`summary`** Gets all virtual folders.
|
||||
|
||||
**`throws`** {RequiredError}
|
||||
|
||||
**`memberof`** LibraryStructureApi
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `options?` | `any` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`AxiosResponse`<[`VirtualFolderInfo`](../interfaces/generated_client.VirtualFolderInfo.md)[]\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/library-structure-api.ts:807](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/library-structure-api.ts#L807)
|
||||
|
||||
___
|
||||
|
||||
### removeMediaPath
|
||||
|
||||
▸ **removeMediaPath**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/library-structure-api.ts:819](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/library-structure-api.ts#L819)
|
||||
|
||||
___
|
||||
|
||||
### removeVirtualFolder
|
||||
|
||||
▸ **removeVirtualFolder**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/library-structure-api.ts:831](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/library-structure-api.ts#L831)
|
||||
|
||||
___
|
||||
|
||||
### renameVirtualFolder
|
||||
|
||||
▸ **renameVirtualFolder**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/library-structure-api.ts:843](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/library-structure-api.ts#L843)
|
||||
|
||||
___
|
||||
|
||||
### updateLibraryOptions
|
||||
|
||||
▸ **updateLibraryOptions**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/library-structure-api.ts:855](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/library-structure-api.ts#L855)
|
||||
|
||||
___
|
||||
|
||||
### updateMediaPath
|
||||
|
||||
▸ **updateMediaPath**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/library-structure-api.ts:867](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/library-structure-api.ts#L867)
|
File diff suppressed because one or more lines are too long
1235
docs/classes/generated_client.LiveTvApi.md
Normal file
1235
docs/classes/generated_client.LiveTvApi.md
Normal file
File diff suppressed because it is too large
Load Diff
File diff suppressed because one or more lines are too long
194
docs/classes/generated_client.LocalizationApi.md
Normal file
194
docs/classes/generated_client.LocalizationApi.md
Normal file
@ -0,0 +1,194 @@
|
||||
[jellyfin-sdk-typescript](../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 |
|
||||
| :------ | :------ |
|
||||
| `configuration?` | [`Configuration`](generated_client.Configuration.md) |
|
||||
| `basePath` | `string` |
|
||||
| `axios` | `AxiosInstance` |
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L52)
|
||||
|
||||
## Properties
|
||||
|
||||
### axios
|
||||
|
||||
• `Protected` **axios**: `AxiosInstance`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.axios
|
||||
|
||||
___
|
||||
|
||||
### basePath
|
||||
|
||||
• `Protected` **basePath**: `string`
|
||||
|
||||
#### 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/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L50)
|
||||
|
||||
## Methods
|
||||
|
||||
### getCountries
|
||||
|
||||
▸ **getCountries**(`options?`): `Promise`<`AxiosResponse`<[`CountryInfo`](../interfaces/generated_client.CountryInfo.md)[]\>\>
|
||||
|
||||
**`summary`** Gets known countries.
|
||||
|
||||
**`throws`** {RequiredError}
|
||||
|
||||
**`memberof`** LocalizationApi
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `options?` | `any` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`AxiosResponse`<[`CountryInfo`](../interfaces/generated_client.CountryInfo.md)[]\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/localization-api.ts:282](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/localization-api.ts#L282)
|
||||
|
||||
___
|
||||
|
||||
### getCultures
|
||||
|
||||
▸ **getCultures**(`options?`): `Promise`<`AxiosResponse`<[`CultureDto`](../interfaces/generated_client.CultureDto.md)[]\>\>
|
||||
|
||||
**`summary`** Gets known cultures.
|
||||
|
||||
**`throws`** {RequiredError}
|
||||
|
||||
**`memberof`** LocalizationApi
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `options?` | `any` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`AxiosResponse`<[`CultureDto`](../interfaces/generated_client.CultureDto.md)[]\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/localization-api.ts:293](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/localization-api.ts#L293)
|
||||
|
||||
___
|
||||
|
||||
### getLocalizationOptions
|
||||
|
||||
▸ **getLocalizationOptions**(`options?`): `Promise`<`AxiosResponse`<[`LocalizationOption`](../interfaces/generated_client.LocalizationOption.md)[]\>\>
|
||||
|
||||
**`summary`** Gets localization options.
|
||||
|
||||
**`throws`** {RequiredError}
|
||||
|
||||
**`memberof`** LocalizationApi
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `options?` | `any` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`AxiosResponse`<[`LocalizationOption`](../interfaces/generated_client.LocalizationOption.md)[]\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/localization-api.ts:304](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/localization-api.ts#L304)
|
||||
|
||||
___
|
||||
|
||||
### getParentalRatings
|
||||
|
||||
▸ **getParentalRatings**(`options?`): `Promise`<`AxiosResponse`<[`ParentalRating`](../interfaces/generated_client.ParentalRating.md)[]\>\>
|
||||
|
||||
**`summary`** Gets known parental ratings.
|
||||
|
||||
**`throws`** {RequiredError}
|
||||
|
||||
**`memberof`** LocalizationApi
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `options?` | `any` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`AxiosResponse`<[`ParentalRating`](../interfaces/generated_client.ParentalRating.md)[]\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/localization-api.ts:315](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/localization-api.ts#L315)
|
File diff suppressed because one or more lines are too long
228
docs/classes/generated_client.MediaInfoApi.md
Normal file
228
docs/classes/generated_client.MediaInfoApi.md
Normal file
@ -0,0 +1,228 @@
|
||||
[jellyfin-sdk-typescript](../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 |
|
||||
| :------ | :------ |
|
||||
| `configuration?` | [`Configuration`](generated_client.Configuration.md) |
|
||||
| `basePath` | `string` |
|
||||
| `axios` | `AxiosInstance` |
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L52)
|
||||
|
||||
## Properties
|
||||
|
||||
### axios
|
||||
|
||||
• `Protected` **axios**: `AxiosInstance`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.axios
|
||||
|
||||
___
|
||||
|
||||
### basePath
|
||||
|
||||
• `Protected` **basePath**: `string`
|
||||
|
||||
#### 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/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L50)
|
||||
|
||||
## Methods
|
||||
|
||||
### closeLiveStream
|
||||
|
||||
▸ **closeLiveStream**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/media-info-api.ts:820](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/media-info-api.ts#L820)
|
||||
|
||||
___
|
||||
|
||||
### getBitrateTestBytes
|
||||
|
||||
▸ **getBitrateTestBytes**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/media-info-api.ts:832](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/media-info-api.ts#L832)
|
||||
|
||||
___
|
||||
|
||||
### getPlaybackInfo
|
||||
|
||||
▸ **getPlaybackInfo**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`PlaybackInfoResponse`](../interfaces/generated_client.PlaybackInfoResponse.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/media-info-api.ts:844](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/media-info-api.ts#L844)
|
||||
|
||||
___
|
||||
|
||||
### getPostedPlaybackInfo
|
||||
|
||||
▸ **getPostedPlaybackInfo**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`PlaybackInfoResponse`](../interfaces/generated_client.PlaybackInfoResponse.md)\>\>
|
||||
|
||||
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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/media-info-api.ts:856](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/media-info-api.ts#L856)
|
||||
|
||||
___
|
||||
|
||||
### openLiveStream
|
||||
|
||||
▸ **openLiveStream**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`LiveStreamResponse`](../interfaces/generated_client.LiveStreamResponse.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/media-info-api.ts:868](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/media-info-api.ts#L868)
|
File diff suppressed because one or more lines are too long
114
docs/classes/generated_client.MoviesApi.md
Normal file
114
docs/classes/generated_client.MoviesApi.md
Normal file
@ -0,0 +1,114 @@
|
||||
[jellyfin-sdk-typescript](../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 |
|
||||
| :------ | :------ |
|
||||
| `configuration?` | [`Configuration`](generated_client.Configuration.md) |
|
||||
| `basePath` | `string` |
|
||||
| `axios` | `AxiosInstance` |
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L52)
|
||||
|
||||
## Properties
|
||||
|
||||
### axios
|
||||
|
||||
• `Protected` **axios**: `AxiosInstance`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.axios
|
||||
|
||||
___
|
||||
|
||||
### basePath
|
||||
|
||||
• `Protected` **basePath**: `string`
|
||||
|
||||
#### 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/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L50)
|
||||
|
||||
## Methods
|
||||
|
||||
### getMovieRecommendations
|
||||
|
||||
▸ **getMovieRecommendations**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`RecommendationDto`](../interfaces/generated_client.RecommendationDto.md)[]\>\>
|
||||
|
||||
**`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)[]\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/movies-api.ts:200](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/movies-api.ts#L200)
|
File diff suppressed because one or more lines are too long
144
docs/classes/generated_client.MusicGenresApi.md
Normal file
144
docs/classes/generated_client.MusicGenresApi.md
Normal file
@ -0,0 +1,144 @@
|
||||
[jellyfin-sdk-typescript](../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 |
|
||||
| :------ | :------ |
|
||||
| `configuration?` | [`Configuration`](generated_client.Configuration.md) |
|
||||
| `basePath` | `string` |
|
||||
| `axios` | `AxiosInstance` |
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L52)
|
||||
|
||||
## Properties
|
||||
|
||||
### axios
|
||||
|
||||
• `Protected` **axios**: `AxiosInstance`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.axios
|
||||
|
||||
___
|
||||
|
||||
### basePath
|
||||
|
||||
• `Protected` **basePath**: `string`
|
||||
|
||||
#### 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/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L50)
|
||||
|
||||
## Methods
|
||||
|
||||
### getMusicGenre
|
||||
|
||||
▸ **getMusicGenre**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/music-genres-api.ts:447](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/music-genres-api.ts#L447)
|
||||
|
||||
___
|
||||
|
||||
### getMusicGenres
|
||||
|
||||
▸ **getMusicGenres**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/music-genres-api.ts:460](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/music-genres-api.ts#L460)
|
File diff suppressed because one or more lines are too long
280
docs/classes/generated_client.NotificationsApi.md
Normal file
280
docs/classes/generated_client.NotificationsApi.md
Normal file
@ -0,0 +1,280 @@
|
||||
[jellyfin-sdk-typescript](../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 |
|
||||
| :------ | :------ |
|
||||
| `configuration?` | [`Configuration`](generated_client.Configuration.md) |
|
||||
| `basePath` | `string` |
|
||||
| `axios` | `AxiosInstance` |
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L52)
|
||||
|
||||
## Properties
|
||||
|
||||
### axios
|
||||
|
||||
• `Protected` **axios**: `AxiosInstance`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.axios
|
||||
|
||||
___
|
||||
|
||||
### basePath
|
||||
|
||||
• `Protected` **basePath**: `string`
|
||||
|
||||
#### 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/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L50)
|
||||
|
||||
## Methods
|
||||
|
||||
### createAdminNotification
|
||||
|
||||
▸ **createAdminNotification**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/notifications-api.ts:543](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/notifications-api.ts#L543)
|
||||
|
||||
___
|
||||
|
||||
### getNotificationServices
|
||||
|
||||
▸ **getNotificationServices**(`options?`): `Promise`<`AxiosResponse`<[`NameIdPair`](../interfaces/generated_client.NameIdPair.md)[]\>\>
|
||||
|
||||
**`summary`** Gets notification services.
|
||||
|
||||
**`throws`** {RequiredError}
|
||||
|
||||
**`memberof`** NotificationsApi
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `options?` | `any` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`AxiosResponse`<[`NameIdPair`](../interfaces/generated_client.NameIdPair.md)[]\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/notifications-api.ts:554](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/notifications-api.ts#L554)
|
||||
|
||||
___
|
||||
|
||||
### getNotificationTypes
|
||||
|
||||
▸ **getNotificationTypes**(`options?`): `Promise`<`AxiosResponse`<[`NotificationTypeInfo`](../interfaces/generated_client.NotificationTypeInfo.md)[]\>\>
|
||||
|
||||
**`summary`** Gets notification types.
|
||||
|
||||
**`throws`** {RequiredError}
|
||||
|
||||
**`memberof`** NotificationsApi
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `options?` | `any` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`AxiosResponse`<[`NotificationTypeInfo`](../interfaces/generated_client.NotificationTypeInfo.md)[]\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/notifications-api.ts:565](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/notifications-api.ts#L565)
|
||||
|
||||
___
|
||||
|
||||
### getNotifications
|
||||
|
||||
▸ **getNotifications**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`NotificationResultDto`](../interfaces/generated_client.NotificationResultDto.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/notifications-api.ts:577](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/notifications-api.ts#L577)
|
||||
|
||||
___
|
||||
|
||||
### getNotificationsSummary
|
||||
|
||||
▸ **getNotificationsSummary**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`NotificationsSummaryDto`](../interfaces/generated_client.NotificationsSummaryDto.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/notifications-api.ts:589](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/notifications-api.ts#L589)
|
||||
|
||||
___
|
||||
|
||||
### setRead
|
||||
|
||||
▸ **setRead**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/notifications-api.ts:601](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/notifications-api.ts#L601)
|
||||
|
||||
___
|
||||
|
||||
### setUnread
|
||||
|
||||
▸ **setUnread**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/notifications-api.ts:613](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/notifications-api.ts#L613)
|
File diff suppressed because one or more lines are too long
252
docs/classes/generated_client.PackageApi.md
Normal file
252
docs/classes/generated_client.PackageApi.md
Normal file
@ -0,0 +1,252 @@
|
||||
[jellyfin-sdk-typescript](../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 |
|
||||
| :------ | :------ |
|
||||
| `configuration?` | [`Configuration`](generated_client.Configuration.md) |
|
||||
| `basePath` | `string` |
|
||||
| `axios` | `AxiosInstance` |
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L52)
|
||||
|
||||
## Properties
|
||||
|
||||
### axios
|
||||
|
||||
• `Protected` **axios**: `AxiosInstance`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.axios
|
||||
|
||||
___
|
||||
|
||||
### basePath
|
||||
|
||||
• `Protected` **basePath**: `string`
|
||||
|
||||
#### 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/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L50)
|
||||
|
||||
## Methods
|
||||
|
||||
### cancelPackageInstallation
|
||||
|
||||
▸ **cancelPackageInstallation**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/package-api.ts:523](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/package-api.ts#L523)
|
||||
|
||||
___
|
||||
|
||||
### getPackageInfo
|
||||
|
||||
▸ **getPackageInfo**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`PackageInfo`](../interfaces/generated_client.PackageInfo.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/package-api.ts:535](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/package-api.ts#L535)
|
||||
|
||||
___
|
||||
|
||||
### getPackages
|
||||
|
||||
▸ **getPackages**(`options?`): `Promise`<`AxiosResponse`<[`PackageInfo`](../interfaces/generated_client.PackageInfo.md)[]\>\>
|
||||
|
||||
**`summary`** Gets available packages.
|
||||
|
||||
**`throws`** {RequiredError}
|
||||
|
||||
**`memberof`** PackageApi
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `options?` | `any` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`AxiosResponse`<[`PackageInfo`](../interfaces/generated_client.PackageInfo.md)[]\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/package-api.ts:546](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/package-api.ts#L546)
|
||||
|
||||
___
|
||||
|
||||
### getRepositories
|
||||
|
||||
▸ **getRepositories**(`options?`): `Promise`<`AxiosResponse`<[`RepositoryInfo`](../interfaces/generated_client.RepositoryInfo.md)[]\>\>
|
||||
|
||||
**`summary`** Gets all package repositories.
|
||||
|
||||
**`throws`** {RequiredError}
|
||||
|
||||
**`memberof`** PackageApi
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `options?` | `any` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`AxiosResponse`<[`RepositoryInfo`](../interfaces/generated_client.RepositoryInfo.md)[]\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/package-api.ts:557](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/package-api.ts#L557)
|
||||
|
||||
___
|
||||
|
||||
### installPackage
|
||||
|
||||
▸ **installPackage**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/package-api.ts:569](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/package-api.ts#L569)
|
||||
|
||||
___
|
||||
|
||||
### setRepositories
|
||||
|
||||
▸ **setRepositories**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/package-api.ts:581](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/package-api.ts#L581)
|
File diff suppressed because one or more lines are too long
142
docs/classes/generated_client.PersonsApi.md
Normal file
142
docs/classes/generated_client.PersonsApi.md
Normal file
@ -0,0 +1,142 @@
|
||||
[jellyfin-sdk-typescript](../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 |
|
||||
| :------ | :------ |
|
||||
| `configuration?` | [`Configuration`](generated_client.Configuration.md) |
|
||||
| `basePath` | `string` |
|
||||
| `axios` | `AxiosInstance` |
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L52)
|
||||
|
||||
## Properties
|
||||
|
||||
### axios
|
||||
|
||||
• `Protected` **axios**: `AxiosInstance`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.axios
|
||||
|
||||
___
|
||||
|
||||
### basePath
|
||||
|
||||
• `Protected` **basePath**: `string`
|
||||
|
||||
#### 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/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L50)
|
||||
|
||||
## Methods
|
||||
|
||||
### getPerson
|
||||
|
||||
▸ **getPerson**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDto`](../interfaces/generated_client.BaseItemDto.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/persons-api.ts:406](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/persons-api.ts#L406)
|
||||
|
||||
___
|
||||
|
||||
### getPersons
|
||||
|
||||
▸ **getPersons**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/persons-api.ts:418](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/persons-api.ts#L418)
|
File diff suppressed because one or more lines are too long
228
docs/classes/generated_client.PlaylistsApi.md
Normal file
228
docs/classes/generated_client.PlaylistsApi.md
Normal file
@ -0,0 +1,228 @@
|
||||
[jellyfin-sdk-typescript](../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 |
|
||||
| :------ | :------ |
|
||||
| `configuration?` | [`Configuration`](generated_client.Configuration.md) |
|
||||
| `basePath` | `string` |
|
||||
| `axios` | `AxiosInstance` |
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L52)
|
||||
|
||||
## Properties
|
||||
|
||||
### axios
|
||||
|
||||
• `Protected` **axios**: `AxiosInstance`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.axios
|
||||
|
||||
___
|
||||
|
||||
### basePath
|
||||
|
||||
• `Protected` **basePath**: `string`
|
||||
|
||||
#### 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/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L50)
|
||||
|
||||
## Methods
|
||||
|
||||
### addToPlaylist
|
||||
|
||||
▸ **addToPlaylist**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/playlists-api.ts:675](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/playlists-api.ts#L675)
|
||||
|
||||
___
|
||||
|
||||
### createPlaylist
|
||||
|
||||
▸ **createPlaylist**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`PlaylistCreationResult`](../interfaces/generated_client.PlaylistCreationResult.md)\>\>
|
||||
|
||||
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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/playlists-api.ts:687](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/playlists-api.ts#L687)
|
||||
|
||||
___
|
||||
|
||||
### getPlaylistItems
|
||||
|
||||
▸ **getPlaylistItems**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`BaseItemDtoQueryResult`](../interfaces/generated_client.BaseItemDtoQueryResult.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/playlists-api.ts:699](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/playlists-api.ts#L699)
|
||||
|
||||
___
|
||||
|
||||
### moveItem
|
||||
|
||||
▸ **moveItem**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/playlists-api.ts:711](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/playlists-api.ts#L711)
|
||||
|
||||
___
|
||||
|
||||
### removeFromPlaylist
|
||||
|
||||
▸ **removeFromPlaylist**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/playlists-api.ts:723](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/playlists-api.ts#L723)
|
File diff suppressed because one or more lines are too long
338
docs/classes/generated_client.PlaystateApi.md
Normal file
338
docs/classes/generated_client.PlaystateApi.md
Normal file
@ -0,0 +1,338 @@
|
||||
[jellyfin-sdk-typescript](../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 |
|
||||
| :------ | :------ |
|
||||
| `configuration?` | [`Configuration`](generated_client.Configuration.md) |
|
||||
| `basePath` | `string` |
|
||||
| `axios` | `AxiosInstance` |
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L52)
|
||||
|
||||
## Properties
|
||||
|
||||
### axios
|
||||
|
||||
• `Protected` **axios**: `AxiosInstance`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.axios
|
||||
|
||||
___
|
||||
|
||||
### basePath
|
||||
|
||||
• `Protected` **basePath**: `string`
|
||||
|
||||
#### 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/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L50)
|
||||
|
||||
## Methods
|
||||
|
||||
### markPlayedItem
|
||||
|
||||
▸ **markPlayedItem**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`UserItemDataDto`](../interfaces/generated_client.UserItemDataDto.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/playstate-api.ts:1133](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/playstate-api.ts#L1133)
|
||||
|
||||
___
|
||||
|
||||
### markUnplayedItem
|
||||
|
||||
▸ **markUnplayedItem**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`UserItemDataDto`](../interfaces/generated_client.UserItemDataDto.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/playstate-api.ts:1145](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/playstate-api.ts#L1145)
|
||||
|
||||
___
|
||||
|
||||
### onPlaybackProgress
|
||||
|
||||
▸ **onPlaybackProgress**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/playstate-api.ts:1157](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/playstate-api.ts#L1157)
|
||||
|
||||
___
|
||||
|
||||
### onPlaybackStart
|
||||
|
||||
▸ **onPlaybackStart**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/playstate-api.ts:1169](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/playstate-api.ts#L1169)
|
||||
|
||||
___
|
||||
|
||||
### onPlaybackStopped
|
||||
|
||||
▸ **onPlaybackStopped**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/playstate-api.ts:1181](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/playstate-api.ts#L1181)
|
||||
|
||||
___
|
||||
|
||||
### pingPlaybackSession
|
||||
|
||||
▸ **pingPlaybackSession**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/playstate-api.ts:1193](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/playstate-api.ts#L1193)
|
||||
|
||||
___
|
||||
|
||||
### reportPlaybackProgress
|
||||
|
||||
▸ **reportPlaybackProgress**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/playstate-api.ts:1205](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/playstate-api.ts#L1205)
|
||||
|
||||
___
|
||||
|
||||
### reportPlaybackStart
|
||||
|
||||
▸ **reportPlaybackStart**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/playstate-api.ts:1217](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/playstate-api.ts#L1217)
|
||||
|
||||
___
|
||||
|
||||
### reportPlaybackStopped
|
||||
|
||||
▸ **reportPlaybackStopped**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/playstate-api.ts:1229](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/playstate-api.ts#L1229)
|
File diff suppressed because one or more lines are too long
371
docs/classes/generated_client.PluginsApi.md
Normal file
371
docs/classes/generated_client.PluginsApi.md
Normal file
@ -0,0 +1,371 @@
|
||||
[jellyfin-sdk-typescript](../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)
|
||||
- [updatePluginSecurityInfo](generated_client.PluginsApi.md#updatepluginsecurityinfo)
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new PluginsApi**(`configuration?`, `basePath?`, `axios?`)
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `configuration?` | [`Configuration`](generated_client.Configuration.md) |
|
||||
| `basePath` | `string` |
|
||||
| `axios` | `AxiosInstance` |
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L52)
|
||||
|
||||
## Properties
|
||||
|
||||
### axios
|
||||
|
||||
• `Protected` **axios**: `AxiosInstance`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.axios
|
||||
|
||||
___
|
||||
|
||||
### basePath
|
||||
|
||||
• `Protected` **basePath**: `string`
|
||||
|
||||
#### 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/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L50)
|
||||
|
||||
## Methods
|
||||
|
||||
### disablePlugin
|
||||
|
||||
▸ **disablePlugin**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/plugins-api.ts:835](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/plugins-api.ts#L835)
|
||||
|
||||
___
|
||||
|
||||
### enablePlugin
|
||||
|
||||
▸ **enablePlugin**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/plugins-api.ts:847](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/plugins-api.ts#L847)
|
||||
|
||||
___
|
||||
|
||||
### getPluginConfiguration
|
||||
|
||||
▸ **getPluginConfiguration**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`object`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/plugins-api.ts:859](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/plugins-api.ts#L859)
|
||||
|
||||
___
|
||||
|
||||
### getPluginImage
|
||||
|
||||
▸ **getPluginImage**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/plugins-api.ts:871](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/plugins-api.ts#L871)
|
||||
|
||||
___
|
||||
|
||||
### getPluginManifest
|
||||
|
||||
▸ **getPluginManifest**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/plugins-api.ts:883](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/plugins-api.ts#L883)
|
||||
|
||||
___
|
||||
|
||||
### getPlugins
|
||||
|
||||
▸ **getPlugins**(`options?`): `Promise`<`AxiosResponse`<[`PluginInfo`](../interfaces/generated_client.PluginInfo.md)[]\>\>
|
||||
|
||||
**`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)[]\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/plugins-api.ts:894](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/plugins-api.ts#L894)
|
||||
|
||||
___
|
||||
|
||||
### uninstallPlugin
|
||||
|
||||
▸ **uninstallPlugin**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/plugins-api.ts:907](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/plugins-api.ts#L907)
|
||||
|
||||
___
|
||||
|
||||
### uninstallPluginByVersion
|
||||
|
||||
▸ **uninstallPluginByVersion**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/plugins-api.ts:919](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/plugins-api.ts#L919)
|
||||
|
||||
___
|
||||
|
||||
### updatePluginConfiguration
|
||||
|
||||
▸ **updatePluginConfiguration**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/plugins-api.ts:931](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/plugins-api.ts#L931)
|
||||
|
||||
___
|
||||
|
||||
### updatePluginSecurityInfo
|
||||
|
||||
▸ **updatePluginSecurityInfo**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`summary`** Updates plugin security info.
|
||||
|
||||
**`deprecated`**
|
||||
|
||||
**`throws`** {RequiredError}
|
||||
|
||||
**`memberof`** PluginsApi
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `requestParameters` | [`PluginsApiUpdatePluginSecurityInfoRequest`](../interfaces/generated_client.PluginsApiUpdatePluginSecurityInfoRequest.md) | Request parameters. |
|
||||
| `options?` | `any` | - |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/plugins-api.ts:944](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/plugins-api.ts#L944)
|
File diff suppressed because one or more lines are too long
278
docs/classes/generated_client.QuickConnectApi.md
Normal file
278
docs/classes/generated_client.QuickConnectApi.md
Normal file
@ -0,0 +1,278 @@
|
||||
[jellyfin-sdk-typescript](../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
|
||||
|
||||
- [activate](generated_client.QuickConnectApi.md#activate)
|
||||
- [authorize](generated_client.QuickConnectApi.md#authorize)
|
||||
- [available](generated_client.QuickConnectApi.md#available)
|
||||
- [connect](generated_client.QuickConnectApi.md#connect)
|
||||
- [deauthorize](generated_client.QuickConnectApi.md#deauthorize)
|
||||
- [getStatus](generated_client.QuickConnectApi.md#getstatus)
|
||||
- [initiate](generated_client.QuickConnectApi.md#initiate)
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new QuickConnectApi**(`configuration?`, `basePath?`, `axios?`)
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `configuration?` | [`Configuration`](generated_client.Configuration.md) |
|
||||
| `basePath` | `string` |
|
||||
| `axios` | `AxiosInstance` |
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L52)
|
||||
|
||||
## Properties
|
||||
|
||||
### axios
|
||||
|
||||
• `Protected` **axios**: `AxiosInstance`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.axios
|
||||
|
||||
___
|
||||
|
||||
### basePath
|
||||
|
||||
• `Protected` **basePath**: `string`
|
||||
|
||||
#### 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/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L50)
|
||||
|
||||
## Methods
|
||||
|
||||
### activate
|
||||
|
||||
▸ **activate**(`options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`summary`** Temporarily activates quick connect for five minutes.
|
||||
|
||||
**`throws`** {RequiredError}
|
||||
|
||||
**`memberof`** QuickConnectApi
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `options?` | `any` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/quick-connect-api.ts:494](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/quick-connect-api.ts#L494)
|
||||
|
||||
___
|
||||
|
||||
### authorize
|
||||
|
||||
▸ **authorize**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`boolean`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/quick-connect-api.ts:506](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/quick-connect-api.ts#L506)
|
||||
|
||||
___
|
||||
|
||||
### available
|
||||
|
||||
▸ **available**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`summary`** Enables or disables quick connect.
|
||||
|
||||
**`throws`** {RequiredError}
|
||||
|
||||
**`memberof`** QuickConnectApi
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `requestParameters` | [`QuickConnectApiAvailableRequest`](../interfaces/generated_client.QuickConnectApiAvailableRequest.md) | Request parameters. |
|
||||
| `options?` | `any` | - |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/quick-connect-api.ts:518](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/quick-connect-api.ts#L518)
|
||||
|
||||
___
|
||||
|
||||
### connect
|
||||
|
||||
▸ **connect**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`QuickConnectResult`](../interfaces/generated_client.QuickConnectResult.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/quick-connect-api.ts:530](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/quick-connect-api.ts#L530)
|
||||
|
||||
___
|
||||
|
||||
### deauthorize
|
||||
|
||||
▸ **deauthorize**(`options?`): `Promise`<`AxiosResponse`<`number`\>\>
|
||||
|
||||
**`summary`** Deauthorize all quick connect devices for the current user.
|
||||
|
||||
**`throws`** {RequiredError}
|
||||
|
||||
**`memberof`** QuickConnectApi
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `options?` | `any` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`AxiosResponse`<`number`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/quick-connect-api.ts:541](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/quick-connect-api.ts#L541)
|
||||
|
||||
___
|
||||
|
||||
### getStatus
|
||||
|
||||
▸ **getStatus**(`options?`): `Promise`<`AxiosResponse`<[`QuickConnectState`](../enums/generated_client.QuickConnectState.md)\>\>
|
||||
|
||||
**`summary`** Gets the current quick connect state.
|
||||
|
||||
**`throws`** {RequiredError}
|
||||
|
||||
**`memberof`** QuickConnectApi
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `options?` | `any` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`AxiosResponse`<[`QuickConnectState`](../enums/generated_client.QuickConnectState.md)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/quick-connect-api.ts:552](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/quick-connect-api.ts#L552)
|
||||
|
||||
___
|
||||
|
||||
### initiate
|
||||
|
||||
▸ **initiate**(`options?`): `Promise`<`AxiosResponse`<[`QuickConnectResult`](../interfaces/generated_client.QuickConnectResult.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/quick-connect-api.ts:563](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/quick-connect-api.ts#L563)
|
File diff suppressed because one or more lines are too long
170
docs/classes/generated_client.RemoteImageApi.md
Normal file
170
docs/classes/generated_client.RemoteImageApi.md
Normal file
@ -0,0 +1,170 @@
|
||||
[jellyfin-sdk-typescript](../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 |
|
||||
| :------ | :------ |
|
||||
| `configuration?` | [`Configuration`](generated_client.Configuration.md) |
|
||||
| `basePath` | `string` |
|
||||
| `axios` | `AxiosInstance` |
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L52)
|
||||
|
||||
## Properties
|
||||
|
||||
### axios
|
||||
|
||||
• `Protected` **axios**: `AxiosInstance`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.axios
|
||||
|
||||
___
|
||||
|
||||
### basePath
|
||||
|
||||
• `Protected` **basePath**: `string`
|
||||
|
||||
#### 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/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L50)
|
||||
|
||||
## Methods
|
||||
|
||||
### downloadRemoteImage
|
||||
|
||||
▸ **downloadRemoteImage**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/remote-image-api.ts:391](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/remote-image-api.ts#L391)
|
||||
|
||||
___
|
||||
|
||||
### getRemoteImageProviders
|
||||
|
||||
▸ **getRemoteImageProviders**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`ImageProviderInfo`](../interfaces/generated_client.ImageProviderInfo.md)[]\>\>
|
||||
|
||||
**`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)[]\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/remote-image-api.ts:403](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/remote-image-api.ts#L403)
|
||||
|
||||
___
|
||||
|
||||
### getRemoteImages
|
||||
|
||||
▸ **getRemoteImages**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`RemoteImageResult`](../interfaces/generated_client.RemoteImageResult.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/remote-image-api.ts:415](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/remote-image-api.ts#L415)
|
File diff suppressed because one or more lines are too long
226
docs/classes/generated_client.ScheduledTasksApi.md
Normal file
226
docs/classes/generated_client.ScheduledTasksApi.md
Normal file
@ -0,0 +1,226 @@
|
||||
[jellyfin-sdk-typescript](../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 |
|
||||
| :------ | :------ |
|
||||
| `configuration?` | [`Configuration`](generated_client.Configuration.md) |
|
||||
| `basePath` | `string` |
|
||||
| `axios` | `AxiosInstance` |
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L52)
|
||||
|
||||
## Properties
|
||||
|
||||
### axios
|
||||
|
||||
• `Protected` **axios**: `AxiosInstance`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.axios
|
||||
|
||||
___
|
||||
|
||||
### basePath
|
||||
|
||||
• `Protected` **basePath**: `string`
|
||||
|
||||
#### 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/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L50)
|
||||
|
||||
## Methods
|
||||
|
||||
### getTask
|
||||
|
||||
▸ **getTask**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`TaskInfo`](../interfaces/generated_client.TaskInfo.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/scheduled-tasks-api.ts:463](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/scheduled-tasks-api.ts#L463)
|
||||
|
||||
___
|
||||
|
||||
### getTasks
|
||||
|
||||
▸ **getTasks**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`TaskInfo`](../interfaces/generated_client.TaskInfo.md)[]\>\>
|
||||
|
||||
**`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)[]\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/scheduled-tasks-api.ts:475](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/scheduled-tasks-api.ts#L475)
|
||||
|
||||
___
|
||||
|
||||
### startTask
|
||||
|
||||
▸ **startTask**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/scheduled-tasks-api.ts:487](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/scheduled-tasks-api.ts#L487)
|
||||
|
||||
___
|
||||
|
||||
### stopTask
|
||||
|
||||
▸ **stopTask**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/scheduled-tasks-api.ts:499](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/scheduled-tasks-api.ts#L499)
|
||||
|
||||
___
|
||||
|
||||
### updateTask
|
||||
|
||||
▸ **updateTask**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/scheduled-tasks-api.ts:511](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/scheduled-tasks-api.ts#L511)
|
File diff suppressed because one or more lines are too long
114
docs/classes/generated_client.SearchApi.md
Normal file
114
docs/classes/generated_client.SearchApi.md
Normal file
@ -0,0 +1,114 @@
|
||||
[jellyfin-sdk-typescript](../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 |
|
||||
| :------ | :------ |
|
||||
| `configuration?` | [`Configuration`](generated_client.Configuration.md) |
|
||||
| `basePath` | `string` |
|
||||
| `axios` | `AxiosInstance` |
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L52)
|
||||
|
||||
## Properties
|
||||
|
||||
### axios
|
||||
|
||||
• `Protected` **axios**: `AxiosInstance`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.axios
|
||||
|
||||
___
|
||||
|
||||
### basePath
|
||||
|
||||
• `Protected` **basePath**: `string`
|
||||
|
||||
#### 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/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L50)
|
||||
|
||||
## Methods
|
||||
|
||||
### get
|
||||
|
||||
▸ **get**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<[`SearchHintResult`](../interfaces/generated_client.SearchHintResult.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/search-api.ts:382](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/search-api.ts#L382)
|
File diff suppressed because one or more lines are too long
531
docs/classes/generated_client.SessionApi.md
Normal file
531
docs/classes/generated_client.SessionApi.md
Normal file
@ -0,0 +1,531 @@
|
||||
[jellyfin-sdk-typescript](../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 |
|
||||
| :------ | :------ |
|
||||
| `configuration?` | [`Configuration`](generated_client.Configuration.md) |
|
||||
| `basePath` | `string` |
|
||||
| `axios` | `AxiosInstance` |
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L52)
|
||||
|
||||
## Properties
|
||||
|
||||
### axios
|
||||
|
||||
• `Protected` **axios**: `AxiosInstance`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.axios
|
||||
|
||||
___
|
||||
|
||||
### basePath
|
||||
|
||||
• `Protected` **basePath**: `string`
|
||||
|
||||
#### 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/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L50)
|
||||
|
||||
## Methods
|
||||
|
||||
### addUserToSession
|
||||
|
||||
▸ **addUserToSession**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/session-api.ts:1581](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/session-api.ts#L1581)
|
||||
|
||||
___
|
||||
|
||||
### displayContent
|
||||
|
||||
▸ **displayContent**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/session-api.ts:1593](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/session-api.ts#L1593)
|
||||
|
||||
___
|
||||
|
||||
### getAuthProviders
|
||||
|
||||
▸ **getAuthProviders**(`options?`): `Promise`<`AxiosResponse`<[`NameIdPair`](../interfaces/generated_client.NameIdPair.md)[]\>\>
|
||||
|
||||
**`summary`** Get all auth providers.
|
||||
|
||||
**`throws`** {RequiredError}
|
||||
|
||||
**`memberof`** SessionApi
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `options?` | `any` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`AxiosResponse`<[`NameIdPair`](../interfaces/generated_client.NameIdPair.md)[]\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/session-api.ts:1604](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/session-api.ts#L1604)
|
||||
|
||||
___
|
||||
|
||||
### getPasswordResetProviders
|
||||
|
||||
▸ **getPasswordResetProviders**(`options?`): `Promise`<`AxiosResponse`<[`NameIdPair`](../interfaces/generated_client.NameIdPair.md)[]\>\>
|
||||
|
||||
**`summary`** Get all password reset providers.
|
||||
|
||||
**`throws`** {RequiredError}
|
||||
|
||||
**`memberof`** SessionApi
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `options?` | `any` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`AxiosResponse`<[`NameIdPair`](../interfaces/generated_client.NameIdPair.md)[]\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/session-api.ts:1615](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/session-api.ts#L1615)
|
||||
|
||||
___
|
||||
|
||||
### getSessions
|
||||
|
||||
▸ **getSessions**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<[`SessionInfo`](../interfaces/generated_client.SessionInfo.md)[]\>\>
|
||||
|
||||
**`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)[]\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/session-api.ts:1627](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/session-api.ts#L1627)
|
||||
|
||||
___
|
||||
|
||||
### play
|
||||
|
||||
▸ **play**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/session-api.ts:1639](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/session-api.ts#L1639)
|
||||
|
||||
___
|
||||
|
||||
### postCapabilities
|
||||
|
||||
▸ **postCapabilities**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/session-api.ts:1651](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/session-api.ts#L1651)
|
||||
|
||||
___
|
||||
|
||||
### postFullCapabilities
|
||||
|
||||
▸ **postFullCapabilities**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/session-api.ts:1663](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/session-api.ts#L1663)
|
||||
|
||||
___
|
||||
|
||||
### removeUserFromSession
|
||||
|
||||
▸ **removeUserFromSession**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/session-api.ts:1675](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/session-api.ts#L1675)
|
||||
|
||||
___
|
||||
|
||||
### reportSessionEnded
|
||||
|
||||
▸ **reportSessionEnded**(`options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`summary`** Reports that a session has ended.
|
||||
|
||||
**`throws`** {RequiredError}
|
||||
|
||||
**`memberof`** SessionApi
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `options?` | `any` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/session-api.ts:1686](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/session-api.ts#L1686)
|
||||
|
||||
___
|
||||
|
||||
### reportViewing
|
||||
|
||||
▸ **reportViewing**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/session-api.ts:1698](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/session-api.ts#L1698)
|
||||
|
||||
___
|
||||
|
||||
### sendFullGeneralCommand
|
||||
|
||||
▸ **sendFullGeneralCommand**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/session-api.ts:1710](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/session-api.ts#L1710)
|
||||
|
||||
___
|
||||
|
||||
### sendGeneralCommand
|
||||
|
||||
▸ **sendGeneralCommand**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/session-api.ts:1722](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/session-api.ts#L1722)
|
||||
|
||||
___
|
||||
|
||||
### sendMessageCommand
|
||||
|
||||
▸ **sendMessageCommand**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/session-api.ts:1734](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/session-api.ts#L1734)
|
||||
|
||||
___
|
||||
|
||||
### sendPlaystateCommand
|
||||
|
||||
▸ **sendPlaystateCommand**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/session-api.ts:1746](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/session-api.ts#L1746)
|
||||
|
||||
___
|
||||
|
||||
### sendSystemCommand
|
||||
|
||||
▸ **sendSystemCommand**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/session-api.ts:1758](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/session-api.ts#L1758)
|
File diff suppressed because one or more lines are too long
278
docs/classes/generated_client.StartupApi.md
Normal file
278
docs/classes/generated_client.StartupApi.md
Normal file
@ -0,0 +1,278 @@
|
||||
[jellyfin-sdk-typescript](../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 |
|
||||
| :------ | :------ |
|
||||
| `configuration?` | [`Configuration`](generated_client.Configuration.md) |
|
||||
| `basePath` | `string` |
|
||||
| `axios` | `AxiosInstance` |
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L52)
|
||||
|
||||
## Properties
|
||||
|
||||
### axios
|
||||
|
||||
• `Protected` **axios**: `AxiosInstance`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseAPI.axios
|
||||
|
||||
___
|
||||
|
||||
### basePath
|
||||
|
||||
• `Protected` **basePath**: `string`
|
||||
|
||||
#### 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/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/base.ts#L50)
|
||||
|
||||
## Methods
|
||||
|
||||
### completeWizard
|
||||
|
||||
▸ **completeWizard**(`options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`summary`** Completes the startup wizard.
|
||||
|
||||
**`throws`** {RequiredError}
|
||||
|
||||
**`memberof`** StartupApi
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `options?` | `any` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/startup-api.ts:500](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/startup-api.ts#L500)
|
||||
|
||||
___
|
||||
|
||||
### getFirstUser
|
||||
|
||||
▸ **getFirstUser**(`options?`): `Promise`<`AxiosResponse`<[`StartupUserDto`](../interfaces/generated_client.StartupUserDto.md)\>\>
|
||||
|
||||
**`summary`** Gets the first user.
|
||||
|
||||
**`throws`** {RequiredError}
|
||||
|
||||
**`memberof`** StartupApi
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `options?` | `any` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`AxiosResponse`<[`StartupUserDto`](../interfaces/generated_client.StartupUserDto.md)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/startup-api.ts:511](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/startup-api.ts#L511)
|
||||
|
||||
___
|
||||
|
||||
### getFirstUser2
|
||||
|
||||
▸ **getFirstUser2**(`options?`): `Promise`<`AxiosResponse`<[`StartupUserDto`](../interfaces/generated_client.StartupUserDto.md)\>\>
|
||||
|
||||
**`summary`** Gets the first user.
|
||||
|
||||
**`throws`** {RequiredError}
|
||||
|
||||
**`memberof`** StartupApi
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `options?` | `any` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`AxiosResponse`<[`StartupUserDto`](../interfaces/generated_client.StartupUserDto.md)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/startup-api.ts:522](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/startup-api.ts#L522)
|
||||
|
||||
___
|
||||
|
||||
### getStartupConfiguration
|
||||
|
||||
▸ **getStartupConfiguration**(`options?`): `Promise`<`AxiosResponse`<[`StartupConfigurationDto`](../interfaces/generated_client.StartupConfigurationDto.md)\>\>
|
||||
|
||||
**`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)\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/startup-api.ts:533](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/startup-api.ts#L533)
|
||||
|
||||
___
|
||||
|
||||
### setRemoteAccess
|
||||
|
||||
▸ **setRemoteAccess**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/startup-api.ts:545](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/startup-api.ts#L545)
|
||||
|
||||
___
|
||||
|
||||
### updateInitialConfiguration
|
||||
|
||||
▸ **updateInitialConfiguration**(`requestParameters`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/startup-api.ts:557](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/startup-api.ts#L557)
|
||||
|
||||
___
|
||||
|
||||
### updateStartupUser
|
||||
|
||||
▸ **updateStartupUser**(`requestParameters?`, `options?`): `Promise`<`AxiosResponse`<`void`\>\>
|
||||
|
||||
**`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`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[generated-client/api/startup-api.ts:569](https://github.com/thornbill/jellyfin-sdk-typescript/blob/46678c1/src/generated-client/api/startup-api.ts#L569)
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user