@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.
Files changed (274) hide show
  1. package/README.md +9 -7
  2. package/lib/api.d.ts +1 -0
  3. package/lib/api.js +4 -4
  4. package/lib/discovery/recommended-server-discovery.js +24 -16
  5. package/lib/generated-client/api/activity-log-api.js +12 -1
  6. package/lib/generated-client/api/api-key-api.js +14 -3
  7. package/lib/generated-client/api/artists-api.d.ts +28 -26
  8. package/lib/generated-client/api/artists-api.js +26 -15
  9. package/lib/generated-client/api/audio-api.d.ts +8 -8
  10. package/lib/generated-client/api/audio-api.js +21 -10
  11. package/lib/generated-client/api/branding-api.js +14 -3
  12. package/lib/generated-client/api/channels-api.d.ts +9 -8
  13. package/lib/generated-client/api/channels-api.js +19 -8
  14. package/lib/generated-client/api/client-log-api.js +12 -1
  15. package/lib/generated-client/api/collection-api.js +14 -3
  16. package/lib/generated-client/api/configuration-api.d.ts +0 -47
  17. package/lib/generated-client/api/configuration-api.js +16 -71
  18. package/lib/generated-client/api/dashboard-api.js +13 -2
  19. package/lib/generated-client/api/devices-api.d.ts +3 -12
  20. package/lib/generated-client/api/devices-api.js +21 -16
  21. package/lib/generated-client/api/display-preferences-api.d.ts +22 -22
  22. package/lib/generated-client/api/display-preferences-api.js +29 -22
  23. package/lib/generated-client/api/dynamic-hls-api.d.ts +28 -10
  24. package/lib/generated-client/api/dynamic-hls-api.js +45 -22
  25. package/lib/generated-client/api/environment-api.js +17 -6
  26. package/lib/generated-client/api/filter-api.d.ts +9 -8
  27. package/lib/generated-client/api/filter-api.js +16 -5
  28. package/lib/generated-client/api/genres-api.d.ts +9 -8
  29. package/lib/generated-client/api/genres-api.js +16 -5
  30. package/lib/generated-client/api/hls-segment-api.js +16 -5
  31. package/lib/generated-client/api/image-api.d.ts +109 -1184
  32. package/lib/generated-client/api/image-api.js +218 -1056
  33. package/lib/generated-client/api/instant-mix-api.d.ts +35 -35
  34. package/lib/generated-client/api/instant-mix-api.js +79 -68
  35. package/lib/generated-client/api/item-lookup-api.js +22 -11
  36. package/lib/generated-client/api/item-refresh-api.js +12 -1
  37. package/lib/generated-client/api/item-update-api.js +14 -3
  38. package/lib/generated-client/api/items-api.d.ts +333 -1012
  39. package/lib/generated-client/api/items-api.js +178 -595
  40. package/lib/generated-client/api/library-api.d.ts +9 -8
  41. package/lib/generated-client/api/library-api.js +39 -28
  42. package/lib/generated-client/api/library-structure-api.js +19 -8
  43. package/lib/generated-client/api/live-tv-api.d.ts +17 -16
  44. package/lib/generated-client/api/live-tv-api.js +58 -47
  45. package/lib/generated-client/api/localization-api.js +15 -4
  46. package/lib/generated-client/api/lyrics-api.d.ts +344 -0
  47. package/lib/generated-client/api/{dlna-api.js → lyrics-api.js} +165 -125
  48. package/lib/generated-client/api/media-info-api.d.ts +7 -7
  49. package/lib/generated-client/api/media-info-api.js +19 -10
  50. package/lib/generated-client/api/movies-api.js +12 -1
  51. package/lib/generated-client/api/music-genres-api.d.ts +9 -8
  52. package/lib/generated-client/api/music-genres-api.js +16 -5
  53. package/lib/generated-client/api/package-api.js +17 -6
  54. package/lib/generated-client/api/persons-api.js +13 -2
  55. package/lib/generated-client/api/playlists-api.d.ts +315 -36
  56. package/lib/generated-client/api/playlists-api.js +395 -29
  57. package/lib/generated-client/api/playstate-api.d.ts +41 -68
  58. package/lib/generated-client/api/playstate-api.js +74 -81
  59. package/lib/generated-client/api/plugins-api.js +20 -9
  60. package/lib/generated-client/api/quick-connect-api.d.ts +46 -37
  61. package/lib/generated-client/api/quick-connect-api.js +67 -50
  62. package/lib/generated-client/api/remote-image-api.js +14 -3
  63. package/lib/generated-client/api/scheduled-tasks-api.js +16 -5
  64. package/lib/generated-client/api/search-api.d.ts +41 -40
  65. package/lib/generated-client/api/search-api.js +29 -18
  66. package/lib/generated-client/api/session-api.d.ts +9 -17
  67. package/lib/generated-client/api/session-api.js +35 -30
  68. package/lib/generated-client/api/startup-api.js +18 -7
  69. package/lib/generated-client/api/studios-api.js +13 -2
  70. package/lib/generated-client/api/subtitle-api.d.ts +7 -7
  71. package/lib/generated-client/api/subtitle-api.js +33 -22
  72. package/lib/generated-client/api/suggestions-api.d.ts +14 -13
  73. package/lib/generated-client/api/suggestions-api.js +24 -13
  74. package/lib/generated-client/api/sync-play-api.js +32 -21
  75. package/lib/generated-client/api/system-api.js +21 -10
  76. package/lib/generated-client/api/time-sync-api.js +12 -1
  77. package/lib/generated-client/api/tmdb-api.js +12 -1
  78. package/lib/generated-client/api/trailers-api.d.ts +35 -33
  79. package/lib/generated-client/api/trailers-api.js +33 -22
  80. package/lib/generated-client/api/trickplay-api.d.ts +176 -0
  81. package/lib/generated-client/api/trickplay-api.js +213 -0
  82. package/lib/generated-client/api/tv-shows-api.d.ts +25 -15
  83. package/lib/generated-client/api/tv-shows-api.js +32 -15
  84. package/lib/generated-client/api/universal-audio-api.d.ts +17 -16
  85. package/lib/generated-client/api/universal-audio-api.js +19 -8
  86. package/lib/generated-client/api/user-api.d.ts +35 -155
  87. package/lib/generated-client/api/user-api.js +65 -203
  88. package/lib/generated-client/api/user-library-api.d.ts +100 -100
  89. package/lib/generated-client/api/user-library-api.js +136 -125
  90. package/lib/generated-client/api/user-views-api.d.ts +22 -21
  91. package/lib/generated-client/api/user-views-api.js +33 -22
  92. package/lib/generated-client/api/video-attachments-api.js +12 -1
  93. package/lib/generated-client/api/videos-api.js +18 -7
  94. package/lib/generated-client/api/years-api.d.ts +15 -13
  95. package/lib/generated-client/api/years-api.js +19 -8
  96. package/lib/generated-client/api.d.ts +2 -4
  97. package/lib/generated-client/base.js +13 -0
  98. package/lib/generated-client/common.js +11 -0
  99. package/lib/generated-client/index.js +19 -10
  100. package/lib/generated-client/models/activity-log-entry-message.d.ts +37 -0
  101. package/lib/generated-client/models/activity-log-entry-start-message.d.ts +30 -0
  102. package/lib/generated-client/models/activity-log-entry-stop-message.d.ts +24 -0
  103. package/lib/generated-client/models/audio-spatial-format.d.ts +21 -0
  104. package/lib/generated-client/models/audio-spatial-format.js +24 -0
  105. package/lib/generated-client/models/authenticate-user-by-name.d.ts +0 -7
  106. package/lib/generated-client/models/base-item-dto.d.ts +37 -17
  107. package/lib/generated-client/models/base-item-person.d.ts +4 -3
  108. package/lib/generated-client/models/cast-receiver-application.d.ts +29 -0
  109. package/lib/generated-client/models/client-capabilities-dto.d.ts +17 -20
  110. package/lib/generated-client/models/client-capabilities.d.ts +16 -19
  111. package/lib/generated-client/models/collection-type-options.d.ts +9 -9
  112. package/lib/generated-client/models/collection-type-options.js +9 -9
  113. package/lib/generated-client/models/collection-type.d.ts +31 -0
  114. package/lib/generated-client/models/collection-type.js +34 -0
  115. package/lib/generated-client/models/container-profile.d.ts +1 -1
  116. package/lib/generated-client/models/create-playlist-dto.d.ts +18 -4
  117. package/lib/generated-client/models/create-user-by-name.d.ts +1 -1
  118. package/lib/generated-client/models/device-info.d.ts +6 -0
  119. package/lib/generated-client/models/device-profile.d.ts +0 -171
  120. package/lib/generated-client/models/dlna-profile-type.d.ts +1 -0
  121. package/lib/generated-client/models/dlna-profile-type.js +2 -1
  122. package/lib/generated-client/models/down-mix-stereo-algorithms.d.ts +21 -0
  123. package/lib/generated-client/models/down-mix-stereo-algorithms.js +24 -0
  124. package/lib/generated-client/models/encoding-options.d.ts +77 -40
  125. package/lib/generated-client/models/external-id-media-type.d.ts +1 -0
  126. package/lib/generated-client/models/external-id-media-type.js +2 -1
  127. package/lib/generated-client/models/extra-type.d.ts +30 -0
  128. package/lib/generated-client/models/extra-type.js +33 -0
  129. package/lib/generated-client/models/force-keep-alive-message.d.ts +36 -0
  130. package/lib/generated-client/models/general-command-message.d.ts +37 -0
  131. package/lib/generated-client/models/general-command-type.d.ts +1 -0
  132. package/lib/generated-client/models/general-command-type.js +2 -1
  133. package/lib/generated-client/models/get-programs-dto.d.ts +4 -3
  134. package/lib/generated-client/models/group-info-dto-group-update.d.ts +37 -0
  135. package/lib/generated-client/models/group-state-update-group-update.d.ts +37 -0
  136. package/lib/generated-client/models/group-state-update.d.ts +31 -0
  137. package/lib/generated-client/models/group-update.d.ts +20 -0
  138. package/lib/generated-client/models/hardware-encoding-type.d.ts +1 -0
  139. package/lib/generated-client/models/hardware-encoding-type.js +2 -1
  140. package/lib/generated-client/models/image-format.d.ts +1 -0
  141. package/lib/generated-client/models/image-format.js +2 -1
  142. package/lib/generated-client/models/image-resolution.d.ts +27 -0
  143. package/lib/generated-client/models/{ffmpeg-location.js → image-resolution.js} +12 -7
  144. package/lib/generated-client/models/inbound-keep-alive-message.d.ts +24 -0
  145. package/lib/generated-client/models/inbound-web-socket-message.d.ts +23 -0
  146. package/lib/generated-client/models/index.d.ts +74 -25
  147. package/lib/generated-client/models/index.js +17 -6
  148. package/lib/generated-client/models/item-fields.d.ts +1 -2
  149. package/lib/generated-client/models/item-fields.js +1 -2
  150. package/lib/generated-client/models/item-sort-by.d.ts +50 -0
  151. package/lib/generated-client/models/item-sort-by.js +53 -0
  152. package/lib/generated-client/models/library-changed-message.d.ts +37 -0
  153. package/lib/generated-client/models/library-options.d.ts +36 -0
  154. package/lib/generated-client/models/live-tv-options.d.ts +12 -0
  155. package/lib/generated-client/models/log-file.d.ts +1 -1
  156. package/lib/generated-client/models/lyric-dto.d.ts +31 -0
  157. package/lib/generated-client/models/lyric-line.d.ts +29 -0
  158. package/lib/generated-client/models/lyric-metadata.d.ts +77 -0
  159. package/lib/generated-client/models/media-source-info.d.ts +3 -2
  160. package/lib/generated-client/models/media-stream-protocol.d.ts +20 -0
  161. package/lib/generated-client/models/{header-match-type.js → media-stream-protocol.js} +5 -6
  162. package/lib/generated-client/models/media-stream-type.d.ts +1 -0
  163. package/lib/generated-client/models/media-stream-type.js +2 -1
  164. package/lib/generated-client/models/media-stream.d.ts +27 -6
  165. package/lib/generated-client/models/media-type.d.ts +23 -0
  166. package/lib/generated-client/models/{architecture.js → media-type.js} +8 -9
  167. package/lib/generated-client/models/metadata-editor-info.d.ts +3 -2
  168. package/lib/generated-client/models/network-configuration.d.ts +50 -116
  169. package/lib/generated-client/models/outbound-keep-alive-message.d.ts +30 -0
  170. package/lib/generated-client/models/outbound-web-socket-message.d.ts +44 -0
  171. package/lib/generated-client/models/parental-rating.d.ts +1 -1
  172. package/lib/generated-client/models/person-kind.d.ts +43 -0
  173. package/lib/generated-client/models/person-kind.js +46 -0
  174. package/lib/generated-client/models/play-message.d.ts +37 -0
  175. package/lib/generated-client/models/play-queue-update-group-update.d.ts +37 -0
  176. package/lib/generated-client/models/play-queue-update-reason.d.ts +28 -0
  177. package/lib/generated-client/models/play-queue-update-reason.js +31 -0
  178. package/lib/generated-client/models/play-queue-update.d.ts +69 -0
  179. package/lib/generated-client/models/playback-order.d.ts +20 -0
  180. package/lib/generated-client/models/{send-to-user-type.js → playback-order.js} +5 -6
  181. package/lib/generated-client/models/playback-progress-info.d.ts +7 -0
  182. package/lib/generated-client/models/playback-request-type.d.ts +35 -0
  183. package/lib/generated-client/models/playback-request-type.js +38 -0
  184. package/lib/generated-client/models/playback-start-info.d.ts +7 -0
  185. package/lib/generated-client/models/player-state-info.d.ts +7 -0
  186. package/lib/generated-client/models/playlist-user-permissions.d.ts +29 -0
  187. package/lib/generated-client/models/playstate-message.d.ts +37 -0
  188. package/lib/generated-client/models/plugin-installation-cancelled-message.d.ts +37 -0
  189. package/lib/generated-client/models/plugin-installation-completed-message.d.ts +37 -0
  190. package/lib/generated-client/models/plugin-installation-failed-message.d.ts +37 -0
  191. package/lib/generated-client/models/plugin-installing-message.d.ts +37 -0
  192. package/lib/generated-client/models/plugin-uninstalled-message.d.ts +37 -0
  193. package/lib/generated-client/models/process-priority-class.d.ts +24 -0
  194. package/lib/generated-client/models/process-priority-class.js +27 -0
  195. package/lib/generated-client/models/public-system-info.d.ts +1 -0
  196. package/lib/generated-client/models/refresh-progress-message.d.ts +38 -0
  197. package/lib/generated-client/models/remote-lyric-info-dto.d.ts +36 -0
  198. package/lib/generated-client/models/remote-subtitle-info.d.ts +30 -0
  199. package/lib/generated-client/models/remove-from-playlist-request-dto.d.ts +1 -1
  200. package/lib/generated-client/models/restart-required-message.d.ts +30 -0
  201. package/lib/generated-client/models/scheduled-task-ended-message.d.ts +37 -0
  202. package/lib/generated-client/models/scheduled-tasks-info-message.d.ts +37 -0
  203. package/lib/generated-client/models/scheduled-tasks-info-start-message.d.ts +30 -0
  204. package/lib/generated-client/models/scheduled-tasks-info-stop-message.d.ts +24 -0
  205. package/lib/generated-client/models/search-hint.d.ts +20 -17
  206. package/lib/generated-client/models/series-status.d.ts +2 -1
  207. package/lib/generated-client/models/series-status.js +3 -2
  208. package/lib/generated-client/models/series-timer-cancelled-message.d.ts +37 -0
  209. package/lib/generated-client/models/series-timer-created-message.d.ts +37 -0
  210. package/lib/generated-client/models/server-configuration.d.ts +45 -0
  211. package/lib/generated-client/models/server-restarting-message.d.ts +30 -0
  212. package/lib/generated-client/models/server-shutting-down-message.d.ts +30 -0
  213. package/lib/generated-client/models/session-info.d.ts +9 -9
  214. package/lib/generated-client/models/sessions-message.d.ts +37 -0
  215. package/lib/generated-client/models/sessions-start-message.d.ts +30 -0
  216. package/lib/generated-client/models/sessions-stop-message.d.ts +24 -0
  217. package/lib/generated-client/models/string-group-update.d.ts +36 -0
  218. package/lib/generated-client/models/sync-play-command-message.d.ts +37 -0
  219. package/lib/generated-client/models/sync-play-group-update-command-message.d.ts +37 -0
  220. package/lib/generated-client/models/sync-play-queue-item.d.ts +29 -0
  221. package/lib/generated-client/models/system-info.d.ts +17 -6
  222. package/lib/generated-client/models/timer-cancelled-message.d.ts +37 -0
  223. package/lib/generated-client/models/timer-created-message.d.ts +37 -0
  224. package/lib/generated-client/models/transcoding-info.d.ts +3 -2
  225. package/lib/generated-client/models/transcoding-info.js +15 -0
  226. package/lib/generated-client/models/transcoding-profile.d.ts +3 -2
  227. package/lib/generated-client/models/trickplay-info.d.ts +59 -0
  228. package/lib/generated-client/models/trickplay-options.d.ts +85 -0
  229. package/lib/generated-client/models/trickplay-scan-behavior.d.ts +20 -0
  230. package/lib/generated-client/models/{notification-level.js → trickplay-scan-behavior.js} +5 -6
  231. package/lib/generated-client/models/tuner-host-info.d.ts +6 -0
  232. package/lib/generated-client/models/update-playlist-dto.d.ts +42 -0
  233. package/lib/generated-client/models/update-playlist-user-dto.d.ts +23 -0
  234. package/lib/generated-client/models/update-user-item-data-dto.d.ts +83 -0
  235. package/lib/generated-client/models/upload-subtitle-dto.d.ts +6 -0
  236. package/lib/generated-client/models/user-configuration.d.ts +6 -0
  237. package/lib/generated-client/models/user-data-change-info.d.ts +30 -0
  238. package/lib/generated-client/models/user-data-changed-message.d.ts +37 -0
  239. package/lib/generated-client/models/user-deleted-message.d.ts +36 -0
  240. package/lib/generated-client/models/user-dto.d.ts +1 -0
  241. package/lib/generated-client/models/user-policy.d.ts +26 -2
  242. package/lib/generated-client/models/user-updated-message.d.ts +37 -0
  243. package/lib/generated-client/models/video-range-type.d.ts +27 -0
  244. package/lib/generated-client/models/video-range-type.js +30 -0
  245. package/lib/generated-client/models/video-range.d.ts +21 -0
  246. package/lib/generated-client/models/{device-profile-type.js → video-range.js} +6 -5
  247. package/lib/generated-client/models/web-socket-message.d.ts +18 -0
  248. package/lib/node_modules/tslib/tslib.es6.js +9 -2
  249. package/lib/utils/api/image-api.d.ts +2 -2
  250. package/lib/utils/api/image-api.js +2 -2
  251. package/lib/utils/api/image-urls-api.d.ts +55 -0
  252. package/lib/utils/api/image-urls-api.js +103 -0
  253. package/lib/utils/api/index.d.ts +2 -4
  254. package/lib/utils/api/index.js +2 -4
  255. package/lib/utils/api/{dlna-api.d.ts → lyrics-api.d.ts} +2 -2
  256. package/lib/utils/api/{dlna-api.js → lyrics-api.js} +4 -4
  257. package/lib/utils/api/{dlna-server-api.d.ts → trickplay-api.d.ts} +2 -2
  258. package/lib/utils/api/trickplay-api.js +12 -0
  259. package/lib/utils/authentication.js +5 -6
  260. package/lib/utils/index.d.ts +2 -1
  261. package/lib/utils/index.js +2 -1
  262. package/lib/utils/versioning.d.ts +9 -0
  263. package/lib/utils/versioning.js +32 -0
  264. package/lib/versions.d.ts +2 -2
  265. package/lib/versions.js +2 -2
  266. package/package.json +19 -22
  267. package/lib/generated-client/api/dlna-server-api.js +0 -1088
  268. package/lib/generated-client/api/image-by-name-api.js +0 -423
  269. package/lib/generated-client/api/notifications-api.js +0 -484
  270. package/lib/utils/api/dlna-server-api.js +0 -12
  271. package/lib/utils/api/image-by-name-api.d.ts +0 -8
  272. package/lib/utils/api/image-by-name-api.js +0 -12
  273. package/lib/utils/api/notifications-api.d.ts +0 -8
  274. package/lib/utils/api/notifications-api.js +0 -12
@@ -16,7 +16,9 @@ import { BaseItemKind } from '../models';
16
16
  import { ImageType } from '../models';
17
17
  import { ItemFields } from '../models';
18
18
  import { ItemFilter } from '../models';
19
+ import { ItemSortBy } from '../models';
19
20
  import { LocationType } from '../models';
21
+ import { MediaType } from '../models';
20
22
  import { SeriesStatus } from '../models';
21
23
  import { SortOrder } from '../models';
22
24
  import { VideoType } from '../models';
@@ -28,7 +30,7 @@ export declare const TrailersApiAxiosParamCreator: (configuration?: Configuratio
28
30
  /**
29
31
  *
30
32
  * @summary Finds movies and trailers similar to a given trailer.
31
- * @param {string} [userId] The user id.
33
+ * @param {string} [userId] The user id supplied as query parameter; this is required when not using an API key.
32
34
  * @param {string} [maxOfficialRating] Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).
33
35
  * @param {boolean} [hasThemeSong] Optional filter by items with theme songs.
34
36
  * @param {boolean} [hasThemeVideo] Optional filter by items with theme videos.
@@ -51,9 +53,9 @@ export declare const TrailersApiAxiosParamCreator: (configuration?: Configuratio
51
53
  * @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format = ISO.
52
54
  * @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format = ISO.
53
55
  * @param {boolean} [hasOverview] Optional filter by items that have an overview or not.
54
- * @param {boolean} [hasImdbId] Optional filter by items that have an imdb id or not.
55
- * @param {boolean} [hasTmdbId] Optional filter by items that have a tmdb id or not.
56
- * @param {boolean} [hasTvdbId] Optional filter by items that have a tvdb id or not.
56
+ * @param {boolean} [hasImdbId] Optional filter by items that have an IMDb id or not.
57
+ * @param {boolean} [hasTmdbId] Optional filter by items that have a TMDb id or not.
58
+ * @param {boolean} [hasTvdbId] Optional filter by items that have a TVDb id or not.
57
59
  * @param {boolean} [isMovie] Optional filter for live tv movies.
58
60
  * @param {boolean} [isSeries] Optional filter for live tv series.
59
61
  * @param {boolean} [isNews] Optional filter for live tv news.
@@ -64,15 +66,15 @@ export declare const TrailersApiAxiosParamCreator: (configuration?: Configuratio
64
66
  * @param {number} [limit] Optional. The maximum number of records to return.
65
67
  * @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false.
66
68
  * @param {string} [searchTerm] Optional. Filter based on a search term.
67
- * @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
69
+ * @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending, Descending.
68
70
  * @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
69
71
  * @param {Array<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines.
70
72
  * @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
71
73
  * @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.
72
74
  * @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
73
- * @param {Array<string>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
75
+ * @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
74
76
  * @param {Array<ImageType>} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
75
- * @param {Array<string>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
77
+ * @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
76
78
  * @param {boolean} [isPlayed] Optional filter by items that are played, or not.
77
79
  * @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
78
80
  * @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
@@ -115,7 +117,7 @@ export declare const TrailersApiAxiosParamCreator: (configuration?: Configuratio
115
117
  * @param {*} [options] Override http request option.
116
118
  * @throws {RequiredError}
117
119
  */
118
- getTrailers: (userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: Array<LocationType>, excludeLocationTypes?: Array<LocationType>, isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, excludeItemIds?: Array<string>, startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: Array<SortOrder>, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<string>, imageTypes?: Array<ImageType>, sortBy?: Array<string>, isPlayed?: boolean, genres?: 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>, artists?: Array<string>, excludeArtistIds?: Array<string>, artistIds?: Array<string>, albumArtistIds?: Array<string>, contributingArtistIds?: Array<string>, albums?: Array<string>, albumIds?: Array<string>, ids?: Array<string>, videoTypes?: Array<VideoType>, minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: Array<SeriesStatus>, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: Array<string>, genreIds?: Array<string>, enableTotalRecordCount?: boolean, enableImages?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
120
+ getTrailers: (userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: Array<LocationType>, excludeLocationTypes?: Array<LocationType>, isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, excludeItemIds?: Array<string>, startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: Array<SortOrder>, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<MediaType>, imageTypes?: Array<ImageType>, sortBy?: Array<ItemSortBy>, isPlayed?: boolean, genres?: 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>, artists?: Array<string>, excludeArtistIds?: Array<string>, artistIds?: Array<string>, albumArtistIds?: Array<string>, contributingArtistIds?: Array<string>, albums?: Array<string>, albumIds?: Array<string>, ids?: Array<string>, videoTypes?: Array<VideoType>, minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: Array<SeriesStatus>, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: Array<string>, genreIds?: Array<string>, enableTotalRecordCount?: boolean, enableImages?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
119
121
  };
120
122
  /**
121
123
  * TrailersApi - functional programming interface
@@ -125,7 +127,7 @@ export declare const TrailersApiFp: (configuration?: Configuration) => {
125
127
  /**
126
128
  *
127
129
  * @summary Finds movies and trailers similar to a given trailer.
128
- * @param {string} [userId] The user id.
130
+ * @param {string} [userId] The user id supplied as query parameter; this is required when not using an API key.
129
131
  * @param {string} [maxOfficialRating] Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).
130
132
  * @param {boolean} [hasThemeSong] Optional filter by items with theme songs.
131
133
  * @param {boolean} [hasThemeVideo] Optional filter by items with theme videos.
@@ -148,9 +150,9 @@ export declare const TrailersApiFp: (configuration?: Configuration) => {
148
150
  * @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format &#x3D; ISO.
149
151
  * @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format &#x3D; ISO.
150
152
  * @param {boolean} [hasOverview] Optional filter by items that have an overview or not.
151
- * @param {boolean} [hasImdbId] Optional filter by items that have an imdb id or not.
152
- * @param {boolean} [hasTmdbId] Optional filter by items that have a tmdb id or not.
153
- * @param {boolean} [hasTvdbId] Optional filter by items that have a tvdb id or not.
153
+ * @param {boolean} [hasImdbId] Optional filter by items that have an IMDb id or not.
154
+ * @param {boolean} [hasTmdbId] Optional filter by items that have a TMDb id or not.
155
+ * @param {boolean} [hasTvdbId] Optional filter by items that have a TVDb id or not.
154
156
  * @param {boolean} [isMovie] Optional filter for live tv movies.
155
157
  * @param {boolean} [isSeries] Optional filter for live tv series.
156
158
  * @param {boolean} [isNews] Optional filter for live tv news.
@@ -161,15 +163,15 @@ export declare const TrailersApiFp: (configuration?: Configuration) => {
161
163
  * @param {number} [limit] Optional. The maximum number of records to return.
162
164
  * @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false.
163
165
  * @param {string} [searchTerm] Optional. Filter based on a search term.
164
- * @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
166
+ * @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending, Descending.
165
167
  * @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
166
168
  * @param {Array<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines.
167
169
  * @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
168
170
  * @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.
169
171
  * @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
170
- * @param {Array<string>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
172
+ * @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
171
173
  * @param {Array<ImageType>} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
172
- * @param {Array<string>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
174
+ * @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
173
175
  * @param {boolean} [isPlayed] Optional filter by items that are played, or not.
174
176
  * @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
175
177
  * @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
@@ -212,7 +214,7 @@ export declare const TrailersApiFp: (configuration?: Configuration) => {
212
214
  * @param {*} [options] Override http request option.
213
215
  * @throws {RequiredError}
214
216
  */
215
- getTrailers(userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: Array<LocationType>, excludeLocationTypes?: Array<LocationType>, isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, excludeItemIds?: Array<string>, startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: Array<SortOrder>, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<string>, imageTypes?: Array<ImageType>, sortBy?: Array<string>, isPlayed?: boolean, genres?: 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>, artists?: Array<string>, excludeArtistIds?: Array<string>, artistIds?: Array<string>, albumArtistIds?: Array<string>, contributingArtistIds?: Array<string>, albums?: Array<string>, albumIds?: Array<string>, ids?: Array<string>, videoTypes?: Array<VideoType>, minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: Array<SeriesStatus>, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: Array<string>, genreIds?: Array<string>, enableTotalRecordCount?: boolean, enableImages?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>;
217
+ getTrailers(userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: Array<LocationType>, excludeLocationTypes?: Array<LocationType>, isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, excludeItemIds?: Array<string>, startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: Array<SortOrder>, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<MediaType>, imageTypes?: Array<ImageType>, sortBy?: Array<ItemSortBy>, isPlayed?: boolean, genres?: 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>, artists?: Array<string>, excludeArtistIds?: Array<string>, artistIds?: Array<string>, albumArtistIds?: Array<string>, contributingArtistIds?: Array<string>, albums?: Array<string>, albumIds?: Array<string>, ids?: Array<string>, videoTypes?: Array<VideoType>, minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: Array<SeriesStatus>, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: Array<string>, genreIds?: Array<string>, enableTotalRecordCount?: boolean, enableImages?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>;
216
218
  };
217
219
  /**
218
220
  * TrailersApi - factory interface
@@ -222,7 +224,7 @@ export declare const TrailersApiFactory: (configuration?: Configuration, basePat
222
224
  /**
223
225
  *
224
226
  * @summary Finds movies and trailers similar to a given trailer.
225
- * @param {string} [userId] The user id.
227
+ * @param {string} [userId] The user id supplied as query parameter; this is required when not using an API key.
226
228
  * @param {string} [maxOfficialRating] Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).
227
229
  * @param {boolean} [hasThemeSong] Optional filter by items with theme songs.
228
230
  * @param {boolean} [hasThemeVideo] Optional filter by items with theme videos.
@@ -245,9 +247,9 @@ export declare const TrailersApiFactory: (configuration?: Configuration, basePat
245
247
  * @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format &#x3D; ISO.
246
248
  * @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format &#x3D; ISO.
247
249
  * @param {boolean} [hasOverview] Optional filter by items that have an overview or not.
248
- * @param {boolean} [hasImdbId] Optional filter by items that have an imdb id or not.
249
- * @param {boolean} [hasTmdbId] Optional filter by items that have a tmdb id or not.
250
- * @param {boolean} [hasTvdbId] Optional filter by items that have a tvdb id or not.
250
+ * @param {boolean} [hasImdbId] Optional filter by items that have an IMDb id or not.
251
+ * @param {boolean} [hasTmdbId] Optional filter by items that have a TMDb id or not.
252
+ * @param {boolean} [hasTvdbId] Optional filter by items that have a TVDb id or not.
251
253
  * @param {boolean} [isMovie] Optional filter for live tv movies.
252
254
  * @param {boolean} [isSeries] Optional filter for live tv series.
253
255
  * @param {boolean} [isNews] Optional filter for live tv news.
@@ -258,15 +260,15 @@ export declare const TrailersApiFactory: (configuration?: Configuration, basePat
258
260
  * @param {number} [limit] Optional. The maximum number of records to return.
259
261
  * @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false.
260
262
  * @param {string} [searchTerm] Optional. Filter based on a search term.
261
- * @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
263
+ * @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending, Descending.
262
264
  * @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
263
265
  * @param {Array<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines.
264
266
  * @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
265
267
  * @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.
266
268
  * @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
267
- * @param {Array<string>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
269
+ * @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
268
270
  * @param {Array<ImageType>} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
269
- * @param {Array<string>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
271
+ * @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
270
272
  * @param {boolean} [isPlayed] Optional filter by items that are played, or not.
271
273
  * @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
272
274
  * @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
@@ -309,7 +311,7 @@ export declare const TrailersApiFactory: (configuration?: Configuration, basePat
309
311
  * @param {*} [options] Override http request option.
310
312
  * @throws {RequiredError}
311
313
  */
312
- getTrailers(userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: Array<LocationType>, excludeLocationTypes?: Array<LocationType>, isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, excludeItemIds?: Array<string>, startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: Array<SortOrder>, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<string>, imageTypes?: Array<ImageType>, sortBy?: Array<string>, isPlayed?: boolean, genres?: 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>, artists?: Array<string>, excludeArtistIds?: Array<string>, artistIds?: Array<string>, albumArtistIds?: Array<string>, contributingArtistIds?: Array<string>, albums?: Array<string>, albumIds?: Array<string>, ids?: Array<string>, videoTypes?: Array<VideoType>, minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: Array<SeriesStatus>, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: Array<string>, genreIds?: Array<string>, enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>;
314
+ getTrailers(userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: Array<LocationType>, excludeLocationTypes?: Array<LocationType>, isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, excludeItemIds?: Array<string>, startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: Array<SortOrder>, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<MediaType>, imageTypes?: Array<ImageType>, sortBy?: Array<ItemSortBy>, isPlayed?: boolean, genres?: 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>, artists?: Array<string>, excludeArtistIds?: Array<string>, artistIds?: Array<string>, albumArtistIds?: Array<string>, contributingArtistIds?: Array<string>, albums?: Array<string>, albumIds?: Array<string>, ids?: Array<string>, videoTypes?: Array<VideoType>, minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: Array<SeriesStatus>, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: Array<string>, genreIds?: Array<string>, enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>;
313
315
  };
314
316
  /**
315
317
  * Request parameters for getTrailers operation in TrailersApi.
@@ -318,7 +320,7 @@ export declare const TrailersApiFactory: (configuration?: Configuration, basePat
318
320
  */
319
321
  export interface TrailersApiGetTrailersRequest {
320
322
  /**
321
- * The user id.
323
+ * The user id supplied as query parameter; this is required when not using an API key.
322
324
  * @type {string}
323
325
  * @memberof TrailersApiGetTrailers
324
326
  */
@@ -456,19 +458,19 @@ export interface TrailersApiGetTrailersRequest {
456
458
  */
457
459
  readonly hasOverview?: boolean;
458
460
  /**
459
- * Optional filter by items that have an imdb id or not.
461
+ * Optional filter by items that have an IMDb id or not.
460
462
  * @type {boolean}
461
463
  * @memberof TrailersApiGetTrailers
462
464
  */
463
465
  readonly hasImdbId?: boolean;
464
466
  /**
465
- * Optional filter by items that have a tmdb id or not.
467
+ * Optional filter by items that have a TMDb id or not.
466
468
  * @type {boolean}
467
469
  * @memberof TrailersApiGetTrailers
468
470
  */
469
471
  readonly hasTmdbId?: boolean;
470
472
  /**
471
- * Optional filter by items that have a tvdb id or not.
473
+ * Optional filter by items that have a TVDb id or not.
472
474
  * @type {boolean}
473
475
  * @memberof TrailersApiGetTrailers
474
476
  */
@@ -534,7 +536,7 @@ export interface TrailersApiGetTrailersRequest {
534
536
  */
535
537
  readonly searchTerm?: string;
536
538
  /**
537
- * Sort Order - Ascending,Descending.
539
+ * Sort Order - Ascending, Descending.
538
540
  * @type {Array<SortOrder>}
539
541
  * @memberof TrailersApiGetTrailers
540
542
  */
@@ -571,10 +573,10 @@ export interface TrailersApiGetTrailersRequest {
571
573
  readonly isFavorite?: boolean;
572
574
  /**
573
575
  * Optional filter by MediaType. Allows multiple, comma delimited.
574
- * @type {Array<string>}
576
+ * @type {Array<MediaType>}
575
577
  * @memberof TrailersApiGetTrailers
576
578
  */
577
- readonly mediaTypes?: Array<string>;
579
+ readonly mediaTypes?: Array<MediaType>;
578
580
  /**
579
581
  * Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
580
582
  * @type {Array<ImageType>}
@@ -583,10 +585,10 @@ export interface TrailersApiGetTrailersRequest {
583
585
  readonly imageTypes?: Array<ImageType>;
584
586
  /**
585
587
  * Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
586
- * @type {Array<string>}
588
+ * @type {Array<ItemSortBy>}
587
589
  * @memberof TrailersApiGetTrailers
588
590
  */
589
- readonly sortBy?: Array<string>;
591
+ readonly sortBy?: Array<ItemSortBy>;
590
592
  /**
591
593
  * Optional filter by items that are played, or not.
592
594
  * @type {boolean}
@@ -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
  * TrailersApi - axios parameter creator
9
20
  * @export
@@ -13,7 +24,7 @@ const TrailersApiAxiosParamCreator = function (configuration) {
13
24
  /**
14
25
  *
15
26
  * @summary Finds movies and trailers similar to a given trailer.
16
- * @param {string} [userId] The user id.
27
+ * @param {string} [userId] The user id supplied as query parameter; this is required when not using an API key.
17
28
  * @param {string} [maxOfficialRating] Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).
18
29
  * @param {boolean} [hasThemeSong] Optional filter by items with theme songs.
19
30
  * @param {boolean} [hasThemeVideo] Optional filter by items with theme videos.
@@ -36,9 +47,9 @@ const TrailersApiAxiosParamCreator = function (configuration) {
36
47
  * @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format &#x3D; ISO.
37
48
  * @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format &#x3D; ISO.
38
49
  * @param {boolean} [hasOverview] Optional filter by items that have an overview or not.
39
- * @param {boolean} [hasImdbId] Optional filter by items that have an imdb id or not.
40
- * @param {boolean} [hasTmdbId] Optional filter by items that have a tmdb id or not.
41
- * @param {boolean} [hasTvdbId] Optional filter by items that have a tvdb id or not.
50
+ * @param {boolean} [hasImdbId] Optional filter by items that have an IMDb id or not.
51
+ * @param {boolean} [hasTmdbId] Optional filter by items that have a TMDb id or not.
52
+ * @param {boolean} [hasTvdbId] Optional filter by items that have a TVDb id or not.
42
53
  * @param {boolean} [isMovie] Optional filter for live tv movies.
43
54
  * @param {boolean} [isSeries] Optional filter for live tv series.
44
55
  * @param {boolean} [isNews] Optional filter for live tv news.
@@ -49,15 +60,15 @@ const TrailersApiAxiosParamCreator = function (configuration) {
49
60
  * @param {number} [limit] Optional. The maximum number of records to return.
50
61
  * @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false.
51
62
  * @param {string} [searchTerm] Optional. Filter based on a search term.
52
- * @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
63
+ * @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending, Descending.
53
64
  * @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
54
65
  * @param {Array<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines.
55
66
  * @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
56
67
  * @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.
57
68
  * @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
58
- * @param {Array<string>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
69
+ * @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
59
70
  * @param {Array<ImageType>} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
60
- * @param {Array<string>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
71
+ * @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
61
72
  * @param {boolean} [isPlayed] Optional filter by items that are played, or not.
62
73
  * @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
63
74
  * @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
@@ -100,7 +111,7 @@ const TrailersApiAxiosParamCreator = function (configuration) {
100
111
  * @param {*} [options] Override http request option.
101
112
  * @throws {RequiredError}
102
113
  */
103
- getTrailers: (userId, maxOfficialRating, hasThemeSong, hasThemeVideo, hasSubtitles, hasSpecialFeature, hasTrailer, adjacentTo, parentIndexNumber, hasParentalRating, isHd, is4K, locationTypes, excludeLocationTypes, isMissing, isUnaired, minCommunityRating, minCriticRating, minPremiereDate, minDateLastSaved, minDateLastSavedForUser, maxPremiereDate, hasOverview, hasImdbId, hasTmdbId, hasTvdbId, isMovie, isSeries, isNews, isKids, isSports, excludeItemIds, startIndex, limit, recursive, searchTerm, sortOrder, parentId, fields, excludeItemTypes, filters, isFavorite, mediaTypes, imageTypes, sortBy, isPlayed, genres, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, artists, excludeArtistIds, artistIds, albumArtistIds, contributingArtistIds, albums, albumIds, ids, videoTypes, minOfficialRating, isLocked, isPlaceHolder, hasOfficialRating, collapseBoxSetItems, minWidth, minHeight, maxWidth, maxHeight, is3D, seriesStatus, nameStartsWithOrGreater, nameStartsWith, nameLessThan, studioIds, genreIds, enableTotalRecordCount, enableImages, options = {}) => __awaiter(this, void 0, void 0, function* () {
114
+ getTrailers: (userId_1, maxOfficialRating_1, hasThemeSong_1, hasThemeVideo_1, hasSubtitles_1, hasSpecialFeature_1, hasTrailer_1, adjacentTo_1, parentIndexNumber_1, hasParentalRating_1, isHd_1, is4K_1, locationTypes_1, excludeLocationTypes_1, isMissing_1, isUnaired_1, minCommunityRating_1, minCriticRating_1, minPremiereDate_1, minDateLastSaved_1, minDateLastSavedForUser_1, maxPremiereDate_1, hasOverview_1, hasImdbId_1, hasTmdbId_1, hasTvdbId_1, isMovie_1, isSeries_1, isNews_1, isKids_1, isSports_1, excludeItemIds_1, startIndex_1, limit_1, recursive_1, searchTerm_1, sortOrder_1, parentId_1, fields_1, excludeItemTypes_1, filters_1, isFavorite_1, mediaTypes_1, imageTypes_1, sortBy_1, isPlayed_1, genres_1, officialRatings_1, tags_1, years_1, enableUserData_1, imageTypeLimit_1, enableImageTypes_1, person_1, personIds_1, personTypes_1, studios_1, artists_1, excludeArtistIds_1, artistIds_1, albumArtistIds_1, contributingArtistIds_1, albums_1, albumIds_1, ids_1, videoTypes_1, minOfficialRating_1, isLocked_1, isPlaceHolder_1, hasOfficialRating_1, collapseBoxSetItems_1, minWidth_1, minHeight_1, maxWidth_1, maxHeight_1, is3D_1, seriesStatus_1, nameStartsWithOrGreater_1, nameStartsWith_1, nameLessThan_1, studioIds_1, genreIds_1, enableTotalRecordCount_1, enableImages_1, ...args_1) => __awaiter(this, [userId_1, maxOfficialRating_1, hasThemeSong_1, hasThemeVideo_1, hasSubtitles_1, hasSpecialFeature_1, hasTrailer_1, adjacentTo_1, parentIndexNumber_1, hasParentalRating_1, isHd_1, is4K_1, locationTypes_1, excludeLocationTypes_1, isMissing_1, isUnaired_1, minCommunityRating_1, minCriticRating_1, minPremiereDate_1, minDateLastSaved_1, minDateLastSavedForUser_1, maxPremiereDate_1, hasOverview_1, hasImdbId_1, hasTmdbId_1, hasTvdbId_1, isMovie_1, isSeries_1, isNews_1, isKids_1, isSports_1, excludeItemIds_1, startIndex_1, limit_1, recursive_1, searchTerm_1, sortOrder_1, parentId_1, fields_1, excludeItemTypes_1, filters_1, isFavorite_1, mediaTypes_1, imageTypes_1, sortBy_1, isPlayed_1, genres_1, officialRatings_1, tags_1, years_1, enableUserData_1, imageTypeLimit_1, enableImageTypes_1, person_1, personIds_1, personTypes_1, studios_1, artists_1, excludeArtistIds_1, artistIds_1, albumArtistIds_1, contributingArtistIds_1, albums_1, albumIds_1, ids_1, videoTypes_1, minOfficialRating_1, isLocked_1, isPlaceHolder_1, hasOfficialRating_1, collapseBoxSetItems_1, minWidth_1, minHeight_1, maxWidth_1, maxHeight_1, is3D_1, seriesStatus_1, nameStartsWithOrGreater_1, nameStartsWith_1, nameLessThan_1, studioIds_1, genreIds_1, enableTotalRecordCount_1, enableImages_1, ...args_1], void 0, function* (userId, maxOfficialRating, hasThemeSong, hasThemeVideo, hasSubtitles, hasSpecialFeature, hasTrailer, adjacentTo, parentIndexNumber, hasParentalRating, isHd, is4K, locationTypes, excludeLocationTypes, isMissing, isUnaired, minCommunityRating, minCriticRating, minPremiereDate, minDateLastSaved, minDateLastSavedForUser, maxPremiereDate, hasOverview, hasImdbId, hasTmdbId, hasTvdbId, isMovie, isSeries, isNews, isKids, isSports, excludeItemIds, startIndex, limit, recursive, searchTerm, sortOrder, parentId, fields, excludeItemTypes, filters, isFavorite, mediaTypes, imageTypes, sortBy, isPlayed, genres, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, artists, excludeArtistIds, artistIds, albumArtistIds, contributingArtistIds, albums, albumIds, ids, videoTypes, minOfficialRating, isLocked, isPlaceHolder, hasOfficialRating, collapseBoxSetItems, minWidth, minHeight, maxWidth, maxHeight, is3D, seriesStatus, nameStartsWithOrGreater, nameStartsWith, nameLessThan, studioIds, genreIds, enableTotalRecordCount, enableImages, options = {}) {
104
115
  const localVarPath = `/Trailers`;
105
116
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
106
117
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -393,7 +404,7 @@ const TrailersApiFp = function (configuration) {
393
404
  /**
394
405
  *
395
406
  * @summary Finds movies and trailers similar to a given trailer.
396
- * @param {string} [userId] The user id.
407
+ * @param {string} [userId] The user id supplied as query parameter; this is required when not using an API key.
397
408
  * @param {string} [maxOfficialRating] Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).
398
409
  * @param {boolean} [hasThemeSong] Optional filter by items with theme songs.
399
410
  * @param {boolean} [hasThemeVideo] Optional filter by items with theme videos.
@@ -416,9 +427,9 @@ const TrailersApiFp = function (configuration) {
416
427
  * @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format &#x3D; ISO.
417
428
  * @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format &#x3D; ISO.
418
429
  * @param {boolean} [hasOverview] Optional filter by items that have an overview or not.
419
- * @param {boolean} [hasImdbId] Optional filter by items that have an imdb id or not.
420
- * @param {boolean} [hasTmdbId] Optional filter by items that have a tmdb id or not.
421
- * @param {boolean} [hasTvdbId] Optional filter by items that have a tvdb id or not.
430
+ * @param {boolean} [hasImdbId] Optional filter by items that have an IMDb id or not.
431
+ * @param {boolean} [hasTmdbId] Optional filter by items that have a TMDb id or not.
432
+ * @param {boolean} [hasTvdbId] Optional filter by items that have a TVDb id or not.
422
433
  * @param {boolean} [isMovie] Optional filter for live tv movies.
423
434
  * @param {boolean} [isSeries] Optional filter for live tv series.
424
435
  * @param {boolean} [isNews] Optional filter for live tv news.
@@ -429,15 +440,15 @@ const TrailersApiFp = function (configuration) {
429
440
  * @param {number} [limit] Optional. The maximum number of records to return.
430
441
  * @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false.
431
442
  * @param {string} [searchTerm] Optional. Filter based on a search term.
432
- * @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
443
+ * @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending, Descending.
433
444
  * @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
434
445
  * @param {Array<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines.
435
446
  * @param {Array<BaseItemKind>} [excludeItemTypes] 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. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.
437
448
  * @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
438
- * @param {Array<string>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
449
+ * @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
439
450
  * @param {Array<ImageType>} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
440
- * @param {Array<string>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
451
+ * @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
441
452
  * @param {boolean} [isPlayed] Optional filter by items that are played, or not.
442
453
  * @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
443
454
  * @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
@@ -498,7 +509,7 @@ const TrailersApiFactory = function (configuration, basePath, axios) {
498
509
  /**
499
510
  *
500
511
  * @summary Finds movies and trailers similar to a given trailer.
501
- * @param {string} [userId] The user id.
512
+ * @param {string} [userId] The user id supplied as query parameter; this is required when not using an API key.
502
513
  * @param {string} [maxOfficialRating] Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).
503
514
  * @param {boolean} [hasThemeSong] Optional filter by items with theme songs.
504
515
  * @param {boolean} [hasThemeVideo] Optional filter by items with theme videos.
@@ -521,9 +532,9 @@ const TrailersApiFactory = function (configuration, basePath, axios) {
521
532
  * @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format &#x3D; ISO.
522
533
  * @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format &#x3D; ISO.
523
534
  * @param {boolean} [hasOverview] Optional filter by items that have an overview or not.
524
- * @param {boolean} [hasImdbId] Optional filter by items that have an imdb id or not.
525
- * @param {boolean} [hasTmdbId] Optional filter by items that have a tmdb id or not.
526
- * @param {boolean} [hasTvdbId] Optional filter by items that have a tvdb id or not.
535
+ * @param {boolean} [hasImdbId] Optional filter by items that have an IMDb id or not.
536
+ * @param {boolean} [hasTmdbId] Optional filter by items that have a TMDb id or not.
537
+ * @param {boolean} [hasTvdbId] Optional filter by items that have a TVDb id or not.
527
538
  * @param {boolean} [isMovie] Optional filter for live tv movies.
528
539
  * @param {boolean} [isSeries] Optional filter for live tv series.
529
540
  * @param {boolean} [isNews] Optional filter for live tv news.
@@ -534,15 +545,15 @@ const TrailersApiFactory = function (configuration, basePath, axios) {
534
545
  * @param {number} [limit] Optional. The maximum number of records to return.
535
546
  * @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false.
536
547
  * @param {string} [searchTerm] Optional. Filter based on a search term.
537
- * @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
548
+ * @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending, Descending.
538
549
  * @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
539
550
  * @param {Array<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines.
540
551
  * @param {Array<BaseItemKind>} [excludeItemTypes] 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. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.
542
553
  * @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
543
- * @param {Array<string>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
554
+ * @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
544
555
  * @param {Array<ImageType>} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
545
- * @param {Array<string>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
556
+ * @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
546
557
  * @param {boolean} [isPlayed] Optional filter by items that are played, or not.
547
558
  * @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
548
559
  * @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
@@ -0,0 +1,176 @@
1
+ /**
2
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
3
+ * Do not edit the class manually.
4
+ *
5
+ * Jellyfin API
6
+ *
7
+ * This Source Code Form is subject to the terms of the Mozilla Public
8
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
9
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
10
+ */
11
+ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
12
+ import { Configuration } from '../configuration';
13
+ import { RequestArgs, BaseAPI } from '../base';
14
+ /**
15
+ * TrickplayApi - axios parameter creator
16
+ * @export
17
+ */
18
+ export declare const TrickplayApiAxiosParamCreator: (configuration?: Configuration) => {
19
+ /**
20
+ *
21
+ * @summary Gets an image tiles playlist for trickplay.
22
+ * @param {string} itemId The item id.
23
+ * @param {number} width The width of a single tile.
24
+ * @param {string} [mediaSourceId] The media version id, if using an alternate version.
25
+ * @param {*} [options] Override http request option.
26
+ * @throws {RequiredError}
27
+ */
28
+ getTrickplayHlsPlaylist: (itemId: string, width: number, mediaSourceId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
29
+ /**
30
+ *
31
+ * @summary Gets a trickplay tile image.
32
+ * @param {string} itemId The item id.
33
+ * @param {number} width The width of a single tile.
34
+ * @param {number} index The index of the desired tile.
35
+ * @param {string} [mediaSourceId] The media version id, if using an alternate version.
36
+ * @param {*} [options] Override http request option.
37
+ * @throws {RequiredError}
38
+ */
39
+ getTrickplayTileImage: (itemId: string, width: number, index: number, mediaSourceId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
40
+ };
41
+ /**
42
+ * TrickplayApi - functional programming interface
43
+ * @export
44
+ */
45
+ export declare const TrickplayApiFp: (configuration?: Configuration) => {
46
+ /**
47
+ *
48
+ * @summary Gets an image tiles playlist for trickplay.
49
+ * @param {string} itemId The item id.
50
+ * @param {number} width The width of a single tile.
51
+ * @param {string} [mediaSourceId] The media version id, if using an alternate version.
52
+ * @param {*} [options] Override http request option.
53
+ * @throws {RequiredError}
54
+ */
55
+ getTrickplayHlsPlaylist(itemId: string, width: number, mediaSourceId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
56
+ /**
57
+ *
58
+ * @summary Gets a trickplay tile image.
59
+ * @param {string} itemId The item id.
60
+ * @param {number} width The width of a single tile.
61
+ * @param {number} index The index of the desired tile.
62
+ * @param {string} [mediaSourceId] The media version id, if using an alternate version.
63
+ * @param {*} [options] Override http request option.
64
+ * @throws {RequiredError}
65
+ */
66
+ getTrickplayTileImage(itemId: string, width: number, index: number, mediaSourceId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
67
+ };
68
+ /**
69
+ * TrickplayApi - factory interface
70
+ * @export
71
+ */
72
+ export declare const TrickplayApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
73
+ /**
74
+ *
75
+ * @summary Gets an image tiles playlist for trickplay.
76
+ * @param {string} itemId The item id.
77
+ * @param {number} width The width of a single tile.
78
+ * @param {string} [mediaSourceId] The media version id, if using an alternate version.
79
+ * @param {*} [options] Override http request option.
80
+ * @throws {RequiredError}
81
+ */
82
+ getTrickplayHlsPlaylist(itemId: string, width: number, mediaSourceId?: string, options?: any): AxiosPromise<any>;
83
+ /**
84
+ *
85
+ * @summary Gets a trickplay tile image.
86
+ * @param {string} itemId The item id.
87
+ * @param {number} width The width of a single tile.
88
+ * @param {number} index The index of the desired tile.
89
+ * @param {string} [mediaSourceId] The media version id, if using an alternate version.
90
+ * @param {*} [options] Override http request option.
91
+ * @throws {RequiredError}
92
+ */
93
+ getTrickplayTileImage(itemId: string, width: number, index: number, mediaSourceId?: string, options?: any): AxiosPromise<any>;
94
+ };
95
+ /**
96
+ * Request parameters for getTrickplayHlsPlaylist operation in TrickplayApi.
97
+ * @export
98
+ * @interface TrickplayApiGetTrickplayHlsPlaylistRequest
99
+ */
100
+ export interface TrickplayApiGetTrickplayHlsPlaylistRequest {
101
+ /**
102
+ * The item id.
103
+ * @type {string}
104
+ * @memberof TrickplayApiGetTrickplayHlsPlaylist
105
+ */
106
+ readonly itemId: string;
107
+ /**
108
+ * The width of a single tile.
109
+ * @type {number}
110
+ * @memberof TrickplayApiGetTrickplayHlsPlaylist
111
+ */
112
+ readonly width: number;
113
+ /**
114
+ * The media version id, if using an alternate version.
115
+ * @type {string}
116
+ * @memberof TrickplayApiGetTrickplayHlsPlaylist
117
+ */
118
+ readonly mediaSourceId?: string;
119
+ }
120
+ /**
121
+ * Request parameters for getTrickplayTileImage operation in TrickplayApi.
122
+ * @export
123
+ * @interface TrickplayApiGetTrickplayTileImageRequest
124
+ */
125
+ export interface TrickplayApiGetTrickplayTileImageRequest {
126
+ /**
127
+ * The item id.
128
+ * @type {string}
129
+ * @memberof TrickplayApiGetTrickplayTileImage
130
+ */
131
+ readonly itemId: string;
132
+ /**
133
+ * The width of a single tile.
134
+ * @type {number}
135
+ * @memberof TrickplayApiGetTrickplayTileImage
136
+ */
137
+ readonly width: number;
138
+ /**
139
+ * The index of the desired tile.
140
+ * @type {number}
141
+ * @memberof TrickplayApiGetTrickplayTileImage
142
+ */
143
+ readonly index: number;
144
+ /**
145
+ * The media version id, if using an alternate version.
146
+ * @type {string}
147
+ * @memberof TrickplayApiGetTrickplayTileImage
148
+ */
149
+ readonly mediaSourceId?: string;
150
+ }
151
+ /**
152
+ * TrickplayApi - object-oriented interface
153
+ * @export
154
+ * @class TrickplayApi
155
+ * @extends {BaseAPI}
156
+ */
157
+ export declare class TrickplayApi extends BaseAPI {
158
+ /**
159
+ *
160
+ * @summary Gets an image tiles playlist for trickplay.
161
+ * @param {TrickplayApiGetTrickplayHlsPlaylistRequest} requestParameters Request parameters.
162
+ * @param {*} [options] Override http request option.
163
+ * @throws {RequiredError}
164
+ * @memberof TrickplayApi
165
+ */
166
+ getTrickplayHlsPlaylist(requestParameters: TrickplayApiGetTrickplayHlsPlaylistRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>;
167
+ /**
168
+ *
169
+ * @summary Gets a trickplay tile image.
170
+ * @param {TrickplayApiGetTrickplayTileImageRequest} requestParameters Request parameters.
171
+ * @param {*} [options] Override http request option.
172
+ * @throws {RequiredError}
173
+ * @memberof TrickplayApi
174
+ */
175
+ getTrickplayTileImage(requestParameters: TrickplayApiGetTrickplayTileImageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>;
176
+ }