Merge pull request #187 from thornbill/jellyfin-10.8.0

Update to Jellyfin 10.8.0 OpenAPI spec

README.md

@@ -13,19 +13,6 @@ A TypeScript SDK for Jellyfin.
 
 > Warning: This project is under active development, so API changes may occur.
 
-## Breaking Changes
-
-### v0.5.0
-
-* Build directory is now `lib` instead of `dist`.
-  Any imports used that were previously in `dist` will need updated.
-  [#147](https://github.com/thornbill/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)
-* 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)
-
 ## Install
 
 ```sh
@@ -97,6 +84,25 @@ console.log('Libraries =>', libraries.data);
 await api.logout();
 ```
 
+## Breaking Changes
+
+### v0.5.0
+
+* Build directory is now `lib` instead of `dist`.
+  Any imports used that were previously in `dist` will need updated.
+  [#147](https://github.com/thornbill/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)
+* 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)
+* `BaseItemKind` is now included in the generated client.
+  Imports will need updated.
+  [#187](https://github.com/thornbill/jellyfin-sdk-typescript/pull/187)
+
 ## Roadmap to 1.0
 
 * [ ] More complete device profile generation utilities

docs/README.md

@@ -15,19 +15,6 @@ A TypeScript SDK for Jellyfin.
 
 > Warning: This project is under active development, so API changes may occur.
 
-## Breaking Changes
-
-### v0.5.0
-
-* Build directory is now `lib` instead of `dist`.
-  Any imports used that were previously in `dist` will need updated.
-  [#147](https://github.com/thornbill/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)
-* 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)
-
 ## Install
 
 ```sh
@@ -99,6 +86,25 @@ console.log('Libraries =>', libraries.data);
 await api.logout();
 ```
 
+## Breaking Changes
+
+### v0.5.0
+
+* Build directory is now `lib` instead of `dist`.
+  Any imports used that were previously in `dist` will need updated.
+  [#147](https://github.com/thornbill/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)
+* 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)
+* `BaseItemKind` is now included in the generated client.
+  Imports will need updated.
+  [#187](https://github.com/thornbill/jellyfin-sdk-typescript/pull/187)
+
 ## Roadmap to 1.0
 
 * [ ] More complete device profile generation utilities

docs/classes/generated_client.ActivityLogApi.md

@@ -50,7 +50,7 @@ BaseAPI.constructor
 
 #### Defined in
 
-[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/03092f3/src/generated-client/base.ts#L52)
+[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/base.ts#L52)
 
 ## Properties
 
@@ -84,7 +84,7 @@ BaseAPI.configuration
 
 #### Defined in
 
-[generated-client/base.ts:50](https://github.com/thornbill/jellyfin-sdk-typescript/blob/03092f3/src/generated-client/base.ts#L50)
+[generated-client/base.ts:50](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/base.ts#L50)
 
 ## Methods
 
@@ -111,4 +111,4 @@ BaseAPI.configuration
 
 #### Defined in
 
-[generated-client/api/activity-log-api.ts:186](https://github.com/thornbill/jellyfin-sdk-typescript/blob/03092f3/src/generated-client/api/activity-log-api.ts#L186)
+[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)

docs/classes/generated_client.ApiKeyApi.md

@@ -52,7 +52,7 @@ BaseAPI.constructor
 
 #### Defined in
 
-[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/03092f3/src/generated-client/base.ts#L52)
+[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/base.ts#L52)
 
 ## Properties
 
@@ -86,7 +86,7 @@ BaseAPI.configuration
 
 #### Defined in
 
-[generated-client/base.ts:50](https://github.com/thornbill/jellyfin-sdk-typescript/blob/03092f3/src/generated-client/base.ts#L50)
+[generated-client/base.ts:50](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/base.ts#L50)
 
 ## Methods
 
@@ -113,7 +113,7 @@ BaseAPI.configuration
 
 #### Defined in
 
-[generated-client/api/api-key-api.ts:268](https://github.com/thornbill/jellyfin-sdk-typescript/blob/03092f3/src/generated-client/api/api-key-api.ts#L268)
+[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)
 
 ___
 
@@ -139,7 +139,7 @@ ___
 
 #### Defined in
 
-[generated-client/api/api-key-api.ts:279](https://github.com/thornbill/jellyfin-sdk-typescript/blob/03092f3/src/generated-client/api/api-key-api.ts#L279)
+[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)
 
 ___
 
@@ -166,4 +166,4 @@ ___
 
 #### Defined in
 
-[generated-client/api/api-key-api.ts:291](https://github.com/thornbill/jellyfin-sdk-typescript/blob/03092f3/src/generated-client/api/api-key-api.ts#L291)
+[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)

docs/classes/generated_client.ArtistsApi.md

@@ -52,7 +52,7 @@ BaseAPI.constructor
 
 #### Defined in
 
-[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/03092f3/src/generated-client/base.ts#L52)
+[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/base.ts#L52)
 
 ## Properties
 
@@ -86,7 +86,7 @@ BaseAPI.configuration
 
 #### Defined in
 
-[generated-client/base.ts:50](https://github.com/thornbill/jellyfin-sdk-typescript/blob/03092f3/src/generated-client/base.ts#L50)
+[generated-client/base.ts:50](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/base.ts#L50)
 
 ## Methods
 
@@ -113,7 +113,7 @@ BaseAPI.configuration
 
 #### Defined in
 
-[generated-client/api/artists-api.ts:1121](https://github.com/thornbill/jellyfin-sdk-typescript/blob/03092f3/src/generated-client/api/artists-api.ts#L1121)
+[generated-client/api/artists-api.ts:1181](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/api/artists-api.ts#L1181)
 
 ___
 
@@ -140,7 +140,7 @@ ___
 
 #### Defined in
 
-[generated-client/api/artists-api.ts:1133](https://github.com/thornbill/jellyfin-sdk-typescript/blob/03092f3/src/generated-client/api/artists-api.ts#L1133)
+[generated-client/api/artists-api.ts:1193](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/api/artists-api.ts#L1193)
 
 ___
 
@@ -167,4 +167,4 @@ ___
 
 #### Defined in
 
-[generated-client/api/artists-api.ts:1145](https://github.com/thornbill/jellyfin-sdk-typescript/blob/03092f3/src/generated-client/api/artists-api.ts#L1145)
+[generated-client/api/artists-api.ts:1205](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/api/artists-api.ts#L1205)

docs/classes/generated_client.AudioApi.md

@@ -53,7 +53,7 @@ BaseAPI.constructor
 
 #### Defined in
 
-[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/03092f3/src/generated-client/base.ts#L52)
+[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/base.ts#L52)
 
 ## Properties
 
@@ -87,7 +87,7 @@ BaseAPI.configuration
 
 #### Defined in
 
-[generated-client/base.ts:50](https://github.com/thornbill/jellyfin-sdk-typescript/blob/03092f3/src/generated-client/base.ts#L50)
+[generated-client/base.ts:50](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/base.ts#L50)
 
 ## Methods
 
@@ -114,7 +114,7 @@ BaseAPI.configuration
 
 #### Defined in
 
-[generated-client/api/audio-api.ts:3033](https://github.com/thornbill/jellyfin-sdk-typescript/blob/03092f3/src/generated-client/api/audio-api.ts#L3033)
+[generated-client/api/audio-api.ts:3033](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/api/audio-api.ts#L3033)
 
 ___
 
@@ -141,7 +141,7 @@ ___
 
 #### Defined in
 
-[generated-client/api/audio-api.ts:3045](https://github.com/thornbill/jellyfin-sdk-typescript/blob/03092f3/src/generated-client/api/audio-api.ts#L3045)
+[generated-client/api/audio-api.ts:3045](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/api/audio-api.ts#L3045)
 
 ___
 
@@ -168,7 +168,7 @@ ___
 
 #### Defined in
 
-[generated-client/api/audio-api.ts:3057](https://github.com/thornbill/jellyfin-sdk-typescript/blob/03092f3/src/generated-client/api/audio-api.ts#L3057)
+[generated-client/api/audio-api.ts:3057](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/api/audio-api.ts#L3057)
 
 ___
 
@@ -195,4 +195,4 @@ ___
 
 #### Defined in
 
-[generated-client/api/audio-api.ts:3069](https://github.com/thornbill/jellyfin-sdk-typescript/blob/03092f3/src/generated-client/api/audio-api.ts#L3069)
+[generated-client/api/audio-api.ts:3069](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/api/audio-api.ts#L3069)

docs/classes/generated_client.BrandingApi.md

@@ -52,7 +52,7 @@ BaseAPI.constructor
 
 #### Defined in
 
-[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/03092f3/src/generated-client/base.ts#L52)
+[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/base.ts#L52)
 
 ## Properties
 
@@ -86,7 +86,7 @@ BaseAPI.configuration
 
 #### Defined in
 
-[generated-client/base.ts:50](https://github.com/thornbill/jellyfin-sdk-typescript/blob/03092f3/src/generated-client/base.ts#L50)
+[generated-client/base.ts:50](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/base.ts#L50)
 
 ## Methods
 
@@ -112,7 +112,7 @@ BaseAPI.configuration
 
 #### Defined in
 
-[generated-client/api/branding-api.ts:215](https://github.com/thornbill/jellyfin-sdk-typescript/blob/03092f3/src/generated-client/api/branding-api.ts#L215)
+[generated-client/api/branding-api.ts:215](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/api/branding-api.ts#L215)
 
 ___
 
@@ -138,7 +138,7 @@ ___
 
 #### Defined in
 
-[generated-client/api/branding-api.ts:226](https://github.com/thornbill/jellyfin-sdk-typescript/blob/03092f3/src/generated-client/api/branding-api.ts#L226)
+[generated-client/api/branding-api.ts:226](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/api/branding-api.ts#L226)
 
 ___
 
@@ -164,4 +164,4 @@ ___
 
 #### Defined in
 
-[generated-client/api/branding-api.ts:237](https://github.com/thornbill/jellyfin-sdk-typescript/blob/03092f3/src/generated-client/api/branding-api.ts#L237)
+[generated-client/api/branding-api.ts:237](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/api/branding-api.ts#L237)

docs/classes/generated_client.ChannelsApi.md

@@ -54,7 +54,7 @@ BaseAPI.constructor
 
 #### Defined in
 
-[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/03092f3/src/generated-client/base.ts#L52)
+[generated-client/base.ts:52](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/base.ts#L52)
 
 ## Properties
 
@@ -88,7 +88,7 @@ BaseAPI.configuration
 
 #### Defined in
 
-[generated-client/base.ts:50](https://github.com/thornbill/jellyfin-sdk-typescript/blob/03092f3/src/generated-client/base.ts#L50)
+[generated-client/base.ts:50](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/base.ts#L50)
 
 ## Methods
 
@@ -114,7 +114,7 @@ BaseAPI.configuration
 
 #### Defined in
 
-[generated-client/api/channels-api.ts:670](https://github.com/thornbill/jellyfin-sdk-typescript/blob/03092f3/src/generated-client/api/channels-api.ts#L670)
+[generated-client/api/channels-api.ts:670](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/api/channels-api.ts#L670)
 
 ___
 
@@ -141,7 +141,7 @@ ___
 
 #### Defined in
 
-[generated-client/api/channels-api.ts:682](https://github.com/thornbill/jellyfin-sdk-typescript/blob/03092f3/src/generated-client/api/channels-api.ts#L682)
+[generated-client/api/channels-api.ts:682](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/api/channels-api.ts#L682)
 
 ___
 
@@ -168,7 +168,7 @@ ___
 
 #### Defined in
 
-[generated-client/api/channels-api.ts:694](https://github.com/thornbill/jellyfin-sdk-typescript/blob/03092f3/src/generated-client/api/channels-api.ts#L694)
+[generated-client/api/channels-api.ts:694](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/api/channels-api.ts#L694)
 
 ___
 
@@ -195,7 +195,7 @@ ___
 
 #### Defined in
 
-[generated-client/api/channels-api.ts:706](https://github.com/thornbill/jellyfin-sdk-typescript/blob/03092f3/src/generated-client/api/channels-api.ts#L706)
+[generated-client/api/channels-api.ts:706](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/api/channels-api.ts#L706)
 
 ___
 
@@ -222,4 +222,4 @@ ___
 
 #### Defined in
 
-[generated-client/api/channels-api.ts:718](https://github.com/thornbill/jellyfin-sdk-typescript/blob/03092f3/src/generated-client/api/channels-api.ts#L718)
+[generated-client/api/channels-api.ts:718](https://github.com/thornbill/jellyfin-sdk-typescript/blob/3ae780a/src/generated-client/api/channels-api.ts#L718)