@jellyfin/sdk 0.8.2 → 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 -4
  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 +17 -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
@@ -1,381 +1,52 @@
1
1
  import { __awaiter } from '../../node_modules/tslib/tslib.es6.js';
2
2
  import globalAxios from 'axios';
3
- import { DUMMY_BASE_URL, setApiKeyToObject, setSearchParams, toPathString, assertParamExists, createRequestFunction } from '../common.js';
3
+ import { assertParamExists, DUMMY_BASE_URL, setApiKeyToObject, setSearchParams, toPathString, serializeDataIfNeeded, createRequestFunction } from '../common.js';
4
4
  import { BaseAPI, BASE_PATH } from '../base.js';
5
5
 
6
6
  /* tslint:disable */
7
+ /* eslint-disable */
7
8
  /**
8
- * ItemsApi - axios parameter creator
9
- * @export
10
- */
11
- const ItemsApiAxiosParamCreator = function (configuration) {
12
- return {
13
- /**
14
- *
15
- * @summary Gets items based on a query.
16
- * @param {string} [userId] The user id supplied as query parameter.
17
- * @param {string} [maxOfficialRating] Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).
18
- * @param {boolean} [hasThemeSong] Optional filter by items with theme songs.
19
- * @param {boolean} [hasThemeVideo] Optional filter by items with theme videos.
20
- * @param {boolean} [hasSubtitles] Optional filter by items with subtitles.
21
- * @param {boolean} [hasSpecialFeature] Optional filter by items with special features.
22
- * @param {boolean} [hasTrailer] Optional filter by items with trailers.
23
- * @param {string} [adjacentTo] Optional. Return items that are siblings of a supplied item.
24
- * @param {number} [parentIndexNumber] Optional filter by parent index number.
25
- * @param {boolean} [hasParentalRating] Optional filter by items that have or do not have a parental rating.
26
- * @param {boolean} [isHd] Optional filter by items that are HD or not.
27
- * @param {boolean} [is4K] Optional filter by items that are 4K or not.
28
- * @param {Array<LocationType>} [locationTypes] Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimited.
29
- * @param {Array<LocationType>} [excludeLocationTypes] Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimited.
30
- * @param {boolean} [isMissing] Optional filter by items that are missing episodes or not.
31
- * @param {boolean} [isUnaired] Optional filter by items that are unaired episodes or not.
32
- * @param {number} [minCommunityRating] Optional filter by minimum community rating.
33
- * @param {number} [minCriticRating] Optional filter by minimum critic rating.
34
- * @param {string} [minPremiereDate] Optional. The minimum premiere date. Format &#x3D; ISO.
35
- * @param {string} [minDateLastSaved] Optional. The minimum last saved date. Format &#x3D; ISO.
36
- * @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format &#x3D; ISO.
37
- * @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format &#x3D; ISO.
38
- * @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.
42
- * @param {boolean} [isMovie] Optional filter for live tv movies.
43
- * @param {boolean} [isSeries] Optional filter for live tv series.
44
- * @param {boolean} [isNews] Optional filter for live tv news.
45
- * @param {boolean} [isKids] Optional filter for live tv kids.
46
- * @param {boolean} [isSports] Optional filter for live tv sports.
47
- * @param {Array<string>} [excludeItemIds] Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited.
48
- * @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results.
49
- * @param {number} [limit] Optional. The maximum number of records to return.
50
- * @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false.
51
- * @param {string} [searchTerm] Optional. Filter based on a search term.
52
- * @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
53
- * @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
54
- * @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
- * @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
56
- * @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.
57
- * @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.
58
- * @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
59
- * @param {Array<string>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
60
- * @param {Array<ImageType>} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
61
- * @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.
62
- * @param {boolean} [isPlayed] Optional filter by items that are played, or not.
63
- * @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
64
- * @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
65
- * @param {Array<string>} [tags] Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.
66
- * @param {Array<number>} [years] Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.
67
- * @param {boolean} [enableUserData] Optional, include user data.
68
- * @param {number} [imageTypeLimit] Optional, the max number of images to return, per image type.
69
- * @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output.
70
- * @param {string} [person] Optional. If specified, results will be filtered to include only those containing the specified person.
71
- * @param {Array<string>} [personIds] Optional. If specified, results will be filtered to include only those containing the specified person id.
72
- * @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.
73
- * @param {Array<string>} [studios] Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.
74
- * @param {Array<string>} [artists] Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited.
75
- * @param {Array<string>} [excludeArtistIds] Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited.
76
- * @param {Array<string>} [artistIds] Optional. If specified, results will be filtered to include only those containing the specified artist id.
77
- * @param {Array<string>} [albumArtistIds] Optional. If specified, results will be filtered to include only those containing the specified album artist id.
78
- * @param {Array<string>} [contributingArtistIds] Optional. If specified, results will be filtered to include only those containing the specified contributing artist id.
79
- * @param {Array<string>} [albums] Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited.
80
- * @param {Array<string>} [albumIds] Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited.
81
- * @param {Array<string>} [ids] Optional. If specific items are needed, specify a list of item id\&#39;s to retrieve. This allows multiple, comma delimited.
82
- * @param {Array<VideoType>} [videoTypes] Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimited.
83
- * @param {string} [minOfficialRating] Optional filter by minimum official rating (PG, PG-13, TV-MA, etc).
84
- * @param {boolean} [isLocked] Optional filter by items that are locked.
85
- * @param {boolean} [isPlaceHolder] Optional filter by items that are placeholders.
86
- * @param {boolean} [hasOfficialRating] Optional filter by items that have official ratings.
87
- * @param {boolean} [collapseBoxSetItems] Whether or not to hide items behind their boxsets.
88
- * @param {number} [minWidth] Optional. Filter by the minimum width of the item.
89
- * @param {number} [minHeight] Optional. Filter by the minimum height of the item.
90
- * @param {number} [maxWidth] Optional. Filter by the maximum width of the item.
91
- * @param {number} [maxHeight] Optional. Filter by the maximum height of the item.
92
- * @param {boolean} [is3D] Optional filter by items that are 3D, or not.
93
- * @param {Array<SeriesStatus>} [seriesStatus] Optional filter by Series Status. Allows multiple, comma delimited.
94
- * @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string.
95
- * @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string.
96
- * @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string.
97
- * @param {Array<string>} [studioIds] Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.
98
- * @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
99
- * @param {boolean} [enableTotalRecordCount] Optional. Enable the total record count.
100
- * @param {boolean} [enableImages] Optional, include image information in output.
101
- * @param {*} [options] Override http request option.
102
- * @throws {RequiredError}
103
- */
104
- getItems: (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, includeItemTypes, 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* () {
105
- const localVarPath = `/Items`;
106
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
107
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
108
- let baseOptions;
109
- if (configuration) {
110
- baseOptions = configuration.baseOptions;
111
- }
112
- const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
113
- const localVarHeaderParameter = {};
114
- const localVarQueryParameter = {};
115
- // authentication CustomAuthentication required
116
- yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
117
- if (userId !== undefined) {
118
- localVarQueryParameter['userId'] = userId;
119
- }
120
- if (maxOfficialRating !== undefined) {
121
- localVarQueryParameter['maxOfficialRating'] = maxOfficialRating;
122
- }
123
- if (hasThemeSong !== undefined) {
124
- localVarQueryParameter['hasThemeSong'] = hasThemeSong;
125
- }
126
- if (hasThemeVideo !== undefined) {
127
- localVarQueryParameter['hasThemeVideo'] = hasThemeVideo;
128
- }
129
- if (hasSubtitles !== undefined) {
130
- localVarQueryParameter['hasSubtitles'] = hasSubtitles;
131
- }
132
- if (hasSpecialFeature !== undefined) {
133
- localVarQueryParameter['hasSpecialFeature'] = hasSpecialFeature;
134
- }
135
- if (hasTrailer !== undefined) {
136
- localVarQueryParameter['hasTrailer'] = hasTrailer;
137
- }
138
- if (adjacentTo !== undefined) {
139
- localVarQueryParameter['adjacentTo'] = adjacentTo;
140
- }
141
- if (parentIndexNumber !== undefined) {
142
- localVarQueryParameter['parentIndexNumber'] = parentIndexNumber;
143
- }
144
- if (hasParentalRating !== undefined) {
145
- localVarQueryParameter['hasParentalRating'] = hasParentalRating;
146
- }
147
- if (isHd !== undefined) {
148
- localVarQueryParameter['isHd'] = isHd;
149
- }
150
- if (is4K !== undefined) {
151
- localVarQueryParameter['is4K'] = is4K;
152
- }
153
- if (locationTypes) {
154
- localVarQueryParameter['locationTypes'] = locationTypes;
155
- }
156
- if (excludeLocationTypes) {
157
- localVarQueryParameter['excludeLocationTypes'] = excludeLocationTypes;
158
- }
159
- if (isMissing !== undefined) {
160
- localVarQueryParameter['isMissing'] = isMissing;
161
- }
162
- if (isUnaired !== undefined) {
163
- localVarQueryParameter['isUnaired'] = isUnaired;
164
- }
165
- if (minCommunityRating !== undefined) {
166
- localVarQueryParameter['minCommunityRating'] = minCommunityRating;
167
- }
168
- if (minCriticRating !== undefined) {
169
- localVarQueryParameter['minCriticRating'] = minCriticRating;
170
- }
171
- if (minPremiereDate !== undefined) {
172
- localVarQueryParameter['minPremiereDate'] = (minPremiereDate instanceof Date) ?
173
- minPremiereDate.toISOString() :
174
- minPremiereDate;
175
- }
176
- if (minDateLastSaved !== undefined) {
177
- localVarQueryParameter['minDateLastSaved'] = (minDateLastSaved instanceof Date) ?
178
- minDateLastSaved.toISOString() :
179
- minDateLastSaved;
180
- }
181
- if (minDateLastSavedForUser !== undefined) {
182
- localVarQueryParameter['minDateLastSavedForUser'] = (minDateLastSavedForUser instanceof Date) ?
183
- minDateLastSavedForUser.toISOString() :
184
- minDateLastSavedForUser;
185
- }
186
- if (maxPremiereDate !== undefined) {
187
- localVarQueryParameter['maxPremiereDate'] = (maxPremiereDate instanceof Date) ?
188
- maxPremiereDate.toISOString() :
189
- maxPremiereDate;
190
- }
191
- if (hasOverview !== undefined) {
192
- localVarQueryParameter['hasOverview'] = hasOverview;
193
- }
194
- if (hasImdbId !== undefined) {
195
- localVarQueryParameter['hasImdbId'] = hasImdbId;
196
- }
197
- if (hasTmdbId !== undefined) {
198
- localVarQueryParameter['hasTmdbId'] = hasTmdbId;
199
- }
200
- if (hasTvdbId !== undefined) {
201
- localVarQueryParameter['hasTvdbId'] = hasTvdbId;
202
- }
203
- if (isMovie !== undefined) {
204
- localVarQueryParameter['isMovie'] = isMovie;
205
- }
206
- if (isSeries !== undefined) {
207
- localVarQueryParameter['isSeries'] = isSeries;
208
- }
209
- if (isNews !== undefined) {
210
- localVarQueryParameter['isNews'] = isNews;
211
- }
212
- if (isKids !== undefined) {
213
- localVarQueryParameter['isKids'] = isKids;
214
- }
215
- if (isSports !== undefined) {
216
- localVarQueryParameter['isSports'] = isSports;
217
- }
218
- if (excludeItemIds) {
219
- localVarQueryParameter['excludeItemIds'] = excludeItemIds;
220
- }
221
- if (startIndex !== undefined) {
222
- localVarQueryParameter['startIndex'] = startIndex;
223
- }
224
- if (limit !== undefined) {
225
- localVarQueryParameter['limit'] = limit;
226
- }
227
- if (recursive !== undefined) {
228
- localVarQueryParameter['recursive'] = recursive;
229
- }
230
- if (searchTerm !== undefined) {
231
- localVarQueryParameter['searchTerm'] = searchTerm;
232
- }
233
- if (sortOrder) {
234
- localVarQueryParameter['sortOrder'] = sortOrder;
235
- }
236
- if (parentId !== undefined) {
237
- localVarQueryParameter['parentId'] = parentId;
238
- }
239
- if (fields) {
240
- localVarQueryParameter['fields'] = fields;
241
- }
242
- if (excludeItemTypes) {
243
- localVarQueryParameter['excludeItemTypes'] = excludeItemTypes;
244
- }
245
- if (includeItemTypes) {
246
- localVarQueryParameter['includeItemTypes'] = includeItemTypes;
247
- }
248
- if (filters) {
249
- localVarQueryParameter['filters'] = filters;
250
- }
251
- if (isFavorite !== undefined) {
252
- localVarQueryParameter['isFavorite'] = isFavorite;
253
- }
254
- if (mediaTypes) {
255
- localVarQueryParameter['mediaTypes'] = mediaTypes;
256
- }
257
- if (imageTypes) {
258
- localVarQueryParameter['imageTypes'] = imageTypes;
259
- }
260
- if (sortBy) {
261
- localVarQueryParameter['sortBy'] = sortBy;
262
- }
263
- if (isPlayed !== undefined) {
264
- localVarQueryParameter['isPlayed'] = isPlayed;
265
- }
266
- if (genres) {
267
- localVarQueryParameter['genres'] = genres;
268
- }
269
- if (officialRatings) {
270
- localVarQueryParameter['officialRatings'] = officialRatings;
271
- }
272
- if (tags) {
273
- localVarQueryParameter['tags'] = tags;
274
- }
275
- if (years) {
276
- localVarQueryParameter['years'] = years;
277
- }
278
- if (enableUserData !== undefined) {
279
- localVarQueryParameter['enableUserData'] = enableUserData;
280
- }
281
- if (imageTypeLimit !== undefined) {
282
- localVarQueryParameter['imageTypeLimit'] = imageTypeLimit;
283
- }
284
- if (enableImageTypes) {
285
- localVarQueryParameter['enableImageTypes'] = enableImageTypes;
286
- }
287
- if (person !== undefined) {
288
- localVarQueryParameter['person'] = person;
289
- }
290
- if (personIds) {
291
- localVarQueryParameter['personIds'] = personIds;
292
- }
293
- if (personTypes) {
294
- localVarQueryParameter['personTypes'] = personTypes;
295
- }
296
- if (studios) {
297
- localVarQueryParameter['studios'] = studios;
298
- }
299
- if (artists) {
300
- localVarQueryParameter['artists'] = artists;
301
- }
302
- if (excludeArtistIds) {
303
- localVarQueryParameter['excludeArtistIds'] = excludeArtistIds;
304
- }
305
- if (artistIds) {
306
- localVarQueryParameter['artistIds'] = artistIds;
307
- }
308
- if (albumArtistIds) {
309
- localVarQueryParameter['albumArtistIds'] = albumArtistIds;
310
- }
311
- if (contributingArtistIds) {
312
- localVarQueryParameter['contributingArtistIds'] = contributingArtistIds;
313
- }
314
- if (albums) {
315
- localVarQueryParameter['albums'] = albums;
316
- }
317
- if (albumIds) {
318
- localVarQueryParameter['albumIds'] = albumIds;
319
- }
320
- if (ids) {
321
- localVarQueryParameter['ids'] = ids;
322
- }
323
- if (videoTypes) {
324
- localVarQueryParameter['videoTypes'] = videoTypes;
325
- }
326
- if (minOfficialRating !== undefined) {
327
- localVarQueryParameter['minOfficialRating'] = minOfficialRating;
328
- }
329
- if (isLocked !== undefined) {
330
- localVarQueryParameter['isLocked'] = isLocked;
331
- }
332
- if (isPlaceHolder !== undefined) {
333
- localVarQueryParameter['isPlaceHolder'] = isPlaceHolder;
334
- }
335
- if (hasOfficialRating !== undefined) {
336
- localVarQueryParameter['hasOfficialRating'] = hasOfficialRating;
337
- }
338
- if (collapseBoxSetItems !== undefined) {
339
- localVarQueryParameter['collapseBoxSetItems'] = collapseBoxSetItems;
340
- }
341
- if (minWidth !== undefined) {
342
- localVarQueryParameter['minWidth'] = minWidth;
343
- }
344
- if (minHeight !== undefined) {
345
- localVarQueryParameter['minHeight'] = minHeight;
346
- }
347
- if (maxWidth !== undefined) {
348
- localVarQueryParameter['maxWidth'] = maxWidth;
349
- }
350
- if (maxHeight !== undefined) {
351
- localVarQueryParameter['maxHeight'] = maxHeight;
352
- }
353
- if (is3D !== undefined) {
354
- localVarQueryParameter['is3D'] = is3D;
355
- }
356
- if (seriesStatus) {
357
- localVarQueryParameter['seriesStatus'] = seriesStatus;
358
- }
359
- if (nameStartsWithOrGreater !== undefined) {
360
- localVarQueryParameter['nameStartsWithOrGreater'] = nameStartsWithOrGreater;
361
- }
362
- if (nameStartsWith !== undefined) {
363
- localVarQueryParameter['nameStartsWith'] = nameStartsWith;
364
- }
365
- if (nameLessThan !== undefined) {
366
- localVarQueryParameter['nameLessThan'] = nameLessThan;
367
- }
368
- if (studioIds) {
369
- localVarQueryParameter['studioIds'] = studioIds;
370
- }
371
- if (genreIds) {
372
- localVarQueryParameter['genreIds'] = genreIds;
373
- }
374
- if (enableTotalRecordCount !== undefined) {
375
- localVarQueryParameter['enableTotalRecordCount'] = enableTotalRecordCount;
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
+ */
18
+ /**
19
+ * ItemsApi - axios parameter creator
20
+ * @export
21
+ */
22
+ const ItemsApiAxiosParamCreator = function (configuration) {
23
+ return {
24
+ /**
25
+ *
26
+ * @summary Get Item User Data.
27
+ * @param {string} itemId The item id.
28
+ * @param {string} [userId] The user id.
29
+ * @param {*} [options] Override http request option.
30
+ * @throws {RequiredError}
31
+ */
32
+ getItemUserData: (itemId_1, userId_1, ...args_1) => __awaiter(this, [itemId_1, userId_1, ...args_1], void 0, function* (itemId, userId, options = {}) {
33
+ // verify required parameter 'itemId' is not null or undefined
34
+ assertParamExists('getItemUserData', 'itemId', itemId);
35
+ const localVarPath = `/UserItems/{itemId}/UserData`
36
+ .replace(`{${"itemId"}}`, encodeURIComponent(String(itemId)));
37
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
38
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
39
+ let baseOptions;
40
+ if (configuration) {
41
+ baseOptions = configuration.baseOptions;
376
42
  }
377
- if (enableImages !== undefined) {
378
- localVarQueryParameter['enableImages'] = enableImages;
43
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
44
+ const localVarHeaderParameter = {};
45
+ const localVarQueryParameter = {};
46
+ // authentication CustomAuthentication required
47
+ yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
48
+ if (userId !== undefined) {
49
+ localVarQueryParameter['userId'] = userId;
379
50
  }
380
51
  setSearchParams(localVarUrlObj, localVarQueryParameter);
381
52
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -388,7 +59,7 @@ const ItemsApiAxiosParamCreator = function (configuration) {
388
59
  /**
389
60
  *
390
61
  * @summary Gets items based on a query.
391
- * @param {string} userId The user id supplied as query parameter.
62
+ * @param {string} [userId] The user id supplied as query parameter; this is required when not using an API key.
392
63
  * @param {string} [maxOfficialRating] Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).
393
64
  * @param {boolean} [hasThemeSong] Optional filter by items with theme songs.
394
65
  * @param {boolean} [hasThemeVideo] Optional filter by items with theme videos.
@@ -411,9 +82,9 @@ const ItemsApiAxiosParamCreator = function (configuration) {
411
82
  * @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format &#x3D; ISO.
412
83
  * @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format &#x3D; ISO.
413
84
  * @param {boolean} [hasOverview] Optional filter by items that have an overview or not.
414
- * @param {boolean} [hasImdbId] Optional filter by items that have an imdb id or not.
415
- * @param {boolean} [hasTmdbId] Optional filter by items that have a tmdb id or not.
416
- * @param {boolean} [hasTvdbId] Optional filter by items that have a tvdb id or not.
85
+ * @param {boolean} [hasImdbId] Optional filter by items that have an IMDb id or not.
86
+ * @param {boolean} [hasTmdbId] Optional filter by items that have a TMDb id or not.
87
+ * @param {boolean} [hasTvdbId] Optional filter by items that have a TVDb id or not.
417
88
  * @param {boolean} [isMovie] Optional filter for live tv movies.
418
89
  * @param {boolean} [isSeries] Optional filter for live tv series.
419
90
  * @param {boolean} [isNews] Optional filter for live tv news.
@@ -424,16 +95,16 @@ const ItemsApiAxiosParamCreator = function (configuration) {
424
95
  * @param {number} [limit] Optional. The maximum number of records to return.
425
96
  * @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false.
426
97
  * @param {string} [searchTerm] Optional. Filter based on a search term.
427
- * @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
98
+ * @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending, Descending.
428
99
  * @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
429
100
  * @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.
430
101
  * @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
431
102
  * @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.
432
103
  * @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.
433
104
  * @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
434
- * @param {Array<string>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
105
+ * @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
435
106
  * @param {Array<ImageType>} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
436
- * @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.
107
+ * @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.
437
108
  * @param {boolean} [isPlayed] Optional filter by items that are played, or not.
438
109
  * @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
439
110
  * @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
@@ -476,11 +147,8 @@ const ItemsApiAxiosParamCreator = function (configuration) {
476
147
  * @param {*} [options] Override http request option.
477
148
  * @throws {RequiredError}
478
149
  */
479
- getItemsByUserId: (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, includeItemTypes, 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* () {
480
- // verify required parameter 'userId' is not null or undefined
481
- assertParamExists('getItemsByUserId', 'userId', userId);
482
- const localVarPath = `/Users/{userId}/Items`
483
- .replace(`{${"userId"}}`, encodeURIComponent(String(userId)));
150
+ getItems: (userId_2, 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, includeItemTypes_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_2) => __awaiter(this, [userId_2, 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, includeItemTypes_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_2], 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, includeItemTypes, 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 = {}) {
151
+ const localVarPath = `/Items`;
484
152
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
485
153
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
486
154
  let baseOptions;
@@ -492,6 +160,9 @@ const ItemsApiAxiosParamCreator = function (configuration) {
492
160
  const localVarQueryParameter = {};
493
161
  // authentication CustomAuthentication required
494
162
  yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
163
+ if (userId !== undefined) {
164
+ localVarQueryParameter['userId'] = userId;
165
+ }
495
166
  if (maxOfficialRating !== undefined) {
496
167
  localVarQueryParameter['maxOfficialRating'] = maxOfficialRating;
497
168
  }
@@ -763,13 +434,13 @@ const ItemsApiAxiosParamCreator = function (configuration) {
763
434
  /**
764
435
  *
765
436
  * @summary Gets items based on a query.
766
- * @param {string} userId The user id.
437
+ * @param {string} [userId] The user id.
767
438
  * @param {number} [startIndex] The start index.
768
439
  * @param {number} [limit] The item limit.
769
440
  * @param {string} [searchTerm] The search term.
770
441
  * @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
771
442
  * @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.
772
- * @param {Array<string>} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited.
443
+ * @param {Array<MediaType>} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited.
773
444
  * @param {boolean} [enableUserData] Optional. Include user data.
774
445
  * @param {number} [imageTypeLimit] Optional. The max number of images to return, per image type.
775
446
  * @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output.
@@ -781,11 +452,8 @@ const ItemsApiAxiosParamCreator = function (configuration) {
781
452
  * @param {*} [options] Override http request option.
782
453
  * @throws {RequiredError}
783
454
  */
784
- getResumeItems: (userId, startIndex, limit, searchTerm, parentId, fields, mediaTypes, enableUserData, imageTypeLimit, enableImageTypes, excludeItemTypes, includeItemTypes, enableTotalRecordCount, enableImages, excludeActiveSessions, options = {}) => __awaiter(this, void 0, void 0, function* () {
785
- // verify required parameter 'userId' is not null or undefined
786
- assertParamExists('getResumeItems', 'userId', userId);
787
- const localVarPath = `/Users/{userId}/Items/Resume`
788
- .replace(`{${"userId"}}`, encodeURIComponent(String(userId)));
455
+ getResumeItems: (userId_3, startIndex_2, limit_2, searchTerm_2, parentId_2, fields_2, mediaTypes_2, enableUserData_2, imageTypeLimit_2, enableImageTypes_2, excludeItemTypes_2, includeItemTypes_2, enableTotalRecordCount_2, enableImages_2, excludeActiveSessions_1, ...args_3) => __awaiter(this, [userId_3, startIndex_2, limit_2, searchTerm_2, parentId_2, fields_2, mediaTypes_2, enableUserData_2, imageTypeLimit_2, enableImageTypes_2, excludeItemTypes_2, includeItemTypes_2, enableTotalRecordCount_2, enableImages_2, excludeActiveSessions_1, ...args_3], void 0, function* (userId, startIndex, limit, searchTerm, parentId, fields, mediaTypes, enableUserData, imageTypeLimit, enableImageTypes, excludeItemTypes, includeItemTypes, enableTotalRecordCount, enableImages, excludeActiveSessions, options = {}) {
456
+ const localVarPath = `/UserItems/Resume`;
789
457
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
790
458
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
791
459
  let baseOptions;
@@ -797,6 +465,9 @@ const ItemsApiAxiosParamCreator = function (configuration) {
797
465
  const localVarQueryParameter = {};
798
466
  // authentication CustomAuthentication required
799
467
  yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
468
+ if (userId !== undefined) {
469
+ localVarQueryParameter['userId'] = userId;
470
+ }
800
471
  if (startIndex !== undefined) {
801
472
  localVarQueryParameter['startIndex'] = startIndex;
802
473
  }
@@ -847,6 +518,46 @@ const ItemsApiAxiosParamCreator = function (configuration) {
847
518
  options: localVarRequestOptions,
848
519
  };
849
520
  }),
521
+ /**
522
+ *
523
+ * @summary Update Item User Data.
524
+ * @param {string} itemId The item id.
525
+ * @param {UpdateUserItemDataDto} updateUserItemDataDto New user data object.
526
+ * @param {string} [userId] The user id.
527
+ * @param {*} [options] Override http request option.
528
+ * @throws {RequiredError}
529
+ */
530
+ updateItemUserData: (itemId_2, updateUserItemDataDto_1, userId_4, ...args_4) => __awaiter(this, [itemId_2, updateUserItemDataDto_1, userId_4, ...args_4], void 0, function* (itemId, updateUserItemDataDto, userId, options = {}) {
531
+ // verify required parameter 'itemId' is not null or undefined
532
+ assertParamExists('updateItemUserData', 'itemId', itemId);
533
+ // verify required parameter 'updateUserItemDataDto' is not null or undefined
534
+ assertParamExists('updateItemUserData', 'updateUserItemDataDto', updateUserItemDataDto);
535
+ const localVarPath = `/UserItems/{itemId}/UserData`
536
+ .replace(`{${"itemId"}}`, encodeURIComponent(String(itemId)));
537
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
538
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
539
+ let baseOptions;
540
+ if (configuration) {
541
+ baseOptions = configuration.baseOptions;
542
+ }
543
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
544
+ const localVarHeaderParameter = {};
545
+ const localVarQueryParameter = {};
546
+ // authentication CustomAuthentication required
547
+ yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
548
+ if (userId !== undefined) {
549
+ localVarQueryParameter['userId'] = userId;
550
+ }
551
+ localVarHeaderParameter['Content-Type'] = 'application/json';
552
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
553
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
554
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
555
+ localVarRequestOptions.data = serializeDataIfNeeded(updateUserItemDataDto, localVarRequestOptions, configuration);
556
+ return {
557
+ url: toPathString(localVarUrlObj),
558
+ options: localVarRequestOptions,
559
+ };
560
+ }),
850
561
  };
851
562
  };
852
563
  /**
@@ -858,105 +569,22 @@ const ItemsApiFp = function (configuration) {
858
569
  return {
859
570
  /**
860
571
  *
861
- * @summary Gets items based on a query.
862
- * @param {string} [userId] The user id supplied as query parameter.
863
- * @param {string} [maxOfficialRating] Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).
864
- * @param {boolean} [hasThemeSong] Optional filter by items with theme songs.
865
- * @param {boolean} [hasThemeVideo] Optional filter by items with theme videos.
866
- * @param {boolean} [hasSubtitles] Optional filter by items with subtitles.
867
- * @param {boolean} [hasSpecialFeature] Optional filter by items with special features.
868
- * @param {boolean} [hasTrailer] Optional filter by items with trailers.
869
- * @param {string} [adjacentTo] Optional. Return items that are siblings of a supplied item.
870
- * @param {number} [parentIndexNumber] Optional filter by parent index number.
871
- * @param {boolean} [hasParentalRating] Optional filter by items that have or do not have a parental rating.
872
- * @param {boolean} [isHd] Optional filter by items that are HD or not.
873
- * @param {boolean} [is4K] Optional filter by items that are 4K or not.
874
- * @param {Array<LocationType>} [locationTypes] Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimited.
875
- * @param {Array<LocationType>} [excludeLocationTypes] Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimited.
876
- * @param {boolean} [isMissing] Optional filter by items that are missing episodes or not.
877
- * @param {boolean} [isUnaired] Optional filter by items that are unaired episodes or not.
878
- * @param {number} [minCommunityRating] Optional filter by minimum community rating.
879
- * @param {number} [minCriticRating] Optional filter by minimum critic rating.
880
- * @param {string} [minPremiereDate] Optional. The minimum premiere date. Format &#x3D; ISO.
881
- * @param {string} [minDateLastSaved] Optional. The minimum last saved date. Format &#x3D; ISO.
882
- * @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format &#x3D; ISO.
883
- * @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format &#x3D; ISO.
884
- * @param {boolean} [hasOverview] Optional filter by items that have an overview or not.
885
- * @param {boolean} [hasImdbId] Optional filter by items that have an imdb id or not.
886
- * @param {boolean} [hasTmdbId] Optional filter by items that have a tmdb id or not.
887
- * @param {boolean} [hasTvdbId] Optional filter by items that have a tvdb id or not.
888
- * @param {boolean} [isMovie] Optional filter for live tv movies.
889
- * @param {boolean} [isSeries] Optional filter for live tv series.
890
- * @param {boolean} [isNews] Optional filter for live tv news.
891
- * @param {boolean} [isKids] Optional filter for live tv kids.
892
- * @param {boolean} [isSports] Optional filter for live tv sports.
893
- * @param {Array<string>} [excludeItemIds] Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited.
894
- * @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results.
895
- * @param {number} [limit] Optional. The maximum number of records to return.
896
- * @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false.
897
- * @param {string} [searchTerm] Optional. Filter based on a search term.
898
- * @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
899
- * @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
900
- * @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.
901
- * @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
902
- * @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.
903
- * @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.
904
- * @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
905
- * @param {Array<string>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
906
- * @param {Array<ImageType>} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
907
- * @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.
908
- * @param {boolean} [isPlayed] Optional filter by items that are played, or not.
909
- * @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
910
- * @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
911
- * @param {Array<string>} [tags] Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.
912
- * @param {Array<number>} [years] Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.
913
- * @param {boolean} [enableUserData] Optional, include user data.
914
- * @param {number} [imageTypeLimit] Optional, the max number of images to return, per image type.
915
- * @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output.
916
- * @param {string} [person] Optional. If specified, results will be filtered to include only those containing the specified person.
917
- * @param {Array<string>} [personIds] Optional. If specified, results will be filtered to include only those containing the specified person id.
918
- * @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.
919
- * @param {Array<string>} [studios] Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.
920
- * @param {Array<string>} [artists] Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited.
921
- * @param {Array<string>} [excludeArtistIds] Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited.
922
- * @param {Array<string>} [artistIds] Optional. If specified, results will be filtered to include only those containing the specified artist id.
923
- * @param {Array<string>} [albumArtistIds] Optional. If specified, results will be filtered to include only those containing the specified album artist id.
924
- * @param {Array<string>} [contributingArtistIds] Optional. If specified, results will be filtered to include only those containing the specified contributing artist id.
925
- * @param {Array<string>} [albums] Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited.
926
- * @param {Array<string>} [albumIds] Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited.
927
- * @param {Array<string>} [ids] Optional. If specific items are needed, specify a list of item id\&#39;s to retrieve. This allows multiple, comma delimited.
928
- * @param {Array<VideoType>} [videoTypes] Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimited.
929
- * @param {string} [minOfficialRating] Optional filter by minimum official rating (PG, PG-13, TV-MA, etc).
930
- * @param {boolean} [isLocked] Optional filter by items that are locked.
931
- * @param {boolean} [isPlaceHolder] Optional filter by items that are placeholders.
932
- * @param {boolean} [hasOfficialRating] Optional filter by items that have official ratings.
933
- * @param {boolean} [collapseBoxSetItems] Whether or not to hide items behind their boxsets.
934
- * @param {number} [minWidth] Optional. Filter by the minimum width of the item.
935
- * @param {number} [minHeight] Optional. Filter by the minimum height of the item.
936
- * @param {number} [maxWidth] Optional. Filter by the maximum width of the item.
937
- * @param {number} [maxHeight] Optional. Filter by the maximum height of the item.
938
- * @param {boolean} [is3D] Optional filter by items that are 3D, or not.
939
- * @param {Array<SeriesStatus>} [seriesStatus] Optional filter by Series Status. Allows multiple, comma delimited.
940
- * @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string.
941
- * @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string.
942
- * @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string.
943
- * @param {Array<string>} [studioIds] Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.
944
- * @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
945
- * @param {boolean} [enableTotalRecordCount] Optional. Enable the total record count.
946
- * @param {boolean} [enableImages] Optional, include image information in output.
572
+ * @summary Get Item User Data.
573
+ * @param {string} itemId The item id.
574
+ * @param {string} [userId] The user id.
947
575
  * @param {*} [options] Override http request option.
948
576
  * @throws {RequiredError}
949
577
  */
950
- getItems(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, includeItemTypes, 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) {
578
+ getItemUserData(itemId, userId, options) {
951
579
  return __awaiter(this, void 0, void 0, function* () {
952
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getItems(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, includeItemTypes, 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);
580
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getItemUserData(itemId, userId, options);
953
581
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
954
582
  });
955
583
  },
956
584
  /**
957
585
  *
958
586
  * @summary Gets items based on a query.
959
- * @param {string} userId The user id supplied as query parameter.
587
+ * @param {string} [userId] The user id supplied as query parameter; this is required when not using an API key.
960
588
  * @param {string} [maxOfficialRating] Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).
961
589
  * @param {boolean} [hasThemeSong] Optional filter by items with theme songs.
962
590
  * @param {boolean} [hasThemeVideo] Optional filter by items with theme videos.
@@ -979,9 +607,9 @@ const ItemsApiFp = function (configuration) {
979
607
  * @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format &#x3D; ISO.
980
608
  * @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format &#x3D; ISO.
981
609
  * @param {boolean} [hasOverview] Optional filter by items that have an overview or not.
982
- * @param {boolean} [hasImdbId] Optional filter by items that have an imdb id or not.
983
- * @param {boolean} [hasTmdbId] Optional filter by items that have a tmdb id or not.
984
- * @param {boolean} [hasTvdbId] Optional filter by items that have a tvdb id or not.
610
+ * @param {boolean} [hasImdbId] Optional filter by items that have an IMDb id or not.
611
+ * @param {boolean} [hasTmdbId] Optional filter by items that have a TMDb id or not.
612
+ * @param {boolean} [hasTvdbId] Optional filter by items that have a TVDb id or not.
985
613
  * @param {boolean} [isMovie] Optional filter for live tv movies.
986
614
  * @param {boolean} [isSeries] Optional filter for live tv series.
987
615
  * @param {boolean} [isNews] Optional filter for live tv news.
@@ -992,16 +620,16 @@ const ItemsApiFp = function (configuration) {
992
620
  * @param {number} [limit] Optional. The maximum number of records to return.
993
621
  * @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false.
994
622
  * @param {string} [searchTerm] Optional. Filter based on a search term.
995
- * @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
623
+ * @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending, Descending.
996
624
  * @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
997
625
  * @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.
998
626
  * @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
999
627
  * @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.
1000
628
  * @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.
1001
629
  * @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
1002
- * @param {Array<string>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
630
+ * @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
1003
631
  * @param {Array<ImageType>} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
1004
- * @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.
632
+ * @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.
1005
633
  * @param {boolean} [isPlayed] Optional filter by items that are played, or not.
1006
634
  * @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
1007
635
  * @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
@@ -1044,22 +672,22 @@ const ItemsApiFp = function (configuration) {
1044
672
  * @param {*} [options] Override http request option.
1045
673
  * @throws {RequiredError}
1046
674
  */
1047
- getItemsByUserId(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, includeItemTypes, 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) {
675
+ getItems(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, includeItemTypes, 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) {
1048
676
  return __awaiter(this, void 0, void 0, function* () {
1049
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getItemsByUserId(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, includeItemTypes, 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);
677
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getItems(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, includeItemTypes, 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);
1050
678
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1051
679
  });
1052
680
  },
1053
681
  /**
1054
682
  *
1055
683
  * @summary Gets items based on a query.
1056
- * @param {string} userId The user id.
684
+ * @param {string} [userId] The user id.
1057
685
  * @param {number} [startIndex] The start index.
1058
686
  * @param {number} [limit] The item limit.
1059
687
  * @param {string} [searchTerm] The search term.
1060
688
  * @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
1061
689
  * @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.
1062
- * @param {Array<string>} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited.
690
+ * @param {Array<MediaType>} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited.
1063
691
  * @param {boolean} [enableUserData] Optional. Include user data.
1064
692
  * @param {number} [imageTypeLimit] Optional. The max number of images to return, per image type.
1065
693
  * @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output.
@@ -1077,6 +705,21 @@ const ItemsApiFp = function (configuration) {
1077
705
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1078
706
  });
1079
707
  },
708
+ /**
709
+ *
710
+ * @summary Update Item User Data.
711
+ * @param {string} itemId The item id.
712
+ * @param {UpdateUserItemDataDto} updateUserItemDataDto New user data object.
713
+ * @param {string} [userId] The user id.
714
+ * @param {*} [options] Override http request option.
715
+ * @throws {RequiredError}
716
+ */
717
+ updateItemUserData(itemId, updateUserItemDataDto, userId, options) {
718
+ return __awaiter(this, void 0, void 0, function* () {
719
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.updateItemUserData(itemId, updateUserItemDataDto, userId, options);
720
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
721
+ });
722
+ },
1080
723
  };
1081
724
  };
1082
725
  /**
@@ -1088,102 +731,19 @@ const ItemsApiFactory = function (configuration, basePath, axios) {
1088
731
  return {
1089
732
  /**
1090
733
  *
1091
- * @summary Gets items based on a query.
1092
- * @param {string} [userId] The user id supplied as query parameter.
1093
- * @param {string} [maxOfficialRating] Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).
1094
- * @param {boolean} [hasThemeSong] Optional filter by items with theme songs.
1095
- * @param {boolean} [hasThemeVideo] Optional filter by items with theme videos.
1096
- * @param {boolean} [hasSubtitles] Optional filter by items with subtitles.
1097
- * @param {boolean} [hasSpecialFeature] Optional filter by items with special features.
1098
- * @param {boolean} [hasTrailer] Optional filter by items with trailers.
1099
- * @param {string} [adjacentTo] Optional. Return items that are siblings of a supplied item.
1100
- * @param {number} [parentIndexNumber] Optional filter by parent index number.
1101
- * @param {boolean} [hasParentalRating] Optional filter by items that have or do not have a parental rating.
1102
- * @param {boolean} [isHd] Optional filter by items that are HD or not.
1103
- * @param {boolean} [is4K] Optional filter by items that are 4K or not.
1104
- * @param {Array<LocationType>} [locationTypes] Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimited.
1105
- * @param {Array<LocationType>} [excludeLocationTypes] Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimited.
1106
- * @param {boolean} [isMissing] Optional filter by items that are missing episodes or not.
1107
- * @param {boolean} [isUnaired] Optional filter by items that are unaired episodes or not.
1108
- * @param {number} [minCommunityRating] Optional filter by minimum community rating.
1109
- * @param {number} [minCriticRating] Optional filter by minimum critic rating.
1110
- * @param {string} [minPremiereDate] Optional. The minimum premiere date. Format &#x3D; ISO.
1111
- * @param {string} [minDateLastSaved] Optional. The minimum last saved date. Format &#x3D; ISO.
1112
- * @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format &#x3D; ISO.
1113
- * @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format &#x3D; ISO.
1114
- * @param {boolean} [hasOverview] Optional filter by items that have an overview or not.
1115
- * @param {boolean} [hasImdbId] Optional filter by items that have an imdb id or not.
1116
- * @param {boolean} [hasTmdbId] Optional filter by items that have a tmdb id or not.
1117
- * @param {boolean} [hasTvdbId] Optional filter by items that have a tvdb id or not.
1118
- * @param {boolean} [isMovie] Optional filter for live tv movies.
1119
- * @param {boolean} [isSeries] Optional filter for live tv series.
1120
- * @param {boolean} [isNews] Optional filter for live tv news.
1121
- * @param {boolean} [isKids] Optional filter for live tv kids.
1122
- * @param {boolean} [isSports] Optional filter for live tv sports.
1123
- * @param {Array<string>} [excludeItemIds] Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited.
1124
- * @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results.
1125
- * @param {number} [limit] Optional. The maximum number of records to return.
1126
- * @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false.
1127
- * @param {string} [searchTerm] Optional. Filter based on a search term.
1128
- * @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
1129
- * @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
1130
- * @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.
1131
- * @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
1132
- * @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.
1133
- * @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.
1134
- * @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
1135
- * @param {Array<string>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
1136
- * @param {Array<ImageType>} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
1137
- * @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.
1138
- * @param {boolean} [isPlayed] Optional filter by items that are played, or not.
1139
- * @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
1140
- * @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
1141
- * @param {Array<string>} [tags] Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.
1142
- * @param {Array<number>} [years] Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.
1143
- * @param {boolean} [enableUserData] Optional, include user data.
1144
- * @param {number} [imageTypeLimit] Optional, the max number of images to return, per image type.
1145
- * @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output.
1146
- * @param {string} [person] Optional. If specified, results will be filtered to include only those containing the specified person.
1147
- * @param {Array<string>} [personIds] Optional. If specified, results will be filtered to include only those containing the specified person id.
1148
- * @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.
1149
- * @param {Array<string>} [studios] Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.
1150
- * @param {Array<string>} [artists] Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited.
1151
- * @param {Array<string>} [excludeArtistIds] Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited.
1152
- * @param {Array<string>} [artistIds] Optional. If specified, results will be filtered to include only those containing the specified artist id.
1153
- * @param {Array<string>} [albumArtistIds] Optional. If specified, results will be filtered to include only those containing the specified album artist id.
1154
- * @param {Array<string>} [contributingArtistIds] Optional. If specified, results will be filtered to include only those containing the specified contributing artist id.
1155
- * @param {Array<string>} [albums] Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited.
1156
- * @param {Array<string>} [albumIds] Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited.
1157
- * @param {Array<string>} [ids] Optional. If specific items are needed, specify a list of item id\&#39;s to retrieve. This allows multiple, comma delimited.
1158
- * @param {Array<VideoType>} [videoTypes] Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimited.
1159
- * @param {string} [minOfficialRating] Optional filter by minimum official rating (PG, PG-13, TV-MA, etc).
1160
- * @param {boolean} [isLocked] Optional filter by items that are locked.
1161
- * @param {boolean} [isPlaceHolder] Optional filter by items that are placeholders.
1162
- * @param {boolean} [hasOfficialRating] Optional filter by items that have official ratings.
1163
- * @param {boolean} [collapseBoxSetItems] Whether or not to hide items behind their boxsets.
1164
- * @param {number} [minWidth] Optional. Filter by the minimum width of the item.
1165
- * @param {number} [minHeight] Optional. Filter by the minimum height of the item.
1166
- * @param {number} [maxWidth] Optional. Filter by the maximum width of the item.
1167
- * @param {number} [maxHeight] Optional. Filter by the maximum height of the item.
1168
- * @param {boolean} [is3D] Optional filter by items that are 3D, or not.
1169
- * @param {Array<SeriesStatus>} [seriesStatus] Optional filter by Series Status. Allows multiple, comma delimited.
1170
- * @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string.
1171
- * @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string.
1172
- * @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string.
1173
- * @param {Array<string>} [studioIds] Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.
1174
- * @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
1175
- * @param {boolean} [enableTotalRecordCount] Optional. Enable the total record count.
1176
- * @param {boolean} [enableImages] Optional, include image information in output.
734
+ * @summary Get Item User Data.
735
+ * @param {string} itemId The item id.
736
+ * @param {string} [userId] The user id.
1177
737
  * @param {*} [options] Override http request option.
1178
738
  * @throws {RequiredError}
1179
739
  */
1180
- getItems(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, includeItemTypes, 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) {
1181
- return localVarFp.getItems(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, includeItemTypes, 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).then((request) => request(axios, basePath));
740
+ getItemUserData(itemId, userId, options) {
741
+ return localVarFp.getItemUserData(itemId, userId, options).then((request) => request(axios, basePath));
1182
742
  },
1183
743
  /**
1184
744
  *
1185
745
  * @summary Gets items based on a query.
1186
- * @param {string} userId The user id supplied as query parameter.
746
+ * @param {string} [userId] The user id supplied as query parameter; this is required when not using an API key.
1187
747
  * @param {string} [maxOfficialRating] Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).
1188
748
  * @param {boolean} [hasThemeSong] Optional filter by items with theme songs.
1189
749
  * @param {boolean} [hasThemeVideo] Optional filter by items with theme videos.
@@ -1206,9 +766,9 @@ const ItemsApiFactory = function (configuration, basePath, axios) {
1206
766
  * @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format &#x3D; ISO.
1207
767
  * @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format &#x3D; ISO.
1208
768
  * @param {boolean} [hasOverview] Optional filter by items that have an overview or not.
1209
- * @param {boolean} [hasImdbId] Optional filter by items that have an imdb id or not.
1210
- * @param {boolean} [hasTmdbId] Optional filter by items that have a tmdb id or not.
1211
- * @param {boolean} [hasTvdbId] Optional filter by items that have a tvdb id or not.
769
+ * @param {boolean} [hasImdbId] Optional filter by items that have an IMDb id or not.
770
+ * @param {boolean} [hasTmdbId] Optional filter by items that have a TMDb id or not.
771
+ * @param {boolean} [hasTvdbId] Optional filter by items that have a TVDb id or not.
1212
772
  * @param {boolean} [isMovie] Optional filter for live tv movies.
1213
773
  * @param {boolean} [isSeries] Optional filter for live tv series.
1214
774
  * @param {boolean} [isNews] Optional filter for live tv news.
@@ -1219,16 +779,16 @@ const ItemsApiFactory = function (configuration, basePath, axios) {
1219
779
  * @param {number} [limit] Optional. The maximum number of records to return.
1220
780
  * @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false.
1221
781
  * @param {string} [searchTerm] Optional. Filter based on a search term.
1222
- * @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
782
+ * @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending, Descending.
1223
783
  * @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
1224
784
  * @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.
1225
785
  * @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
1226
786
  * @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.
1227
787
  * @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.
1228
788
  * @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
1229
- * @param {Array<string>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
789
+ * @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
1230
790
  * @param {Array<ImageType>} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
1231
- * @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.
791
+ * @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.
1232
792
  * @param {boolean} [isPlayed] Optional filter by items that are played, or not.
1233
793
  * @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
1234
794
  * @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
@@ -1271,19 +831,19 @@ const ItemsApiFactory = function (configuration, basePath, axios) {
1271
831
  * @param {*} [options] Override http request option.
1272
832
  * @throws {RequiredError}
1273
833
  */
1274
- getItemsByUserId(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, includeItemTypes, 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) {
1275
- return localVarFp.getItemsByUserId(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, includeItemTypes, 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).then((request) => request(axios, basePath));
834
+ getItems(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, includeItemTypes, 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) {
835
+ return localVarFp.getItems(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, includeItemTypes, 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).then((request) => request(axios, basePath));
1276
836
  },
1277
837
  /**
1278
838
  *
1279
839
  * @summary Gets items based on a query.
1280
- * @param {string} userId The user id.
840
+ * @param {string} [userId] The user id.
1281
841
  * @param {number} [startIndex] The start index.
1282
842
  * @param {number} [limit] The item limit.
1283
843
  * @param {string} [searchTerm] The search term.
1284
844
  * @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
1285
845
  * @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.
1286
- * @param {Array<string>} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited.
846
+ * @param {Array<MediaType>} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited.
1287
847
  * @param {boolean} [enableUserData] Optional. Include user data.
1288
848
  * @param {number} [imageTypeLimit] Optional. The max number of images to return, per image type.
1289
849
  * @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output.
@@ -1298,6 +858,18 @@ const ItemsApiFactory = function (configuration, basePath, axios) {
1298
858
  getResumeItems(userId, startIndex, limit, searchTerm, parentId, fields, mediaTypes, enableUserData, imageTypeLimit, enableImageTypes, excludeItemTypes, includeItemTypes, enableTotalRecordCount, enableImages, excludeActiveSessions, options) {
1299
859
  return localVarFp.getResumeItems(userId, startIndex, limit, searchTerm, parentId, fields, mediaTypes, enableUserData, imageTypeLimit, enableImageTypes, excludeItemTypes, includeItemTypes, enableTotalRecordCount, enableImages, excludeActiveSessions, options).then((request) => request(axios, basePath));
1300
860
  },
861
+ /**
862
+ *
863
+ * @summary Update Item User Data.
864
+ * @param {string} itemId The item id.
865
+ * @param {UpdateUserItemDataDto} updateUserItemDataDto New user data object.
866
+ * @param {string} [userId] The user id.
867
+ * @param {*} [options] Override http request option.
868
+ * @throws {RequiredError}
869
+ */
870
+ updateItemUserData(itemId, updateUserItemDataDto, userId, options) {
871
+ return localVarFp.updateItemUserData(itemId, updateUserItemDataDto, userId, options).then((request) => request(axios, basePath));
872
+ },
1301
873
  };
1302
874
  };
1303
875
  /**
@@ -1307,6 +879,17 @@ const ItemsApiFactory = function (configuration, basePath, axios) {
1307
879
  * @extends {BaseAPI}
1308
880
  */
1309
881
  class ItemsApi extends BaseAPI {
882
+ /**
883
+ *
884
+ * @summary Get Item User Data.
885
+ * @param {ItemsApiGetItemUserDataRequest} requestParameters Request parameters.
886
+ * @param {*} [options] Override http request option.
887
+ * @throws {RequiredError}
888
+ * @memberof ItemsApi
889
+ */
890
+ getItemUserData(requestParameters, options) {
891
+ return ItemsApiFp(this.configuration).getItemUserData(requestParameters.itemId, requestParameters.userId, options).then((request) => request(this.axios, this.basePath));
892
+ }
1310
893
  /**
1311
894
  *
1312
895
  * @summary Gets items based on a query.
@@ -1321,24 +904,24 @@ class ItemsApi extends BaseAPI {
1321
904
  /**
1322
905
  *
1323
906
  * @summary Gets items based on a query.
1324
- * @param {ItemsApiGetItemsByUserIdRequest} requestParameters Request parameters.
907
+ * @param {ItemsApiGetResumeItemsRequest} requestParameters Request parameters.
1325
908
  * @param {*} [options] Override http request option.
1326
909
  * @throws {RequiredError}
1327
910
  * @memberof ItemsApi
1328
911
  */
1329
- getItemsByUserId(requestParameters, options) {
1330
- return ItemsApiFp(this.configuration).getItemsByUserId(requestParameters.userId, requestParameters.maxOfficialRating, requestParameters.hasThemeSong, requestParameters.hasThemeVideo, requestParameters.hasSubtitles, requestParameters.hasSpecialFeature, requestParameters.hasTrailer, requestParameters.adjacentTo, requestParameters.parentIndexNumber, requestParameters.hasParentalRating, requestParameters.isHd, requestParameters.is4K, requestParameters.locationTypes, requestParameters.excludeLocationTypes, requestParameters.isMissing, requestParameters.isUnaired, requestParameters.minCommunityRating, requestParameters.minCriticRating, requestParameters.minPremiereDate, requestParameters.minDateLastSaved, requestParameters.minDateLastSavedForUser, requestParameters.maxPremiereDate, requestParameters.hasOverview, requestParameters.hasImdbId, requestParameters.hasTmdbId, requestParameters.hasTvdbId, requestParameters.isMovie, requestParameters.isSeries, requestParameters.isNews, requestParameters.isKids, requestParameters.isSports, requestParameters.excludeItemIds, requestParameters.startIndex, requestParameters.limit, requestParameters.recursive, requestParameters.searchTerm, requestParameters.sortOrder, requestParameters.parentId, requestParameters.fields, requestParameters.excludeItemTypes, requestParameters.includeItemTypes, requestParameters.filters, requestParameters.isFavorite, requestParameters.mediaTypes, requestParameters.imageTypes, requestParameters.sortBy, requestParameters.isPlayed, requestParameters.genres, requestParameters.officialRatings, requestParameters.tags, requestParameters.years, requestParameters.enableUserData, requestParameters.imageTypeLimit, requestParameters.enableImageTypes, requestParameters.person, requestParameters.personIds, requestParameters.personTypes, requestParameters.studios, requestParameters.artists, requestParameters.excludeArtistIds, requestParameters.artistIds, requestParameters.albumArtistIds, requestParameters.contributingArtistIds, requestParameters.albums, requestParameters.albumIds, requestParameters.ids, requestParameters.videoTypes, requestParameters.minOfficialRating, requestParameters.isLocked, requestParameters.isPlaceHolder, requestParameters.hasOfficialRating, requestParameters.collapseBoxSetItems, requestParameters.minWidth, requestParameters.minHeight, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.is3D, requestParameters.seriesStatus, requestParameters.nameStartsWithOrGreater, requestParameters.nameStartsWith, requestParameters.nameLessThan, requestParameters.studioIds, requestParameters.genreIds, requestParameters.enableTotalRecordCount, requestParameters.enableImages, options).then((request) => request(this.axios, this.basePath));
912
+ getResumeItems(requestParameters = {}, options) {
913
+ return ItemsApiFp(this.configuration).getResumeItems(requestParameters.userId, requestParameters.startIndex, requestParameters.limit, requestParameters.searchTerm, requestParameters.parentId, requestParameters.fields, requestParameters.mediaTypes, requestParameters.enableUserData, requestParameters.imageTypeLimit, requestParameters.enableImageTypes, requestParameters.excludeItemTypes, requestParameters.includeItemTypes, requestParameters.enableTotalRecordCount, requestParameters.enableImages, requestParameters.excludeActiveSessions, options).then((request) => request(this.axios, this.basePath));
1331
914
  }
1332
915
  /**
1333
916
  *
1334
- * @summary Gets items based on a query.
1335
- * @param {ItemsApiGetResumeItemsRequest} requestParameters Request parameters.
917
+ * @summary Update Item User Data.
918
+ * @param {ItemsApiUpdateItemUserDataRequest} requestParameters Request parameters.
1336
919
  * @param {*} [options] Override http request option.
1337
920
  * @throws {RequiredError}
1338
921
  * @memberof ItemsApi
1339
922
  */
1340
- getResumeItems(requestParameters, options) {
1341
- return ItemsApiFp(this.configuration).getResumeItems(requestParameters.userId, requestParameters.startIndex, requestParameters.limit, requestParameters.searchTerm, requestParameters.parentId, requestParameters.fields, requestParameters.mediaTypes, requestParameters.enableUserData, requestParameters.imageTypeLimit, requestParameters.enableImageTypes, requestParameters.excludeItemTypes, requestParameters.includeItemTypes, requestParameters.enableTotalRecordCount, requestParameters.enableImages, requestParameters.excludeActiveSessions, options).then((request) => request(this.axios, this.basePath));
923
+ updateItemUserData(requestParameters, options) {
924
+ return ItemsApiFp(this.configuration).updateItemUserData(requestParameters.itemId, requestParameters.updateUserItemDataDto, requestParameters.userId, options).then((request) => request(this.axios, this.basePath));
1342
925
  }
1343
926
  }
1344
927