@jellyfin/sdk 0.9.0 → 0.11.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 +10 -0
- package/lib/api.d.ts +0 -11
- package/lib/api.js +0 -14
- package/lib/discovery/discovery-service.js +4 -9
- package/lib/discovery/recommended-server-discovery.js +17 -22
- package/lib/generated-client/api/activity-log-api.d.ts +9 -12
- package/lib/generated-client/api/activity-log-api.js +15 -18
- package/lib/generated-client/api/api-key-api.d.ts +18 -18
- package/lib/generated-client/api/api-key-api.js +40 -38
- package/lib/generated-client/api/artists-api.d.ts +27 -90
- package/lib/generated-client/api/artists-api.js +43 -104
- package/lib/generated-client/api/audio-api.d.ts +81 -249
- package/lib/generated-client/api/audio-api.js +105 -266
- package/lib/generated-client/api/branding-api.d.ts +16 -16
- package/lib/generated-client/api/branding-api.js +31 -29
- package/lib/generated-client/api/channels-api.d.ts +33 -51
- package/lib/generated-client/api/channels-api.js +68 -82
- package/lib/generated-client/api/client-log-api.d.ts +13 -13
- package/lib/generated-client/api/client-log-api.js +17 -17
- package/lib/generated-client/api/collection-api.d.ts +19 -24
- package/lib/generated-client/api/collection-api.js +43 -46
- package/lib/generated-client/api/configuration-api.d.ts +28 -29
- package/lib/generated-client/api/configuration-api.js +65 -62
- package/lib/generated-client/api/dashboard-api.d.ts +14 -14
- package/lib/generated-client/api/dashboard-api.js +28 -27
- package/lib/generated-client/api/devices-api.d.ts +31 -33
- package/lib/generated-client/api/devices-api.js +71 -68
- package/lib/generated-client/api/display-preferences-api.d.ts +14 -19
- package/lib/generated-client/api/display-preferences-api.js +29 -33
- package/lib/generated-client/api/dynamic-hls-api.d.ts +246 -607
- package/lib/generated-client/api/dynamic-hls-api.js +269 -628
- package/lib/generated-client/api/environment-api.d.ts +33 -35
- package/lib/generated-client/api/environment-api.js +76 -73
- package/lib/generated-client/api/filter-api.d.ts +17 -29
- package/lib/generated-client/api/filter-api.js +29 -40
- package/lib/generated-client/api/genres-api.d.ts +20 -38
- package/lib/generated-client/api/genres-api.js +29 -46
- package/lib/generated-client/api/hls-segment-api.d.ts +28 -35
- package/lib/generated-client/api/hls-segment-api.js +68 -71
- package/lib/generated-client/api/image-api.d.ts +206 -644
- package/lib/generated-client/api/image-api.js +501 -903
- package/lib/generated-client/api/instant-mix-api.d.ts +46 -102
- package/lib/generated-client/api/instant-mix-api.js +113 -162
- package/lib/generated-client/api/item-lookup-api.d.ts +69 -71
- package/lib/generated-client/api/item-lookup-api.js +155 -147
- package/lib/generated-client/api/item-refresh-api.d.ts +9 -13
- package/lib/generated-client/api/item-refresh-api.js +15 -19
- package/lib/generated-client/api/item-update-api.d.ts +20 -22
- package/lib/generated-client/api/item-update-api.js +43 -43
- package/lib/generated-client/api/items-api.d.ts +44 -137
- package/lib/generated-client/api/items-api.js +63 -156
- package/lib/generated-client/api/library-api.d.ts +185 -170
- package/lib/generated-client/api/library-api.js +378 -359
- package/lib/generated-client/api/library-structure-api.d.ts +48 -58
- package/lib/generated-client/api/library-structure-api.js +110 -113
- package/lib/generated-client/api/live-tv-api.d.ts +224 -332
- package/lib/generated-client/api/live-tv-api.js +558 -626
- package/lib/generated-client/api/localization-api.d.ts +23 -23
- package/lib/generated-client/api/localization-api.js +45 -42
- package/lib/generated-client/api/lyrics-api.d.ts +39 -42
- package/lib/generated-client/api/lyrics-api.js +87 -85
- package/lib/generated-client/api/media-info-api.d.ts +40 -59
- package/lib/generated-client/api/media-info-api.js +77 -95
- package/lib/generated-client/api/media-segments-api.d.ts +95 -0
- package/lib/generated-client/api/media-segments-api.js +123 -0
- package/lib/generated-client/api/movies-api.d.ts +10 -14
- package/lib/generated-client/api/movies-api.js +15 -19
- package/lib/generated-client/api/music-genres-api.d.ts +20 -38
- package/lib/generated-client/api/music-genres-api.js +29 -46
- package/lib/generated-client/api/package-api.d.ts +33 -37
- package/lib/generated-client/api/package-api.js +79 -78
- package/lib/generated-client/api/persons-api.d.ts +18 -31
- package/lib/generated-client/api/persons-api.js +29 -41
- package/lib/generated-client/api/playlists-api.d.ts +109 -84
- package/lib/generated-client/api/playlists-api.js +207 -154
- package/lib/generated-client/api/playstate-api.d.ts +54 -80
- package/lib/generated-client/api/playstate-api.js +127 -145
- package/lib/generated-client/api/plugins-api.d.ts +48 -52
- package/lib/generated-client/api/plugins-api.js +124 -120
- package/lib/generated-client/api/quick-connect-api.d.ts +22 -23
- package/lib/generated-client/api/quick-connect-api.js +48 -46
- package/lib/generated-client/api/remote-image-api.d.ts +21 -28
- package/lib/generated-client/api/remote-image-api.js +43 -48
- package/lib/generated-client/api/scheduled-tasks-api.d.ts +30 -32
- package/lib/generated-client/api/scheduled-tasks-api.js +71 -69
- package/lib/generated-client/api/search-api.d.ts +11 -28
- package/lib/generated-client/api/search-api.js +15 -32
- package/lib/generated-client/api/session-api.d.ts +90 -117
- package/lib/generated-client/api/session-api.js +216 -228
- package/lib/generated-client/api/startup-api.d.ts +37 -37
- package/lib/generated-client/api/startup-api.js +87 -81
- package/lib/generated-client/api/studios-api.d.ts +18 -35
- package/lib/generated-client/api/studios-api.js +29 -45
- package/lib/generated-client/api/subtitle-api.d.ts +55 -86
- package/lib/generated-client/api/subtitle-api.js +136 -158
- package/lib/generated-client/api/suggestions-api.d.ts +11 -16
- package/lib/generated-client/api/suggestions-api.js +15 -20
- package/lib/generated-client/api/sync-play-api.d.ts +120 -120
- package/lib/generated-client/api/sync-play-api.js +280 -260
- package/lib/generated-client/api/system-api.d.ts +49 -49
- package/lib/generated-client/api/system-api.js +111 -102
- package/lib/generated-client/api/time-sync-api.d.ts +8 -8
- package/lib/generated-client/api/time-sync-api.js +11 -11
- package/lib/generated-client/api/tmdb-api.d.ts +8 -8
- package/lib/generated-client/api/tmdb-api.js +12 -12
- package/lib/generated-client/api/trailers-api.d.ts +19 -102
- package/lib/generated-client/api/trailers-api.js +15 -98
- package/lib/generated-client/api/trickplay-api.d.ts +13 -18
- package/lib/generated-client/api/trickplay-api.js +29 -33
- package/lib/generated-client/api/tv-shows-api.d.ts +27 -72
- package/lib/generated-client/api/tv-shows-api.js +57 -99
- package/lib/generated-client/api/universal-audio-api.d.ts +30 -48
- package/lib/generated-client/api/universal-audio-api.js +41 -64
- package/lib/generated-client/api/user-api.d.ts +83 -88
- package/lib/generated-client/api/user-api.js +186 -178
- package/lib/generated-client/api/user-library-api.d.ts +59 -78
- package/lib/generated-client/api/user-library-api.js +141 -151
- package/lib/generated-client/api/user-views-api.d.ts +16 -19
- package/lib/generated-client/api/user-views-api.js +29 -31
- package/lib/generated-client/api/video-attachments-api.d.ts +8 -10
- package/lib/generated-client/api/video-attachments-api.js +14 -16
- package/lib/generated-client/api/videos-api.d.ts +97 -274
- package/lib/generated-client/api/videos-api.js +147 -314
- package/lib/generated-client/api/years-api.d.ts +21 -36
- package/lib/generated-client/api/years-api.js +29 -43
- package/lib/generated-client/api.d.ts +1 -0
- package/lib/generated-client/base.d.ts +15 -4
- package/lib/generated-client/base.js +8 -4
- package/lib/generated-client/common.d.ts +3 -3
- package/lib/generated-client/common.js +30 -24
- package/lib/generated-client/configuration.d.ts +8 -0
- package/lib/generated-client/configuration.js +1 -0
- package/lib/generated-client/index.js +8 -1
- package/lib/generated-client/models/access-schedule.d.ts +1 -1
- package/lib/generated-client/models/activity-log-entry-message.d.ts +2 -2
- package/lib/generated-client/models/activity-log-entry-query-result.d.ts +3 -3
- package/lib/generated-client/models/activity-log-entry-start-message.d.ts +1 -1
- package/lib/generated-client/models/activity-log-entry-stop-message.d.ts +1 -1
- package/lib/generated-client/models/activity-log-entry.d.ts +1 -1
- package/lib/generated-client/models/add-virtual-folder-dto.d.ts +1 -1
- package/lib/generated-client/models/album-info-remote-search-query.d.ts +1 -1
- package/lib/generated-client/models/album-info.d.ts +5 -5
- package/lib/generated-client/models/all-theme-media-result.d.ts +1 -1
- package/lib/generated-client/models/artist-info-remote-search-query.d.ts +1 -1
- package/lib/generated-client/models/artist-info.d.ts +3 -3
- package/lib/generated-client/models/authentication-info-query-result.d.ts +3 -3
- package/lib/generated-client/models/authentication-result.d.ts +7 -7
- package/lib/generated-client/models/base-item-dto-query-result.d.ts +3 -3
- package/lib/generated-client/models/base-item-dto.d.ts +26 -26
- package/lib/generated-client/models/base-item-person.d.ts +2 -2
- package/lib/generated-client/models/book-info-remote-search-query.d.ts +1 -1
- package/lib/generated-client/models/book-info.d.ts +2 -2
- package/lib/generated-client/models/box-set-info-remote-search-query.d.ts +1 -1
- package/lib/generated-client/models/box-set-info.d.ts +2 -2
- package/lib/generated-client/models/channel-features.d.ts +3 -3
- package/lib/generated-client/models/channel-mapping-options-dto.d.ts +3 -3
- package/lib/generated-client/models/client-capabilities-dto.d.ts +3 -17
- package/lib/generated-client/models/client-capabilities.d.ts +3 -3
- package/lib/generated-client/models/codec-profile.d.ts +15 -9
- package/lib/generated-client/models/container-profile.d.ts +12 -6
- package/lib/generated-client/models/create-playlist-dto.d.ts +2 -2
- package/lib/generated-client/models/deinterlace-method.d.ts +20 -0
- package/lib/generated-client/models/{hardware-encoding-type.js → deinterlace-method.js} +5 -10
- package/lib/generated-client/models/device-info-dto-query-result.d.ts +36 -0
- package/lib/generated-client/models/device-info-dto.d.ts +84 -0
- package/lib/generated-client/models/device-info-query-result.d.ts +1 -1
- package/lib/generated-client/models/device-info.d.ts +1 -1
- package/lib/generated-client/models/device-profile.d.ts +8 -8
- package/lib/generated-client/models/direct-play-profile.d.ts +6 -6
- package/lib/generated-client/models/display-preferences-dto.d.ts +4 -4
- package/lib/generated-client/models/down-mix-stereo-algorithms.d.ts +3 -1
- package/lib/generated-client/models/down-mix-stereo-algorithms.js +4 -2
- package/lib/generated-client/models/encoder-preset.d.ts +29 -0
- package/lib/generated-client/models/encoder-preset.js +32 -0
- package/lib/generated-client/models/encoding-options.d.ts +43 -19
- package/lib/generated-client/models/external-id-info.d.ts +2 -1
- package/lib/generated-client/models/file-system-entry-info.d.ts +1 -1
- package/lib/generated-client/models/force-keep-alive-message.d.ts +1 -1
- package/lib/generated-client/models/forgot-password-result.d.ts +1 -1
- package/lib/generated-client/models/general-command-message.d.ts +2 -2
- package/lib/generated-client/models/general-command.d.ts +3 -3
- package/lib/generated-client/models/get-programs-dto.d.ts +34 -34
- package/lib/generated-client/models/group-info-dto-group-update.d.ts +2 -2
- package/lib/generated-client/models/group-info-dto.d.ts +1 -1
- package/lib/generated-client/models/group-state-update-group-update.d.ts +2 -2
- package/lib/generated-client/models/group-state-update.d.ts +2 -2
- package/lib/generated-client/models/group-update.d.ts +23 -5
- package/lib/generated-client/models/hardware-acceleration-type.d.ts +26 -0
- package/lib/generated-client/models/hardware-acceleration-type.js +29 -0
- package/lib/generated-client/models/image-info.d.ts +1 -1
- package/lib/generated-client/models/image-option.d.ts +1 -1
- package/lib/generated-client/models/image-provider-info.d.ts +1 -1
- package/lib/generated-client/models/inbound-keep-alive-message.d.ts +1 -1
- package/lib/generated-client/models/inbound-web-socket-message.d.ts +22 -8
- package/lib/generated-client/models/index.d.ts +13 -6
- package/lib/generated-client/models/index.js +7 -1
- package/lib/generated-client/models/installation-info.d.ts +1 -1
- package/lib/generated-client/models/library-changed-message.d.ts +2 -2
- package/lib/generated-client/models/library-options-result-dto.d.ts +8 -2
- package/lib/generated-client/models/library-options.d.ts +57 -3
- package/lib/generated-client/models/library-type-options-dto.d.ts +3 -3
- package/lib/generated-client/models/listings-provider-info.d.ts +1 -1
- package/lib/generated-client/models/live-stream-response.d.ts +1 -1
- package/lib/generated-client/models/live-tv-info.d.ts +1 -1
- package/lib/generated-client/models/live-tv-options.d.ts +2 -2
- package/lib/generated-client/models/live-tv-service-info.d.ts +1 -1
- package/lib/generated-client/models/lyric-dto.d.ts +2 -2
- package/lib/generated-client/models/media-path-dto.d.ts +1 -1
- package/lib/generated-client/models/media-path-info.d.ts +0 -6
- package/lib/generated-client/models/media-segment-dto-query-result.d.ts +36 -0
- package/lib/generated-client/models/media-segment-dto.d.ts +48 -0
- package/lib/generated-client/models/media-segment-type.d.ts +24 -0
- package/lib/generated-client/models/media-segment-type.js +27 -0
- package/lib/generated-client/models/media-source-info.d.ts +29 -11
- package/lib/generated-client/models/media-stream.d.ts +17 -5
- package/lib/generated-client/models/media-update-info-dto.d.ts +1 -1
- package/lib/generated-client/models/metadata-editor-info.d.ts +6 -6
- package/lib/generated-client/models/movie-info-remote-search-query.d.ts +1 -1
- package/lib/generated-client/models/movie-info.d.ts +2 -2
- package/lib/generated-client/models/music-video-info-remote-search-query.d.ts +1 -1
- package/lib/generated-client/models/music-video-info.d.ts +2 -2
- package/lib/generated-client/models/open-live-stream-dto.d.ts +8 -2
- package/lib/generated-client/models/outbound-keep-alive-message.d.ts +1 -1
- package/lib/generated-client/models/outbound-web-socket-message.d.ts +85 -29
- package/lib/generated-client/models/package-info.d.ts +1 -1
- package/lib/generated-client/models/person-lookup-info-remote-search-query.d.ts +1 -1
- package/lib/generated-client/models/person-lookup-info.d.ts +2 -2
- package/lib/generated-client/models/play-message.d.ts +2 -2
- package/lib/generated-client/models/play-queue-update-group-update.d.ts +2 -2
- package/lib/generated-client/models/play-queue-update.d.ts +4 -4
- package/lib/generated-client/models/play-request.d.ts +1 -1
- package/lib/generated-client/models/playback-info-dto.d.ts +7 -1
- package/lib/generated-client/models/playback-info-response.d.ts +2 -2
- package/lib/generated-client/models/playback-progress-info.d.ts +5 -5
- package/lib/generated-client/models/playback-start-info.d.ts +5 -5
- package/lib/generated-client/models/playback-stop-info.d.ts +2 -2
- package/lib/generated-client/models/player-state-info.d.ts +3 -3
- package/lib/generated-client/models/playlist-dto.d.ts +36 -0
- package/lib/generated-client/models/playstate-message.d.ts +2 -2
- package/lib/generated-client/models/playstate-request.d.ts +1 -1
- package/lib/generated-client/models/plugin-info.d.ts +1 -1
- package/lib/generated-client/models/plugin-installation-cancelled-message.d.ts +2 -2
- package/lib/generated-client/models/plugin-installation-completed-message.d.ts +2 -2
- package/lib/generated-client/models/plugin-installation-failed-message.d.ts +2 -2
- package/lib/generated-client/models/plugin-installing-message.d.ts +2 -2
- package/lib/generated-client/models/plugin-uninstalled-message.d.ts +2 -2
- package/lib/generated-client/models/problem-details.d.ts +1 -1
- package/lib/generated-client/models/profile-condition.d.ts +2 -2
- package/lib/generated-client/models/query-filters.d.ts +1 -1
- package/lib/generated-client/models/queue-request-dto.d.ts +1 -1
- package/lib/generated-client/models/recommendation-dto.d.ts +2 -2
- package/lib/generated-client/models/refresh-progress-message.d.ts +3 -3
- package/lib/generated-client/models/remote-image-info.d.ts +2 -2
- package/lib/generated-client/models/remote-image-result.d.ts +1 -1
- package/lib/generated-client/models/remote-lyric-info-dto.d.ts +1 -1
- package/lib/generated-client/models/remote-search-result.d.ts +2 -2
- package/lib/generated-client/models/restart-required-message.d.ts +1 -1
- package/lib/generated-client/models/scheduled-task-ended-message.d.ts +2 -2
- package/lib/generated-client/models/scheduled-tasks-info-message.d.ts +2 -2
- package/lib/generated-client/models/scheduled-tasks-info-start-message.d.ts +1 -1
- package/lib/generated-client/models/scheduled-tasks-info-stop-message.d.ts +1 -1
- package/lib/generated-client/models/search-hint-result.d.ts +1 -1
- package/lib/generated-client/models/search-hint.d.ts +3 -3
- package/lib/generated-client/models/send-command.d.ts +1 -1
- package/lib/generated-client/models/series-info-remote-search-query.d.ts +1 -1
- package/lib/generated-client/models/series-info.d.ts +2 -2
- package/lib/generated-client/models/series-timer-cancelled-message.d.ts +2 -2
- package/lib/generated-client/models/series-timer-created-message.d.ts +2 -2
- package/lib/generated-client/models/series-timer-info-dto-query-result.d.ts +3 -3
- package/lib/generated-client/models/series-timer-info-dto.d.ts +3 -3
- package/lib/generated-client/models/server-configuration.d.ts +8 -14
- package/lib/generated-client/models/server-restarting-message.d.ts +1 -1
- package/lib/generated-client/models/server-shutting-down-message.d.ts +1 -1
- package/lib/generated-client/models/session-info-dto.d.ts +199 -0
- package/lib/generated-client/models/session-info.d.ts +8 -8
- package/lib/generated-client/models/sessions-message.d.ts +4 -4
- package/lib/generated-client/models/sessions-start-message.d.ts +1 -1
- package/lib/generated-client/models/sessions-stop-message.d.ts +1 -1
- package/lib/generated-client/models/set-repeat-mode-request-dto.d.ts +1 -1
- package/lib/generated-client/models/set-shuffle-mode-request-dto.d.ts +1 -1
- package/lib/generated-client/models/song-info.d.ts +2 -2
- package/lib/generated-client/models/string-group-update.d.ts +1 -1
- package/lib/generated-client/models/subtitle-profile.d.ts +6 -6
- package/lib/generated-client/models/sync-play-command-message.d.ts +2 -2
- package/lib/generated-client/models/sync-play-group-update-command-message.d.ts +2 -2
- package/lib/generated-client/models/system-info.d.ts +2 -2
- package/lib/generated-client/models/task-info.d.ts +3 -3
- package/lib/generated-client/models/task-result.d.ts +1 -1
- package/lib/generated-client/models/task-trigger-info.d.ts +1 -1
- package/lib/generated-client/models/theme-media-result.d.ts +2 -2
- package/lib/generated-client/models/timer-cancelled-message.d.ts +2 -2
- package/lib/generated-client/models/timer-created-message.d.ts +2 -2
- package/lib/generated-client/models/timer-info-dto-query-result.d.ts +3 -3
- package/lib/generated-client/models/timer-info-dto.d.ts +3 -3
- package/lib/generated-client/models/tonemapping-algorithm.d.ts +26 -0
- package/lib/generated-client/models/tonemapping-algorithm.js +29 -0
- package/lib/generated-client/models/tonemapping-mode.d.ts +23 -0
- package/lib/generated-client/models/tonemapping-mode.js +26 -0
- package/lib/generated-client/models/tonemapping-range.d.ts +21 -0
- package/lib/generated-client/models/tonemapping-range.js +24 -0
- package/lib/generated-client/models/trailer-info-remote-search-query.d.ts +1 -1
- package/lib/generated-client/models/trailer-info.d.ts +2 -2
- package/lib/generated-client/models/transcode-reason.d.ts +1 -0
- package/lib/generated-client/models/transcode-reason.js +2 -1
- package/lib/generated-client/models/transcoding-info.d.ts +16 -16
- package/lib/generated-client/models/transcoding-profile.d.ts +24 -18
- package/lib/generated-client/models/trickplay-options.d.ts +8 -2
- package/lib/generated-client/models/tuner-host-info.d.ts +18 -0
- package/lib/generated-client/models/type-options.d.ts +1 -1
- package/lib/generated-client/models/update-library-options-dto.d.ts +1 -1
- package/lib/generated-client/models/update-media-path-request-dto.d.ts +1 -1
- package/lib/generated-client/models/update-playlist-dto.d.ts +1 -1
- package/lib/generated-client/models/user-configuration.d.ts +1 -1
- package/lib/generated-client/models/user-data-change-info.d.ts +3 -3
- package/lib/generated-client/models/user-data-changed-message.d.ts +2 -2
- package/lib/generated-client/models/user-deleted-message.d.ts +1 -1
- package/lib/generated-client/models/user-dto.d.ts +2 -2
- package/lib/generated-client/models/user-item-data-dto.d.ts +2 -2
- package/lib/generated-client/models/user-policy.d.ts +3 -3
- package/lib/generated-client/models/user-updated-message.d.ts +2 -2
- package/lib/generated-client/models/virtual-folder-info.d.ts +2 -2
- package/lib/generated-client/models/web-socket-message.d.ts +2 -2
- package/lib/utils/address-candidates.js +15 -10
- package/lib/utils/api/image-urls-api.js +16 -4
- package/lib/utils/api/index.d.ts +1 -0
- package/lib/utils/api/index.js +1 -0
- package/lib/utils/api/media-segments-api.d.ts +8 -0
- package/lib/utils/api/media-segments-api.js +12 -0
- package/lib/utils/index.js +1 -1
- package/lib/utils/url/index.d.ts +16 -3
- package/lib/utils/url/index.js +26 -4
- package/lib/versions.d.ts +1 -1
- package/lib/versions.js +1 -1
- package/package.json +13 -12
- package/lib/node_modules/tslib/tslib.es6.js +0 -33
|
@@ -8,18 +8,18 @@
|
|
|
8
8
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
9
9
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
10
10
|
*/
|
|
11
|
-
import {
|
|
12
|
-
import {
|
|
13
|
-
import { RequestArgs, BaseAPI } from '../base';
|
|
14
|
-
import { BaseItemDto } from '../models';
|
|
15
|
-
import { BaseItemDtoQueryResult } from '../models';
|
|
16
|
-
import { BaseItemKind } from '../models';
|
|
17
|
-
import { ImageType } from '../models';
|
|
18
|
-
import { ItemFields } from '../models';
|
|
19
|
-
import { ItemFilter } from '../models';
|
|
20
|
-
import { ItemSortBy } from '../models';
|
|
21
|
-
import { MediaType } from '../models';
|
|
22
|
-
import { SortOrder } from '../models';
|
|
11
|
+
import type { Configuration } from '../configuration';
|
|
12
|
+
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
13
|
+
import { type RequestArgs, BaseAPI } from '../base';
|
|
14
|
+
import type { BaseItemDto } from '../models';
|
|
15
|
+
import type { BaseItemDtoQueryResult } from '../models';
|
|
16
|
+
import type { BaseItemKind } from '../models';
|
|
17
|
+
import type { ImageType } from '../models';
|
|
18
|
+
import type { ItemFields } from '../models';
|
|
19
|
+
import type { ItemFilter } from '../models';
|
|
20
|
+
import type { ItemSortBy } from '../models';
|
|
21
|
+
import type { MediaType } from '../models';
|
|
22
|
+
import type { SortOrder } from '../models';
|
|
23
23
|
/**
|
|
24
24
|
* ArtistsApi - axios parameter creator
|
|
25
25
|
* @export
|
|
@@ -63,7 +63,7 @@ export declare const ArtistsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
63
63
|
* @param {*} [options] Override http request option.
|
|
64
64
|
* @throws {RequiredError}
|
|
65
65
|
*/
|
|
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?:
|
|
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?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
67
67
|
/**
|
|
68
68
|
*
|
|
69
69
|
* @summary Gets an artist by name.
|
|
@@ -72,7 +72,7 @@ export declare const ArtistsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
72
72
|
* @param {*} [options] Override http request option.
|
|
73
73
|
* @throws {RequiredError}
|
|
74
74
|
*/
|
|
75
|
-
getArtistByName: (name: string, userId?: string, options?:
|
|
75
|
+
getArtistByName: (name: string, userId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
76
76
|
/**
|
|
77
77
|
*
|
|
78
78
|
* @summary Gets all artists from a given item, folder, or the entire library.
|
|
@@ -111,7 +111,7 @@ export declare const ArtistsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
111
111
|
* @param {*} [options] Override http request option.
|
|
112
112
|
* @throws {RequiredError}
|
|
113
113
|
*/
|
|
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?:
|
|
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?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
115
115
|
};
|
|
116
116
|
/**
|
|
117
117
|
* ArtistsApi - functional programming interface
|
|
@@ -156,7 +156,7 @@ export declare const ArtistsApiFp: (configuration?: Configuration) => {
|
|
|
156
156
|
* @param {*} [options] Override http request option.
|
|
157
157
|
* @throws {RequiredError}
|
|
158
158
|
*/
|
|
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?:
|
|
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?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>;
|
|
160
160
|
/**
|
|
161
161
|
*
|
|
162
162
|
* @summary Gets an artist by name.
|
|
@@ -165,7 +165,7 @@ export declare const ArtistsApiFp: (configuration?: Configuration) => {
|
|
|
165
165
|
* @param {*} [options] Override http request option.
|
|
166
166
|
* @throws {RequiredError}
|
|
167
167
|
*/
|
|
168
|
-
getArtistByName(name: string, userId?: string, options?:
|
|
168
|
+
getArtistByName(name: string, userId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>;
|
|
169
169
|
/**
|
|
170
170
|
*
|
|
171
171
|
* @summary Gets all artists from a given item, folder, or the entire library.
|
|
@@ -204,7 +204,7 @@ export declare const ArtistsApiFp: (configuration?: Configuration) => {
|
|
|
204
204
|
* @param {*} [options] Override http request option.
|
|
205
205
|
* @throws {RequiredError}
|
|
206
206
|
*/
|
|
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?:
|
|
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?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>;
|
|
208
208
|
};
|
|
209
209
|
/**
|
|
210
210
|
* ArtistsApi - factory interface
|
|
@@ -214,90 +214,27 @@ export declare const ArtistsApiFactory: (configuration?: Configuration, basePath
|
|
|
214
214
|
/**
|
|
215
215
|
*
|
|
216
216
|
* @summary Gets all album artists from a given item, folder, or the entire library.
|
|
217
|
-
* @param {
|
|
218
|
-
* @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results.
|
|
219
|
-
* @param {number} [limit] Optional. The maximum number of records to return.
|
|
220
|
-
* @param {string} [searchTerm] Optional. Search term.
|
|
221
|
-
* @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
|
|
222
|
-
* @param {Array<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output.
|
|
223
|
-
* @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited.
|
|
224
|
-
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
225
|
-
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply.
|
|
226
|
-
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
|
|
227
|
-
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
|
|
228
|
-
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
229
|
-
* @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
|
|
230
|
-
* @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
231
|
-
* @param {Array<string>} [tags] Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.
|
|
232
|
-
* @param {Array<number>} [years] Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.
|
|
233
|
-
* @param {boolean} [enableUserData] Optional, include user data.
|
|
234
|
-
* @param {number} [imageTypeLimit] Optional, the max number of images to return, per image type.
|
|
235
|
-
* @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output.
|
|
236
|
-
* @param {string} [person] Optional. If specified, results will be filtered to include only those containing the specified person.
|
|
237
|
-
* @param {Array<string>} [personIds] Optional. If specified, results will be filtered to include only those containing the specified person ids.
|
|
238
|
-
* @param {Array<string>} [personTypes] Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited.
|
|
239
|
-
* @param {Array<string>} [studios] Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.
|
|
240
|
-
* @param {Array<string>} [studioIds] Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.
|
|
241
|
-
* @param {string} [userId] User id.
|
|
242
|
-
* @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string.
|
|
243
|
-
* @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string.
|
|
244
|
-
* @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string.
|
|
245
|
-
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
|
|
246
|
-
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
247
|
-
* @param {boolean} [enableImages] Optional, include image information in output.
|
|
248
|
-
* @param {boolean} [enableTotalRecordCount] Total record count.
|
|
217
|
+
* @param {ArtistsApiGetAlbumArtistsRequest} requestParameters Request parameters.
|
|
249
218
|
* @param {*} [options] Override http request option.
|
|
250
219
|
* @throws {RequiredError}
|
|
251
220
|
*/
|
|
252
|
-
getAlbumArtists(
|
|
221
|
+
getAlbumArtists(requestParameters?: ArtistsApiGetAlbumArtistsRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDtoQueryResult>;
|
|
253
222
|
/**
|
|
254
223
|
*
|
|
255
224
|
* @summary Gets an artist by name.
|
|
256
|
-
* @param {
|
|
257
|
-
* @param {string} [userId] Optional. Filter by user id, and attach user data.
|
|
225
|
+
* @param {ArtistsApiGetArtistByNameRequest} requestParameters Request parameters.
|
|
258
226
|
* @param {*} [options] Override http request option.
|
|
259
227
|
* @throws {RequiredError}
|
|
260
228
|
*/
|
|
261
|
-
getArtistByName(
|
|
229
|
+
getArtistByName(requestParameters: ArtistsApiGetArtistByNameRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDto>;
|
|
262
230
|
/**
|
|
263
231
|
*
|
|
264
232
|
* @summary Gets all artists from a given item, folder, or the entire library.
|
|
265
|
-
* @param {
|
|
266
|
-
* @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results.
|
|
267
|
-
* @param {number} [limit] Optional. The maximum number of records to return.
|
|
268
|
-
* @param {string} [searchTerm] Optional. Search term.
|
|
269
|
-
* @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
|
|
270
|
-
* @param {Array<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output.
|
|
271
|
-
* @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited.
|
|
272
|
-
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
273
|
-
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply.
|
|
274
|
-
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
|
|
275
|
-
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
|
|
276
|
-
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
277
|
-
* @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
|
|
278
|
-
* @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
279
|
-
* @param {Array<string>} [tags] Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.
|
|
280
|
-
* @param {Array<number>} [years] Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.
|
|
281
|
-
* @param {boolean} [enableUserData] Optional, include user data.
|
|
282
|
-
* @param {number} [imageTypeLimit] Optional, the max number of images to return, per image type.
|
|
283
|
-
* @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output.
|
|
284
|
-
* @param {string} [person] Optional. If specified, results will be filtered to include only those containing the specified person.
|
|
285
|
-
* @param {Array<string>} [personIds] Optional. If specified, results will be filtered to include only those containing the specified person ids.
|
|
286
|
-
* @param {Array<string>} [personTypes] Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited.
|
|
287
|
-
* @param {Array<string>} [studios] Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.
|
|
288
|
-
* @param {Array<string>} [studioIds] Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.
|
|
289
|
-
* @param {string} [userId] User id.
|
|
290
|
-
* @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string.
|
|
291
|
-
* @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string.
|
|
292
|
-
* @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string.
|
|
293
|
-
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
|
|
294
|
-
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
295
|
-
* @param {boolean} [enableImages] Optional, include image information in output.
|
|
296
|
-
* @param {boolean} [enableTotalRecordCount] Total record count.
|
|
233
|
+
* @param {ArtistsApiGetArtistsRequest} requestParameters Request parameters.
|
|
297
234
|
* @param {*} [options] Override http request option.
|
|
298
235
|
* @throws {RequiredError}
|
|
299
236
|
*/
|
|
300
|
-
getArtists(
|
|
237
|
+
getArtists(requestParameters?: ArtistsApiGetArtistsRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDtoQueryResult>;
|
|
301
238
|
};
|
|
302
239
|
/**
|
|
303
240
|
* Request parameters for getAlbumArtists operation in ArtistsApi.
|
|
@@ -731,7 +668,7 @@ export declare class ArtistsApi extends BaseAPI {
|
|
|
731
668
|
* @throws {RequiredError}
|
|
732
669
|
* @memberof ArtistsApi
|
|
733
670
|
*/
|
|
734
|
-
getAlbumArtists(requestParameters?: ArtistsApiGetAlbumArtistsRequest, options?:
|
|
671
|
+
getAlbumArtists(requestParameters?: ArtistsApiGetAlbumArtistsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any>>;
|
|
735
672
|
/**
|
|
736
673
|
*
|
|
737
674
|
* @summary Gets an artist by name.
|
|
@@ -740,7 +677,7 @@ export declare class ArtistsApi extends BaseAPI {
|
|
|
740
677
|
* @throws {RequiredError}
|
|
741
678
|
* @memberof ArtistsApi
|
|
742
679
|
*/
|
|
743
|
-
getArtistByName(requestParameters: ArtistsApiGetArtistByNameRequest, options?:
|
|
680
|
+
getArtistByName(requestParameters: ArtistsApiGetArtistByNameRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDto, any>>;
|
|
744
681
|
/**
|
|
745
682
|
*
|
|
746
683
|
* @summary Gets all artists from a given item, folder, or the entire library.
|
|
@@ -749,5 +686,5 @@ export declare class ArtistsApi extends BaseAPI {
|
|
|
749
686
|
* @throws {RequiredError}
|
|
750
687
|
* @memberof ArtistsApi
|
|
751
688
|
*/
|
|
752
|
-
getArtists(requestParameters?: ArtistsApiGetArtistsRequest, options?:
|
|
689
|
+
getArtists(requestParameters?: ArtistsApiGetArtistsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any>>;
|
|
753
690
|
}
|
|
@@ -1,7 +1,6 @@
|
|
|
1
|
-
import { __awaiter } from '../../node_modules/tslib/tslib.es6.js';
|
|
2
1
|
import globalAxios from 'axios';
|
|
3
2
|
import { DUMMY_BASE_URL, setApiKeyToObject, setSearchParams, toPathString, assertParamExists, createRequestFunction } from '../common.js';
|
|
4
|
-
import { BaseAPI, BASE_PATH } from '../base.js';
|
|
3
|
+
import { operationServerMap, BaseAPI, BASE_PATH } from '../base.js';
|
|
5
4
|
|
|
6
5
|
/* tslint:disable */
|
|
7
6
|
/* eslint-disable */
|
|
@@ -59,7 +58,7 @@ const ArtistsApiAxiosParamCreator = function (configuration) {
|
|
|
59
58
|
* @param {*} [options] Override http request option.
|
|
60
59
|
* @throws {RequiredError}
|
|
61
60
|
*/
|
|
62
|
-
getAlbumArtists:
|
|
61
|
+
getAlbumArtists: async (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 = {}) => {
|
|
63
62
|
const localVarPath = `/Artists/AlbumArtists`;
|
|
64
63
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
65
64
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -67,11 +66,11 @@ const ArtistsApiAxiosParamCreator = function (configuration) {
|
|
|
67
66
|
if (configuration) {
|
|
68
67
|
baseOptions = configuration.baseOptions;
|
|
69
68
|
}
|
|
70
|
-
const localVarRequestOptions =
|
|
69
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
71
70
|
const localVarHeaderParameter = {};
|
|
72
71
|
const localVarQueryParameter = {};
|
|
73
72
|
// authentication CustomAuthentication required
|
|
74
|
-
|
|
73
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
75
74
|
if (minCommunityRating !== undefined) {
|
|
76
75
|
localVarQueryParameter['minCommunityRating'] = minCommunityRating;
|
|
77
76
|
}
|
|
@@ -170,12 +169,12 @@ const ArtistsApiAxiosParamCreator = function (configuration) {
|
|
|
170
169
|
}
|
|
171
170
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
172
171
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
173
|
-
localVarRequestOptions.headers =
|
|
172
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
174
173
|
return {
|
|
175
174
|
url: toPathString(localVarUrlObj),
|
|
176
175
|
options: localVarRequestOptions,
|
|
177
176
|
};
|
|
178
|
-
}
|
|
177
|
+
},
|
|
179
178
|
/**
|
|
180
179
|
*
|
|
181
180
|
* @summary Gets an artist by name.
|
|
@@ -184,7 +183,7 @@ const ArtistsApiAxiosParamCreator = function (configuration) {
|
|
|
184
183
|
* @param {*} [options] Override http request option.
|
|
185
184
|
* @throws {RequiredError}
|
|
186
185
|
*/
|
|
187
|
-
getArtistByName:
|
|
186
|
+
getArtistByName: async (name, userId, options = {}) => {
|
|
188
187
|
// verify required parameter 'name' is not null or undefined
|
|
189
188
|
assertParamExists('getArtistByName', 'name', name);
|
|
190
189
|
const localVarPath = `/Artists/{name}`
|
|
@@ -195,22 +194,22 @@ const ArtistsApiAxiosParamCreator = function (configuration) {
|
|
|
195
194
|
if (configuration) {
|
|
196
195
|
baseOptions = configuration.baseOptions;
|
|
197
196
|
}
|
|
198
|
-
const localVarRequestOptions =
|
|
197
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
199
198
|
const localVarHeaderParameter = {};
|
|
200
199
|
const localVarQueryParameter = {};
|
|
201
200
|
// authentication CustomAuthentication required
|
|
202
|
-
|
|
201
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
203
202
|
if (userId !== undefined) {
|
|
204
203
|
localVarQueryParameter['userId'] = userId;
|
|
205
204
|
}
|
|
206
205
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
207
206
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
208
|
-
localVarRequestOptions.headers =
|
|
207
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
209
208
|
return {
|
|
210
209
|
url: toPathString(localVarUrlObj),
|
|
211
210
|
options: localVarRequestOptions,
|
|
212
211
|
};
|
|
213
|
-
}
|
|
212
|
+
},
|
|
214
213
|
/**
|
|
215
214
|
*
|
|
216
215
|
* @summary Gets all artists from a given item, folder, or the entire library.
|
|
@@ -249,7 +248,7 @@ const ArtistsApiAxiosParamCreator = function (configuration) {
|
|
|
249
248
|
* @param {*} [options] Override http request option.
|
|
250
249
|
* @throws {RequiredError}
|
|
251
250
|
*/
|
|
252
|
-
getArtists:
|
|
251
|
+
getArtists: async (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 = {}) => {
|
|
253
252
|
const localVarPath = `/Artists`;
|
|
254
253
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
255
254
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -257,11 +256,11 @@ const ArtistsApiAxiosParamCreator = function (configuration) {
|
|
|
257
256
|
if (configuration) {
|
|
258
257
|
baseOptions = configuration.baseOptions;
|
|
259
258
|
}
|
|
260
|
-
const localVarRequestOptions =
|
|
259
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
261
260
|
const localVarHeaderParameter = {};
|
|
262
261
|
const localVarQueryParameter = {};
|
|
263
262
|
// authentication CustomAuthentication required
|
|
264
|
-
|
|
263
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
265
264
|
if (minCommunityRating !== undefined) {
|
|
266
265
|
localVarQueryParameter['minCommunityRating'] = minCommunityRating;
|
|
267
266
|
}
|
|
@@ -360,12 +359,12 @@ const ArtistsApiAxiosParamCreator = function (configuration) {
|
|
|
360
359
|
}
|
|
361
360
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
362
361
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
363
|
-
localVarRequestOptions.headers =
|
|
362
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
364
363
|
return {
|
|
365
364
|
url: toPathString(localVarUrlObj),
|
|
366
365
|
options: localVarRequestOptions,
|
|
367
366
|
};
|
|
368
|
-
}
|
|
367
|
+
},
|
|
369
368
|
};
|
|
370
369
|
};
|
|
371
370
|
/**
|
|
@@ -413,11 +412,12 @@ const ArtistsApiFp = function (configuration) {
|
|
|
413
412
|
* @param {*} [options] Override http request option.
|
|
414
413
|
* @throws {RequiredError}
|
|
415
414
|
*/
|
|
416
|
-
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) {
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
415
|
+
async 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) {
|
|
416
|
+
var _a, _b, _c;
|
|
417
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.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);
|
|
418
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
419
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ArtistsApi.getAlbumArtists']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
420
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
421
421
|
},
|
|
422
422
|
/**
|
|
423
423
|
*
|
|
@@ -427,11 +427,12 @@ const ArtistsApiFp = function (configuration) {
|
|
|
427
427
|
* @param {*} [options] Override http request option.
|
|
428
428
|
* @throws {RequiredError}
|
|
429
429
|
*/
|
|
430
|
-
getArtistByName(name, userId, options) {
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
430
|
+
async getArtistByName(name, userId, options) {
|
|
431
|
+
var _a, _b, _c;
|
|
432
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getArtistByName(name, userId, options);
|
|
433
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
434
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ArtistsApi.getArtistByName']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
435
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
435
436
|
},
|
|
436
437
|
/**
|
|
437
438
|
*
|
|
@@ -471,11 +472,12 @@ const ArtistsApiFp = function (configuration) {
|
|
|
471
472
|
* @param {*} [options] Override http request option.
|
|
472
473
|
* @throws {RequiredError}
|
|
473
474
|
*/
|
|
474
|
-
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) {
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
475
|
+
async 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) {
|
|
476
|
+
var _a, _b, _c;
|
|
477
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.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);
|
|
478
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
479
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ArtistsApi.getArtists']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
480
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
479
481
|
},
|
|
480
482
|
};
|
|
481
483
|
};
|
|
@@ -489,95 +491,32 @@ const ArtistsApiFactory = function (configuration, basePath, axios) {
|
|
|
489
491
|
/**
|
|
490
492
|
*
|
|
491
493
|
* @summary Gets all album artists from a given item, folder, or the entire library.
|
|
492
|
-
* @param {
|
|
493
|
-
* @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results.
|
|
494
|
-
* @param {number} [limit] Optional. The maximum number of records to return.
|
|
495
|
-
* @param {string} [searchTerm] Optional. Search term.
|
|
496
|
-
* @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
|
|
497
|
-
* @param {Array<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output.
|
|
498
|
-
* @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited.
|
|
499
|
-
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
500
|
-
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply.
|
|
501
|
-
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
|
|
502
|
-
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
|
|
503
|
-
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
504
|
-
* @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
|
|
505
|
-
* @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
506
|
-
* @param {Array<string>} [tags] Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.
|
|
507
|
-
* @param {Array<number>} [years] Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.
|
|
508
|
-
* @param {boolean} [enableUserData] Optional, include user data.
|
|
509
|
-
* @param {number} [imageTypeLimit] Optional, the max number of images to return, per image type.
|
|
510
|
-
* @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output.
|
|
511
|
-
* @param {string} [person] Optional. If specified, results will be filtered to include only those containing the specified person.
|
|
512
|
-
* @param {Array<string>} [personIds] Optional. If specified, results will be filtered to include only those containing the specified person ids.
|
|
513
|
-
* @param {Array<string>} [personTypes] Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited.
|
|
514
|
-
* @param {Array<string>} [studios] Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.
|
|
515
|
-
* @param {Array<string>} [studioIds] Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.
|
|
516
|
-
* @param {string} [userId] User id.
|
|
517
|
-
* @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string.
|
|
518
|
-
* @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string.
|
|
519
|
-
* @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string.
|
|
520
|
-
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
|
|
521
|
-
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
522
|
-
* @param {boolean} [enableImages] Optional, include image information in output.
|
|
523
|
-
* @param {boolean} [enableTotalRecordCount] Total record count.
|
|
494
|
+
* @param {ArtistsApiGetAlbumArtistsRequest} requestParameters Request parameters.
|
|
524
495
|
* @param {*} [options] Override http request option.
|
|
525
496
|
* @throws {RequiredError}
|
|
526
497
|
*/
|
|
527
|
-
getAlbumArtists(
|
|
528
|
-
return localVarFp.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).then((request) => request(axios, basePath));
|
|
498
|
+
getAlbumArtists(requestParameters = {}, options) {
|
|
499
|
+
return localVarFp.getAlbumArtists(requestParameters.minCommunityRating, requestParameters.startIndex, requestParameters.limit, requestParameters.searchTerm, requestParameters.parentId, requestParameters.fields, requestParameters.excludeItemTypes, requestParameters.includeItemTypes, requestParameters.filters, requestParameters.isFavorite, requestParameters.mediaTypes, requestParameters.genres, requestParameters.genreIds, requestParameters.officialRatings, requestParameters.tags, requestParameters.years, requestParameters.enableUserData, requestParameters.imageTypeLimit, requestParameters.enableImageTypes, requestParameters.person, requestParameters.personIds, requestParameters.personTypes, requestParameters.studios, requestParameters.studioIds, requestParameters.userId, requestParameters.nameStartsWithOrGreater, requestParameters.nameStartsWith, requestParameters.nameLessThan, requestParameters.sortBy, requestParameters.sortOrder, requestParameters.enableImages, requestParameters.enableTotalRecordCount, options).then((request) => request(axios, basePath));
|
|
529
500
|
},
|
|
530
501
|
/**
|
|
531
502
|
*
|
|
532
503
|
* @summary Gets an artist by name.
|
|
533
|
-
* @param {
|
|
534
|
-
* @param {string} [userId] Optional. Filter by user id, and attach user data.
|
|
504
|
+
* @param {ArtistsApiGetArtistByNameRequest} requestParameters Request parameters.
|
|
535
505
|
* @param {*} [options] Override http request option.
|
|
536
506
|
* @throws {RequiredError}
|
|
537
507
|
*/
|
|
538
|
-
getArtistByName(
|
|
539
|
-
return localVarFp.getArtistByName(name, userId, options).then((request) => request(axios, basePath));
|
|
508
|
+
getArtistByName(requestParameters, options) {
|
|
509
|
+
return localVarFp.getArtistByName(requestParameters.name, requestParameters.userId, options).then((request) => request(axios, basePath));
|
|
540
510
|
},
|
|
541
511
|
/**
|
|
542
512
|
*
|
|
543
513
|
* @summary Gets all artists from a given item, folder, or the entire library.
|
|
544
|
-
* @param {
|
|
545
|
-
* @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results.
|
|
546
|
-
* @param {number} [limit] Optional. The maximum number of records to return.
|
|
547
|
-
* @param {string} [searchTerm] Optional. Search term.
|
|
548
|
-
* @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
|
|
549
|
-
* @param {Array<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output.
|
|
550
|
-
* @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited.
|
|
551
|
-
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
552
|
-
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply.
|
|
553
|
-
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
|
|
554
|
-
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
|
|
555
|
-
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
556
|
-
* @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
|
|
557
|
-
* @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
558
|
-
* @param {Array<string>} [tags] Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.
|
|
559
|
-
* @param {Array<number>} [years] Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.
|
|
560
|
-
* @param {boolean} [enableUserData] Optional, include user data.
|
|
561
|
-
* @param {number} [imageTypeLimit] Optional, the max number of images to return, per image type.
|
|
562
|
-
* @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output.
|
|
563
|
-
* @param {string} [person] Optional. If specified, results will be filtered to include only those containing the specified person.
|
|
564
|
-
* @param {Array<string>} [personIds] Optional. If specified, results will be filtered to include only those containing the specified person ids.
|
|
565
|
-
* @param {Array<string>} [personTypes] Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited.
|
|
566
|
-
* @param {Array<string>} [studios] Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.
|
|
567
|
-
* @param {Array<string>} [studioIds] Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.
|
|
568
|
-
* @param {string} [userId] User id.
|
|
569
|
-
* @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string.
|
|
570
|
-
* @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string.
|
|
571
|
-
* @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string.
|
|
572
|
-
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
|
|
573
|
-
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
574
|
-
* @param {boolean} [enableImages] Optional, include image information in output.
|
|
575
|
-
* @param {boolean} [enableTotalRecordCount] Total record count.
|
|
514
|
+
* @param {ArtistsApiGetArtistsRequest} requestParameters Request parameters.
|
|
576
515
|
* @param {*} [options] Override http request option.
|
|
577
516
|
* @throws {RequiredError}
|
|
578
517
|
*/
|
|
579
|
-
getArtists(
|
|
580
|
-
return localVarFp.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).then((request) => request(axios, basePath));
|
|
518
|
+
getArtists(requestParameters = {}, options) {
|
|
519
|
+
return localVarFp.getArtists(requestParameters.minCommunityRating, requestParameters.startIndex, requestParameters.limit, requestParameters.searchTerm, requestParameters.parentId, requestParameters.fields, requestParameters.excludeItemTypes, requestParameters.includeItemTypes, requestParameters.filters, requestParameters.isFavorite, requestParameters.mediaTypes, requestParameters.genres, requestParameters.genreIds, requestParameters.officialRatings, requestParameters.tags, requestParameters.years, requestParameters.enableUserData, requestParameters.imageTypeLimit, requestParameters.enableImageTypes, requestParameters.person, requestParameters.personIds, requestParameters.personTypes, requestParameters.studios, requestParameters.studioIds, requestParameters.userId, requestParameters.nameStartsWithOrGreater, requestParameters.nameStartsWith, requestParameters.nameLessThan, requestParameters.sortBy, requestParameters.sortOrder, requestParameters.enableImages, requestParameters.enableTotalRecordCount, options).then((request) => request(axios, basePath));
|
|
581
520
|
},
|
|
582
521
|
};
|
|
583
522
|
};
|