Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update OpenAPI spec for Jellyfin 10.8.1 #208

Merged
merged 6 commits into from
Jul 14, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
29 changes: 21 additions & 8 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,19 @@
@thornbill/jellyfin-sdk / [Modules](modules.md)

<h1 align="center">jellyfin-sdk-typescript</h1>
<h3 align="center">Part of the <a href="https://jellyfin.org">Jellyfin Project</a></h3>

---

<p align="center">
<a href="https://github.com/thornbill/jellyfin-sdk-typescript/blob/master/LICENSE"><img alt="MPL-2.0 license" src="https://img.shields.io/github/license/thornbill/jellyfin-sdk-typescript"></a>
<a href="https://github.com/thornbill/jellyfin-sdk-typescript/releases"><img alt="Current Release" src="https://img.shields.io/github/release/thornbill/jellyfin-sdk-typescript.svg"/></a>
<img alt="Logo Banner" src="https://raw.githubusercontent.com/jellyfin/jellyfin-ux/master/branding/SVG/banner-logo-solid.svg?sanitize=true"/>
<br/>
<br/>
<a href="https://github.com/jellyfin/jellyfin-sdk-typescript/blob/master/LICENSE"><img alt="MPL-2.0 license" src="https://img.shields.io/github/license/jellyfin/jellyfin-sdk-typescript"></a>
<a href="https://github.com/jellyfin/jellyfin-sdk-typescript/releases"><img alt="Current Release" src="https://img.shields.io/github/release/jellyfin/jellyfin-sdk-typescript.svg"/></a>
<a href="https://www.npmjs.com/package/@thornbill/jellyfin-sdk"><img alt="npm" src="https://img.shields.io/npm/v/@thornbill/jellyfin-sdk"></a>
<a href="https://codecov.io/gh/thornbill/jellyfin-sdk-typescript">
<img alt="Codecov" src="https://img.shields.io/codecov/c/github/thornbill/jellyfin-sdk-typescript?token=Wk8RS9tDnb">
<a href="https://codecov.io/gh/jellyfin/jellyfin-sdk-typescript">
<img alt="Codecov" src="https://img.shields.io/codecov/c/github/jellyfin/jellyfin-sdk-typescript?token=eFF0jvWiyq">
</a>
</p>

Expand All @@ -27,6 +33,13 @@ or
yarn add @thornbill/jellyfin-sdk
```

### Supported Jellyfin Versions

| SDK Version | Jellyfin Version |
|:-:|:-:|
| 0.5.0 | 10.8.x |
| <0.5.0 | 10.7.x |

### React Native

The generated Axios client used in this library depends on `URL` and `URLSearchParams` to be available on the global scope.
Expand Down Expand Up @@ -92,18 +105,18 @@ await api.logout();

* Build directory is now `lib` instead of `dist`.
Any imports used that were previously in `dist` will need updated.
[#147](https://github.com/thornbill/jellyfin-sdk-typescript/pull/147)
[#147](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/147)
* Duplicated exports were removed.
Any imports may need updated if you referenced one of the duplicates.
[#148](https://github.com/thornbill/jellyfin-sdk-typescript/pull/148)
[#148](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/148)
* API classes are no longer exposed via getters.
Instead you need to call a function passing the `Api` instance as a parameter.
For example: `getSystemApi(api)`.
While I do feel this is a slightly worse developer experience, it was a necessary change to support tree-shaking.
[#149](https://github.com/thornbill/jellyfin-sdk-typescript/pull/149)
[#149](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/149)
* `BaseItemKind` is now included in the generated client.
Imports will need updated.
[#187](https://github.com/thornbill/jellyfin-sdk-typescript/pull/187)
[#187](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/187)

## Roadmap to 1.0

Expand Down
6 changes: 3 additions & 3 deletions docs/classes/generated_client.ActivityLogApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ BaseAPI.constructor

#### Defined in

[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/base.ts#L52)
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)

## Properties

Expand Down Expand Up @@ -84,7 +84,7 @@ BaseAPI.configuration

#### Defined in

[generated-client/base.ts:50](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/base.ts#L50)
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)

## Methods

Expand All @@ -111,4 +111,4 @@ BaseAPI.configuration

#### Defined in

[generated-client/api/activity-log-api.ts:186](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/api/activity-log-api.ts#L186)
[generated-client/api/activity-log-api.ts:186](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/activity-log-api.ts#L186)
10 changes: 5 additions & 5 deletions docs/classes/generated_client.ApiKeyApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ BaseAPI.constructor

#### Defined in

[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/base.ts#L52)
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)

## Properties

Expand Down Expand Up @@ -86,7 +86,7 @@ BaseAPI.configuration

#### Defined in

[generated-client/base.ts:50](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/base.ts#L50)
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)

## Methods

Expand All @@ -113,7 +113,7 @@ BaseAPI.configuration

#### Defined in

[generated-client/api/api-key-api.ts:268](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/api/api-key-api.ts#L268)
[generated-client/api/api-key-api.ts:268](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/api-key-api.ts#L268)

___

Expand All @@ -139,7 +139,7 @@ ___

#### Defined in

[generated-client/api/api-key-api.ts:279](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/api/api-key-api.ts#L279)
[generated-client/api/api-key-api.ts:279](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/api-key-api.ts#L279)

___

Expand All @@ -166,4 +166,4 @@ ___

#### Defined in

[generated-client/api/api-key-api.ts:291](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/api/api-key-api.ts#L291)
[generated-client/api/api-key-api.ts:291](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/api-key-api.ts#L291)
10 changes: 5 additions & 5 deletions docs/classes/generated_client.ArtistsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ BaseAPI.constructor

#### Defined in

[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/base.ts#L52)
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)

## Properties

Expand Down Expand Up @@ -86,7 +86,7 @@ BaseAPI.configuration

#### Defined in

[generated-client/base.ts:50](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/base.ts#L50)
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)

## Methods

Expand All @@ -113,7 +113,7 @@ BaseAPI.configuration

#### Defined in

[generated-client/api/artists-api.ts:1181](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/api/artists-api.ts#L1181)
[generated-client/api/artists-api.ts:1181](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L1181)

___

Expand All @@ -140,7 +140,7 @@ ___

#### Defined in

[generated-client/api/artists-api.ts:1193](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/api/artists-api.ts#L1193)
[generated-client/api/artists-api.ts:1193](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L1193)

___

Expand All @@ -167,4 +167,4 @@ ___

#### Defined in

[generated-client/api/artists-api.ts:1205](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/api/artists-api.ts#L1205)
[generated-client/api/artists-api.ts:1205](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/artists-api.ts#L1205)
12 changes: 6 additions & 6 deletions docs/classes/generated_client.AudioApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ BaseAPI.constructor

#### Defined in

[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/base.ts#L52)
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)

## Properties

Expand Down Expand Up @@ -87,7 +87,7 @@ BaseAPI.configuration

#### Defined in

[generated-client/base.ts:50](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/base.ts#L50)
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)

## Methods

Expand All @@ -114,7 +114,7 @@ BaseAPI.configuration

#### Defined in

[generated-client/api/audio-api.ts:3033](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/api/audio-api.ts#L3033)
[generated-client/api/audio-api.ts:3033](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L3033)

___

Expand All @@ -141,7 +141,7 @@ ___

#### Defined in

[generated-client/api/audio-api.ts:3045](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/api/audio-api.ts#L3045)
[generated-client/api/audio-api.ts:3045](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L3045)

___

Expand All @@ -168,7 +168,7 @@ ___

#### Defined in

[generated-client/api/audio-api.ts:3057](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/api/audio-api.ts#L3057)
[generated-client/api/audio-api.ts:3057](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L3057)

___

Expand All @@ -195,4 +195,4 @@ ___

#### Defined in

[generated-client/api/audio-api.ts:3069](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/api/audio-api.ts#L3069)
[generated-client/api/audio-api.ts:3069](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/audio-api.ts#L3069)
10 changes: 5 additions & 5 deletions docs/classes/generated_client.BrandingApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ BaseAPI.constructor

#### Defined in

[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/base.ts#L52)
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)

## Properties

Expand Down Expand Up @@ -86,7 +86,7 @@ BaseAPI.configuration

#### Defined in

[generated-client/base.ts:50](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/base.ts#L50)
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)

## Methods

Expand All @@ -112,7 +112,7 @@ BaseAPI.configuration

#### Defined in

[generated-client/api/branding-api.ts:215](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/api/branding-api.ts#L215)
[generated-client/api/branding-api.ts:215](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/branding-api.ts#L215)

___

Expand All @@ -138,7 +138,7 @@ ___

#### Defined in

[generated-client/api/branding-api.ts:226](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/api/branding-api.ts#L226)
[generated-client/api/branding-api.ts:226](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/branding-api.ts#L226)

___

Expand All @@ -164,4 +164,4 @@ ___

#### Defined in

[generated-client/api/branding-api.ts:237](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/api/branding-api.ts#L237)
[generated-client/api/branding-api.ts:237](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/branding-api.ts#L237)
14 changes: 7 additions & 7 deletions docs/classes/generated_client.ChannelsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ BaseAPI.constructor

#### Defined in

[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/base.ts#L52)
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)

## Properties

Expand Down Expand Up @@ -88,7 +88,7 @@ BaseAPI.configuration

#### Defined in

[generated-client/base.ts:50](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/base.ts#L50)
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)

## Methods

Expand All @@ -114,7 +114,7 @@ BaseAPI.configuration

#### Defined in

[generated-client/api/channels-api.ts:670](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/api/channels-api.ts#L670)
[generated-client/api/channels-api.ts:670](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/channels-api.ts#L670)

___

Expand All @@ -141,7 +141,7 @@ ___

#### Defined in

[generated-client/api/channels-api.ts:682](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/api/channels-api.ts#L682)
[generated-client/api/channels-api.ts:682](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/channels-api.ts#L682)

___

Expand All @@ -168,7 +168,7 @@ ___

#### Defined in

[generated-client/api/channels-api.ts:694](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/api/channels-api.ts#L694)
[generated-client/api/channels-api.ts:694](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/channels-api.ts#L694)

___

Expand All @@ -195,7 +195,7 @@ ___

#### Defined in

[generated-client/api/channels-api.ts:706](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/api/channels-api.ts#L706)
[generated-client/api/channels-api.ts:706](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/channels-api.ts#L706)

___

Expand All @@ -222,4 +222,4 @@ ___

#### Defined in

[generated-client/api/channels-api.ts:718](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/api/channels-api.ts#L718)
[generated-client/api/channels-api.ts:718](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/channels-api.ts#L718)
6 changes: 3 additions & 3 deletions docs/classes/generated_client.ClientLogApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ BaseAPI.constructor

#### Defined in

[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/base.ts#L52)
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)

## Properties

Expand Down Expand Up @@ -84,7 +84,7 @@ BaseAPI.configuration

#### Defined in

[generated-client/base.ts:50](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/base.ts#L50)
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)

## Methods

Expand All @@ -111,4 +111,4 @@ BaseAPI.configuration

#### Defined in

[generated-client/api/client-log-api.ts:143](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/api/client-log-api.ts#L143)
[generated-client/api/client-log-api.ts:143](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/client-log-api.ts#L143)
10 changes: 5 additions & 5 deletions docs/classes/generated_client.CollectionApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ BaseAPI.constructor

#### Defined in

[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/base.ts#L52)
[generated-client/base.ts:52](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L52)

## Properties

Expand Down Expand Up @@ -86,7 +86,7 @@ BaseAPI.configuration

#### Defined in

[generated-client/base.ts:50](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/base.ts#L50)
[generated-client/base.ts:50](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/base.ts#L50)

## Methods

Expand All @@ -113,7 +113,7 @@ BaseAPI.configuration

#### Defined in

[generated-client/api/collection-api.ts:360](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/api/collection-api.ts#L360)
[generated-client/api/collection-api.ts:360](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/collection-api.ts#L360)

___

Expand All @@ -140,7 +140,7 @@ ___

#### Defined in

[generated-client/api/collection-api.ts:372](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/api/collection-api.ts#L372)
[generated-client/api/collection-api.ts:372](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/collection-api.ts#L372)

___

Expand All @@ -167,4 +167,4 @@ ___

#### Defined in

[generated-client/api/collection-api.ts:384](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/api/collection-api.ts#L384)
[generated-client/api/collection-api.ts:384](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/fa599ae/src/generated-client/api/collection-api.ts#L384)
Loading