@jellyfin/sdk 0.8.1 → 0.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -7
- package/lib/api.d.ts +1 -0
- package/lib/api.js +4 -4
- package/lib/discovery/recommended-server-discovery.js +24 -16
- package/lib/generated-client/api/activity-log-api.js +12 -1
- package/lib/generated-client/api/api-key-api.js +14 -3
- package/lib/generated-client/api/artists-api.d.ts +28 -26
- package/lib/generated-client/api/artists-api.js +26 -15
- package/lib/generated-client/api/audio-api.d.ts +8 -8
- package/lib/generated-client/api/audio-api.js +21 -10
- package/lib/generated-client/api/branding-api.js +14 -3
- package/lib/generated-client/api/channels-api.d.ts +9 -8
- package/lib/generated-client/api/channels-api.js +19 -8
- package/lib/generated-client/api/client-log-api.js +12 -1
- package/lib/generated-client/api/collection-api.js +14 -3
- package/lib/generated-client/api/configuration-api.d.ts +0 -47
- package/lib/generated-client/api/configuration-api.js +16 -71
- package/lib/generated-client/api/dashboard-api.js +13 -2
- package/lib/generated-client/api/devices-api.d.ts +3 -12
- package/lib/generated-client/api/devices-api.js +21 -16
- package/lib/generated-client/api/display-preferences-api.d.ts +22 -22
- package/lib/generated-client/api/display-preferences-api.js +29 -22
- package/lib/generated-client/api/dynamic-hls-api.d.ts +28 -10
- package/lib/generated-client/api/dynamic-hls-api.js +45 -22
- package/lib/generated-client/api/environment-api.js +17 -6
- package/lib/generated-client/api/filter-api.d.ts +9 -8
- package/lib/generated-client/api/filter-api.js +16 -5
- package/lib/generated-client/api/genres-api.d.ts +9 -8
- package/lib/generated-client/api/genres-api.js +16 -5
- package/lib/generated-client/api/hls-segment-api.js +16 -5
- package/lib/generated-client/api/image-api.d.ts +109 -1184
- package/lib/generated-client/api/image-api.js +218 -1056
- package/lib/generated-client/api/instant-mix-api.d.ts +35 -35
- package/lib/generated-client/api/instant-mix-api.js +79 -68
- package/lib/generated-client/api/item-lookup-api.js +22 -11
- package/lib/generated-client/api/item-refresh-api.js +12 -1
- package/lib/generated-client/api/item-update-api.js +14 -3
- package/lib/generated-client/api/items-api.d.ts +333 -1012
- package/lib/generated-client/api/items-api.js +178 -595
- package/lib/generated-client/api/library-api.d.ts +9 -8
- package/lib/generated-client/api/library-api.js +39 -28
- package/lib/generated-client/api/library-structure-api.js +19 -8
- package/lib/generated-client/api/live-tv-api.d.ts +17 -16
- package/lib/generated-client/api/live-tv-api.js +58 -47
- package/lib/generated-client/api/localization-api.js +15 -4
- package/lib/generated-client/api/lyrics-api.d.ts +344 -0
- package/lib/generated-client/api/{dlna-api.js → lyrics-api.js} +165 -125
- package/lib/generated-client/api/media-info-api.d.ts +7 -7
- package/lib/generated-client/api/media-info-api.js +19 -10
- package/lib/generated-client/api/movies-api.js +12 -1
- package/lib/generated-client/api/music-genres-api.d.ts +9 -8
- package/lib/generated-client/api/music-genres-api.js +16 -5
- package/lib/generated-client/api/package-api.js +17 -6
- package/lib/generated-client/api/persons-api.js +13 -2
- package/lib/generated-client/api/playlists-api.d.ts +315 -36
- package/lib/generated-client/api/playlists-api.js +395 -29
- package/lib/generated-client/api/playstate-api.d.ts +41 -68
- package/lib/generated-client/api/playstate-api.js +74 -81
- package/lib/generated-client/api/plugins-api.js +20 -9
- package/lib/generated-client/api/quick-connect-api.d.ts +46 -37
- package/lib/generated-client/api/quick-connect-api.js +67 -50
- package/lib/generated-client/api/remote-image-api.js +14 -3
- package/lib/generated-client/api/scheduled-tasks-api.js +16 -5
- package/lib/generated-client/api/search-api.d.ts +41 -40
- package/lib/generated-client/api/search-api.js +29 -18
- package/lib/generated-client/api/session-api.d.ts +9 -17
- package/lib/generated-client/api/session-api.js +35 -30
- package/lib/generated-client/api/startup-api.js +18 -7
- package/lib/generated-client/api/studios-api.js +13 -2
- package/lib/generated-client/api/subtitle-api.d.ts +7 -7
- package/lib/generated-client/api/subtitle-api.js +33 -22
- package/lib/generated-client/api/suggestions-api.d.ts +14 -13
- package/lib/generated-client/api/suggestions-api.js +24 -13
- package/lib/generated-client/api/sync-play-api.js +32 -21
- package/lib/generated-client/api/system-api.js +21 -10
- package/lib/generated-client/api/time-sync-api.js +12 -1
- package/lib/generated-client/api/tmdb-api.js +12 -1
- package/lib/generated-client/api/trailers-api.d.ts +35 -33
- package/lib/generated-client/api/trailers-api.js +33 -22
- package/lib/generated-client/api/trickplay-api.d.ts +176 -0
- package/lib/generated-client/api/trickplay-api.js +213 -0
- package/lib/generated-client/api/tv-shows-api.d.ts +25 -15
- package/lib/generated-client/api/tv-shows-api.js +32 -15
- package/lib/generated-client/api/universal-audio-api.d.ts +17 -16
- package/lib/generated-client/api/universal-audio-api.js +19 -8
- package/lib/generated-client/api/user-api.d.ts +35 -155
- package/lib/generated-client/api/user-api.js +65 -203
- package/lib/generated-client/api/user-library-api.d.ts +100 -100
- package/lib/generated-client/api/user-library-api.js +136 -125
- package/lib/generated-client/api/user-views-api.d.ts +22 -21
- package/lib/generated-client/api/user-views-api.js +33 -22
- package/lib/generated-client/api/video-attachments-api.js +12 -1
- package/lib/generated-client/api/videos-api.js +18 -7
- package/lib/generated-client/api/years-api.d.ts +15 -13
- package/lib/generated-client/api/years-api.js +19 -8
- package/lib/generated-client/api.d.ts +2 -4
- package/lib/generated-client/base.js +13 -0
- package/lib/generated-client/common.js +11 -0
- package/lib/generated-client/index.js +19 -10
- package/lib/generated-client/models/activity-log-entry-message.d.ts +37 -0
- package/lib/generated-client/models/activity-log-entry-start-message.d.ts +30 -0
- package/lib/generated-client/models/activity-log-entry-stop-message.d.ts +24 -0
- package/lib/generated-client/models/audio-spatial-format.d.ts +21 -0
- package/lib/generated-client/models/audio-spatial-format.js +24 -0
- package/lib/generated-client/models/authenticate-user-by-name.d.ts +0 -7
- package/lib/generated-client/models/base-item-dto.d.ts +37 -17
- package/lib/generated-client/models/base-item-person.d.ts +4 -3
- package/lib/generated-client/models/cast-receiver-application.d.ts +29 -0
- package/lib/generated-client/models/client-capabilities-dto.d.ts +17 -20
- package/lib/generated-client/models/client-capabilities.d.ts +16 -19
- package/lib/generated-client/models/collection-type-options.d.ts +9 -9
- package/lib/generated-client/models/collection-type-options.js +9 -9
- package/lib/generated-client/models/collection-type.d.ts +31 -0
- package/lib/generated-client/models/collection-type.js +34 -0
- package/lib/generated-client/models/container-profile.d.ts +1 -1
- package/lib/generated-client/models/create-playlist-dto.d.ts +18 -4
- package/lib/generated-client/models/create-user-by-name.d.ts +1 -1
- package/lib/generated-client/models/device-info.d.ts +6 -0
- package/lib/generated-client/models/device-profile.d.ts +0 -171
- package/lib/generated-client/models/dlna-profile-type.d.ts +1 -0
- package/lib/generated-client/models/dlna-profile-type.js +2 -1
- package/lib/generated-client/models/down-mix-stereo-algorithms.d.ts +21 -0
- package/lib/generated-client/models/down-mix-stereo-algorithms.js +24 -0
- package/lib/generated-client/models/encoding-options.d.ts +77 -40
- package/lib/generated-client/models/external-id-media-type.d.ts +1 -0
- package/lib/generated-client/models/external-id-media-type.js +2 -1
- package/lib/generated-client/models/extra-type.d.ts +30 -0
- package/lib/generated-client/models/extra-type.js +33 -0
- package/lib/generated-client/models/force-keep-alive-message.d.ts +36 -0
- package/lib/generated-client/models/general-command-message.d.ts +37 -0
- package/lib/generated-client/models/general-command-type.d.ts +1 -0
- package/lib/generated-client/models/general-command-type.js +2 -1
- package/lib/generated-client/models/get-programs-dto.d.ts +4 -3
- package/lib/generated-client/models/group-info-dto-group-update.d.ts +37 -0
- package/lib/generated-client/models/group-state-update-group-update.d.ts +37 -0
- package/lib/generated-client/models/group-state-update.d.ts +31 -0
- package/lib/generated-client/models/group-update.d.ts +20 -0
- package/lib/generated-client/models/hardware-encoding-type.d.ts +1 -0
- package/lib/generated-client/models/hardware-encoding-type.js +2 -1
- package/lib/generated-client/models/image-format.d.ts +1 -0
- package/lib/generated-client/models/image-format.js +2 -1
- package/lib/generated-client/models/image-resolution.d.ts +27 -0
- package/lib/generated-client/models/{ffmpeg-location.js → image-resolution.js} +12 -7
- package/lib/generated-client/models/inbound-keep-alive-message.d.ts +24 -0
- package/lib/generated-client/models/inbound-web-socket-message.d.ts +23 -0
- package/lib/generated-client/models/index.d.ts +74 -25
- package/lib/generated-client/models/index.js +17 -6
- package/lib/generated-client/models/item-fields.d.ts +1 -2
- package/lib/generated-client/models/item-fields.js +1 -2
- package/lib/generated-client/models/item-sort-by.d.ts +50 -0
- package/lib/generated-client/models/item-sort-by.js +53 -0
- package/lib/generated-client/models/library-changed-message.d.ts +37 -0
- package/lib/generated-client/models/library-options.d.ts +36 -0
- package/lib/generated-client/models/live-tv-options.d.ts +12 -0
- package/lib/generated-client/models/log-file.d.ts +1 -1
- package/lib/generated-client/models/lyric-dto.d.ts +31 -0
- package/lib/generated-client/models/lyric-line.d.ts +29 -0
- package/lib/generated-client/models/lyric-metadata.d.ts +77 -0
- package/lib/generated-client/models/media-source-info.d.ts +3 -2
- package/lib/generated-client/models/media-stream-protocol.d.ts +20 -0
- package/lib/generated-client/models/{header-match-type.js → media-stream-protocol.js} +5 -6
- package/lib/generated-client/models/media-stream-type.d.ts +1 -0
- package/lib/generated-client/models/media-stream-type.js +2 -1
- package/lib/generated-client/models/media-stream.d.ts +27 -6
- package/lib/generated-client/models/media-type.d.ts +23 -0
- package/lib/generated-client/models/{architecture.js → media-type.js} +8 -9
- package/lib/generated-client/models/metadata-editor-info.d.ts +3 -2
- package/lib/generated-client/models/network-configuration.d.ts +50 -116
- package/lib/generated-client/models/outbound-keep-alive-message.d.ts +30 -0
- package/lib/generated-client/models/outbound-web-socket-message.d.ts +44 -0
- package/lib/generated-client/models/parental-rating.d.ts +1 -1
- package/lib/generated-client/models/person-kind.d.ts +43 -0
- package/lib/generated-client/models/person-kind.js +46 -0
- package/lib/generated-client/models/play-message.d.ts +37 -0
- package/lib/generated-client/models/play-queue-update-group-update.d.ts +37 -0
- package/lib/generated-client/models/play-queue-update-reason.d.ts +28 -0
- package/lib/generated-client/models/play-queue-update-reason.js +31 -0
- package/lib/generated-client/models/play-queue-update.d.ts +69 -0
- package/lib/generated-client/models/playback-order.d.ts +20 -0
- package/lib/generated-client/models/{send-to-user-type.js → playback-order.js} +5 -6
- package/lib/generated-client/models/playback-progress-info.d.ts +7 -0
- package/lib/generated-client/models/playback-request-type.d.ts +35 -0
- package/lib/generated-client/models/playback-request-type.js +38 -0
- package/lib/generated-client/models/playback-start-info.d.ts +7 -0
- package/lib/generated-client/models/player-state-info.d.ts +7 -0
- package/lib/generated-client/models/playlist-user-permissions.d.ts +29 -0
- package/lib/generated-client/models/playstate-message.d.ts +37 -0
- package/lib/generated-client/models/plugin-installation-cancelled-message.d.ts +37 -0
- package/lib/generated-client/models/plugin-installation-completed-message.d.ts +37 -0
- package/lib/generated-client/models/plugin-installation-failed-message.d.ts +37 -0
- package/lib/generated-client/models/plugin-installing-message.d.ts +37 -0
- package/lib/generated-client/models/plugin-uninstalled-message.d.ts +37 -0
- package/lib/generated-client/models/process-priority-class.d.ts +24 -0
- package/lib/generated-client/models/process-priority-class.js +27 -0
- package/lib/generated-client/models/public-system-info.d.ts +1 -0
- package/lib/generated-client/models/refresh-progress-message.d.ts +38 -0
- package/lib/generated-client/models/remote-lyric-info-dto.d.ts +36 -0
- package/lib/generated-client/models/remote-subtitle-info.d.ts +30 -0
- package/lib/generated-client/models/remove-from-playlist-request-dto.d.ts +1 -1
- package/lib/generated-client/models/restart-required-message.d.ts +30 -0
- package/lib/generated-client/models/scheduled-task-ended-message.d.ts +37 -0
- package/lib/generated-client/models/scheduled-tasks-info-message.d.ts +37 -0
- package/lib/generated-client/models/scheduled-tasks-info-start-message.d.ts +30 -0
- package/lib/generated-client/models/scheduled-tasks-info-stop-message.d.ts +24 -0
- package/lib/generated-client/models/search-hint.d.ts +20 -17
- package/lib/generated-client/models/series-status.d.ts +2 -1
- package/lib/generated-client/models/series-status.js +3 -2
- package/lib/generated-client/models/series-timer-cancelled-message.d.ts +37 -0
- package/lib/generated-client/models/series-timer-created-message.d.ts +37 -0
- package/lib/generated-client/models/server-configuration.d.ts +45 -0
- package/lib/generated-client/models/server-restarting-message.d.ts +30 -0
- package/lib/generated-client/models/server-shutting-down-message.d.ts +30 -0
- package/lib/generated-client/models/session-info.d.ts +9 -9
- package/lib/generated-client/models/sessions-message.d.ts +37 -0
- package/lib/generated-client/models/sessions-start-message.d.ts +30 -0
- package/lib/generated-client/models/sessions-stop-message.d.ts +24 -0
- package/lib/generated-client/models/string-group-update.d.ts +36 -0
- package/lib/generated-client/models/sync-play-command-message.d.ts +37 -0
- package/lib/generated-client/models/sync-play-group-update-command-message.d.ts +37 -0
- package/lib/generated-client/models/sync-play-queue-item.d.ts +29 -0
- package/lib/generated-client/models/system-info.d.ts +17 -6
- package/lib/generated-client/models/timer-cancelled-message.d.ts +37 -0
- package/lib/generated-client/models/timer-created-message.d.ts +37 -0
- package/lib/generated-client/models/transcoding-info.d.ts +3 -2
- package/lib/generated-client/models/transcoding-info.js +15 -0
- package/lib/generated-client/models/transcoding-profile.d.ts +3 -2
- package/lib/generated-client/models/trickplay-info.d.ts +59 -0
- package/lib/generated-client/models/trickplay-options.d.ts +85 -0
- package/lib/generated-client/models/trickplay-scan-behavior.d.ts +20 -0
- package/lib/generated-client/models/{notification-level.js → trickplay-scan-behavior.js} +5 -6
- package/lib/generated-client/models/tuner-host-info.d.ts +6 -0
- package/lib/generated-client/models/update-playlist-dto.d.ts +42 -0
- package/lib/generated-client/models/update-playlist-user-dto.d.ts +23 -0
- package/lib/generated-client/models/update-user-item-data-dto.d.ts +83 -0
- package/lib/generated-client/models/upload-subtitle-dto.d.ts +6 -0
- package/lib/generated-client/models/user-configuration.d.ts +6 -0
- package/lib/generated-client/models/user-data-change-info.d.ts +30 -0
- package/lib/generated-client/models/user-data-changed-message.d.ts +37 -0
- package/lib/generated-client/models/user-deleted-message.d.ts +36 -0
- package/lib/generated-client/models/user-dto.d.ts +1 -0
- package/lib/generated-client/models/user-policy.d.ts +26 -2
- package/lib/generated-client/models/user-updated-message.d.ts +37 -0
- package/lib/generated-client/models/video-range-type.d.ts +27 -0
- package/lib/generated-client/models/video-range-type.js +30 -0
- package/lib/generated-client/models/video-range.d.ts +21 -0
- package/lib/generated-client/models/{device-profile-type.js → video-range.js} +6 -5
- package/lib/generated-client/models/web-socket-message.d.ts +18 -0
- package/lib/node_modules/tslib/tslib.es6.js +9 -2
- package/lib/utils/api/image-api.d.ts +2 -2
- package/lib/utils/api/image-api.js +2 -2
- package/lib/utils/api/image-urls-api.d.ts +55 -0
- package/lib/utils/api/image-urls-api.js +103 -0
- package/lib/utils/api/index.d.ts +2 -4
- package/lib/utils/api/index.js +2 -4
- package/lib/utils/api/{dlna-api.d.ts → lyrics-api.d.ts} +2 -2
- package/lib/utils/api/{dlna-api.js → lyrics-api.js} +4 -4
- package/lib/utils/api/{dlna-server-api.d.ts → trickplay-api.d.ts} +2 -2
- package/lib/utils/api/trickplay-api.js +12 -0
- package/lib/utils/authentication.js +5 -6
- package/lib/utils/index.d.ts +2 -1
- package/lib/utils/index.js +2 -1
- package/lib/utils/versioning.d.ts +9 -0
- package/lib/utils/versioning.js +32 -0
- package/lib/versions.d.ts +2 -2
- package/lib/versions.js +2 -2
- package/package.json +19 -22
- package/lib/generated-client/api/dlna-server-api.js +0 -1088
- package/lib/generated-client/api/image-by-name-api.js +0 -423
- package/lib/generated-client/api/notifications-api.js +0 -484
- package/lib/utils/api/dlna-server-api.js +0 -12
- package/lib/utils/api/image-by-name-api.d.ts +0 -8
- package/lib/utils/api/image-by-name-api.js +0 -12
- package/lib/utils/api/notifications-api.d.ts +0 -8
- package/lib/utils/api/notifications-api.js +0 -12
package/README.md
CHANGED
|
@@ -10,8 +10,8 @@
|
|
|
10
10
|
<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>
|
|
11
11
|
<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>
|
|
12
12
|
<a href="https://www.npmjs.com/package/@jellyfin/sdk"><img alt="npm" src="https://img.shields.io/npm/v/@jellyfin/sdk"></a>
|
|
13
|
-
<a href="https://
|
|
14
|
-
<img alt="
|
|
13
|
+
<a href="https://sonarcloud.io/component_measures?metric=coverage&id=jellyfin_jellyfin-sdk-typescript">
|
|
14
|
+
<img alt="Sonar Coverage" src="https://img.shields.io/sonar/coverage/jellyfin_jellyfin-sdk-typescript/master?server=https%3A%2F%2Fsonarcloud.io">
|
|
15
15
|
</a>
|
|
16
16
|
</p>
|
|
17
17
|
|
|
@@ -35,10 +35,8 @@ yarn add @jellyfin/sdk
|
|
|
35
35
|
|
|
36
36
|
| SDK Version | Jellyfin Version |
|
|
37
37
|
|:-:|:-:|
|
|
38
|
-
| 0.
|
|
39
|
-
| 0.8.0 | 10.8.1 - 10.8.
|
|
40
|
-
| 0.7.0 | 10.8.1 - 10.8.9 |
|
|
41
|
-
| 0.6.0 | 10.8.1 - 10.8.9 |
|
|
38
|
+
| 0.9.0 | 10.9.x |
|
|
39
|
+
| 0.8.2 - 0.6.0 | 10.8.1 - 10.8.13 |
|
|
42
40
|
| 0.5.0 | 10.8.0 |
|
|
43
41
|
| <0.5.0 | 10.7.x |
|
|
44
42
|
|
|
@@ -109,6 +107,10 @@ await api.logout();
|
|
|
109
107
|
|
|
110
108
|
## Breaking Changes
|
|
111
109
|
|
|
110
|
+
### v0.9.0
|
|
111
|
+
|
|
112
|
+
* Updated OpenAPI spec for Jellyfin 10.9.1. [#694](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/694)
|
|
113
|
+
|
|
112
114
|
### v0.8.0
|
|
113
115
|
|
|
114
116
|
* The library is now fully targeted to ES6/ES2015.
|
|
@@ -148,7 +150,7 @@ await api.logout();
|
|
|
148
150
|
* [x] Use custom generator templates for API versions [#231](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/231) (Currently uses sed to update the value could be improved.)
|
|
149
151
|
* [x] Automate OpenAPI spec updates using GitHub [#351](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/351)
|
|
150
152
|
* [x] Create branch tracking unstable Jellyfin builds with automated builds [#354](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/354)
|
|
151
|
-
* [
|
|
153
|
+
* [x] Fix authentication header escaping [#564](https://github.com/jellyfin/jellyfin-sdk-typescript/pull/564)
|
|
152
154
|
* [ ] Add WebSocket API support
|
|
153
155
|
* [ ] Add example projects for different ecosystems [#186](https://github.com/jellyfin/jellyfin-sdk-typescript/issues/186)
|
|
154
156
|
* [ ] Add utility function for `getFile` [#164](https://github.com/jellyfin/jellyfin-sdk-typescript/issues/164)
|
package/lib/api.d.ts
CHANGED
|
@@ -32,6 +32,7 @@ export declare class Api {
|
|
|
32
32
|
logout(): Promise<AxiosResponse<never> | AxiosResponse<void>>;
|
|
33
33
|
/**
|
|
34
34
|
* Get an item image URL.
|
|
35
|
+
* @deprecated Use {@link ImageUrlsApi.getItemImageUrlById} instead.
|
|
35
36
|
* @param itemId The Item ID.
|
|
36
37
|
* @param imageType An optional Image Type (Primary by default).
|
|
37
38
|
* @param params Additional request parameters.
|
package/lib/api.js
CHANGED
|
@@ -2,6 +2,7 @@ import globalAxios from 'axios';
|
|
|
2
2
|
import { Configuration } from './generated-client/configuration.js';
|
|
3
3
|
import { ImageType } from './generated-client/models/image-type.js';
|
|
4
4
|
import { getAuthorizationHeader } from './utils/authentication.js';
|
|
5
|
+
import { getImageApi } from './utils/api/image-api.js';
|
|
5
6
|
import { getSessionApi } from './utils/api/session-api.js';
|
|
6
7
|
import { getUserApi } from './utils/api/user-api.js';
|
|
7
8
|
|
|
@@ -50,16 +51,15 @@ class Api {
|
|
|
50
51
|
}
|
|
51
52
|
/**
|
|
52
53
|
* Get an item image URL.
|
|
54
|
+
* @deprecated Use {@link ImageUrlsApi.getItemImageUrlById} instead.
|
|
53
55
|
* @param itemId The Item ID.
|
|
54
56
|
* @param imageType An optional Image Type (Primary by default).
|
|
55
57
|
* @param params Additional request parameters.
|
|
56
58
|
* @returns The image URL.
|
|
57
59
|
*/
|
|
58
60
|
getItemImageUrl(itemId, imageType = ImageType.Primary, params = {}) {
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
baseURL: this.basePath
|
|
62
|
-
}).getUri({ url: `/Items/${itemId}/Images/${imageType}`, params });
|
|
61
|
+
return getImageApi(this)
|
|
62
|
+
.getItemImageUrlById(itemId, imageType, params);
|
|
63
63
|
}
|
|
64
64
|
get authorizationHeader() {
|
|
65
65
|
return getAuthorizationHeader(this.clientInfo, this.deviceInfo, this.accessToken);
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { __awaiter } from '../node_modules/tslib/tslib.es6.js';
|
|
2
|
-
import { compare } from 'compare-versions';
|
|
3
2
|
import { RecommendedServerInfoScore } from '../models/recommended-server-info.js';
|
|
4
3
|
import { SystemInfoIssue, ProductNameIssue, VersionMissingIssue, VersionUnsupportedIssue, VersionOutdatedIssue, SlowResponseIssue } from '../models/recommended-server-issue.js';
|
|
5
4
|
import { getSystemApi } from '../utils/api/system-api.js';
|
|
5
|
+
import { isVersionLess } from '../utils/versioning.js';
|
|
6
6
|
import { MINIMUM_VERSION, API_VERSION } from '../versions.js';
|
|
7
7
|
|
|
8
8
|
/**
|
|
@@ -36,20 +36,28 @@ function toRecommendedServerInfo(result) {
|
|
|
36
36
|
scores.push(RecommendedServerInfoScore.BAD);
|
|
37
37
|
}
|
|
38
38
|
const version = (_b = result.response) === null || _b === void 0 ? void 0 : _b.data.Version;
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
39
|
+
try {
|
|
40
|
+
if (!version) {
|
|
41
|
+
// No version was returned
|
|
42
|
+
issues.push(new VersionMissingIssue());
|
|
43
|
+
scores.push(RecommendedServerInfoScore.BAD);
|
|
44
|
+
}
|
|
45
|
+
else if (isVersionLess(version, MINIMUM_VERSION)) {
|
|
46
|
+
// Version is less than the minimum supported
|
|
47
|
+
issues.push(new VersionUnsupportedIssue(version));
|
|
48
|
+
scores.push(RecommendedServerInfoScore.OK);
|
|
49
|
+
}
|
|
50
|
+
else if (isVersionLess(version, API_VERSION)) {
|
|
51
|
+
// Version is less than the generated client, but above the minimum
|
|
52
|
+
issues.push(new VersionOutdatedIssue(version));
|
|
53
|
+
scores.push(RecommendedServerInfoScore.GOOD);
|
|
54
|
+
}
|
|
48
55
|
}
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
56
|
+
catch (error) {
|
|
57
|
+
if (error instanceof TypeError) {
|
|
58
|
+
issues.push(new VersionMissingIssue());
|
|
59
|
+
scores.push(RecommendedServerInfoScore.BAD);
|
|
60
|
+
}
|
|
53
61
|
}
|
|
54
62
|
if (result.responseTime > SLOW_RESPONSE_TIME) {
|
|
55
63
|
// Response was slow
|
|
@@ -97,8 +105,8 @@ class RecommendedServerDiscovery {
|
|
|
97
105
|
* @param servers An array of server addresses.
|
|
98
106
|
* @returns The RecommendedServerInfo for each address.
|
|
99
107
|
*/
|
|
100
|
-
discover(
|
|
101
|
-
return __awaiter(this,
|
|
108
|
+
discover(servers_1) {
|
|
109
|
+
return __awaiter(this, arguments, void 0, function* (servers, minimumScore = RecommendedServerInfoScore.BAD) {
|
|
102
110
|
return (yield Promise.all(servers.map(server => this.fetchRecommendedServerInfo(server)))).filter(serverInfo => serverInfo.score >= minimumScore);
|
|
103
111
|
});
|
|
104
112
|
}
|
|
@@ -4,6 +4,17 @@ import { DUMMY_BASE_URL, setApiKeyToObject, setSearchParams, toPathString, creat
|
|
|
4
4
|
import { BaseAPI, BASE_PATH } from '../base.js';
|
|
5
5
|
|
|
6
6
|
/* tslint:disable */
|
|
7
|
+
/* eslint-disable */
|
|
8
|
+
/**
|
|
9
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*
|
|
12
|
+
* Jellyfin API
|
|
13
|
+
*
|
|
14
|
+
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
15
|
+
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
16
|
+
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
17
|
+
*/
|
|
7
18
|
/**
|
|
8
19
|
* ActivityLogApi - axios parameter creator
|
|
9
20
|
* @export
|
|
@@ -20,7 +31,7 @@ const ActivityLogApiAxiosParamCreator = function (configuration) {
|
|
|
20
31
|
* @param {*} [options] Override http request option.
|
|
21
32
|
* @throws {RequiredError}
|
|
22
33
|
*/
|
|
23
|
-
getLogEntries: (
|
|
34
|
+
getLogEntries: (startIndex_1, limit_1, minDate_1, hasUserId_1, ...args_1) => __awaiter(this, [startIndex_1, limit_1, minDate_1, hasUserId_1, ...args_1], void 0, function* (startIndex, limit, minDate, hasUserId, options = {}) {
|
|
24
35
|
const localVarPath = `/System/ActivityLog/Entries`;
|
|
25
36
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
26
37
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -4,6 +4,17 @@ import { assertParamExists, DUMMY_BASE_URL, setApiKeyToObject, setSearchParams,
|
|
|
4
4
|
import { BaseAPI, BASE_PATH } from '../base.js';
|
|
5
5
|
|
|
6
6
|
/* tslint:disable */
|
|
7
|
+
/* eslint-disable */
|
|
8
|
+
/**
|
|
9
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*
|
|
12
|
+
* Jellyfin API
|
|
13
|
+
*
|
|
14
|
+
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
15
|
+
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
16
|
+
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
17
|
+
*/
|
|
7
18
|
/**
|
|
8
19
|
* ApiKeyApi - axios parameter creator
|
|
9
20
|
* @export
|
|
@@ -17,7 +28,7 @@ const ApiKeyApiAxiosParamCreator = function (configuration) {
|
|
|
17
28
|
* @param {*} [options] Override http request option.
|
|
18
29
|
* @throws {RequiredError}
|
|
19
30
|
*/
|
|
20
|
-
createKey: (
|
|
31
|
+
createKey: (app_1, ...args_1) => __awaiter(this, [app_1, ...args_1], void 0, function* (app, options = {}) {
|
|
21
32
|
// verify required parameter 'app' is not null or undefined
|
|
22
33
|
assertParamExists('createKey', 'app', app);
|
|
23
34
|
const localVarPath = `/Auth/Keys`;
|
|
@@ -49,7 +60,7 @@ const ApiKeyApiAxiosParamCreator = function (configuration) {
|
|
|
49
60
|
* @param {*} [options] Override http request option.
|
|
50
61
|
* @throws {RequiredError}
|
|
51
62
|
*/
|
|
52
|
-
getKeys: (
|
|
63
|
+
getKeys: (...args_2) => __awaiter(this, [...args_2], void 0, function* (options = {}) {
|
|
53
64
|
const localVarPath = `/Auth/Keys`;
|
|
54
65
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
55
66
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -77,7 +88,7 @@ const ApiKeyApiAxiosParamCreator = function (configuration) {
|
|
|
77
88
|
* @param {*} [options] Override http request option.
|
|
78
89
|
* @throws {RequiredError}
|
|
79
90
|
*/
|
|
80
|
-
revokeKey: (
|
|
91
|
+
revokeKey: (key_1, ...args_3) => __awaiter(this, [key_1, ...args_3], void 0, function* (key, options = {}) {
|
|
81
92
|
// verify required parameter 'key' is not null or undefined
|
|
82
93
|
assertParamExists('revokeKey', 'key', key);
|
|
83
94
|
const localVarPath = `/Auth/Keys/{key}`
|
|
@@ -17,6 +17,8 @@ import { BaseItemKind } from '../models';
|
|
|
17
17
|
import { ImageType } from '../models';
|
|
18
18
|
import { ItemFields } from '../models';
|
|
19
19
|
import { ItemFilter } from '../models';
|
|
20
|
+
import { ItemSortBy } from '../models';
|
|
21
|
+
import { MediaType } from '../models';
|
|
20
22
|
import { SortOrder } from '../models';
|
|
21
23
|
/**
|
|
22
24
|
* ArtistsApi - axios parameter creator
|
|
@@ -36,7 +38,7 @@ export declare const ArtistsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
36
38
|
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
37
39
|
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply.
|
|
38
40
|
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
|
|
39
|
-
* @param {Array<
|
|
41
|
+
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
|
|
40
42
|
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
41
43
|
* @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
|
|
42
44
|
* @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
@@ -54,14 +56,14 @@ export declare const ArtistsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
54
56
|
* @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string.
|
|
55
57
|
* @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string.
|
|
56
58
|
* @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string.
|
|
57
|
-
* @param {Array<
|
|
59
|
+
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
|
|
58
60
|
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
59
61
|
* @param {boolean} [enableImages] Optional, include image information in output.
|
|
60
62
|
* @param {boolean} [enableTotalRecordCount] Total record count.
|
|
61
63
|
* @param {*} [options] Override http request option.
|
|
62
64
|
* @throws {RequiredError}
|
|
63
65
|
*/
|
|
64
|
-
getAlbumArtists: (minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<
|
|
66
|
+
getAlbumArtists: (minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<MediaType>, genres?: Array<string>, genreIds?: Array<string>, officialRatings?: Array<string>, tags?: Array<string>, years?: Array<number>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, person?: string, personIds?: Array<string>, personTypes?: Array<string>, studios?: Array<string>, studioIds?: Array<string>, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array<ItemSortBy>, sortOrder?: Array<SortOrder>, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
65
67
|
/**
|
|
66
68
|
*
|
|
67
69
|
* @summary Gets an artist by name.
|
|
@@ -84,7 +86,7 @@ export declare const ArtistsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
84
86
|
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
85
87
|
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply.
|
|
86
88
|
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
|
|
87
|
-
* @param {Array<
|
|
89
|
+
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
|
|
88
90
|
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
89
91
|
* @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
|
|
90
92
|
* @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
@@ -102,14 +104,14 @@ export declare const ArtistsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
102
104
|
* @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string.
|
|
103
105
|
* @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string.
|
|
104
106
|
* @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string.
|
|
105
|
-
* @param {Array<
|
|
107
|
+
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
|
|
106
108
|
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
107
109
|
* @param {boolean} [enableImages] Optional, include image information in output.
|
|
108
110
|
* @param {boolean} [enableTotalRecordCount] Total record count.
|
|
109
111
|
* @param {*} [options] Override http request option.
|
|
110
112
|
* @throws {RequiredError}
|
|
111
113
|
*/
|
|
112
|
-
getArtists: (minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<
|
|
114
|
+
getArtists: (minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<MediaType>, genres?: Array<string>, genreIds?: Array<string>, officialRatings?: Array<string>, tags?: Array<string>, years?: Array<number>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, person?: string, personIds?: Array<string>, personTypes?: Array<string>, studios?: Array<string>, studioIds?: Array<string>, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array<ItemSortBy>, sortOrder?: Array<SortOrder>, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
113
115
|
};
|
|
114
116
|
/**
|
|
115
117
|
* ArtistsApi - functional programming interface
|
|
@@ -129,7 +131,7 @@ export declare const ArtistsApiFp: (configuration?: Configuration) => {
|
|
|
129
131
|
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
130
132
|
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply.
|
|
131
133
|
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
|
|
132
|
-
* @param {Array<
|
|
134
|
+
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
|
|
133
135
|
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
134
136
|
* @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
|
|
135
137
|
* @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
@@ -147,14 +149,14 @@ export declare const ArtistsApiFp: (configuration?: Configuration) => {
|
|
|
147
149
|
* @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string.
|
|
148
150
|
* @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string.
|
|
149
151
|
* @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string.
|
|
150
|
-
* @param {Array<
|
|
152
|
+
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
|
|
151
153
|
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
152
154
|
* @param {boolean} [enableImages] Optional, include image information in output.
|
|
153
155
|
* @param {boolean} [enableTotalRecordCount] Total record count.
|
|
154
156
|
* @param {*} [options] Override http request option.
|
|
155
157
|
* @throws {RequiredError}
|
|
156
158
|
*/
|
|
157
|
-
getAlbumArtists(minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<
|
|
159
|
+
getAlbumArtists(minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<MediaType>, genres?: Array<string>, genreIds?: Array<string>, officialRatings?: Array<string>, tags?: Array<string>, years?: Array<number>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, person?: string, personIds?: Array<string>, personTypes?: Array<string>, studios?: Array<string>, studioIds?: Array<string>, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array<ItemSortBy>, sortOrder?: Array<SortOrder>, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>;
|
|
158
160
|
/**
|
|
159
161
|
*
|
|
160
162
|
* @summary Gets an artist by name.
|
|
@@ -177,7 +179,7 @@ export declare const ArtistsApiFp: (configuration?: Configuration) => {
|
|
|
177
179
|
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
178
180
|
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply.
|
|
179
181
|
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
|
|
180
|
-
* @param {Array<
|
|
182
|
+
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
|
|
181
183
|
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
182
184
|
* @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
|
|
183
185
|
* @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
@@ -195,14 +197,14 @@ export declare const ArtistsApiFp: (configuration?: Configuration) => {
|
|
|
195
197
|
* @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string.
|
|
196
198
|
* @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string.
|
|
197
199
|
* @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string.
|
|
198
|
-
* @param {Array<
|
|
200
|
+
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
|
|
199
201
|
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
200
202
|
* @param {boolean} [enableImages] Optional, include image information in output.
|
|
201
203
|
* @param {boolean} [enableTotalRecordCount] Total record count.
|
|
202
204
|
* @param {*} [options] Override http request option.
|
|
203
205
|
* @throws {RequiredError}
|
|
204
206
|
*/
|
|
205
|
-
getArtists(minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<
|
|
207
|
+
getArtists(minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<MediaType>, genres?: Array<string>, genreIds?: Array<string>, officialRatings?: Array<string>, tags?: Array<string>, years?: Array<number>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, person?: string, personIds?: Array<string>, personTypes?: Array<string>, studios?: Array<string>, studioIds?: Array<string>, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array<ItemSortBy>, sortOrder?: Array<SortOrder>, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>;
|
|
206
208
|
};
|
|
207
209
|
/**
|
|
208
210
|
* ArtistsApi - factory interface
|
|
@@ -222,7 +224,7 @@ export declare const ArtistsApiFactory: (configuration?: Configuration, basePath
|
|
|
222
224
|
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
223
225
|
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply.
|
|
224
226
|
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
|
|
225
|
-
* @param {Array<
|
|
227
|
+
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
|
|
226
228
|
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
227
229
|
* @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
|
|
228
230
|
* @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
@@ -240,14 +242,14 @@ export declare const ArtistsApiFactory: (configuration?: Configuration, basePath
|
|
|
240
242
|
* @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string.
|
|
241
243
|
* @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string.
|
|
242
244
|
* @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string.
|
|
243
|
-
* @param {Array<
|
|
245
|
+
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
|
|
244
246
|
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
245
247
|
* @param {boolean} [enableImages] Optional, include image information in output.
|
|
246
248
|
* @param {boolean} [enableTotalRecordCount] Total record count.
|
|
247
249
|
* @param {*} [options] Override http request option.
|
|
248
250
|
* @throws {RequiredError}
|
|
249
251
|
*/
|
|
250
|
-
getAlbumArtists(minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<
|
|
252
|
+
getAlbumArtists(minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<MediaType>, genres?: Array<string>, genreIds?: Array<string>, officialRatings?: Array<string>, tags?: Array<string>, years?: Array<number>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, person?: string, personIds?: Array<string>, personTypes?: Array<string>, studios?: Array<string>, studioIds?: Array<string>, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array<ItemSortBy>, sortOrder?: Array<SortOrder>, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>;
|
|
251
253
|
/**
|
|
252
254
|
*
|
|
253
255
|
* @summary Gets an artist by name.
|
|
@@ -270,7 +272,7 @@ export declare const ArtistsApiFactory: (configuration?: Configuration, basePath
|
|
|
270
272
|
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
271
273
|
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply.
|
|
272
274
|
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
|
|
273
|
-
* @param {Array<
|
|
275
|
+
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
|
|
274
276
|
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
275
277
|
* @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
|
|
276
278
|
* @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
@@ -288,14 +290,14 @@ export declare const ArtistsApiFactory: (configuration?: Configuration, basePath
|
|
|
288
290
|
* @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string.
|
|
289
291
|
* @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string.
|
|
290
292
|
* @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string.
|
|
291
|
-
* @param {Array<
|
|
293
|
+
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
|
|
292
294
|
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
293
295
|
* @param {boolean} [enableImages] Optional, include image information in output.
|
|
294
296
|
* @param {boolean} [enableTotalRecordCount] Total record count.
|
|
295
297
|
* @param {*} [options] Override http request option.
|
|
296
298
|
* @throws {RequiredError}
|
|
297
299
|
*/
|
|
298
|
-
getArtists(minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<
|
|
300
|
+
getArtists(minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<MediaType>, genres?: Array<string>, genreIds?: Array<string>, officialRatings?: Array<string>, tags?: Array<string>, years?: Array<number>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, person?: string, personIds?: Array<string>, personTypes?: Array<string>, studios?: Array<string>, studioIds?: Array<string>, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array<ItemSortBy>, sortOrder?: Array<SortOrder>, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>;
|
|
299
301
|
};
|
|
300
302
|
/**
|
|
301
303
|
* Request parameters for getAlbumArtists operation in ArtistsApi.
|
|
@@ -365,10 +367,10 @@ export interface ArtistsApiGetAlbumArtistsRequest {
|
|
|
365
367
|
readonly isFavorite?: boolean;
|
|
366
368
|
/**
|
|
367
369
|
* Optional filter by MediaType. Allows multiple, comma delimited.
|
|
368
|
-
* @type {Array<
|
|
370
|
+
* @type {Array<MediaType>}
|
|
369
371
|
* @memberof ArtistsApiGetAlbumArtists
|
|
370
372
|
*/
|
|
371
|
-
readonly mediaTypes?: Array<
|
|
373
|
+
readonly mediaTypes?: Array<MediaType>;
|
|
372
374
|
/**
|
|
373
375
|
* Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
374
376
|
* @type {Array<string>}
|
|
@@ -473,10 +475,10 @@ export interface ArtistsApiGetAlbumArtistsRequest {
|
|
|
473
475
|
readonly nameLessThan?: string;
|
|
474
476
|
/**
|
|
475
477
|
* Optional. Specify one or more sort orders, comma delimited.
|
|
476
|
-
* @type {Array<
|
|
478
|
+
* @type {Array<ItemSortBy>}
|
|
477
479
|
* @memberof ArtistsApiGetAlbumArtists
|
|
478
480
|
*/
|
|
479
|
-
readonly sortBy?: Array<
|
|
481
|
+
readonly sortBy?: Array<ItemSortBy>;
|
|
480
482
|
/**
|
|
481
483
|
* Sort Order - Ascending,Descending.
|
|
482
484
|
* @type {Array<SortOrder>}
|
|
@@ -583,10 +585,10 @@ export interface ArtistsApiGetArtistsRequest {
|
|
|
583
585
|
readonly isFavorite?: boolean;
|
|
584
586
|
/**
|
|
585
587
|
* Optional filter by MediaType. Allows multiple, comma delimited.
|
|
586
|
-
* @type {Array<
|
|
588
|
+
* @type {Array<MediaType>}
|
|
587
589
|
* @memberof ArtistsApiGetArtists
|
|
588
590
|
*/
|
|
589
|
-
readonly mediaTypes?: Array<
|
|
591
|
+
readonly mediaTypes?: Array<MediaType>;
|
|
590
592
|
/**
|
|
591
593
|
* Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
592
594
|
* @type {Array<string>}
|
|
@@ -691,10 +693,10 @@ export interface ArtistsApiGetArtistsRequest {
|
|
|
691
693
|
readonly nameLessThan?: string;
|
|
692
694
|
/**
|
|
693
695
|
* Optional. Specify one or more sort orders, comma delimited.
|
|
694
|
-
* @type {Array<
|
|
696
|
+
* @type {Array<ItemSortBy>}
|
|
695
697
|
* @memberof ArtistsApiGetArtists
|
|
696
698
|
*/
|
|
697
|
-
readonly sortBy?: Array<
|
|
699
|
+
readonly sortBy?: Array<ItemSortBy>;
|
|
698
700
|
/**
|
|
699
701
|
* Sort Order - Ascending,Descending.
|
|
700
702
|
* @type {Array<SortOrder>}
|
|
@@ -4,6 +4,17 @@ import { DUMMY_BASE_URL, setApiKeyToObject, setSearchParams, toPathString, asser
|
|
|
4
4
|
import { BaseAPI, BASE_PATH } from '../base.js';
|
|
5
5
|
|
|
6
6
|
/* tslint:disable */
|
|
7
|
+
/* eslint-disable */
|
|
8
|
+
/**
|
|
9
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*
|
|
12
|
+
* Jellyfin API
|
|
13
|
+
*
|
|
14
|
+
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
15
|
+
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
16
|
+
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
17
|
+
*/
|
|
7
18
|
/**
|
|
8
19
|
* ArtistsApi - axios parameter creator
|
|
9
20
|
* @export
|
|
@@ -23,7 +34,7 @@ const ArtistsApiAxiosParamCreator = function (configuration) {
|
|
|
23
34
|
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
24
35
|
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply.
|
|
25
36
|
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
|
|
26
|
-
* @param {Array<
|
|
37
|
+
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
|
|
27
38
|
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
28
39
|
* @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
|
|
29
40
|
* @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
@@ -41,14 +52,14 @@ const ArtistsApiAxiosParamCreator = function (configuration) {
|
|
|
41
52
|
* @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string.
|
|
42
53
|
* @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string.
|
|
43
54
|
* @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string.
|
|
44
|
-
* @param {Array<
|
|
55
|
+
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
|
|
45
56
|
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
46
57
|
* @param {boolean} [enableImages] Optional, include image information in output.
|
|
47
58
|
* @param {boolean} [enableTotalRecordCount] Total record count.
|
|
48
59
|
* @param {*} [options] Override http request option.
|
|
49
60
|
* @throws {RequiredError}
|
|
50
61
|
*/
|
|
51
|
-
getAlbumArtists: (minCommunityRating, startIndex, limit, searchTerm, parentId, fields, excludeItemTypes, includeItemTypes, filters, isFavorite, mediaTypes, genres, genreIds, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, studioIds, userId, nameStartsWithOrGreater, nameStartsWith, nameLessThan, sortBy, sortOrder, enableImages, enableTotalRecordCount, options = {})
|
|
62
|
+
getAlbumArtists: (minCommunityRating_1, startIndex_1, limit_1, searchTerm_1, parentId_1, fields_1, excludeItemTypes_1, includeItemTypes_1, filters_1, isFavorite_1, mediaTypes_1, genres_1, genreIds_1, officialRatings_1, tags_1, years_1, enableUserData_1, imageTypeLimit_1, enableImageTypes_1, person_1, personIds_1, personTypes_1, studios_1, studioIds_1, userId_1, nameStartsWithOrGreater_1, nameStartsWith_1, nameLessThan_1, sortBy_1, sortOrder_1, enableImages_1, enableTotalRecordCount_1, ...args_1) => __awaiter(this, [minCommunityRating_1, startIndex_1, limit_1, searchTerm_1, parentId_1, fields_1, excludeItemTypes_1, includeItemTypes_1, filters_1, isFavorite_1, mediaTypes_1, genres_1, genreIds_1, officialRatings_1, tags_1, years_1, enableUserData_1, imageTypeLimit_1, enableImageTypes_1, person_1, personIds_1, personTypes_1, studios_1, studioIds_1, userId_1, nameStartsWithOrGreater_1, nameStartsWith_1, nameLessThan_1, sortBy_1, sortOrder_1, enableImages_1, enableTotalRecordCount_1, ...args_1], void 0, function* (minCommunityRating, startIndex, limit, searchTerm, parentId, fields, excludeItemTypes, includeItemTypes, filters, isFavorite, mediaTypes, genres, genreIds, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, studioIds, userId, nameStartsWithOrGreater, nameStartsWith, nameLessThan, sortBy, sortOrder, enableImages, enableTotalRecordCount, options = {}) {
|
|
52
63
|
const localVarPath = `/Artists/AlbumArtists`;
|
|
53
64
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
54
65
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -173,7 +184,7 @@ const ArtistsApiAxiosParamCreator = function (configuration) {
|
|
|
173
184
|
* @param {*} [options] Override http request option.
|
|
174
185
|
* @throws {RequiredError}
|
|
175
186
|
*/
|
|
176
|
-
getArtistByName: (
|
|
187
|
+
getArtistByName: (name_1, userId_2, ...args_2) => __awaiter(this, [name_1, userId_2, ...args_2], void 0, function* (name, userId, options = {}) {
|
|
177
188
|
// verify required parameter 'name' is not null or undefined
|
|
178
189
|
assertParamExists('getArtistByName', 'name', name);
|
|
179
190
|
const localVarPath = `/Artists/{name}`
|
|
@@ -213,7 +224,7 @@ const ArtistsApiAxiosParamCreator = function (configuration) {
|
|
|
213
224
|
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
214
225
|
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply.
|
|
215
226
|
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
|
|
216
|
-
* @param {Array<
|
|
227
|
+
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
|
|
217
228
|
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
218
229
|
* @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
|
|
219
230
|
* @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
@@ -231,14 +242,14 @@ const ArtistsApiAxiosParamCreator = function (configuration) {
|
|
|
231
242
|
* @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string.
|
|
232
243
|
* @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string.
|
|
233
244
|
* @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string.
|
|
234
|
-
* @param {Array<
|
|
245
|
+
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
|
|
235
246
|
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
236
247
|
* @param {boolean} [enableImages] Optional, include image information in output.
|
|
237
248
|
* @param {boolean} [enableTotalRecordCount] Total record count.
|
|
238
249
|
* @param {*} [options] Override http request option.
|
|
239
250
|
* @throws {RequiredError}
|
|
240
251
|
*/
|
|
241
|
-
getArtists: (minCommunityRating, startIndex, limit, searchTerm, parentId, fields, excludeItemTypes, includeItemTypes, filters, isFavorite, mediaTypes, genres, genreIds, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, studioIds, userId, nameStartsWithOrGreater, nameStartsWith, nameLessThan, sortBy, sortOrder, enableImages, enableTotalRecordCount, options = {})
|
|
252
|
+
getArtists: (minCommunityRating_2, startIndex_2, limit_2, searchTerm_2, parentId_2, fields_2, excludeItemTypes_2, includeItemTypes_2, filters_2, isFavorite_2, mediaTypes_2, genres_2, genreIds_2, officialRatings_2, tags_2, years_2, enableUserData_2, imageTypeLimit_2, enableImageTypes_2, person_2, personIds_2, personTypes_2, studios_2, studioIds_2, userId_3, nameStartsWithOrGreater_2, nameStartsWith_2, nameLessThan_2, sortBy_2, sortOrder_2, enableImages_2, enableTotalRecordCount_2, ...args_3) => __awaiter(this, [minCommunityRating_2, startIndex_2, limit_2, searchTerm_2, parentId_2, fields_2, excludeItemTypes_2, includeItemTypes_2, filters_2, isFavorite_2, mediaTypes_2, genres_2, genreIds_2, officialRatings_2, tags_2, years_2, enableUserData_2, imageTypeLimit_2, enableImageTypes_2, person_2, personIds_2, personTypes_2, studios_2, studioIds_2, userId_3, nameStartsWithOrGreater_2, nameStartsWith_2, nameLessThan_2, sortBy_2, sortOrder_2, enableImages_2, enableTotalRecordCount_2, ...args_3], void 0, function* (minCommunityRating, startIndex, limit, searchTerm, parentId, fields, excludeItemTypes, includeItemTypes, filters, isFavorite, mediaTypes, genres, genreIds, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, studioIds, userId, nameStartsWithOrGreater, nameStartsWith, nameLessThan, sortBy, sortOrder, enableImages, enableTotalRecordCount, options = {}) {
|
|
242
253
|
const localVarPath = `/Artists`;
|
|
243
254
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
244
255
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -377,7 +388,7 @@ const ArtistsApiFp = function (configuration) {
|
|
|
377
388
|
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
378
389
|
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply.
|
|
379
390
|
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
|
|
380
|
-
* @param {Array<
|
|
391
|
+
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
|
|
381
392
|
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
382
393
|
* @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
|
|
383
394
|
* @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
@@ -395,7 +406,7 @@ const ArtistsApiFp = function (configuration) {
|
|
|
395
406
|
* @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string.
|
|
396
407
|
* @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string.
|
|
397
408
|
* @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string.
|
|
398
|
-
* @param {Array<
|
|
409
|
+
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
|
|
399
410
|
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
400
411
|
* @param {boolean} [enableImages] Optional, include image information in output.
|
|
401
412
|
* @param {boolean} [enableTotalRecordCount] Total record count.
|
|
@@ -435,7 +446,7 @@ const ArtistsApiFp = function (configuration) {
|
|
|
435
446
|
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
436
447
|
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply.
|
|
437
448
|
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
|
|
438
|
-
* @param {Array<
|
|
449
|
+
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
|
|
439
450
|
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
440
451
|
* @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
|
|
441
452
|
* @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
@@ -453,7 +464,7 @@ const ArtistsApiFp = function (configuration) {
|
|
|
453
464
|
* @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string.
|
|
454
465
|
* @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string.
|
|
455
466
|
* @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string.
|
|
456
|
-
* @param {Array<
|
|
467
|
+
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
|
|
457
468
|
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
458
469
|
* @param {boolean} [enableImages] Optional, include image information in output.
|
|
459
470
|
* @param {boolean} [enableTotalRecordCount] Total record count.
|
|
@@ -488,7 +499,7 @@ const ArtistsApiFactory = function (configuration, basePath, axios) {
|
|
|
488
499
|
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
489
500
|
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply.
|
|
490
501
|
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
|
|
491
|
-
* @param {Array<
|
|
502
|
+
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
|
|
492
503
|
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
493
504
|
* @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
|
|
494
505
|
* @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
@@ -506,7 +517,7 @@ const ArtistsApiFactory = function (configuration, basePath, axios) {
|
|
|
506
517
|
* @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string.
|
|
507
518
|
* @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string.
|
|
508
519
|
* @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string.
|
|
509
|
-
* @param {Array<
|
|
520
|
+
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
|
|
510
521
|
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
511
522
|
* @param {boolean} [enableImages] Optional, include image information in output.
|
|
512
523
|
* @param {boolean} [enableTotalRecordCount] Total record count.
|
|
@@ -540,7 +551,7 @@ const ArtistsApiFactory = function (configuration, basePath, axios) {
|
|
|
540
551
|
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
541
552
|
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply.
|
|
542
553
|
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
|
|
543
|
-
* @param {Array<
|
|
554
|
+
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
|
|
544
555
|
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
545
556
|
* @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
|
|
546
557
|
* @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
@@ -558,7 +569,7 @@ const ArtistsApiFactory = function (configuration, basePath, axios) {
|
|
|
558
569
|
* @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string.
|
|
559
570
|
* @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string.
|
|
560
571
|
* @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string.
|
|
561
|
-
* @param {Array<
|
|
572
|
+
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
|
|
562
573
|
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
563
574
|
* @param {boolean} [enableImages] Optional, include image information in output.
|
|
564
575
|
* @param {boolean} [enableTotalRecordCount] Total record count.
|