@jellyfin/sdk 0.7.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 (870) hide show
  1. package/.gitattributes +5 -0
  2. package/LICENSE +373 -0
  3. package/README.md +141 -0
  4. package/lib/api.d.ts +42 -0
  5. package/lib/api.js +99 -0
  6. package/lib/discovery/discovery-service.d.ts +41 -0
  7. package/lib/discovery/discovery-service.js +112 -0
  8. package/lib/discovery/index.d.ts +7 -0
  9. package/lib/discovery/index.js +23 -0
  10. package/lib/discovery/recommended-server-discovery.d.ts +23 -0
  11. package/lib/discovery/recommended-server-discovery.js +153 -0
  12. package/lib/generated-client/api/activity-log-api.d.ts +113 -0
  13. package/lib/generated-client/api/activity-log-api.js +234 -0
  14. package/lib/generated-client/api/api-key-api.d.ts +161 -0
  15. package/lib/generated-client/api/api-key-api.js +374 -0
  16. package/lib/generated-client/api/artists-api.d.ts +751 -0
  17. package/lib/generated-client/api/artists-api.js +759 -0
  18. package/lib/generated-client/api/audio-api.d.ts +1985 -0
  19. package/lib/generated-client/api/audio-api.js +1582 -0
  20. package/lib/generated-client/api/branding-api.d.ts +127 -0
  21. package/lib/generated-client/api/branding-api.js +334 -0
  22. package/lib/generated-client/api/channels-api.d.ts +419 -0
  23. package/lib/generated-client/api/channels-api.js +648 -0
  24. package/lib/generated-client/api/client-log-api.d.ts +86 -0
  25. package/lib/generated-client/api/client-log-api.js +213 -0
  26. package/lib/generated-client/api/collection-api.d.ts +223 -0
  27. package/lib/generated-client/api/collection-api.js +414 -0
  28. package/lib/generated-client/api/configuration-api.d.ts +293 -0
  29. package/lib/generated-client/api/configuration-api.js +623 -0
  30. package/lib/generated-client/api/dashboard-api.d.ts +132 -0
  31. package/lib/generated-client/api/dashboard-api.js +290 -0
  32. package/lib/generated-client/api/devices-api.d.ts +291 -0
  33. package/lib/generated-client/api/devices-api.js +567 -0
  34. package/lib/generated-client/api/display-preferences-api.d.ts +177 -0
  35. package/lib/generated-client/api/display-preferences-api.js +335 -0
  36. package/lib/generated-client/api/dlna-api.d.ts +292 -0
  37. package/lib/generated-client/api/dlna-api.js +619 -0
  38. package/lib/generated-client/api/dlna-server-api.d.ts +784 -0
  39. package/lib/generated-client/api/dlna-server-api.js +1464 -0
  40. package/lib/generated-client/api/dynamic-hls-api.d.ts +4604 -0
  41. package/lib/generated-client/api/dynamic-hls-api.js +3611 -0
  42. package/lib/generated-client/api/environment-api.d.ts +289 -0
  43. package/lib/generated-client/api/environment-api.js +628 -0
  44. package/lib/generated-client/api/filter-api.d.ts +242 -0
  45. package/lib/generated-client/api/filter-api.js +370 -0
  46. package/lib/generated-client/api/genres-api.d.ts +299 -0
  47. package/lib/generated-client/api/genres-api.js +405 -0
  48. package/lib/generated-client/api/hls-segment-api.d.ts +332 -0
  49. package/lib/generated-client/api/hls-segment-api.js +567 -0
  50. package/lib/generated-client/api/image-api.d.ts +6744 -0
  51. package/lib/generated-client/api/image-api.js +6515 -0
  52. package/lib/generated-client/api/image-by-name-api.d.ts +292 -0
  53. package/lib/generated-client/api/image-by-name-api.js +601 -0
  54. package/lib/generated-client/api/instant-mix-api.d.ts +918 -0
  55. package/lib/generated-client/api/instant-mix-api.js +1138 -0
  56. package/lib/generated-client/api/item-lookup-api.d.ts +574 -0
  57. package/lib/generated-client/api/item-lookup-api.js +1065 -0
  58. package/lib/generated-client/api/item-refresh-api.d.ts +122 -0
  59. package/lib/generated-client/api/item-refresh-api.js +237 -0
  60. package/lib/generated-client/api/item-update-api.d.ts +197 -0
  61. package/lib/generated-client/api/item-update-api.js +392 -0
  62. package/lib/generated-client/api/items-api.d.ts +1824 -0
  63. package/lib/generated-client/api/items-api.js +1488 -0
  64. package/lib/generated-client/api/library-api.d.ts +1482 -0
  65. package/lib/generated-client/api/library-api.js +2414 -0
  66. package/lib/generated-client/api/library-structure-api.d.ts +486 -0
  67. package/lib/generated-client/api/library-structure-api.js +852 -0
  68. package/lib/generated-client/api/live-tv-api.d.ts +2844 -0
  69. package/lib/generated-client/api/live-tv-api.js +4165 -0
  70. package/lib/generated-client/api/localization-api.d.ts +159 -0
  71. package/lib/generated-client/api/localization-api.js +434 -0
  72. package/lib/generated-client/api/media-info-api.d.ts +516 -0
  73. package/lib/generated-client/api/media-info-api.js +711 -0
  74. package/lib/generated-client/api/movies-api.d.ts +123 -0
  75. package/lib/generated-client/api/movies-api.js +238 -0
  76. package/lib/generated-client/api/music-genres-api.d.ts +303 -0
  77. package/lib/generated-client/api/music-genres-api.js +409 -0
  78. package/lib/generated-client/api/notifications-api.d.ts +332 -0
  79. package/lib/generated-client/api/notifications-api.js +698 -0
  80. package/lib/generated-client/api/package-api.d.ts +319 -0
  81. package/lib/generated-client/api/package-api.js +639 -0
  82. package/lib/generated-client/api/persons-api.d.ts +253 -0
  83. package/lib/generated-client/api/persons-api.js +375 -0
  84. package/lib/generated-client/api/playlists-api.d.ts +427 -0
  85. package/lib/generated-client/api/playlists-api.js +649 -0
  86. package/lib/generated-client/api/playstate-api.d.ts +720 -0
  87. package/lib/generated-client/api/playstate-api.js +1055 -0
  88. package/lib/generated-client/api/plugins-api.d.ts +477 -0
  89. package/lib/generated-client/api/plugins-api.js +898 -0
  90. package/lib/generated-client/api/quick-connect-api.d.ts +190 -0
  91. package/lib/generated-client/api/quick-connect-api.js +428 -0
  92. package/lib/generated-client/api/remote-image-api.d.ts +243 -0
  93. package/lib/generated-client/api/remote-image-api.js +423 -0
  94. package/lib/generated-client/api/scheduled-tasks-api.d.ts +289 -0
  95. package/lib/generated-client/api/scheduled-tasks-api.js +559 -0
  96. package/lib/generated-client/api/search-api.d.ts +240 -0
  97. package/lib/generated-client/api/search-api.js +317 -0
  98. package/lib/generated-client/api/session-api.d.ts +985 -0
  99. package/lib/generated-client/api/session-api.js +1622 -0
  100. package/lib/generated-client/api/startup-api.d.ts +296 -0
  101. package/lib/generated-client/api/startup-api.js +685 -0
  102. package/lib/generated-client/api/studios-api.d.ts +289 -0
  103. package/lib/generated-client/api/studios-api.js +399 -0
  104. package/lib/generated-client/api/subtitle-api.d.ts +764 -0
  105. package/lib/generated-client/api/subtitle-api.js +1126 -0
  106. package/lib/generated-client/api/suggestions-api.d.ts +132 -0
  107. package/lib/generated-client/api/suggestions-api.js +243 -0
  108. package/lib/generated-client/api/sync-play-api.d.ts +937 -0
  109. package/lib/generated-client/api/sync-play-api.js +1854 -0
  110. package/lib/generated-client/api/system-api.d.ts +355 -0
  111. package/lib/generated-client/api/system-api.js +879 -0
  112. package/lib/generated-client/api/time-sync-api.d.ts +69 -0
  113. package/lib/generated-client/api/time-sync-api.js +198 -0
  114. package/lib/generated-client/api/tmdb-api.d.ts +69 -0
  115. package/lib/generated-client/api/tmdb-api.js +206 -0
  116. package/lib/generated-client/api/trailers-api.d.ts +841 -0
  117. package/lib/generated-client/api/trailers-api.js +720 -0
  118. package/lib/generated-client/api/tv-shows-api.d.ts +622 -0
  119. package/lib/generated-client/api/tv-shows-api.js +730 -0
  120. package/lib/generated-client/api/universal-audio-api.d.ts +437 -0
  121. package/lib/generated-client/api/universal-audio-api.js +500 -0
  122. package/lib/generated-client/api/user-api.d.ts +826 -0
  123. package/lib/generated-client/api/user-api.js +1457 -0
  124. package/lib/generated-client/api/user-library-api.d.ts +676 -0
  125. package/lib/generated-client/api/user-library-api.js +1074 -0
  126. package/lib/generated-client/api/user-views-api.d.ts +160 -0
  127. package/lib/generated-client/api/user-views-api.js +314 -0
  128. package/lib/generated-client/api/video-attachments-api.d.ts +103 -0
  129. package/lib/generated-client/api/video-attachments-api.js +217 -0
  130. package/lib/generated-client/api/videos-api.d.ts +2205 -0
  131. package/lib/generated-client/api/videos-api.js +1887 -0
  132. package/lib/generated-client/api/years-api.d.ts +272 -0
  133. package/lib/generated-client/api/years-api.js +387 -0
  134. package/lib/generated-client/api.d.ts +71 -0
  135. package/lib/generated-client/api.js +89 -0
  136. package/lib/generated-client/base.d.ts +54 -0
  137. package/lib/generated-client/base.js +84 -0
  138. package/lib/generated-client/common.d.ts +64 -0
  139. package/lib/generated-client/common.js +242 -0
  140. package/lib/generated-client/configuration.d.ts +82 -0
  141. package/lib/generated-client/configuration.js +43 -0
  142. package/lib/generated-client/index.d.ts +13 -0
  143. package/lib/generated-client/index.js +31 -0
  144. package/lib/generated-client/models/access-schedule.d.ts +48 -0
  145. package/lib/generated-client/models/access-schedule.js +14 -0
  146. package/lib/generated-client/models/activity-log-entry-query-result.d.ts +36 -0
  147. package/lib/generated-client/models/activity-log-entry-query-result.js +14 -0
  148. package/lib/generated-client/models/activity-log-entry.d.ts +79 -0
  149. package/lib/generated-client/models/activity-log-entry.js +14 -0
  150. package/lib/generated-client/models/add-virtual-folder-dto.d.ts +24 -0
  151. package/lib/generated-client/models/add-virtual-folder-dto.js +14 -0
  152. package/lib/generated-client/models/admin-notification-dto.d.ts +42 -0
  153. package/lib/generated-client/models/admin-notification-dto.js +14 -0
  154. package/lib/generated-client/models/album-info-remote-search-query.d.ts +42 -0
  155. package/lib/generated-client/models/album-info-remote-search-query.js +14 -0
  156. package/lib/generated-client/models/album-info.d.ts +106 -0
  157. package/lib/generated-client/models/album-info.js +14 -0
  158. package/lib/generated-client/models/all-theme-media-result.d.ts +36 -0
  159. package/lib/generated-client/models/all-theme-media-result.js +14 -0
  160. package/lib/generated-client/models/architecture.d.ts +23 -0
  161. package/lib/generated-client/models/architecture.js +29 -0
  162. package/lib/generated-client/models/artist-info-remote-search-query.d.ts +42 -0
  163. package/lib/generated-client/models/artist-info-remote-search-query.js +14 -0
  164. package/lib/generated-client/models/artist-info.d.ts +92 -0
  165. package/lib/generated-client/models/artist-info.js +14 -0
  166. package/lib/generated-client/models/authenticate-user-by-name.d.ts +36 -0
  167. package/lib/generated-client/models/authenticate-user-by-name.js +14 -0
  168. package/lib/generated-client/models/authentication-info-query-result.d.ts +36 -0
  169. package/lib/generated-client/models/authentication-info-query-result.js +14 -0
  170. package/lib/generated-client/models/authentication-info.d.ts +89 -0
  171. package/lib/generated-client/models/authentication-info.js +14 -0
  172. package/lib/generated-client/models/authentication-result.d.ts +43 -0
  173. package/lib/generated-client/models/authentication-result.js +14 -0
  174. package/lib/generated-client/models/base-item-dto-image-blur-hashes.d.ts +121 -0
  175. package/lib/generated-client/models/base-item-dto-image-blur-hashes.js +14 -0
  176. package/lib/generated-client/models/base-item-dto-query-result.d.ts +36 -0
  177. package/lib/generated-client/models/base-item-dto-query-result.js +14 -0
  178. package/lib/generated-client/models/base-item-dto.d.ts +947 -0
  179. package/lib/generated-client/models/base-item-dto.js +14 -0
  180. package/lib/generated-client/models/base-item-kind.d.ts +54 -0
  181. package/lib/generated-client/models/base-item-kind.js +60 -0
  182. package/lib/generated-client/models/base-item-person-image-blur-hashes.d.ts +121 -0
  183. package/lib/generated-client/models/base-item-person-image-blur-hashes.js +14 -0
  184. package/lib/generated-client/models/base-item-person.d.ts +54 -0
  185. package/lib/generated-client/models/base-item-person.js +14 -0
  186. package/lib/generated-client/models/base-item.d.ts +84 -0
  187. package/lib/generated-client/models/base-item.js +14 -0
  188. package/lib/generated-client/models/book-info-remote-search-query.d.ts +42 -0
  189. package/lib/generated-client/models/book-info-remote-search-query.js +14 -0
  190. package/lib/generated-client/models/book-info.d.ts +91 -0
  191. package/lib/generated-client/models/book-info.js +14 -0
  192. package/lib/generated-client/models/box-set-info-remote-search-query.d.ts +42 -0
  193. package/lib/generated-client/models/box-set-info-remote-search-query.js +14 -0
  194. package/lib/generated-client/models/box-set-info.d.ts +85 -0
  195. package/lib/generated-client/models/box-set-info.js +14 -0
  196. package/lib/generated-client/models/branding-options.d.ts +35 -0
  197. package/lib/generated-client/models/branding-options.js +14 -0
  198. package/lib/generated-client/models/buffer-request-dto.d.ts +41 -0
  199. package/lib/generated-client/models/buffer-request-dto.js +14 -0
  200. package/lib/generated-client/models/channel-features.d.ts +92 -0
  201. package/lib/generated-client/models/channel-features.js +14 -0
  202. package/lib/generated-client/models/channel-item-sort-field.d.ts +24 -0
  203. package/lib/generated-client/models/channel-item-sort-field.js +30 -0
  204. package/lib/generated-client/models/channel-mapping-options-dto.d.ts +44 -0
  205. package/lib/generated-client/models/channel-mapping-options-dto.js +14 -0
  206. package/lib/generated-client/models/channel-media-content-type.d.ts +25 -0
  207. package/lib/generated-client/models/channel-media-content-type.js +31 -0
  208. package/lib/generated-client/models/channel-media-type.d.ts +20 -0
  209. package/lib/generated-client/models/channel-media-type.js +26 -0
  210. package/lib/generated-client/models/channel-type.d.ts +19 -0
  211. package/lib/generated-client/models/channel-type.js +25 -0
  212. package/lib/generated-client/models/chapter-info.d.ts +47 -0
  213. package/lib/generated-client/models/chapter-info.js +14 -0
  214. package/lib/generated-client/models/client-capabilities-dto.d.ts +79 -0
  215. package/lib/generated-client/models/client-capabilities-dto.js +14 -0
  216. package/lib/generated-client/models/client-capabilities.d.ts +79 -0
  217. package/lib/generated-client/models/client-capabilities.js +14 -0
  218. package/lib/generated-client/models/client-log-document-response-dto.d.ts +23 -0
  219. package/lib/generated-client/models/client-log-document-response-dto.js +14 -0
  220. package/lib/generated-client/models/codec-profile.d.ts +49 -0
  221. package/lib/generated-client/models/codec-profile.js +14 -0
  222. package/lib/generated-client/models/codec-type.d.ts +20 -0
  223. package/lib/generated-client/models/codec-type.js +26 -0
  224. package/lib/generated-client/models/collection-creation-result.d.ts +23 -0
  225. package/lib/generated-client/models/collection-creation-result.js +14 -0
  226. package/lib/generated-client/models/collection-type-options.d.ts +25 -0
  227. package/lib/generated-client/models/collection-type-options.js +31 -0
  228. package/lib/generated-client/models/config-image-types.d.ts +59 -0
  229. package/lib/generated-client/models/config-image-types.js +14 -0
  230. package/lib/generated-client/models/configuration-page-info.d.ts +53 -0
  231. package/lib/generated-client/models/configuration-page-info.js +14 -0
  232. package/lib/generated-client/models/container-profile.d.ts +37 -0
  233. package/lib/generated-client/models/container-profile.js +14 -0
  234. package/lib/generated-client/models/control-response.d.ts +37 -0
  235. package/lib/generated-client/models/control-response.js +14 -0
  236. package/lib/generated-client/models/country-info.d.ts +41 -0
  237. package/lib/generated-client/models/country-info.js +14 -0
  238. package/lib/generated-client/models/create-playlist-dto.d.ts +41 -0
  239. package/lib/generated-client/models/create-playlist-dto.js +14 -0
  240. package/lib/generated-client/models/create-user-by-name.d.ts +29 -0
  241. package/lib/generated-client/models/create-user-by-name.js +14 -0
  242. package/lib/generated-client/models/culture-dto.d.ts +47 -0
  243. package/lib/generated-client/models/culture-dto.js +14 -0
  244. package/lib/generated-client/models/day-of-week.d.ts +24 -0
  245. package/lib/generated-client/models/day-of-week.js +30 -0
  246. package/lib/generated-client/models/day-pattern.d.ts +20 -0
  247. package/lib/generated-client/models/day-pattern.js +26 -0
  248. package/lib/generated-client/models/default-directory-browser-info-dto.d.ts +23 -0
  249. package/lib/generated-client/models/default-directory-browser-info-dto.js +14 -0
  250. package/lib/generated-client/models/device-identification.d.ts +72 -0
  251. package/lib/generated-client/models/device-identification.js +14 -0
  252. package/lib/generated-client/models/device-info-query-result.d.ts +36 -0
  253. package/lib/generated-client/models/device-info-query-result.js +14 -0
  254. package/lib/generated-client/models/device-info.d.ts +78 -0
  255. package/lib/generated-client/models/device-info.js +14 -0
  256. package/lib/generated-client/models/device-options-dto.d.ts +35 -0
  257. package/lib/generated-client/models/device-options-dto.js +14 -0
  258. package/lib/generated-client/models/device-options.d.ts +35 -0
  259. package/lib/generated-client/models/device-options.js +14 -0
  260. package/lib/generated-client/models/device-profile-info.d.ts +36 -0
  261. package/lib/generated-client/models/device-profile-info.js +14 -0
  262. package/lib/generated-client/models/device-profile-type.d.ts +19 -0
  263. package/lib/generated-client/models/device-profile-type.js +25 -0
  264. package/lib/generated-client/models/device-profile.d.ts +259 -0
  265. package/lib/generated-client/models/device-profile.js +14 -0
  266. package/lib/generated-client/models/direct-play-profile.d.ts +42 -0
  267. package/lib/generated-client/models/direct-play-profile.js +14 -0
  268. package/lib/generated-client/models/display-preferences-dto.d.ts +105 -0
  269. package/lib/generated-client/models/display-preferences-dto.js +14 -0
  270. package/lib/generated-client/models/dlna-options.d.ts +83 -0
  271. package/lib/generated-client/models/dlna-options.js +14 -0
  272. package/lib/generated-client/models/dlna-profile-type.d.ts +21 -0
  273. package/lib/generated-client/models/dlna-profile-type.js +27 -0
  274. package/lib/generated-client/models/dynamic-day-of-week.d.ts +27 -0
  275. package/lib/generated-client/models/dynamic-day-of-week.js +33 -0
  276. package/lib/generated-client/models/embedded-subtitle-options.d.ts +21 -0
  277. package/lib/generated-client/models/embedded-subtitle-options.js +27 -0
  278. package/lib/generated-client/models/encoding-context.d.ts +19 -0
  279. package/lib/generated-client/models/encoding-context.js +25 -0
  280. package/lib/generated-client/models/encoding-options.d.ts +245 -0
  281. package/lib/generated-client/models/encoding-options.js +14 -0
  282. package/lib/generated-client/models/end-point-info.d.ts +29 -0
  283. package/lib/generated-client/models/end-point-info.js +14 -0
  284. package/lib/generated-client/models/external-id-info.d.ts +42 -0
  285. package/lib/generated-client/models/external-id-info.js +14 -0
  286. package/lib/generated-client/models/external-id-media-type.d.ts +29 -0
  287. package/lib/generated-client/models/external-id-media-type.js +35 -0
  288. package/lib/generated-client/models/external-url.d.ts +29 -0
  289. package/lib/generated-client/models/external-url.js +14 -0
  290. package/lib/generated-client/models/ffmpeg-location.d.ts +21 -0
  291. package/lib/generated-client/models/ffmpeg-location.js +27 -0
  292. package/lib/generated-client/models/file-system-entry-info.d.ts +36 -0
  293. package/lib/generated-client/models/file-system-entry-info.js +14 -0
  294. package/lib/generated-client/models/file-system-entry-type.d.ts +21 -0
  295. package/lib/generated-client/models/file-system-entry-type.js +27 -0
  296. package/lib/generated-client/models/font-file.d.ts +41 -0
  297. package/lib/generated-client/models/font-file.js +14 -0
  298. package/lib/generated-client/models/forgot-password-action.d.ts +20 -0
  299. package/lib/generated-client/models/forgot-password-action.js +26 -0
  300. package/lib/generated-client/models/forgot-password-dto.d.ts +23 -0
  301. package/lib/generated-client/models/forgot-password-dto.js +14 -0
  302. package/lib/generated-client/models/forgot-password-pin-dto.d.ts +23 -0
  303. package/lib/generated-client/models/forgot-password-pin-dto.js +14 -0
  304. package/lib/generated-client/models/forgot-password-result.d.ts +36 -0
  305. package/lib/generated-client/models/forgot-password-result.js +14 -0
  306. package/lib/generated-client/models/general-command-type.d.ts +59 -0
  307. package/lib/generated-client/models/general-command-type.js +65 -0
  308. package/lib/generated-client/models/general-command.d.ts +38 -0
  309. package/lib/generated-client/models/general-command.js +14 -0
  310. package/lib/generated-client/models/get-programs-dto.d.ts +182 -0
  311. package/lib/generated-client/models/get-programs-dto.js +14 -0
  312. package/lib/generated-client/models/group-info-dto.d.ts +48 -0
  313. package/lib/generated-client/models/group-info-dto.js +14 -0
  314. package/lib/generated-client/models/group-queue-mode.d.ts +19 -0
  315. package/lib/generated-client/models/group-queue-mode.js +25 -0
  316. package/lib/generated-client/models/group-repeat-mode.d.ts +20 -0
  317. package/lib/generated-client/models/group-repeat-mode.js +26 -0
  318. package/lib/generated-client/models/group-shuffle-mode.d.ts +19 -0
  319. package/lib/generated-client/models/group-shuffle-mode.js +25 -0
  320. package/lib/generated-client/models/group-state-type.d.ts +21 -0
  321. package/lib/generated-client/models/group-state-type.js +27 -0
  322. package/lib/generated-client/models/group-update-type.d.ts +28 -0
  323. package/lib/generated-client/models/group-update-type.js +34 -0
  324. package/lib/generated-client/models/guide-info.d.ts +29 -0
  325. package/lib/generated-client/models/guide-info.js +14 -0
  326. package/lib/generated-client/models/hardware-encoding-type.d.ts +23 -0
  327. package/lib/generated-client/models/hardware-encoding-type.js +29 -0
  328. package/lib/generated-client/models/header-match-type.d.ts +20 -0
  329. package/lib/generated-client/models/header-match-type.js +26 -0
  330. package/lib/generated-client/models/http-header-info.d.ts +36 -0
  331. package/lib/generated-client/models/http-header-info.js +14 -0
  332. package/lib/generated-client/models/ignore-wait-request-dto.d.ts +23 -0
  333. package/lib/generated-client/models/ignore-wait-request-dto.js +14 -0
  334. package/lib/generated-client/models/image-by-name-info.d.ts +47 -0
  335. package/lib/generated-client/models/image-by-name-info.js +14 -0
  336. package/lib/generated-client/models/image-format.d.ts +22 -0
  337. package/lib/generated-client/models/image-format.js +28 -0
  338. package/lib/generated-client/models/image-info.d.ts +66 -0
  339. package/lib/generated-client/models/image-info.js +14 -0
  340. package/lib/generated-client/models/image-option.d.ts +36 -0
  341. package/lib/generated-client/models/image-option.js +14 -0
  342. package/lib/generated-client/models/image-orientation.d.ts +25 -0
  343. package/lib/generated-client/models/image-orientation.js +31 -0
  344. package/lib/generated-client/models/image-provider-info.d.ts +30 -0
  345. package/lib/generated-client/models/image-provider-info.js +14 -0
  346. package/lib/generated-client/models/image-saving-convention.d.ts +19 -0
  347. package/lib/generated-client/models/image-saving-convention.js +25 -0
  348. package/lib/generated-client/models/image-type.d.ts +30 -0
  349. package/lib/generated-client/models/image-type.js +36 -0
  350. package/lib/generated-client/models/index.d.ts +284 -0
  351. package/lib/generated-client/models/index.js +300 -0
  352. package/lib/generated-client/models/installation-info.d.ts +60 -0
  353. package/lib/generated-client/models/installation-info.js +14 -0
  354. package/lib/generated-client/models/iplugin.d.ts +59 -0
  355. package/lib/generated-client/models/iplugin.js +14 -0
  356. package/lib/generated-client/models/iso-type.d.ts +19 -0
  357. package/lib/generated-client/models/iso-type.js +25 -0
  358. package/lib/generated-client/models/item-counts.d.ts +89 -0
  359. package/lib/generated-client/models/item-counts.js +14 -0
  360. package/lib/generated-client/models/item-fields.d.ts +78 -0
  361. package/lib/generated-client/models/item-fields.js +84 -0
  362. package/lib/generated-client/models/item-filter.d.ts +26 -0
  363. package/lib/generated-client/models/item-filter.js +32 -0
  364. package/lib/generated-client/models/join-group-request-dto.d.ts +23 -0
  365. package/lib/generated-client/models/join-group-request-dto.js +14 -0
  366. package/lib/generated-client/models/keep-until.d.ts +21 -0
  367. package/lib/generated-client/models/keep-until.js +27 -0
  368. package/lib/generated-client/models/library-option-info-dto.d.ts +29 -0
  369. package/lib/generated-client/models/library-option-info-dto.js +14 -0
  370. package/lib/generated-client/models/library-options-result-dto.d.ts +43 -0
  371. package/lib/generated-client/models/library-options-result-dto.js +14 -0
  372. package/lib/generated-client/models/library-options.d.ts +183 -0
  373. package/lib/generated-client/models/library-options.js +14 -0
  374. package/lib/generated-client/models/library-type-options-dto.d.ts +50 -0
  375. package/lib/generated-client/models/library-type-options-dto.js +14 -0
  376. package/lib/generated-client/models/library-update-info.d.ts +59 -0
  377. package/lib/generated-client/models/library-update-info.js +14 -0
  378. package/lib/generated-client/models/listings-provider-info.d.ts +126 -0
  379. package/lib/generated-client/models/listings-provider-info.js +14 -0
  380. package/lib/generated-client/models/live-stream-response.d.ts +24 -0
  381. package/lib/generated-client/models/live-stream-response.js +14 -0
  382. package/lib/generated-client/models/live-tv-info.d.ts +36 -0
  383. package/lib/generated-client/models/live-tv-info.js +14 -0
  384. package/lib/generated-client/models/live-tv-options.d.ts +97 -0
  385. package/lib/generated-client/models/live-tv-options.js +14 -0
  386. package/lib/generated-client/models/live-tv-service-info.d.ts +66 -0
  387. package/lib/generated-client/models/live-tv-service-info.js +14 -0
  388. package/lib/generated-client/models/live-tv-service-status.d.ts +19 -0
  389. package/lib/generated-client/models/live-tv-service-status.js +25 -0
  390. package/lib/generated-client/models/localization-option.d.ts +29 -0
  391. package/lib/generated-client/models/localization-option.js +14 -0
  392. package/lib/generated-client/models/location-type.d.ts +21 -0
  393. package/lib/generated-client/models/location-type.js +27 -0
  394. package/lib/generated-client/models/log-file.d.ts +41 -0
  395. package/lib/generated-client/models/log-file.js +14 -0
  396. package/lib/generated-client/models/log-level.d.ts +24 -0
  397. package/lib/generated-client/models/log-level.js +30 -0
  398. package/lib/generated-client/models/media-attachment.d.ts +59 -0
  399. package/lib/generated-client/models/media-attachment.js +14 -0
  400. package/lib/generated-client/models/media-encoder-path-dto.d.ts +29 -0
  401. package/lib/generated-client/models/media-encoder-path-dto.js +14 -0
  402. package/lib/generated-client/models/media-path-dto.d.ts +36 -0
  403. package/lib/generated-client/models/media-path-dto.js +14 -0
  404. package/lib/generated-client/models/media-path-info.d.ts +29 -0
  405. package/lib/generated-client/models/media-path-info.js +14 -0
  406. package/lib/generated-client/models/media-protocol.d.ts +24 -0
  407. package/lib/generated-client/models/media-protocol.js +30 -0
  408. package/lib/generated-client/models/media-source-info.d.ts +279 -0
  409. package/lib/generated-client/models/media-source-info.js +14 -0
  410. package/lib/generated-client/models/media-source-type.d.ts +20 -0
  411. package/lib/generated-client/models/media-source-type.js +26 -0
  412. package/lib/generated-client/models/media-stream-type.d.ts +21 -0
  413. package/lib/generated-client/models/media-stream-type.js +27 -0
  414. package/lib/generated-client/models/media-stream.d.ts +367 -0
  415. package/lib/generated-client/models/media-stream.js +14 -0
  416. package/lib/generated-client/models/media-update-info-dto.d.ts +24 -0
  417. package/lib/generated-client/models/media-update-info-dto.js +14 -0
  418. package/lib/generated-client/models/media-update-info-path-dto.d.ts +29 -0
  419. package/lib/generated-client/models/media-update-info-path-dto.js +14 -0
  420. package/lib/generated-client/models/media-url.d.ts +29 -0
  421. package/lib/generated-client/models/media-url.js +14 -0
  422. package/lib/generated-client/models/message-command.d.ts +35 -0
  423. package/lib/generated-client/models/message-command.js +14 -0
  424. package/lib/generated-client/models/metadata-configuration.d.ts +23 -0
  425. package/lib/generated-client/models/metadata-configuration.js +14 -0
  426. package/lib/generated-client/models/metadata-editor-info.d.ts +58 -0
  427. package/lib/generated-client/models/metadata-editor-info.js +14 -0
  428. package/lib/generated-client/models/metadata-field.d.ts +26 -0
  429. package/lib/generated-client/models/metadata-field.js +32 -0
  430. package/lib/generated-client/models/metadata-options.d.ts +59 -0
  431. package/lib/generated-client/models/metadata-options.js +14 -0
  432. package/lib/generated-client/models/metadata-refresh-mode.d.ts +21 -0
  433. package/lib/generated-client/models/metadata-refresh-mode.js +27 -0
  434. package/lib/generated-client/models/move-playlist-item-request-dto.d.ts +29 -0
  435. package/lib/generated-client/models/move-playlist-item-request-dto.js +14 -0
  436. package/lib/generated-client/models/movie-info-remote-search-query.d.ts +42 -0
  437. package/lib/generated-client/models/movie-info-remote-search-query.js +14 -0
  438. package/lib/generated-client/models/movie-info.d.ts +85 -0
  439. package/lib/generated-client/models/movie-info.js +14 -0
  440. package/lib/generated-client/models/music-video-info-remote-search-query.d.ts +42 -0
  441. package/lib/generated-client/models/music-video-info-remote-search-query.js +14 -0
  442. package/lib/generated-client/models/music-video-info.d.ts +91 -0
  443. package/lib/generated-client/models/music-video-info.js +14 -0
  444. package/lib/generated-client/models/name-guid-pair.d.ts +29 -0
  445. package/lib/generated-client/models/name-guid-pair.js +14 -0
  446. package/lib/generated-client/models/name-id-pair.d.ts +29 -0
  447. package/lib/generated-client/models/name-id-pair.js +14 -0
  448. package/lib/generated-client/models/name-value-pair.d.ts +29 -0
  449. package/lib/generated-client/models/name-value-pair.js +14 -0
  450. package/lib/generated-client/models/network-configuration.d.ts +221 -0
  451. package/lib/generated-client/models/network-configuration.js +14 -0
  452. package/lib/generated-client/models/new-group-request-dto.d.ts +23 -0
  453. package/lib/generated-client/models/new-group-request-dto.js +14 -0
  454. package/lib/generated-client/models/next-item-request-dto.d.ts +23 -0
  455. package/lib/generated-client/models/next-item-request-dto.js +14 -0
  456. package/lib/generated-client/models/notification-dto.d.ts +66 -0
  457. package/lib/generated-client/models/notification-dto.js +14 -0
  458. package/lib/generated-client/models/notification-level.d.ts +20 -0
  459. package/lib/generated-client/models/notification-level.js +26 -0
  460. package/lib/generated-client/models/notification-option.d.ts +54 -0
  461. package/lib/generated-client/models/notification-option.js +14 -0
  462. package/lib/generated-client/models/notification-options.d.ts +24 -0
  463. package/lib/generated-client/models/notification-options.js +14 -0
  464. package/lib/generated-client/models/notification-result-dto.d.ts +30 -0
  465. package/lib/generated-client/models/notification-result-dto.js +14 -0
  466. package/lib/generated-client/models/notification-type-info.d.ts +47 -0
  467. package/lib/generated-client/models/notification-type-info.js +14 -0
  468. package/lib/generated-client/models/notifications-summary-dto.d.ts +30 -0
  469. package/lib/generated-client/models/notifications-summary-dto.js +14 -0
  470. package/lib/generated-client/models/object-group-update.d.ts +36 -0
  471. package/lib/generated-client/models/object-group-update.js +14 -0
  472. package/lib/generated-client/models/open-live-stream-dto.d.ts +97 -0
  473. package/lib/generated-client/models/open-live-stream-dto.js +14 -0
  474. package/lib/generated-client/models/package-info.d.ts +66 -0
  475. package/lib/generated-client/models/package-info.js +14 -0
  476. package/lib/generated-client/models/parental-rating.d.ts +29 -0
  477. package/lib/generated-client/models/parental-rating.js +14 -0
  478. package/lib/generated-client/models/path-substitution.d.ts +29 -0
  479. package/lib/generated-client/models/path-substitution.js +14 -0
  480. package/lib/generated-client/models/person-lookup-info-remote-search-query.d.ts +42 -0
  481. package/lib/generated-client/models/person-lookup-info-remote-search-query.js +14 -0
  482. package/lib/generated-client/models/person-lookup-info.d.ts +85 -0
  483. package/lib/generated-client/models/person-lookup-info.js +14 -0
  484. package/lib/generated-client/models/pin-redeem-result.d.ts +29 -0
  485. package/lib/generated-client/models/pin-redeem-result.js +14 -0
  486. package/lib/generated-client/models/ping-request-dto.d.ts +23 -0
  487. package/lib/generated-client/models/ping-request-dto.js +14 -0
  488. package/lib/generated-client/models/play-access.d.ts +19 -0
  489. package/lib/generated-client/models/play-access.js +25 -0
  490. package/lib/generated-client/models/play-command.d.ts +22 -0
  491. package/lib/generated-client/models/play-command.js +28 -0
  492. package/lib/generated-client/models/play-method.d.ts +20 -0
  493. package/lib/generated-client/models/play-method.js +26 -0
  494. package/lib/generated-client/models/play-request-dto.d.ts +35 -0
  495. package/lib/generated-client/models/play-request-dto.js +14 -0
  496. package/lib/generated-client/models/play-request.d.ts +66 -0
  497. package/lib/generated-client/models/play-request.js +14 -0
  498. package/lib/generated-client/models/playback-error-code.d.ts +20 -0
  499. package/lib/generated-client/models/playback-error-code.js +26 -0
  500. package/lib/generated-client/models/playback-info-dto.d.ts +108 -0
  501. package/lib/generated-client/models/playback-info-dto.js +14 -0
  502. package/lib/generated-client/models/playback-info-response.d.ts +37 -0
  503. package/lib/generated-client/models/playback-info-response.js +14 -0
  504. package/lib/generated-client/models/playback-progress-info.d.ts +141 -0
  505. package/lib/generated-client/models/playback-progress-info.js +14 -0
  506. package/lib/generated-client/models/playback-start-info.d.ts +141 -0
  507. package/lib/generated-client/models/playback-start-info.js +14 -0
  508. package/lib/generated-client/models/playback-stop-info.d.ts +85 -0
  509. package/lib/generated-client/models/playback-stop-info.js +14 -0
  510. package/lib/generated-client/models/player-state-info.d.ts +85 -0
  511. package/lib/generated-client/models/player-state-info.js +14 -0
  512. package/lib/generated-client/models/playlist-creation-result.d.ts +23 -0
  513. package/lib/generated-client/models/playlist-creation-result.js +14 -0
  514. package/lib/generated-client/models/playstate-command.d.ts +26 -0
  515. package/lib/generated-client/models/playstate-command.js +32 -0
  516. package/lib/generated-client/models/playstate-request.d.ts +36 -0
  517. package/lib/generated-client/models/playstate-request.js +14 -0
  518. package/lib/generated-client/models/plugin-info.d.ts +66 -0
  519. package/lib/generated-client/models/plugin-info.js +14 -0
  520. package/lib/generated-client/models/plugin-status.d.ts +24 -0
  521. package/lib/generated-client/models/plugin-status.js +30 -0
  522. package/lib/generated-client/models/previous-item-request-dto.d.ts +23 -0
  523. package/lib/generated-client/models/previous-item-request-dto.js +14 -0
  524. package/lib/generated-client/models/problem-details.d.ts +48 -0
  525. package/lib/generated-client/models/problem-details.js +14 -0
  526. package/lib/generated-client/models/profile-condition-type.d.ts +22 -0
  527. package/lib/generated-client/models/profile-condition-type.js +28 -0
  528. package/lib/generated-client/models/profile-condition-value.d.ts +41 -0
  529. package/lib/generated-client/models/profile-condition-value.js +47 -0
  530. package/lib/generated-client/models/profile-condition.d.ts +43 -0
  531. package/lib/generated-client/models/profile-condition.js +14 -0
  532. package/lib/generated-client/models/program-audio.d.ts +23 -0
  533. package/lib/generated-client/models/program-audio.js +29 -0
  534. package/lib/generated-client/models/public-system-info.d.ts +59 -0
  535. package/lib/generated-client/models/public-system-info.js +14 -0
  536. package/lib/generated-client/models/query-filters-legacy.d.ts +41 -0
  537. package/lib/generated-client/models/query-filters-legacy.js +14 -0
  538. package/lib/generated-client/models/query-filters.d.ts +30 -0
  539. package/lib/generated-client/models/query-filters.js +14 -0
  540. package/lib/generated-client/models/queue-item.d.ts +29 -0
  541. package/lib/generated-client/models/queue-item.js +14 -0
  542. package/lib/generated-client/models/queue-request-dto.d.ts +30 -0
  543. package/lib/generated-client/models/queue-request-dto.js +14 -0
  544. package/lib/generated-client/models/quick-connect-dto.d.ts +23 -0
  545. package/lib/generated-client/models/quick-connect-dto.js +14 -0
  546. package/lib/generated-client/models/quick-connect-result.d.ts +65 -0
  547. package/lib/generated-client/models/quick-connect-result.js +14 -0
  548. package/lib/generated-client/models/rating-type.d.ts +19 -0
  549. package/lib/generated-client/models/rating-type.js +25 -0
  550. package/lib/generated-client/models/ready-request-dto.d.ts +41 -0
  551. package/lib/generated-client/models/ready-request-dto.js +14 -0
  552. package/lib/generated-client/models/recommendation-dto.d.ts +43 -0
  553. package/lib/generated-client/models/recommendation-dto.js +14 -0
  554. package/lib/generated-client/models/recommendation-type.d.ts +23 -0
  555. package/lib/generated-client/models/recommendation-type.js +29 -0
  556. package/lib/generated-client/models/recording-status.d.ts +24 -0
  557. package/lib/generated-client/models/recording-status.js +30 -0
  558. package/lib/generated-client/models/remote-image-info.d.ts +79 -0
  559. package/lib/generated-client/models/remote-image-info.js +14 -0
  560. package/lib/generated-client/models/remote-image-result.d.ts +36 -0
  561. package/lib/generated-client/models/remote-image-result.js +14 -0
  562. package/lib/generated-client/models/remote-search-result.d.ts +91 -0
  563. package/lib/generated-client/models/remote-search-result.js +14 -0
  564. package/lib/generated-client/models/remote-subtitle-info.d.ts +83 -0
  565. package/lib/generated-client/models/remote-subtitle-info.js +14 -0
  566. package/lib/generated-client/models/remove-from-playlist-request-dto.d.ts +35 -0
  567. package/lib/generated-client/models/remove-from-playlist-request-dto.js +14 -0
  568. package/lib/generated-client/models/repeat-mode.d.ts +20 -0
  569. package/lib/generated-client/models/repeat-mode.js +26 -0
  570. package/lib/generated-client/models/repository-info.d.ts +35 -0
  571. package/lib/generated-client/models/repository-info.js +14 -0
  572. package/lib/generated-client/models/response-profile.d.ts +61 -0
  573. package/lib/generated-client/models/response-profile.js +14 -0
  574. package/lib/generated-client/models/scroll-direction.d.ts +19 -0
  575. package/lib/generated-client/models/scroll-direction.js +25 -0
  576. package/lib/generated-client/models/search-hint-result.d.ts +30 -0
  577. package/lib/generated-client/models/search-hint-result.js +14 -0
  578. package/lib/generated-client/models/search-hint.d.ts +191 -0
  579. package/lib/generated-client/models/search-hint.js +14 -0
  580. package/lib/generated-client/models/seek-request-dto.d.ts +23 -0
  581. package/lib/generated-client/models/seek-request-dto.js +14 -0
  582. package/lib/generated-client/models/send-command-type.d.ts +21 -0
  583. package/lib/generated-client/models/send-command-type.js +27 -0
  584. package/lib/generated-client/models/send-command.d.ts +54 -0
  585. package/lib/generated-client/models/send-command.js +14 -0
  586. package/lib/generated-client/models/send-to-user-type.d.ts +20 -0
  587. package/lib/generated-client/models/send-to-user-type.js +26 -0
  588. package/lib/generated-client/models/series-info-remote-search-query.d.ts +42 -0
  589. package/lib/generated-client/models/series-info-remote-search-query.js +14 -0
  590. package/lib/generated-client/models/series-info.d.ts +85 -0
  591. package/lib/generated-client/models/series-info.js +14 -0
  592. package/lib/generated-client/models/series-status.d.ts +19 -0
  593. package/lib/generated-client/models/series-status.js +25 -0
  594. package/lib/generated-client/models/series-timer-info-dto-query-result.d.ts +36 -0
  595. package/lib/generated-client/models/series-timer-info-dto-query-result.js +14 -0
  596. package/lib/generated-client/models/series-timer-info-dto.d.ts +232 -0
  597. package/lib/generated-client/models/series-timer-info-dto.js +14 -0
  598. package/lib/generated-client/models/server-configuration.d.ts +310 -0
  599. package/lib/generated-client/models/server-configuration.js +14 -0
  600. package/lib/generated-client/models/server-discovery-info.d.ts +41 -0
  601. package/lib/generated-client/models/server-discovery-info.js +14 -0
  602. package/lib/generated-client/models/session-info.d.ts +199 -0
  603. package/lib/generated-client/models/session-info.js +14 -0
  604. package/lib/generated-client/models/session-message-type.d.ts +51 -0
  605. package/lib/generated-client/models/session-message-type.js +57 -0
  606. package/lib/generated-client/models/session-user-info.d.ts +29 -0
  607. package/lib/generated-client/models/session-user-info.js +14 -0
  608. package/lib/generated-client/models/set-channel-mapping-dto.d.ts +35 -0
  609. package/lib/generated-client/models/set-channel-mapping-dto.js +14 -0
  610. package/lib/generated-client/models/set-playlist-item-request-dto.d.ts +23 -0
  611. package/lib/generated-client/models/set-playlist-item-request-dto.js +14 -0
  612. package/lib/generated-client/models/set-repeat-mode-request-dto.d.ts +24 -0
  613. package/lib/generated-client/models/set-repeat-mode-request-dto.js +14 -0
  614. package/lib/generated-client/models/set-shuffle-mode-request-dto.d.ts +24 -0
  615. package/lib/generated-client/models/set-shuffle-mode-request-dto.js +14 -0
  616. package/lib/generated-client/models/song-info.d.ts +103 -0
  617. package/lib/generated-client/models/song-info.js +14 -0
  618. package/lib/generated-client/models/sort-order.d.ts +19 -0
  619. package/lib/generated-client/models/sort-order.js +25 -0
  620. package/lib/generated-client/models/special-view-option-dto.d.ts +29 -0
  621. package/lib/generated-client/models/special-view-option-dto.js +14 -0
  622. package/lib/generated-client/models/startup-configuration-dto.d.ts +35 -0
  623. package/lib/generated-client/models/startup-configuration-dto.js +14 -0
  624. package/lib/generated-client/models/startup-remote-access-dto.d.ts +29 -0
  625. package/lib/generated-client/models/startup-remote-access-dto.js +14 -0
  626. package/lib/generated-client/models/startup-user-dto.d.ts +29 -0
  627. package/lib/generated-client/models/startup-user-dto.js +14 -0
  628. package/lib/generated-client/models/subtitle-delivery-method.d.ts +22 -0
  629. package/lib/generated-client/models/subtitle-delivery-method.js +28 -0
  630. package/lib/generated-client/models/subtitle-options.d.ts +71 -0
  631. package/lib/generated-client/models/subtitle-options.js +14 -0
  632. package/lib/generated-client/models/subtitle-playback-mode.d.ts +22 -0
  633. package/lib/generated-client/models/subtitle-playback-mode.js +28 -0
  634. package/lib/generated-client/models/subtitle-profile.d.ts +48 -0
  635. package/lib/generated-client/models/subtitle-profile.js +14 -0
  636. package/lib/generated-client/models/sync-play-user-access-type.d.ts +20 -0
  637. package/lib/generated-client/models/sync-play-user-access-type.js +26 -0
  638. package/lib/generated-client/models/system-info.d.ts +177 -0
  639. package/lib/generated-client/models/system-info.js +14 -0
  640. package/lib/generated-client/models/task-completion-status.d.ts +21 -0
  641. package/lib/generated-client/models/task-completion-status.js +27 -0
  642. package/lib/generated-client/models/task-info.d.ts +80 -0
  643. package/lib/generated-client/models/task-info.js +14 -0
  644. package/lib/generated-client/models/task-result.d.ts +66 -0
  645. package/lib/generated-client/models/task-result.js +14 -0
  646. package/lib/generated-client/models/task-state.d.ts +20 -0
  647. package/lib/generated-client/models/task-state.js +26 -0
  648. package/lib/generated-client/models/task-trigger-info.d.ts +48 -0
  649. package/lib/generated-client/models/task-trigger-info.js +14 -0
  650. package/lib/generated-client/models/theme-media-result.d.ts +42 -0
  651. package/lib/generated-client/models/theme-media-result.js +14 -0
  652. package/lib/generated-client/models/timer-event-info.d.ts +29 -0
  653. package/lib/generated-client/models/timer-event-info.js +14 -0
  654. package/lib/generated-client/models/timer-info-dto-query-result.d.ts +36 -0
  655. package/lib/generated-client/models/timer-info-dto-query-result.js +14 -0
  656. package/lib/generated-client/models/timer-info-dto.d.ts +188 -0
  657. package/lib/generated-client/models/timer-info-dto.js +14 -0
  658. package/lib/generated-client/models/trailer-info-remote-search-query.d.ts +42 -0
  659. package/lib/generated-client/models/trailer-info-remote-search-query.js +14 -0
  660. package/lib/generated-client/models/trailer-info.d.ts +85 -0
  661. package/lib/generated-client/models/trailer-info.js +14 -0
  662. package/lib/generated-client/models/transcode-seek-info.d.ts +19 -0
  663. package/lib/generated-client/models/transcode-seek-info.js +25 -0
  664. package/lib/generated-client/models/transcoding-info.d.ts +127 -0
  665. package/lib/generated-client/models/transcoding-info.js +47 -0
  666. package/lib/generated-client/models/transcoding-profile.d.ts +117 -0
  667. package/lib/generated-client/models/transcoding-profile.js +14 -0
  668. package/lib/generated-client/models/transport-stream-timestamp.d.ts +20 -0
  669. package/lib/generated-client/models/transport-stream-timestamp.js +26 -0
  670. package/lib/generated-client/models/tuner-channel-mapping.d.ts +41 -0
  671. package/lib/generated-client/models/tuner-channel-mapping.js +14 -0
  672. package/lib/generated-client/models/tuner-host-info.d.ts +83 -0
  673. package/lib/generated-client/models/tuner-host-info.js +14 -0
  674. package/lib/generated-client/models/type-options.d.ts +54 -0
  675. package/lib/generated-client/models/type-options.js +14 -0
  676. package/lib/generated-client/models/unrated-item.d.ts +26 -0
  677. package/lib/generated-client/models/unrated-item.js +32 -0
  678. package/lib/generated-client/models/update-library-options-dto.d.ts +30 -0
  679. package/lib/generated-client/models/update-library-options-dto.js +14 -0
  680. package/lib/generated-client/models/update-media-path-request-dto.d.ts +30 -0
  681. package/lib/generated-client/models/update-media-path-request-dto.js +14 -0
  682. package/lib/generated-client/models/update-user-easy-password.d.ts +35 -0
  683. package/lib/generated-client/models/update-user-easy-password.js +14 -0
  684. package/lib/generated-client/models/update-user-password.d.ts +41 -0
  685. package/lib/generated-client/models/update-user-password.js +14 -0
  686. package/lib/generated-client/models/upload-subtitle-dto.d.ts +41 -0
  687. package/lib/generated-client/models/upload-subtitle-dto.js +14 -0
  688. package/lib/generated-client/models/user-configuration.d.ts +108 -0
  689. package/lib/generated-client/models/user-configuration.js +14 -0
  690. package/lib/generated-client/models/user-dto.d.ts +103 -0
  691. package/lib/generated-client/models/user-dto.js +14 -0
  692. package/lib/generated-client/models/user-item-data-dto.d.ts +83 -0
  693. package/lib/generated-client/models/user-item-data-dto.js +14 -0
  694. package/lib/generated-client/models/user-policy.d.ts +254 -0
  695. package/lib/generated-client/models/user-policy.js +14 -0
  696. package/lib/generated-client/models/utc-time-response.d.ts +29 -0
  697. package/lib/generated-client/models/utc-time-response.js +14 -0
  698. package/lib/generated-client/models/validate-path-dto.d.ts +35 -0
  699. package/lib/generated-client/models/validate-path-dto.js +14 -0
  700. package/lib/generated-client/models/version-info.d.ts +71 -0
  701. package/lib/generated-client/models/version-info.js +14 -0
  702. package/lib/generated-client/models/video-type.d.ts +21 -0
  703. package/lib/generated-client/models/video-type.js +27 -0
  704. package/lib/generated-client/models/video3-dformat.d.ts +22 -0
  705. package/lib/generated-client/models/video3-dformat.js +28 -0
  706. package/lib/generated-client/models/virtual-folder-info.d.ts +67 -0
  707. package/lib/generated-client/models/virtual-folder-info.js +14 -0
  708. package/lib/generated-client/models/wake-on-lan-info.d.ts +29 -0
  709. package/lib/generated-client/models/wake-on-lan-info.js +14 -0
  710. package/lib/generated-client/models/xbmc-metadata-options.d.ts +47 -0
  711. package/lib/generated-client/models/xbmc-metadata-options.js +14 -0
  712. package/lib/generated-client/models/xml-attribute.d.ts +29 -0
  713. package/lib/generated-client/models/xml-attribute.js +14 -0
  714. package/lib/index.d.ts +10 -0
  715. package/lib/index.js +39 -0
  716. package/lib/jellyfin.d.ts +33 -0
  717. package/lib/jellyfin.js +34 -0
  718. package/lib/models/api/image-request-parameters.d.ts +29 -0
  719. package/lib/models/api/image-request-parameters.js +7 -0
  720. package/lib/models/api/index.d.ts +7 -0
  721. package/lib/models/api/index.js +23 -0
  722. package/lib/models/api/item-sort-by.d.ts +40 -0
  723. package/lib/models/api/item-sort-by.js +44 -0
  724. package/lib/models/client-info.d.ts +12 -0
  725. package/lib/models/client-info.js +7 -0
  726. package/lib/models/device-info.d.ts +12 -0
  727. package/lib/models/device-info.js +7 -0
  728. package/lib/models/index.d.ts +9 -0
  729. package/lib/models/index.js +25 -0
  730. package/lib/models/recommended-server-info.d.ts +22 -0
  731. package/lib/models/recommended-server-info.js +16 -0
  732. package/lib/models/recommended-server-issue.d.ts +48 -0
  733. package/lib/models/recommended-server-issue.js +103 -0
  734. package/lib/utils/address-candidates.d.ts +16 -0
  735. package/lib/utils/address-candidates.js +85 -0
  736. package/lib/utils/api/activity-log-api.d.ts +8 -0
  737. package/lib/utils/api/activity-log-api.js +13 -0
  738. package/lib/utils/api/api-key-api.d.ts +8 -0
  739. package/lib/utils/api/api-key-api.js +13 -0
  740. package/lib/utils/api/artists-api.d.ts +8 -0
  741. package/lib/utils/api/artists-api.js +13 -0
  742. package/lib/utils/api/audio-api.d.ts +8 -0
  743. package/lib/utils/api/audio-api.js +13 -0
  744. package/lib/utils/api/branding-api.d.ts +8 -0
  745. package/lib/utils/api/branding-api.js +13 -0
  746. package/lib/utils/api/channels-api.d.ts +8 -0
  747. package/lib/utils/api/channels-api.js +13 -0
  748. package/lib/utils/api/client-log-api.d.ts +8 -0
  749. package/lib/utils/api/client-log-api.js +13 -0
  750. package/lib/utils/api/collection-api.d.ts +8 -0
  751. package/lib/utils/api/collection-api.js +13 -0
  752. package/lib/utils/api/configuration-api.d.ts +8 -0
  753. package/lib/utils/api/configuration-api.js +13 -0
  754. package/lib/utils/api/dashboard-api.d.ts +8 -0
  755. package/lib/utils/api/dashboard-api.js +13 -0
  756. package/lib/utils/api/devices-api.d.ts +8 -0
  757. package/lib/utils/api/devices-api.js +13 -0
  758. package/lib/utils/api/display-preferences-api.d.ts +8 -0
  759. package/lib/utils/api/display-preferences-api.js +13 -0
  760. package/lib/utils/api/dlna-api.d.ts +8 -0
  761. package/lib/utils/api/dlna-api.js +13 -0
  762. package/lib/utils/api/dlna-server-api.d.ts +8 -0
  763. package/lib/utils/api/dlna-server-api.js +13 -0
  764. package/lib/utils/api/dynamic-hls-api.d.ts +8 -0
  765. package/lib/utils/api/dynamic-hls-api.js +13 -0
  766. package/lib/utils/api/environment-api.d.ts +8 -0
  767. package/lib/utils/api/environment-api.js +13 -0
  768. package/lib/utils/api/filter-api.d.ts +8 -0
  769. package/lib/utils/api/filter-api.js +13 -0
  770. package/lib/utils/api/genres-api.d.ts +8 -0
  771. package/lib/utils/api/genres-api.js +13 -0
  772. package/lib/utils/api/hls-segment-api.d.ts +8 -0
  773. package/lib/utils/api/hls-segment-api.js +13 -0
  774. package/lib/utils/api/image-api.d.ts +8 -0
  775. package/lib/utils/api/image-api.js +13 -0
  776. package/lib/utils/api/image-by-name-api.d.ts +8 -0
  777. package/lib/utils/api/image-by-name-api.js +13 -0
  778. package/lib/utils/api/instant-mix-api.d.ts +8 -0
  779. package/lib/utils/api/instant-mix-api.js +13 -0
  780. package/lib/utils/api/item-lookup-api.d.ts +8 -0
  781. package/lib/utils/api/item-lookup-api.js +13 -0
  782. package/lib/utils/api/item-refresh-api.d.ts +8 -0
  783. package/lib/utils/api/item-refresh-api.js +13 -0
  784. package/lib/utils/api/item-update-api.d.ts +8 -0
  785. package/lib/utils/api/item-update-api.js +13 -0
  786. package/lib/utils/api/items-api.d.ts +8 -0
  787. package/lib/utils/api/items-api.js +13 -0
  788. package/lib/utils/api/library-api.d.ts +8 -0
  789. package/lib/utils/api/library-api.js +13 -0
  790. package/lib/utils/api/library-structure-api.d.ts +8 -0
  791. package/lib/utils/api/library-structure-api.js +13 -0
  792. package/lib/utils/api/live-tv-api.d.ts +8 -0
  793. package/lib/utils/api/live-tv-api.js +13 -0
  794. package/lib/utils/api/localization-api.d.ts +8 -0
  795. package/lib/utils/api/localization-api.js +13 -0
  796. package/lib/utils/api/media-info-api.d.ts +8 -0
  797. package/lib/utils/api/media-info-api.js +13 -0
  798. package/lib/utils/api/movies-api.d.ts +8 -0
  799. package/lib/utils/api/movies-api.js +13 -0
  800. package/lib/utils/api/music-genres-api.d.ts +8 -0
  801. package/lib/utils/api/music-genres-api.js +13 -0
  802. package/lib/utils/api/notifications-api.d.ts +8 -0
  803. package/lib/utils/api/notifications-api.js +13 -0
  804. package/lib/utils/api/package-api.d.ts +8 -0
  805. package/lib/utils/api/package-api.js +13 -0
  806. package/lib/utils/api/persons-api.d.ts +8 -0
  807. package/lib/utils/api/persons-api.js +13 -0
  808. package/lib/utils/api/playlists-api.d.ts +8 -0
  809. package/lib/utils/api/playlists-api.js +13 -0
  810. package/lib/utils/api/playstate-api.d.ts +8 -0
  811. package/lib/utils/api/playstate-api.js +13 -0
  812. package/lib/utils/api/plugins-api.d.ts +8 -0
  813. package/lib/utils/api/plugins-api.js +13 -0
  814. package/lib/utils/api/quick-connect-api.d.ts +8 -0
  815. package/lib/utils/api/quick-connect-api.js +13 -0
  816. package/lib/utils/api/remote-image-api.d.ts +8 -0
  817. package/lib/utils/api/remote-image-api.js +13 -0
  818. package/lib/utils/api/scheduled-tasks-api.d.ts +8 -0
  819. package/lib/utils/api/scheduled-tasks-api.js +13 -0
  820. package/lib/utils/api/search-api.d.ts +8 -0
  821. package/lib/utils/api/search-api.js +13 -0
  822. package/lib/utils/api/session-api.d.ts +8 -0
  823. package/lib/utils/api/session-api.js +13 -0
  824. package/lib/utils/api/startup-api.d.ts +8 -0
  825. package/lib/utils/api/startup-api.js +13 -0
  826. package/lib/utils/api/studios-api.d.ts +8 -0
  827. package/lib/utils/api/studios-api.js +13 -0
  828. package/lib/utils/api/subtitle-api.d.ts +8 -0
  829. package/lib/utils/api/subtitle-api.js +13 -0
  830. package/lib/utils/api/suggestions-api.d.ts +8 -0
  831. package/lib/utils/api/suggestions-api.js +13 -0
  832. package/lib/utils/api/sync-play-api.d.ts +8 -0
  833. package/lib/utils/api/sync-play-api.js +13 -0
  834. package/lib/utils/api/system-api.d.ts +8 -0
  835. package/lib/utils/api/system-api.js +13 -0
  836. package/lib/utils/api/time-sync-api.d.ts +8 -0
  837. package/lib/utils/api/time-sync-api.js +13 -0
  838. package/lib/utils/api/tmdb-api.d.ts +8 -0
  839. package/lib/utils/api/tmdb-api.js +13 -0
  840. package/lib/utils/api/trailers-api.d.ts +8 -0
  841. package/lib/utils/api/trailers-api.js +13 -0
  842. package/lib/utils/api/tv-shows-api.d.ts +8 -0
  843. package/lib/utils/api/tv-shows-api.js +13 -0
  844. package/lib/utils/api/universal-audio-api.d.ts +8 -0
  845. package/lib/utils/api/universal-audio-api.js +13 -0
  846. package/lib/utils/api/user-api.d.ts +8 -0
  847. package/lib/utils/api/user-api.js +13 -0
  848. package/lib/utils/api/user-library-api.d.ts +8 -0
  849. package/lib/utils/api/user-library-api.js +13 -0
  850. package/lib/utils/api/user-views-api.d.ts +8 -0
  851. package/lib/utils/api/user-views-api.js +13 -0
  852. package/lib/utils/api/video-attachments-api.d.ts +8 -0
  853. package/lib/utils/api/video-attachments-api.js +13 -0
  854. package/lib/utils/api/videos-api.d.ts +8 -0
  855. package/lib/utils/api/videos-api.js +13 -0
  856. package/lib/utils/api/years-api.d.ts +8 -0
  857. package/lib/utils/api/years-api.js +13 -0
  858. package/lib/utils/authentication.d.ts +10 -0
  859. package/lib/utils/authentication.js +18 -0
  860. package/lib/utils/browser-profiles.d.ts +25 -0
  861. package/lib/utils/browser-profiles.js +44 -0
  862. package/lib/utils/index.d.ts +9 -0
  863. package/lib/utils/index.js +25 -0
  864. package/lib/utils/normalize-url.d.ts +20 -0
  865. package/lib/utils/normalize-url.js +96 -0
  866. package/lib/utils/url.d.ts +31 -0
  867. package/lib/utils/url.js +54 -0
  868. package/openapi-templates/licenseInfo.mustache +10 -0
  869. package/package.json +46 -0
  870. package/tsconfig.json +25 -0
@@ -0,0 +1,1824 @@
1
+ /**
2
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
3
+ * Do not edit the class manually.
4
+ *
5
+ * Jellyfin API
6
+ *
7
+ * This Source Code Form is subject to the terms of the Mozilla Public
8
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
9
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
10
+ */
11
+ import { AxiosPromise, AxiosInstance } from 'axios';
12
+ import { Configuration } from '../configuration';
13
+ import { RequestArgs, BaseAPI } from '../base';
14
+ import { BaseItemDtoQueryResult } from '../models';
15
+ import { BaseItemKind } from '../models';
16
+ import { ImageType } from '../models';
17
+ import { ItemFields } from '../models';
18
+ import { ItemFilter } from '../models';
19
+ import { LocationType } from '../models';
20
+ import { SeriesStatus } from '../models';
21
+ import { SortOrder } from '../models';
22
+ import { VideoType } from '../models';
23
+ /**
24
+ * ItemsApi - axios parameter creator
25
+ * @export
26
+ */
27
+ export declare const ItemsApiAxiosParamCreator: (configuration?: Configuration) => {
28
+ /**
29
+ *
30
+ * @summary Gets items based on a query.
31
+ * @param {string} [userId] The user id supplied as query parameter.
32
+ * @param {string} [maxOfficialRating] Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).
33
+ * @param {boolean} [hasThemeSong] Optional filter by items with theme songs.
34
+ * @param {boolean} [hasThemeVideo] Optional filter by items with theme videos.
35
+ * @param {boolean} [hasSubtitles] Optional filter by items with subtitles.
36
+ * @param {boolean} [hasSpecialFeature] Optional filter by items with special features.
37
+ * @param {boolean} [hasTrailer] Optional filter by items with trailers.
38
+ * @param {string} [adjacentTo] Optional. Return items that are siblings of a supplied item.
39
+ * @param {number} [parentIndexNumber] Optional filter by parent index number.
40
+ * @param {boolean} [hasParentalRating] Optional filter by items that have or do not have a parental rating.
41
+ * @param {boolean} [isHd] Optional filter by items that are HD or not.
42
+ * @param {boolean} [is4K] Optional filter by items that are 4K or not.
43
+ * @param {Array<LocationType>} [locationTypes] Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimited.
44
+ * @param {Array<LocationType>} [excludeLocationTypes] Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimited.
45
+ * @param {boolean} [isMissing] Optional filter by items that are missing episodes or not.
46
+ * @param {boolean} [isUnaired] Optional filter by items that are unaired episodes or not.
47
+ * @param {number} [minCommunityRating] Optional filter by minimum community rating.
48
+ * @param {number} [minCriticRating] Optional filter by minimum critic rating.
49
+ * @param {string} [minPremiereDate] Optional. The minimum premiere date. Format &#x3D; ISO.
50
+ * @param {string} [minDateLastSaved] Optional. The minimum last saved date. Format &#x3D; ISO.
51
+ * @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format &#x3D; ISO.
52
+ * @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format &#x3D; ISO.
53
+ * @param {boolean} [hasOverview] Optional filter by items that have an overview or not.
54
+ * @param {boolean} [hasImdbId] Optional filter by items that have an imdb id or not.
55
+ * @param {boolean} [hasTmdbId] Optional filter by items that have a tmdb id or not.
56
+ * @param {boolean} [hasTvdbId] Optional filter by items that have a tvdb id or not.
57
+ * @param {boolean} [isMovie] Optional filter for live tv movies.
58
+ * @param {boolean} [isSeries] Optional filter for live tv series.
59
+ * @param {boolean} [isNews] Optional filter for live tv news.
60
+ * @param {boolean} [isKids] Optional filter for live tv kids.
61
+ * @param {boolean} [isSports] Optional filter for live tv sports.
62
+ * @param {Array<string>} [excludeItemIds] Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited.
63
+ * @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results.
64
+ * @param {number} [limit] Optional. The maximum number of records to return.
65
+ * @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false.
66
+ * @param {string} [searchTerm] Optional. Filter based on a search term.
67
+ * @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
68
+ * @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
69
+ * @param {Array<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines.
70
+ * @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
71
+ * @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.
72
+ * @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.
73
+ * @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
74
+ * @param {Array<string>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
75
+ * @param {Array<ImageType>} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
76
+ * @param {Array<string>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
77
+ * @param {boolean} [isPlayed] Optional filter by items that are played, or not.
78
+ * @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
79
+ * @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
80
+ * @param {Array<string>} [tags] Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.
81
+ * @param {Array<number>} [years] Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.
82
+ * @param {boolean} [enableUserData] Optional, include user data.
83
+ * @param {number} [imageTypeLimit] Optional, the max number of images to return, per image type.
84
+ * @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output.
85
+ * @param {string} [person] Optional. If specified, results will be filtered to include only those containing the specified person.
86
+ * @param {Array<string>} [personIds] Optional. If specified, results will be filtered to include only those containing the specified person id.
87
+ * @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.
88
+ * @param {Array<string>} [studios] Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.
89
+ * @param {Array<string>} [artists] Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited.
90
+ * @param {Array<string>} [excludeArtistIds] Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited.
91
+ * @param {Array<string>} [artistIds] Optional. If specified, results will be filtered to include only those containing the specified artist id.
92
+ * @param {Array<string>} [albumArtistIds] Optional. If specified, results will be filtered to include only those containing the specified album artist id.
93
+ * @param {Array<string>} [contributingArtistIds] Optional. If specified, results will be filtered to include only those containing the specified contributing artist id.
94
+ * @param {Array<string>} [albums] Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited.
95
+ * @param {Array<string>} [albumIds] Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited.
96
+ * @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.
97
+ * @param {Array<VideoType>} [videoTypes] Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimited.
98
+ * @param {string} [minOfficialRating] Optional filter by minimum official rating (PG, PG-13, TV-MA, etc).
99
+ * @param {boolean} [isLocked] Optional filter by items that are locked.
100
+ * @param {boolean} [isPlaceHolder] Optional filter by items that are placeholders.
101
+ * @param {boolean} [hasOfficialRating] Optional filter by items that have official ratings.
102
+ * @param {boolean} [collapseBoxSetItems] Whether or not to hide items behind their boxsets.
103
+ * @param {number} [minWidth] Optional. Filter by the minimum width of the item.
104
+ * @param {number} [minHeight] Optional. Filter by the minimum height of the item.
105
+ * @param {number} [maxWidth] Optional. Filter by the maximum width of the item.
106
+ * @param {number} [maxHeight] Optional. Filter by the maximum height of the item.
107
+ * @param {boolean} [is3D] Optional filter by items that are 3D, or not.
108
+ * @param {Array<SeriesStatus>} [seriesStatus] Optional filter by Series Status. Allows multiple, comma delimited.
109
+ * @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string.
110
+ * @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string.
111
+ * @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string.
112
+ * @param {Array<string>} [studioIds] Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.
113
+ * @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
114
+ * @param {boolean} [enableTotalRecordCount] Optional. Enable the total record count.
115
+ * @param {boolean} [enableImages] Optional, include image information in output.
116
+ * @param {*} [options] Override http request option.
117
+ * @throws {RequiredError}
118
+ */
119
+ getItems: (userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: Array<LocationType>, excludeLocationTypes?: Array<LocationType>, isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, excludeItemIds?: Array<string>, startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: Array<SortOrder>, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<string>, imageTypes?: Array<ImageType>, sortBy?: Array<string>, isPlayed?: boolean, genres?: Array<string>, officialRatings?: Array<string>, tags?: Array<string>, years?: Array<number>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, person?: string, personIds?: Array<string>, personTypes?: Array<string>, studios?: Array<string>, artists?: Array<string>, excludeArtistIds?: Array<string>, artistIds?: Array<string>, albumArtistIds?: Array<string>, contributingArtistIds?: Array<string>, albums?: Array<string>, albumIds?: Array<string>, ids?: Array<string>, videoTypes?: Array<VideoType>, minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: Array<SeriesStatus>, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: Array<string>, genreIds?: Array<string>, enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any) => Promise<RequestArgs>;
120
+ /**
121
+ *
122
+ * @summary Gets items based on a query.
123
+ * @param {string} userId The user id supplied as query parameter.
124
+ * @param {string} [maxOfficialRating] Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).
125
+ * @param {boolean} [hasThemeSong] Optional filter by items with theme songs.
126
+ * @param {boolean} [hasThemeVideo] Optional filter by items with theme videos.
127
+ * @param {boolean} [hasSubtitles] Optional filter by items with subtitles.
128
+ * @param {boolean} [hasSpecialFeature] Optional filter by items with special features.
129
+ * @param {boolean} [hasTrailer] Optional filter by items with trailers.
130
+ * @param {string} [adjacentTo] Optional. Return items that are siblings of a supplied item.
131
+ * @param {number} [parentIndexNumber] Optional filter by parent index number.
132
+ * @param {boolean} [hasParentalRating] Optional filter by items that have or do not have a parental rating.
133
+ * @param {boolean} [isHd] Optional filter by items that are HD or not.
134
+ * @param {boolean} [is4K] Optional filter by items that are 4K or not.
135
+ * @param {Array<LocationType>} [locationTypes] Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimited.
136
+ * @param {Array<LocationType>} [excludeLocationTypes] Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimited.
137
+ * @param {boolean} [isMissing] Optional filter by items that are missing episodes or not.
138
+ * @param {boolean} [isUnaired] Optional filter by items that are unaired episodes or not.
139
+ * @param {number} [minCommunityRating] Optional filter by minimum community rating.
140
+ * @param {number} [minCriticRating] Optional filter by minimum critic rating.
141
+ * @param {string} [minPremiereDate] Optional. The minimum premiere date. Format &#x3D; ISO.
142
+ * @param {string} [minDateLastSaved] Optional. The minimum last saved date. Format &#x3D; ISO.
143
+ * @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format &#x3D; ISO.
144
+ * @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format &#x3D; ISO.
145
+ * @param {boolean} [hasOverview] Optional filter by items that have an overview or not.
146
+ * @param {boolean} [hasImdbId] Optional filter by items that have an imdb id or not.
147
+ * @param {boolean} [hasTmdbId] Optional filter by items that have a tmdb id or not.
148
+ * @param {boolean} [hasTvdbId] Optional filter by items that have a tvdb id or not.
149
+ * @param {boolean} [isMovie] Optional filter for live tv movies.
150
+ * @param {boolean} [isSeries] Optional filter for live tv series.
151
+ * @param {boolean} [isNews] Optional filter for live tv news.
152
+ * @param {boolean} [isKids] Optional filter for live tv kids.
153
+ * @param {boolean} [isSports] Optional filter for live tv sports.
154
+ * @param {Array<string>} [excludeItemIds] Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited.
155
+ * @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results.
156
+ * @param {number} [limit] Optional. The maximum number of records to return.
157
+ * @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false.
158
+ * @param {string} [searchTerm] Optional. Filter based on a search term.
159
+ * @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
160
+ * @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
161
+ * @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.
162
+ * @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
163
+ * @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.
164
+ * @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.
165
+ * @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
166
+ * @param {Array<string>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
167
+ * @param {Array<ImageType>} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
168
+ * @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.
169
+ * @param {boolean} [isPlayed] Optional filter by items that are played, or not.
170
+ * @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
171
+ * @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
172
+ * @param {Array<string>} [tags] Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.
173
+ * @param {Array<number>} [years] Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.
174
+ * @param {boolean} [enableUserData] Optional, include user data.
175
+ * @param {number} [imageTypeLimit] Optional, the max number of images to return, per image type.
176
+ * @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output.
177
+ * @param {string} [person] Optional. If specified, results will be filtered to include only those containing the specified person.
178
+ * @param {Array<string>} [personIds] Optional. If specified, results will be filtered to include only those containing the specified person id.
179
+ * @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.
180
+ * @param {Array<string>} [studios] Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.
181
+ * @param {Array<string>} [artists] Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited.
182
+ * @param {Array<string>} [excludeArtistIds] Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited.
183
+ * @param {Array<string>} [artistIds] Optional. If specified, results will be filtered to include only those containing the specified artist id.
184
+ * @param {Array<string>} [albumArtistIds] Optional. If specified, results will be filtered to include only those containing the specified album artist id.
185
+ * @param {Array<string>} [contributingArtistIds] Optional. If specified, results will be filtered to include only those containing the specified contributing artist id.
186
+ * @param {Array<string>} [albums] Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited.
187
+ * @param {Array<string>} [albumIds] Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited.
188
+ * @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.
189
+ * @param {Array<VideoType>} [videoTypes] Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimited.
190
+ * @param {string} [minOfficialRating] Optional filter by minimum official rating (PG, PG-13, TV-MA, etc).
191
+ * @param {boolean} [isLocked] Optional filter by items that are locked.
192
+ * @param {boolean} [isPlaceHolder] Optional filter by items that are placeholders.
193
+ * @param {boolean} [hasOfficialRating] Optional filter by items that have official ratings.
194
+ * @param {boolean} [collapseBoxSetItems] Whether or not to hide items behind their boxsets.
195
+ * @param {number} [minWidth] Optional. Filter by the minimum width of the item.
196
+ * @param {number} [minHeight] Optional. Filter by the minimum height of the item.
197
+ * @param {number} [maxWidth] Optional. Filter by the maximum width of the item.
198
+ * @param {number} [maxHeight] Optional. Filter by the maximum height of the item.
199
+ * @param {boolean} [is3D] Optional filter by items that are 3D, or not.
200
+ * @param {Array<SeriesStatus>} [seriesStatus] Optional filter by Series Status. Allows multiple, comma delimited.
201
+ * @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string.
202
+ * @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string.
203
+ * @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string.
204
+ * @param {Array<string>} [studioIds] Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.
205
+ * @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
206
+ * @param {boolean} [enableTotalRecordCount] Optional. Enable the total record count.
207
+ * @param {boolean} [enableImages] Optional, include image information in output.
208
+ * @param {*} [options] Override http request option.
209
+ * @throws {RequiredError}
210
+ */
211
+ getItemsByUserId: (userId: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: Array<LocationType>, excludeLocationTypes?: Array<LocationType>, isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, excludeItemIds?: Array<string>, startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: Array<SortOrder>, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<string>, imageTypes?: Array<ImageType>, sortBy?: Array<string>, isPlayed?: boolean, genres?: Array<string>, officialRatings?: Array<string>, tags?: Array<string>, years?: Array<number>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, person?: string, personIds?: Array<string>, personTypes?: Array<string>, studios?: Array<string>, artists?: Array<string>, excludeArtistIds?: Array<string>, artistIds?: Array<string>, albumArtistIds?: Array<string>, contributingArtistIds?: Array<string>, albums?: Array<string>, albumIds?: Array<string>, ids?: Array<string>, videoTypes?: Array<VideoType>, minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: Array<SeriesStatus>, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: Array<string>, genreIds?: Array<string>, enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any) => Promise<RequestArgs>;
212
+ /**
213
+ *
214
+ * @summary Gets items based on a query.
215
+ * @param {string} userId The user id.
216
+ * @param {number} [startIndex] The start index.
217
+ * @param {number} [limit] The item limit.
218
+ * @param {string} [searchTerm] The search term.
219
+ * @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
220
+ * @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.
221
+ * @param {Array<string>} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited.
222
+ * @param {boolean} [enableUserData] Optional. Include user data.
223
+ * @param {number} [imageTypeLimit] Optional. The max number of images to return, per image type.
224
+ * @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output.
225
+ * @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
226
+ * @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.
227
+ * @param {boolean} [enableTotalRecordCount] Optional. Enable the total record count.
228
+ * @param {boolean} [enableImages] Optional. Include image information in output.
229
+ * @param {boolean} [excludeActiveSessions] Optional. Whether to exclude the currently active sessions.
230
+ * @param {*} [options] Override http request option.
231
+ * @throws {RequiredError}
232
+ */
233
+ getResumeItems: (userId: string, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, mediaTypes?: Array<string>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, enableTotalRecordCount?: boolean, enableImages?: boolean, excludeActiveSessions?: boolean, options?: any) => Promise<RequestArgs>;
234
+ };
235
+ /**
236
+ * ItemsApi - functional programming interface
237
+ * @export
238
+ */
239
+ export declare const ItemsApiFp: (configuration?: Configuration) => {
240
+ /**
241
+ *
242
+ * @summary Gets items based on a query.
243
+ * @param {string} [userId] The user id supplied as query parameter.
244
+ * @param {string} [maxOfficialRating] Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).
245
+ * @param {boolean} [hasThemeSong] Optional filter by items with theme songs.
246
+ * @param {boolean} [hasThemeVideo] Optional filter by items with theme videos.
247
+ * @param {boolean} [hasSubtitles] Optional filter by items with subtitles.
248
+ * @param {boolean} [hasSpecialFeature] Optional filter by items with special features.
249
+ * @param {boolean} [hasTrailer] Optional filter by items with trailers.
250
+ * @param {string} [adjacentTo] Optional. Return items that are siblings of a supplied item.
251
+ * @param {number} [parentIndexNumber] Optional filter by parent index number.
252
+ * @param {boolean} [hasParentalRating] Optional filter by items that have or do not have a parental rating.
253
+ * @param {boolean} [isHd] Optional filter by items that are HD or not.
254
+ * @param {boolean} [is4K] Optional filter by items that are 4K or not.
255
+ * @param {Array<LocationType>} [locationTypes] Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimited.
256
+ * @param {Array<LocationType>} [excludeLocationTypes] Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimited.
257
+ * @param {boolean} [isMissing] Optional filter by items that are missing episodes or not.
258
+ * @param {boolean} [isUnaired] Optional filter by items that are unaired episodes or not.
259
+ * @param {number} [minCommunityRating] Optional filter by minimum community rating.
260
+ * @param {number} [minCriticRating] Optional filter by minimum critic rating.
261
+ * @param {string} [minPremiereDate] Optional. The minimum premiere date. Format &#x3D; ISO.
262
+ * @param {string} [minDateLastSaved] Optional. The minimum last saved date. Format &#x3D; ISO.
263
+ * @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format &#x3D; ISO.
264
+ * @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format &#x3D; ISO.
265
+ * @param {boolean} [hasOverview] Optional filter by items that have an overview or not.
266
+ * @param {boolean} [hasImdbId] Optional filter by items that have an imdb id or not.
267
+ * @param {boolean} [hasTmdbId] Optional filter by items that have a tmdb id or not.
268
+ * @param {boolean} [hasTvdbId] Optional filter by items that have a tvdb id or not.
269
+ * @param {boolean} [isMovie] Optional filter for live tv movies.
270
+ * @param {boolean} [isSeries] Optional filter for live tv series.
271
+ * @param {boolean} [isNews] Optional filter for live tv news.
272
+ * @param {boolean} [isKids] Optional filter for live tv kids.
273
+ * @param {boolean} [isSports] Optional filter for live tv sports.
274
+ * @param {Array<string>} [excludeItemIds] Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited.
275
+ * @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results.
276
+ * @param {number} [limit] Optional. The maximum number of records to return.
277
+ * @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false.
278
+ * @param {string} [searchTerm] Optional. Filter based on a search term.
279
+ * @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
280
+ * @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
281
+ * @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.
282
+ * @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
283
+ * @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.
284
+ * @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.
285
+ * @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
286
+ * @param {Array<string>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
287
+ * @param {Array<ImageType>} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
288
+ * @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.
289
+ * @param {boolean} [isPlayed] Optional filter by items that are played, or not.
290
+ * @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
291
+ * @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
292
+ * @param {Array<string>} [tags] Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.
293
+ * @param {Array<number>} [years] Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.
294
+ * @param {boolean} [enableUserData] Optional, include user data.
295
+ * @param {number} [imageTypeLimit] Optional, the max number of images to return, per image type.
296
+ * @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output.
297
+ * @param {string} [person] Optional. If specified, results will be filtered to include only those containing the specified person.
298
+ * @param {Array<string>} [personIds] Optional. If specified, results will be filtered to include only those containing the specified person id.
299
+ * @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.
300
+ * @param {Array<string>} [studios] Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.
301
+ * @param {Array<string>} [artists] Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited.
302
+ * @param {Array<string>} [excludeArtistIds] Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited.
303
+ * @param {Array<string>} [artistIds] Optional. If specified, results will be filtered to include only those containing the specified artist id.
304
+ * @param {Array<string>} [albumArtistIds] Optional. If specified, results will be filtered to include only those containing the specified album artist id.
305
+ * @param {Array<string>} [contributingArtistIds] Optional. If specified, results will be filtered to include only those containing the specified contributing artist id.
306
+ * @param {Array<string>} [albums] Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited.
307
+ * @param {Array<string>} [albumIds] Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited.
308
+ * @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.
309
+ * @param {Array<VideoType>} [videoTypes] Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimited.
310
+ * @param {string} [minOfficialRating] Optional filter by minimum official rating (PG, PG-13, TV-MA, etc).
311
+ * @param {boolean} [isLocked] Optional filter by items that are locked.
312
+ * @param {boolean} [isPlaceHolder] Optional filter by items that are placeholders.
313
+ * @param {boolean} [hasOfficialRating] Optional filter by items that have official ratings.
314
+ * @param {boolean} [collapseBoxSetItems] Whether or not to hide items behind their boxsets.
315
+ * @param {number} [minWidth] Optional. Filter by the minimum width of the item.
316
+ * @param {number} [minHeight] Optional. Filter by the minimum height of the item.
317
+ * @param {number} [maxWidth] Optional. Filter by the maximum width of the item.
318
+ * @param {number} [maxHeight] Optional. Filter by the maximum height of the item.
319
+ * @param {boolean} [is3D] Optional filter by items that are 3D, or not.
320
+ * @param {Array<SeriesStatus>} [seriesStatus] Optional filter by Series Status. Allows multiple, comma delimited.
321
+ * @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string.
322
+ * @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string.
323
+ * @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string.
324
+ * @param {Array<string>} [studioIds] Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.
325
+ * @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
326
+ * @param {boolean} [enableTotalRecordCount] Optional. Enable the total record count.
327
+ * @param {boolean} [enableImages] Optional, include image information in output.
328
+ * @param {*} [options] Override http request option.
329
+ * @throws {RequiredError}
330
+ */
331
+ getItems(userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: Array<LocationType>, excludeLocationTypes?: Array<LocationType>, isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, excludeItemIds?: Array<string>, startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: Array<SortOrder>, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<string>, imageTypes?: Array<ImageType>, sortBy?: Array<string>, isPlayed?: boolean, genres?: Array<string>, officialRatings?: Array<string>, tags?: Array<string>, years?: Array<number>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, person?: string, personIds?: Array<string>, personTypes?: Array<string>, studios?: Array<string>, artists?: Array<string>, excludeArtistIds?: Array<string>, artistIds?: Array<string>, albumArtistIds?: Array<string>, contributingArtistIds?: Array<string>, albums?: Array<string>, albumIds?: Array<string>, ids?: Array<string>, videoTypes?: Array<VideoType>, minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: Array<SeriesStatus>, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: Array<string>, genreIds?: Array<string>, enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>;
332
+ /**
333
+ *
334
+ * @summary Gets items based on a query.
335
+ * @param {string} userId The user id supplied as query parameter.
336
+ * @param {string} [maxOfficialRating] Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).
337
+ * @param {boolean} [hasThemeSong] Optional filter by items with theme songs.
338
+ * @param {boolean} [hasThemeVideo] Optional filter by items with theme videos.
339
+ * @param {boolean} [hasSubtitles] Optional filter by items with subtitles.
340
+ * @param {boolean} [hasSpecialFeature] Optional filter by items with special features.
341
+ * @param {boolean} [hasTrailer] Optional filter by items with trailers.
342
+ * @param {string} [adjacentTo] Optional. Return items that are siblings of a supplied item.
343
+ * @param {number} [parentIndexNumber] Optional filter by parent index number.
344
+ * @param {boolean} [hasParentalRating] Optional filter by items that have or do not have a parental rating.
345
+ * @param {boolean} [isHd] Optional filter by items that are HD or not.
346
+ * @param {boolean} [is4K] Optional filter by items that are 4K or not.
347
+ * @param {Array<LocationType>} [locationTypes] Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimited.
348
+ * @param {Array<LocationType>} [excludeLocationTypes] Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimited.
349
+ * @param {boolean} [isMissing] Optional filter by items that are missing episodes or not.
350
+ * @param {boolean} [isUnaired] Optional filter by items that are unaired episodes or not.
351
+ * @param {number} [minCommunityRating] Optional filter by minimum community rating.
352
+ * @param {number} [minCriticRating] Optional filter by minimum critic rating.
353
+ * @param {string} [minPremiereDate] Optional. The minimum premiere date. Format &#x3D; ISO.
354
+ * @param {string} [minDateLastSaved] Optional. The minimum last saved date. Format &#x3D; ISO.
355
+ * @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format &#x3D; ISO.
356
+ * @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format &#x3D; ISO.
357
+ * @param {boolean} [hasOverview] Optional filter by items that have an overview or not.
358
+ * @param {boolean} [hasImdbId] Optional filter by items that have an imdb id or not.
359
+ * @param {boolean} [hasTmdbId] Optional filter by items that have a tmdb id or not.
360
+ * @param {boolean} [hasTvdbId] Optional filter by items that have a tvdb id or not.
361
+ * @param {boolean} [isMovie] Optional filter for live tv movies.
362
+ * @param {boolean} [isSeries] Optional filter for live tv series.
363
+ * @param {boolean} [isNews] Optional filter for live tv news.
364
+ * @param {boolean} [isKids] Optional filter for live tv kids.
365
+ * @param {boolean} [isSports] Optional filter for live tv sports.
366
+ * @param {Array<string>} [excludeItemIds] Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited.
367
+ * @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results.
368
+ * @param {number} [limit] Optional. The maximum number of records to return.
369
+ * @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false.
370
+ * @param {string} [searchTerm] Optional. Filter based on a search term.
371
+ * @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
372
+ * @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
373
+ * @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.
374
+ * @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
375
+ * @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.
376
+ * @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.
377
+ * @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
378
+ * @param {Array<string>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
379
+ * @param {Array<ImageType>} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
380
+ * @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.
381
+ * @param {boolean} [isPlayed] Optional filter by items that are played, or not.
382
+ * @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
383
+ * @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
384
+ * @param {Array<string>} [tags] Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.
385
+ * @param {Array<number>} [years] Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.
386
+ * @param {boolean} [enableUserData] Optional, include user data.
387
+ * @param {number} [imageTypeLimit] Optional, the max number of images to return, per image type.
388
+ * @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output.
389
+ * @param {string} [person] Optional. If specified, results will be filtered to include only those containing the specified person.
390
+ * @param {Array<string>} [personIds] Optional. If specified, results will be filtered to include only those containing the specified person id.
391
+ * @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.
392
+ * @param {Array<string>} [studios] Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.
393
+ * @param {Array<string>} [artists] Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited.
394
+ * @param {Array<string>} [excludeArtistIds] Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited.
395
+ * @param {Array<string>} [artistIds] Optional. If specified, results will be filtered to include only those containing the specified artist id.
396
+ * @param {Array<string>} [albumArtistIds] Optional. If specified, results will be filtered to include only those containing the specified album artist id.
397
+ * @param {Array<string>} [contributingArtistIds] Optional. If specified, results will be filtered to include only those containing the specified contributing artist id.
398
+ * @param {Array<string>} [albums] Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited.
399
+ * @param {Array<string>} [albumIds] Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited.
400
+ * @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.
401
+ * @param {Array<VideoType>} [videoTypes] Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimited.
402
+ * @param {string} [minOfficialRating] Optional filter by minimum official rating (PG, PG-13, TV-MA, etc).
403
+ * @param {boolean} [isLocked] Optional filter by items that are locked.
404
+ * @param {boolean} [isPlaceHolder] Optional filter by items that are placeholders.
405
+ * @param {boolean} [hasOfficialRating] Optional filter by items that have official ratings.
406
+ * @param {boolean} [collapseBoxSetItems] Whether or not to hide items behind their boxsets.
407
+ * @param {number} [minWidth] Optional. Filter by the minimum width of the item.
408
+ * @param {number} [minHeight] Optional. Filter by the minimum height of the item.
409
+ * @param {number} [maxWidth] Optional. Filter by the maximum width of the item.
410
+ * @param {number} [maxHeight] Optional. Filter by the maximum height of the item.
411
+ * @param {boolean} [is3D] Optional filter by items that are 3D, or not.
412
+ * @param {Array<SeriesStatus>} [seriesStatus] Optional filter by Series Status. Allows multiple, comma delimited.
413
+ * @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string.
414
+ * @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string.
415
+ * @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string.
416
+ * @param {Array<string>} [studioIds] Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.
417
+ * @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
418
+ * @param {boolean} [enableTotalRecordCount] Optional. Enable the total record count.
419
+ * @param {boolean} [enableImages] Optional, include image information in output.
420
+ * @param {*} [options] Override http request option.
421
+ * @throws {RequiredError}
422
+ */
423
+ getItemsByUserId(userId: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: Array<LocationType>, excludeLocationTypes?: Array<LocationType>, isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, excludeItemIds?: Array<string>, startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: Array<SortOrder>, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<string>, imageTypes?: Array<ImageType>, sortBy?: Array<string>, isPlayed?: boolean, genres?: Array<string>, officialRatings?: Array<string>, tags?: Array<string>, years?: Array<number>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, person?: string, personIds?: Array<string>, personTypes?: Array<string>, studios?: Array<string>, artists?: Array<string>, excludeArtistIds?: Array<string>, artistIds?: Array<string>, albumArtistIds?: Array<string>, contributingArtistIds?: Array<string>, albums?: Array<string>, albumIds?: Array<string>, ids?: Array<string>, videoTypes?: Array<VideoType>, minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: Array<SeriesStatus>, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: Array<string>, genreIds?: Array<string>, enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>;
424
+ /**
425
+ *
426
+ * @summary Gets items based on a query.
427
+ * @param {string} userId The user id.
428
+ * @param {number} [startIndex] The start index.
429
+ * @param {number} [limit] The item limit.
430
+ * @param {string} [searchTerm] The search term.
431
+ * @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
432
+ * @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.
433
+ * @param {Array<string>} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited.
434
+ * @param {boolean} [enableUserData] Optional. Include user data.
435
+ * @param {number} [imageTypeLimit] Optional. The max number of images to return, per image type.
436
+ * @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output.
437
+ * @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
438
+ * @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.
439
+ * @param {boolean} [enableTotalRecordCount] Optional. Enable the total record count.
440
+ * @param {boolean} [enableImages] Optional. Include image information in output.
441
+ * @param {boolean} [excludeActiveSessions] Optional. Whether to exclude the currently active sessions.
442
+ * @param {*} [options] Override http request option.
443
+ * @throws {RequiredError}
444
+ */
445
+ getResumeItems(userId: string, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, mediaTypes?: Array<string>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, enableTotalRecordCount?: boolean, enableImages?: boolean, excludeActiveSessions?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>;
446
+ };
447
+ /**
448
+ * ItemsApi - factory interface
449
+ * @export
450
+ */
451
+ export declare const ItemsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
452
+ /**
453
+ *
454
+ * @summary Gets items based on a query.
455
+ * @param {string} [userId] The user id supplied as query parameter.
456
+ * @param {string} [maxOfficialRating] Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).
457
+ * @param {boolean} [hasThemeSong] Optional filter by items with theme songs.
458
+ * @param {boolean} [hasThemeVideo] Optional filter by items with theme videos.
459
+ * @param {boolean} [hasSubtitles] Optional filter by items with subtitles.
460
+ * @param {boolean} [hasSpecialFeature] Optional filter by items with special features.
461
+ * @param {boolean} [hasTrailer] Optional filter by items with trailers.
462
+ * @param {string} [adjacentTo] Optional. Return items that are siblings of a supplied item.
463
+ * @param {number} [parentIndexNumber] Optional filter by parent index number.
464
+ * @param {boolean} [hasParentalRating] Optional filter by items that have or do not have a parental rating.
465
+ * @param {boolean} [isHd] Optional filter by items that are HD or not.
466
+ * @param {boolean} [is4K] Optional filter by items that are 4K or not.
467
+ * @param {Array<LocationType>} [locationTypes] Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimited.
468
+ * @param {Array<LocationType>} [excludeLocationTypes] Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimited.
469
+ * @param {boolean} [isMissing] Optional filter by items that are missing episodes or not.
470
+ * @param {boolean} [isUnaired] Optional filter by items that are unaired episodes or not.
471
+ * @param {number} [minCommunityRating] Optional filter by minimum community rating.
472
+ * @param {number} [minCriticRating] Optional filter by minimum critic rating.
473
+ * @param {string} [minPremiereDate] Optional. The minimum premiere date. Format &#x3D; ISO.
474
+ * @param {string} [minDateLastSaved] Optional. The minimum last saved date. Format &#x3D; ISO.
475
+ * @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format &#x3D; ISO.
476
+ * @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format &#x3D; ISO.
477
+ * @param {boolean} [hasOverview] Optional filter by items that have an overview or not.
478
+ * @param {boolean} [hasImdbId] Optional filter by items that have an imdb id or not.
479
+ * @param {boolean} [hasTmdbId] Optional filter by items that have a tmdb id or not.
480
+ * @param {boolean} [hasTvdbId] Optional filter by items that have a tvdb id or not.
481
+ * @param {boolean} [isMovie] Optional filter for live tv movies.
482
+ * @param {boolean} [isSeries] Optional filter for live tv series.
483
+ * @param {boolean} [isNews] Optional filter for live tv news.
484
+ * @param {boolean} [isKids] Optional filter for live tv kids.
485
+ * @param {boolean} [isSports] Optional filter for live tv sports.
486
+ * @param {Array<string>} [excludeItemIds] Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited.
487
+ * @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results.
488
+ * @param {number} [limit] Optional. The maximum number of records to return.
489
+ * @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false.
490
+ * @param {string} [searchTerm] Optional. Filter based on a search term.
491
+ * @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
492
+ * @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
493
+ * @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.
494
+ * @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
495
+ * @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.
496
+ * @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.
497
+ * @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
498
+ * @param {Array<string>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
499
+ * @param {Array<ImageType>} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
500
+ * @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.
501
+ * @param {boolean} [isPlayed] Optional filter by items that are played, or not.
502
+ * @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
503
+ * @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
504
+ * @param {Array<string>} [tags] Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.
505
+ * @param {Array<number>} [years] Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.
506
+ * @param {boolean} [enableUserData] Optional, include user data.
507
+ * @param {number} [imageTypeLimit] Optional, the max number of images to return, per image type.
508
+ * @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output.
509
+ * @param {string} [person] Optional. If specified, results will be filtered to include only those containing the specified person.
510
+ * @param {Array<string>} [personIds] Optional. If specified, results will be filtered to include only those containing the specified person id.
511
+ * @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.
512
+ * @param {Array<string>} [studios] Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.
513
+ * @param {Array<string>} [artists] Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited.
514
+ * @param {Array<string>} [excludeArtistIds] Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited.
515
+ * @param {Array<string>} [artistIds] Optional. If specified, results will be filtered to include only those containing the specified artist id.
516
+ * @param {Array<string>} [albumArtistIds] Optional. If specified, results will be filtered to include only those containing the specified album artist id.
517
+ * @param {Array<string>} [contributingArtistIds] Optional. If specified, results will be filtered to include only those containing the specified contributing artist id.
518
+ * @param {Array<string>} [albums] Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited.
519
+ * @param {Array<string>} [albumIds] Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited.
520
+ * @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.
521
+ * @param {Array<VideoType>} [videoTypes] Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimited.
522
+ * @param {string} [minOfficialRating] Optional filter by minimum official rating (PG, PG-13, TV-MA, etc).
523
+ * @param {boolean} [isLocked] Optional filter by items that are locked.
524
+ * @param {boolean} [isPlaceHolder] Optional filter by items that are placeholders.
525
+ * @param {boolean} [hasOfficialRating] Optional filter by items that have official ratings.
526
+ * @param {boolean} [collapseBoxSetItems] Whether or not to hide items behind their boxsets.
527
+ * @param {number} [minWidth] Optional. Filter by the minimum width of the item.
528
+ * @param {number} [minHeight] Optional. Filter by the minimum height of the item.
529
+ * @param {number} [maxWidth] Optional. Filter by the maximum width of the item.
530
+ * @param {number} [maxHeight] Optional. Filter by the maximum height of the item.
531
+ * @param {boolean} [is3D] Optional filter by items that are 3D, or not.
532
+ * @param {Array<SeriesStatus>} [seriesStatus] Optional filter by Series Status. Allows multiple, comma delimited.
533
+ * @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string.
534
+ * @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string.
535
+ * @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string.
536
+ * @param {Array<string>} [studioIds] Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.
537
+ * @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
538
+ * @param {boolean} [enableTotalRecordCount] Optional. Enable the total record count.
539
+ * @param {boolean} [enableImages] Optional, include image information in output.
540
+ * @param {*} [options] Override http request option.
541
+ * @throws {RequiredError}
542
+ */
543
+ getItems(userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: Array<LocationType>, excludeLocationTypes?: Array<LocationType>, isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, excludeItemIds?: Array<string>, startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: Array<SortOrder>, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<string>, imageTypes?: Array<ImageType>, sortBy?: Array<string>, isPlayed?: boolean, genres?: Array<string>, officialRatings?: Array<string>, tags?: Array<string>, years?: Array<number>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, person?: string, personIds?: Array<string>, personTypes?: Array<string>, studios?: Array<string>, artists?: Array<string>, excludeArtistIds?: Array<string>, artistIds?: Array<string>, albumArtistIds?: Array<string>, contributingArtistIds?: Array<string>, albums?: Array<string>, albumIds?: Array<string>, ids?: Array<string>, videoTypes?: Array<VideoType>, minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: Array<SeriesStatus>, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: Array<string>, genreIds?: Array<string>, enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>;
544
+ /**
545
+ *
546
+ * @summary Gets items based on a query.
547
+ * @param {string} userId The user id supplied as query parameter.
548
+ * @param {string} [maxOfficialRating] Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).
549
+ * @param {boolean} [hasThemeSong] Optional filter by items with theme songs.
550
+ * @param {boolean} [hasThemeVideo] Optional filter by items with theme videos.
551
+ * @param {boolean} [hasSubtitles] Optional filter by items with subtitles.
552
+ * @param {boolean} [hasSpecialFeature] Optional filter by items with special features.
553
+ * @param {boolean} [hasTrailer] Optional filter by items with trailers.
554
+ * @param {string} [adjacentTo] Optional. Return items that are siblings of a supplied item.
555
+ * @param {number} [parentIndexNumber] Optional filter by parent index number.
556
+ * @param {boolean} [hasParentalRating] Optional filter by items that have or do not have a parental rating.
557
+ * @param {boolean} [isHd] Optional filter by items that are HD or not.
558
+ * @param {boolean} [is4K] Optional filter by items that are 4K or not.
559
+ * @param {Array<LocationType>} [locationTypes] Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimited.
560
+ * @param {Array<LocationType>} [excludeLocationTypes] Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimited.
561
+ * @param {boolean} [isMissing] Optional filter by items that are missing episodes or not.
562
+ * @param {boolean} [isUnaired] Optional filter by items that are unaired episodes or not.
563
+ * @param {number} [minCommunityRating] Optional filter by minimum community rating.
564
+ * @param {number} [minCriticRating] Optional filter by minimum critic rating.
565
+ * @param {string} [minPremiereDate] Optional. The minimum premiere date. Format &#x3D; ISO.
566
+ * @param {string} [minDateLastSaved] Optional. The minimum last saved date. Format &#x3D; ISO.
567
+ * @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format &#x3D; ISO.
568
+ * @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format &#x3D; ISO.
569
+ * @param {boolean} [hasOverview] Optional filter by items that have an overview or not.
570
+ * @param {boolean} [hasImdbId] Optional filter by items that have an imdb id or not.
571
+ * @param {boolean} [hasTmdbId] Optional filter by items that have a tmdb id or not.
572
+ * @param {boolean} [hasTvdbId] Optional filter by items that have a tvdb id or not.
573
+ * @param {boolean} [isMovie] Optional filter for live tv movies.
574
+ * @param {boolean} [isSeries] Optional filter for live tv series.
575
+ * @param {boolean} [isNews] Optional filter for live tv news.
576
+ * @param {boolean} [isKids] Optional filter for live tv kids.
577
+ * @param {boolean} [isSports] Optional filter for live tv sports.
578
+ * @param {Array<string>} [excludeItemIds] Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited.
579
+ * @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results.
580
+ * @param {number} [limit] Optional. The maximum number of records to return.
581
+ * @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false.
582
+ * @param {string} [searchTerm] Optional. Filter based on a search term.
583
+ * @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
584
+ * @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
585
+ * @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.
586
+ * @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
587
+ * @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.
588
+ * @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.
589
+ * @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
590
+ * @param {Array<string>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
591
+ * @param {Array<ImageType>} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
592
+ * @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.
593
+ * @param {boolean} [isPlayed] Optional filter by items that are played, or not.
594
+ * @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
595
+ * @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
596
+ * @param {Array<string>} [tags] Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.
597
+ * @param {Array<number>} [years] Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.
598
+ * @param {boolean} [enableUserData] Optional, include user data.
599
+ * @param {number} [imageTypeLimit] Optional, the max number of images to return, per image type.
600
+ * @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output.
601
+ * @param {string} [person] Optional. If specified, results will be filtered to include only those containing the specified person.
602
+ * @param {Array<string>} [personIds] Optional. If specified, results will be filtered to include only those containing the specified person id.
603
+ * @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.
604
+ * @param {Array<string>} [studios] Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.
605
+ * @param {Array<string>} [artists] Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited.
606
+ * @param {Array<string>} [excludeArtistIds] Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited.
607
+ * @param {Array<string>} [artistIds] Optional. If specified, results will be filtered to include only those containing the specified artist id.
608
+ * @param {Array<string>} [albumArtistIds] Optional. If specified, results will be filtered to include only those containing the specified album artist id.
609
+ * @param {Array<string>} [contributingArtistIds] Optional. If specified, results will be filtered to include only those containing the specified contributing artist id.
610
+ * @param {Array<string>} [albums] Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited.
611
+ * @param {Array<string>} [albumIds] Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited.
612
+ * @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.
613
+ * @param {Array<VideoType>} [videoTypes] Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimited.
614
+ * @param {string} [minOfficialRating] Optional filter by minimum official rating (PG, PG-13, TV-MA, etc).
615
+ * @param {boolean} [isLocked] Optional filter by items that are locked.
616
+ * @param {boolean} [isPlaceHolder] Optional filter by items that are placeholders.
617
+ * @param {boolean} [hasOfficialRating] Optional filter by items that have official ratings.
618
+ * @param {boolean} [collapseBoxSetItems] Whether or not to hide items behind their boxsets.
619
+ * @param {number} [minWidth] Optional. Filter by the minimum width of the item.
620
+ * @param {number} [minHeight] Optional. Filter by the minimum height of the item.
621
+ * @param {number} [maxWidth] Optional. Filter by the maximum width of the item.
622
+ * @param {number} [maxHeight] Optional. Filter by the maximum height of the item.
623
+ * @param {boolean} [is3D] Optional filter by items that are 3D, or not.
624
+ * @param {Array<SeriesStatus>} [seriesStatus] Optional filter by Series Status. Allows multiple, comma delimited.
625
+ * @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string.
626
+ * @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string.
627
+ * @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string.
628
+ * @param {Array<string>} [studioIds] Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.
629
+ * @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
630
+ * @param {boolean} [enableTotalRecordCount] Optional. Enable the total record count.
631
+ * @param {boolean} [enableImages] Optional, include image information in output.
632
+ * @param {*} [options] Override http request option.
633
+ * @throws {RequiredError}
634
+ */
635
+ getItemsByUserId(userId: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: Array<LocationType>, excludeLocationTypes?: Array<LocationType>, isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, excludeItemIds?: Array<string>, startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: Array<SortOrder>, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<string>, imageTypes?: Array<ImageType>, sortBy?: Array<string>, isPlayed?: boolean, genres?: Array<string>, officialRatings?: Array<string>, tags?: Array<string>, years?: Array<number>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, person?: string, personIds?: Array<string>, personTypes?: Array<string>, studios?: Array<string>, artists?: Array<string>, excludeArtistIds?: Array<string>, artistIds?: Array<string>, albumArtistIds?: Array<string>, contributingArtistIds?: Array<string>, albums?: Array<string>, albumIds?: Array<string>, ids?: Array<string>, videoTypes?: Array<VideoType>, minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: Array<SeriesStatus>, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: Array<string>, genreIds?: Array<string>, enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>;
636
+ /**
637
+ *
638
+ * @summary Gets items based on a query.
639
+ * @param {string} userId The user id.
640
+ * @param {number} [startIndex] The start index.
641
+ * @param {number} [limit] The item limit.
642
+ * @param {string} [searchTerm] The search term.
643
+ * @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
644
+ * @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.
645
+ * @param {Array<string>} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited.
646
+ * @param {boolean} [enableUserData] Optional. Include user data.
647
+ * @param {number} [imageTypeLimit] Optional. The max number of images to return, per image type.
648
+ * @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output.
649
+ * @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
650
+ * @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.
651
+ * @param {boolean} [enableTotalRecordCount] Optional. Enable the total record count.
652
+ * @param {boolean} [enableImages] Optional. Include image information in output.
653
+ * @param {boolean} [excludeActiveSessions] Optional. Whether to exclude the currently active sessions.
654
+ * @param {*} [options] Override http request option.
655
+ * @throws {RequiredError}
656
+ */
657
+ getResumeItems(userId: string, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, mediaTypes?: Array<string>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, enableTotalRecordCount?: boolean, enableImages?: boolean, excludeActiveSessions?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>;
658
+ };
659
+ /**
660
+ * Request parameters for getItems operation in ItemsApi.
661
+ * @export
662
+ * @interface ItemsApiGetItemsRequest
663
+ */
664
+ export interface ItemsApiGetItemsRequest {
665
+ /**
666
+ * The user id supplied as query parameter.
667
+ * @type {string}
668
+ * @memberof ItemsApiGetItems
669
+ */
670
+ readonly userId?: string;
671
+ /**
672
+ * Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).
673
+ * @type {string}
674
+ * @memberof ItemsApiGetItems
675
+ */
676
+ readonly maxOfficialRating?: string;
677
+ /**
678
+ * Optional filter by items with theme songs.
679
+ * @type {boolean}
680
+ * @memberof ItemsApiGetItems
681
+ */
682
+ readonly hasThemeSong?: boolean;
683
+ /**
684
+ * Optional filter by items with theme videos.
685
+ * @type {boolean}
686
+ * @memberof ItemsApiGetItems
687
+ */
688
+ readonly hasThemeVideo?: boolean;
689
+ /**
690
+ * Optional filter by items with subtitles.
691
+ * @type {boolean}
692
+ * @memberof ItemsApiGetItems
693
+ */
694
+ readonly hasSubtitles?: boolean;
695
+ /**
696
+ * Optional filter by items with special features.
697
+ * @type {boolean}
698
+ * @memberof ItemsApiGetItems
699
+ */
700
+ readonly hasSpecialFeature?: boolean;
701
+ /**
702
+ * Optional filter by items with trailers.
703
+ * @type {boolean}
704
+ * @memberof ItemsApiGetItems
705
+ */
706
+ readonly hasTrailer?: boolean;
707
+ /**
708
+ * Optional. Return items that are siblings of a supplied item.
709
+ * @type {string}
710
+ * @memberof ItemsApiGetItems
711
+ */
712
+ readonly adjacentTo?: string;
713
+ /**
714
+ * Optional filter by parent index number.
715
+ * @type {number}
716
+ * @memberof ItemsApiGetItems
717
+ */
718
+ readonly parentIndexNumber?: number;
719
+ /**
720
+ * Optional filter by items that have or do not have a parental rating.
721
+ * @type {boolean}
722
+ * @memberof ItemsApiGetItems
723
+ */
724
+ readonly hasParentalRating?: boolean;
725
+ /**
726
+ * Optional filter by items that are HD or not.
727
+ * @type {boolean}
728
+ * @memberof ItemsApiGetItems
729
+ */
730
+ readonly isHd?: boolean;
731
+ /**
732
+ * Optional filter by items that are 4K or not.
733
+ * @type {boolean}
734
+ * @memberof ItemsApiGetItems
735
+ */
736
+ readonly is4K?: boolean;
737
+ /**
738
+ * Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimited.
739
+ * @type {Array<LocationType>}
740
+ * @memberof ItemsApiGetItems
741
+ */
742
+ readonly locationTypes?: Array<LocationType>;
743
+ /**
744
+ * Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimited.
745
+ * @type {Array<LocationType>}
746
+ * @memberof ItemsApiGetItems
747
+ */
748
+ readonly excludeLocationTypes?: Array<LocationType>;
749
+ /**
750
+ * Optional filter by items that are missing episodes or not.
751
+ * @type {boolean}
752
+ * @memberof ItemsApiGetItems
753
+ */
754
+ readonly isMissing?: boolean;
755
+ /**
756
+ * Optional filter by items that are unaired episodes or not.
757
+ * @type {boolean}
758
+ * @memberof ItemsApiGetItems
759
+ */
760
+ readonly isUnaired?: boolean;
761
+ /**
762
+ * Optional filter by minimum community rating.
763
+ * @type {number}
764
+ * @memberof ItemsApiGetItems
765
+ */
766
+ readonly minCommunityRating?: number;
767
+ /**
768
+ * Optional filter by minimum critic rating.
769
+ * @type {number}
770
+ * @memberof ItemsApiGetItems
771
+ */
772
+ readonly minCriticRating?: number;
773
+ /**
774
+ * Optional. The minimum premiere date. Format &#x3D; ISO.
775
+ * @type {string}
776
+ * @memberof ItemsApiGetItems
777
+ */
778
+ readonly minPremiereDate?: string;
779
+ /**
780
+ * Optional. The minimum last saved date. Format &#x3D; ISO.
781
+ * @type {string}
782
+ * @memberof ItemsApiGetItems
783
+ */
784
+ readonly minDateLastSaved?: string;
785
+ /**
786
+ * Optional. The minimum last saved date for the current user. Format &#x3D; ISO.
787
+ * @type {string}
788
+ * @memberof ItemsApiGetItems
789
+ */
790
+ readonly minDateLastSavedForUser?: string;
791
+ /**
792
+ * Optional. The maximum premiere date. Format &#x3D; ISO.
793
+ * @type {string}
794
+ * @memberof ItemsApiGetItems
795
+ */
796
+ readonly maxPremiereDate?: string;
797
+ /**
798
+ * Optional filter by items that have an overview or not.
799
+ * @type {boolean}
800
+ * @memberof ItemsApiGetItems
801
+ */
802
+ readonly hasOverview?: boolean;
803
+ /**
804
+ * Optional filter by items that have an imdb id or not.
805
+ * @type {boolean}
806
+ * @memberof ItemsApiGetItems
807
+ */
808
+ readonly hasImdbId?: boolean;
809
+ /**
810
+ * Optional filter by items that have a tmdb id or not.
811
+ * @type {boolean}
812
+ * @memberof ItemsApiGetItems
813
+ */
814
+ readonly hasTmdbId?: boolean;
815
+ /**
816
+ * Optional filter by items that have a tvdb id or not.
817
+ * @type {boolean}
818
+ * @memberof ItemsApiGetItems
819
+ */
820
+ readonly hasTvdbId?: boolean;
821
+ /**
822
+ * Optional filter for live tv movies.
823
+ * @type {boolean}
824
+ * @memberof ItemsApiGetItems
825
+ */
826
+ readonly isMovie?: boolean;
827
+ /**
828
+ * Optional filter for live tv series.
829
+ * @type {boolean}
830
+ * @memberof ItemsApiGetItems
831
+ */
832
+ readonly isSeries?: boolean;
833
+ /**
834
+ * Optional filter for live tv news.
835
+ * @type {boolean}
836
+ * @memberof ItemsApiGetItems
837
+ */
838
+ readonly isNews?: boolean;
839
+ /**
840
+ * Optional filter for live tv kids.
841
+ * @type {boolean}
842
+ * @memberof ItemsApiGetItems
843
+ */
844
+ readonly isKids?: boolean;
845
+ /**
846
+ * Optional filter for live tv sports.
847
+ * @type {boolean}
848
+ * @memberof ItemsApiGetItems
849
+ */
850
+ readonly isSports?: boolean;
851
+ /**
852
+ * Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited.
853
+ * @type {Array<string>}
854
+ * @memberof ItemsApiGetItems
855
+ */
856
+ readonly excludeItemIds?: Array<string>;
857
+ /**
858
+ * Optional. The record index to start at. All items with a lower index will be dropped from the results.
859
+ * @type {number}
860
+ * @memberof ItemsApiGetItems
861
+ */
862
+ readonly startIndex?: number;
863
+ /**
864
+ * Optional. The maximum number of records to return.
865
+ * @type {number}
866
+ * @memberof ItemsApiGetItems
867
+ */
868
+ readonly limit?: number;
869
+ /**
870
+ * When searching within folders, this determines whether or not the search will be recursive. true/false.
871
+ * @type {boolean}
872
+ * @memberof ItemsApiGetItems
873
+ */
874
+ readonly recursive?: boolean;
875
+ /**
876
+ * Optional. Filter based on a search term.
877
+ * @type {string}
878
+ * @memberof ItemsApiGetItems
879
+ */
880
+ readonly searchTerm?: string;
881
+ /**
882
+ * Sort Order - Ascending,Descending.
883
+ * @type {Array<SortOrder>}
884
+ * @memberof ItemsApiGetItems
885
+ */
886
+ readonly sortOrder?: Array<SortOrder>;
887
+ /**
888
+ * Specify this to localize the search to a specific item or folder. Omit to use the root.
889
+ * @type {string}
890
+ * @memberof ItemsApiGetItems
891
+ */
892
+ readonly parentId?: string;
893
+ /**
894
+ * 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.
895
+ * @type {Array<ItemFields>}
896
+ * @memberof ItemsApiGetItems
897
+ */
898
+ readonly fields?: Array<ItemFields>;
899
+ /**
900
+ * Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
901
+ * @type {Array<BaseItemKind>}
902
+ * @memberof ItemsApiGetItems
903
+ */
904
+ readonly excludeItemTypes?: Array<BaseItemKind>;
905
+ /**
906
+ * Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.
907
+ * @type {Array<BaseItemKind>}
908
+ * @memberof ItemsApiGetItems
909
+ */
910
+ readonly includeItemTypes?: Array<BaseItemKind>;
911
+ /**
912
+ * Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.
913
+ * @type {Array<ItemFilter>}
914
+ * @memberof ItemsApiGetItems
915
+ */
916
+ readonly filters?: Array<ItemFilter>;
917
+ /**
918
+ * Optional filter by items that are marked as favorite, or not.
919
+ * @type {boolean}
920
+ * @memberof ItemsApiGetItems
921
+ */
922
+ readonly isFavorite?: boolean;
923
+ /**
924
+ * Optional filter by MediaType. Allows multiple, comma delimited.
925
+ * @type {Array<string>}
926
+ * @memberof ItemsApiGetItems
927
+ */
928
+ readonly mediaTypes?: Array<string>;
929
+ /**
930
+ * Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
931
+ * @type {Array<ImageType>}
932
+ * @memberof ItemsApiGetItems
933
+ */
934
+ readonly imageTypes?: Array<ImageType>;
935
+ /**
936
+ * 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.
937
+ * @type {Array<string>}
938
+ * @memberof ItemsApiGetItems
939
+ */
940
+ readonly sortBy?: Array<string>;
941
+ /**
942
+ * Optional filter by items that are played, or not.
943
+ * @type {boolean}
944
+ * @memberof ItemsApiGetItems
945
+ */
946
+ readonly isPlayed?: boolean;
947
+ /**
948
+ * Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
949
+ * @type {Array<string>}
950
+ * @memberof ItemsApiGetItems
951
+ */
952
+ readonly genres?: Array<string>;
953
+ /**
954
+ * Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
955
+ * @type {Array<string>}
956
+ * @memberof ItemsApiGetItems
957
+ */
958
+ readonly officialRatings?: Array<string>;
959
+ /**
960
+ * Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.
961
+ * @type {Array<string>}
962
+ * @memberof ItemsApiGetItems
963
+ */
964
+ readonly tags?: Array<string>;
965
+ /**
966
+ * Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.
967
+ * @type {Array<number>}
968
+ * @memberof ItemsApiGetItems
969
+ */
970
+ readonly years?: Array<number>;
971
+ /**
972
+ * Optional, include user data.
973
+ * @type {boolean}
974
+ * @memberof ItemsApiGetItems
975
+ */
976
+ readonly enableUserData?: boolean;
977
+ /**
978
+ * Optional, the max number of images to return, per image type.
979
+ * @type {number}
980
+ * @memberof ItemsApiGetItems
981
+ */
982
+ readonly imageTypeLimit?: number;
983
+ /**
984
+ * Optional. The image types to include in the output.
985
+ * @type {Array<ImageType>}
986
+ * @memberof ItemsApiGetItems
987
+ */
988
+ readonly enableImageTypes?: Array<ImageType>;
989
+ /**
990
+ * Optional. If specified, results will be filtered to include only those containing the specified person.
991
+ * @type {string}
992
+ * @memberof ItemsApiGetItems
993
+ */
994
+ readonly person?: string;
995
+ /**
996
+ * Optional. If specified, results will be filtered to include only those containing the specified person id.
997
+ * @type {Array<string>}
998
+ * @memberof ItemsApiGetItems
999
+ */
1000
+ readonly personIds?: Array<string>;
1001
+ /**
1002
+ * Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited.
1003
+ * @type {Array<string>}
1004
+ * @memberof ItemsApiGetItems
1005
+ */
1006
+ readonly personTypes?: Array<string>;
1007
+ /**
1008
+ * Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.
1009
+ * @type {Array<string>}
1010
+ * @memberof ItemsApiGetItems
1011
+ */
1012
+ readonly studios?: Array<string>;
1013
+ /**
1014
+ * Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited.
1015
+ * @type {Array<string>}
1016
+ * @memberof ItemsApiGetItems
1017
+ */
1018
+ readonly artists?: Array<string>;
1019
+ /**
1020
+ * Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited.
1021
+ * @type {Array<string>}
1022
+ * @memberof ItemsApiGetItems
1023
+ */
1024
+ readonly excludeArtistIds?: Array<string>;
1025
+ /**
1026
+ * Optional. If specified, results will be filtered to include only those containing the specified artist id.
1027
+ * @type {Array<string>}
1028
+ * @memberof ItemsApiGetItems
1029
+ */
1030
+ readonly artistIds?: Array<string>;
1031
+ /**
1032
+ * Optional. If specified, results will be filtered to include only those containing the specified album artist id.
1033
+ * @type {Array<string>}
1034
+ * @memberof ItemsApiGetItems
1035
+ */
1036
+ readonly albumArtistIds?: Array<string>;
1037
+ /**
1038
+ * Optional. If specified, results will be filtered to include only those containing the specified contributing artist id.
1039
+ * @type {Array<string>}
1040
+ * @memberof ItemsApiGetItems
1041
+ */
1042
+ readonly contributingArtistIds?: Array<string>;
1043
+ /**
1044
+ * Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited.
1045
+ * @type {Array<string>}
1046
+ * @memberof ItemsApiGetItems
1047
+ */
1048
+ readonly albums?: Array<string>;
1049
+ /**
1050
+ * Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited.
1051
+ * @type {Array<string>}
1052
+ * @memberof ItemsApiGetItems
1053
+ */
1054
+ readonly albumIds?: Array<string>;
1055
+ /**
1056
+ * Optional. If specific items are needed, specify a list of item id\&#39;s to retrieve. This allows multiple, comma delimited.
1057
+ * @type {Array<string>}
1058
+ * @memberof ItemsApiGetItems
1059
+ */
1060
+ readonly ids?: Array<string>;
1061
+ /**
1062
+ * Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimited.
1063
+ * @type {Array<VideoType>}
1064
+ * @memberof ItemsApiGetItems
1065
+ */
1066
+ readonly videoTypes?: Array<VideoType>;
1067
+ /**
1068
+ * Optional filter by minimum official rating (PG, PG-13, TV-MA, etc).
1069
+ * @type {string}
1070
+ * @memberof ItemsApiGetItems
1071
+ */
1072
+ readonly minOfficialRating?: string;
1073
+ /**
1074
+ * Optional filter by items that are locked.
1075
+ * @type {boolean}
1076
+ * @memberof ItemsApiGetItems
1077
+ */
1078
+ readonly isLocked?: boolean;
1079
+ /**
1080
+ * Optional filter by items that are placeholders.
1081
+ * @type {boolean}
1082
+ * @memberof ItemsApiGetItems
1083
+ */
1084
+ readonly isPlaceHolder?: boolean;
1085
+ /**
1086
+ * Optional filter by items that have official ratings.
1087
+ * @type {boolean}
1088
+ * @memberof ItemsApiGetItems
1089
+ */
1090
+ readonly hasOfficialRating?: boolean;
1091
+ /**
1092
+ * Whether or not to hide items behind their boxsets.
1093
+ * @type {boolean}
1094
+ * @memberof ItemsApiGetItems
1095
+ */
1096
+ readonly collapseBoxSetItems?: boolean;
1097
+ /**
1098
+ * Optional. Filter by the minimum width of the item.
1099
+ * @type {number}
1100
+ * @memberof ItemsApiGetItems
1101
+ */
1102
+ readonly minWidth?: number;
1103
+ /**
1104
+ * Optional. Filter by the minimum height of the item.
1105
+ * @type {number}
1106
+ * @memberof ItemsApiGetItems
1107
+ */
1108
+ readonly minHeight?: number;
1109
+ /**
1110
+ * Optional. Filter by the maximum width of the item.
1111
+ * @type {number}
1112
+ * @memberof ItemsApiGetItems
1113
+ */
1114
+ readonly maxWidth?: number;
1115
+ /**
1116
+ * Optional. Filter by the maximum height of the item.
1117
+ * @type {number}
1118
+ * @memberof ItemsApiGetItems
1119
+ */
1120
+ readonly maxHeight?: number;
1121
+ /**
1122
+ * Optional filter by items that are 3D, or not.
1123
+ * @type {boolean}
1124
+ * @memberof ItemsApiGetItems
1125
+ */
1126
+ readonly is3D?: boolean;
1127
+ /**
1128
+ * Optional filter by Series Status. Allows multiple, comma delimited.
1129
+ * @type {Array<SeriesStatus>}
1130
+ * @memberof ItemsApiGetItems
1131
+ */
1132
+ readonly seriesStatus?: Array<SeriesStatus>;
1133
+ /**
1134
+ * Optional filter by items whose name is sorted equally or greater than a given input string.
1135
+ * @type {string}
1136
+ * @memberof ItemsApiGetItems
1137
+ */
1138
+ readonly nameStartsWithOrGreater?: string;
1139
+ /**
1140
+ * Optional filter by items whose name is sorted equally than a given input string.
1141
+ * @type {string}
1142
+ * @memberof ItemsApiGetItems
1143
+ */
1144
+ readonly nameStartsWith?: string;
1145
+ /**
1146
+ * Optional filter by items whose name is equally or lesser than a given input string.
1147
+ * @type {string}
1148
+ * @memberof ItemsApiGetItems
1149
+ */
1150
+ readonly nameLessThan?: string;
1151
+ /**
1152
+ * Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.
1153
+ * @type {Array<string>}
1154
+ * @memberof ItemsApiGetItems
1155
+ */
1156
+ readonly studioIds?: Array<string>;
1157
+ /**
1158
+ * Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
1159
+ * @type {Array<string>}
1160
+ * @memberof ItemsApiGetItems
1161
+ */
1162
+ readonly genreIds?: Array<string>;
1163
+ /**
1164
+ * Optional. Enable the total record count.
1165
+ * @type {boolean}
1166
+ * @memberof ItemsApiGetItems
1167
+ */
1168
+ readonly enableTotalRecordCount?: boolean;
1169
+ /**
1170
+ * Optional, include image information in output.
1171
+ * @type {boolean}
1172
+ * @memberof ItemsApiGetItems
1173
+ */
1174
+ readonly enableImages?: boolean;
1175
+ }
1176
+ /**
1177
+ * Request parameters for getItemsByUserId operation in ItemsApi.
1178
+ * @export
1179
+ * @interface ItemsApiGetItemsByUserIdRequest
1180
+ */
1181
+ export interface ItemsApiGetItemsByUserIdRequest {
1182
+ /**
1183
+ * The user id supplied as query parameter.
1184
+ * @type {string}
1185
+ * @memberof ItemsApiGetItemsByUserId
1186
+ */
1187
+ readonly userId: string;
1188
+ /**
1189
+ * Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).
1190
+ * @type {string}
1191
+ * @memberof ItemsApiGetItemsByUserId
1192
+ */
1193
+ readonly maxOfficialRating?: string;
1194
+ /**
1195
+ * Optional filter by items with theme songs.
1196
+ * @type {boolean}
1197
+ * @memberof ItemsApiGetItemsByUserId
1198
+ */
1199
+ readonly hasThemeSong?: boolean;
1200
+ /**
1201
+ * Optional filter by items with theme videos.
1202
+ * @type {boolean}
1203
+ * @memberof ItemsApiGetItemsByUserId
1204
+ */
1205
+ readonly hasThemeVideo?: boolean;
1206
+ /**
1207
+ * Optional filter by items with subtitles.
1208
+ * @type {boolean}
1209
+ * @memberof ItemsApiGetItemsByUserId
1210
+ */
1211
+ readonly hasSubtitles?: boolean;
1212
+ /**
1213
+ * Optional filter by items with special features.
1214
+ * @type {boolean}
1215
+ * @memberof ItemsApiGetItemsByUserId
1216
+ */
1217
+ readonly hasSpecialFeature?: boolean;
1218
+ /**
1219
+ * Optional filter by items with trailers.
1220
+ * @type {boolean}
1221
+ * @memberof ItemsApiGetItemsByUserId
1222
+ */
1223
+ readonly hasTrailer?: boolean;
1224
+ /**
1225
+ * Optional. Return items that are siblings of a supplied item.
1226
+ * @type {string}
1227
+ * @memberof ItemsApiGetItemsByUserId
1228
+ */
1229
+ readonly adjacentTo?: string;
1230
+ /**
1231
+ * Optional filter by parent index number.
1232
+ * @type {number}
1233
+ * @memberof ItemsApiGetItemsByUserId
1234
+ */
1235
+ readonly parentIndexNumber?: number;
1236
+ /**
1237
+ * Optional filter by items that have or do not have a parental rating.
1238
+ * @type {boolean}
1239
+ * @memberof ItemsApiGetItemsByUserId
1240
+ */
1241
+ readonly hasParentalRating?: boolean;
1242
+ /**
1243
+ * Optional filter by items that are HD or not.
1244
+ * @type {boolean}
1245
+ * @memberof ItemsApiGetItemsByUserId
1246
+ */
1247
+ readonly isHd?: boolean;
1248
+ /**
1249
+ * Optional filter by items that are 4K or not.
1250
+ * @type {boolean}
1251
+ * @memberof ItemsApiGetItemsByUserId
1252
+ */
1253
+ readonly is4K?: boolean;
1254
+ /**
1255
+ * Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimited.
1256
+ * @type {Array<LocationType>}
1257
+ * @memberof ItemsApiGetItemsByUserId
1258
+ */
1259
+ readonly locationTypes?: Array<LocationType>;
1260
+ /**
1261
+ * Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimited.
1262
+ * @type {Array<LocationType>}
1263
+ * @memberof ItemsApiGetItemsByUserId
1264
+ */
1265
+ readonly excludeLocationTypes?: Array<LocationType>;
1266
+ /**
1267
+ * Optional filter by items that are missing episodes or not.
1268
+ * @type {boolean}
1269
+ * @memberof ItemsApiGetItemsByUserId
1270
+ */
1271
+ readonly isMissing?: boolean;
1272
+ /**
1273
+ * Optional filter by items that are unaired episodes or not.
1274
+ * @type {boolean}
1275
+ * @memberof ItemsApiGetItemsByUserId
1276
+ */
1277
+ readonly isUnaired?: boolean;
1278
+ /**
1279
+ * Optional filter by minimum community rating.
1280
+ * @type {number}
1281
+ * @memberof ItemsApiGetItemsByUserId
1282
+ */
1283
+ readonly minCommunityRating?: number;
1284
+ /**
1285
+ * Optional filter by minimum critic rating.
1286
+ * @type {number}
1287
+ * @memberof ItemsApiGetItemsByUserId
1288
+ */
1289
+ readonly minCriticRating?: number;
1290
+ /**
1291
+ * Optional. The minimum premiere date. Format &#x3D; ISO.
1292
+ * @type {string}
1293
+ * @memberof ItemsApiGetItemsByUserId
1294
+ */
1295
+ readonly minPremiereDate?: string;
1296
+ /**
1297
+ * Optional. The minimum last saved date. Format &#x3D; ISO.
1298
+ * @type {string}
1299
+ * @memberof ItemsApiGetItemsByUserId
1300
+ */
1301
+ readonly minDateLastSaved?: string;
1302
+ /**
1303
+ * Optional. The minimum last saved date for the current user. Format &#x3D; ISO.
1304
+ * @type {string}
1305
+ * @memberof ItemsApiGetItemsByUserId
1306
+ */
1307
+ readonly minDateLastSavedForUser?: string;
1308
+ /**
1309
+ * Optional. The maximum premiere date. Format &#x3D; ISO.
1310
+ * @type {string}
1311
+ * @memberof ItemsApiGetItemsByUserId
1312
+ */
1313
+ readonly maxPremiereDate?: string;
1314
+ /**
1315
+ * Optional filter by items that have an overview or not.
1316
+ * @type {boolean}
1317
+ * @memberof ItemsApiGetItemsByUserId
1318
+ */
1319
+ readonly hasOverview?: boolean;
1320
+ /**
1321
+ * Optional filter by items that have an imdb id or not.
1322
+ * @type {boolean}
1323
+ * @memberof ItemsApiGetItemsByUserId
1324
+ */
1325
+ readonly hasImdbId?: boolean;
1326
+ /**
1327
+ * Optional filter by items that have a tmdb id or not.
1328
+ * @type {boolean}
1329
+ * @memberof ItemsApiGetItemsByUserId
1330
+ */
1331
+ readonly hasTmdbId?: boolean;
1332
+ /**
1333
+ * Optional filter by items that have a tvdb id or not.
1334
+ * @type {boolean}
1335
+ * @memberof ItemsApiGetItemsByUserId
1336
+ */
1337
+ readonly hasTvdbId?: boolean;
1338
+ /**
1339
+ * Optional filter for live tv movies.
1340
+ * @type {boolean}
1341
+ * @memberof ItemsApiGetItemsByUserId
1342
+ */
1343
+ readonly isMovie?: boolean;
1344
+ /**
1345
+ * Optional filter for live tv series.
1346
+ * @type {boolean}
1347
+ * @memberof ItemsApiGetItemsByUserId
1348
+ */
1349
+ readonly isSeries?: boolean;
1350
+ /**
1351
+ * Optional filter for live tv news.
1352
+ * @type {boolean}
1353
+ * @memberof ItemsApiGetItemsByUserId
1354
+ */
1355
+ readonly isNews?: boolean;
1356
+ /**
1357
+ * Optional filter for live tv kids.
1358
+ * @type {boolean}
1359
+ * @memberof ItemsApiGetItemsByUserId
1360
+ */
1361
+ readonly isKids?: boolean;
1362
+ /**
1363
+ * Optional filter for live tv sports.
1364
+ * @type {boolean}
1365
+ * @memberof ItemsApiGetItemsByUserId
1366
+ */
1367
+ readonly isSports?: boolean;
1368
+ /**
1369
+ * Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited.
1370
+ * @type {Array<string>}
1371
+ * @memberof ItemsApiGetItemsByUserId
1372
+ */
1373
+ readonly excludeItemIds?: Array<string>;
1374
+ /**
1375
+ * Optional. The record index to start at. All items with a lower index will be dropped from the results.
1376
+ * @type {number}
1377
+ * @memberof ItemsApiGetItemsByUserId
1378
+ */
1379
+ readonly startIndex?: number;
1380
+ /**
1381
+ * Optional. The maximum number of records to return.
1382
+ * @type {number}
1383
+ * @memberof ItemsApiGetItemsByUserId
1384
+ */
1385
+ readonly limit?: number;
1386
+ /**
1387
+ * When searching within folders, this determines whether or not the search will be recursive. true/false.
1388
+ * @type {boolean}
1389
+ * @memberof ItemsApiGetItemsByUserId
1390
+ */
1391
+ readonly recursive?: boolean;
1392
+ /**
1393
+ * Optional. Filter based on a search term.
1394
+ * @type {string}
1395
+ * @memberof ItemsApiGetItemsByUserId
1396
+ */
1397
+ readonly searchTerm?: string;
1398
+ /**
1399
+ * Sort Order - Ascending,Descending.
1400
+ * @type {Array<SortOrder>}
1401
+ * @memberof ItemsApiGetItemsByUserId
1402
+ */
1403
+ readonly sortOrder?: Array<SortOrder>;
1404
+ /**
1405
+ * Specify this to localize the search to a specific item or folder. Omit to use the root.
1406
+ * @type {string}
1407
+ * @memberof ItemsApiGetItemsByUserId
1408
+ */
1409
+ readonly parentId?: string;
1410
+ /**
1411
+ * 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.
1412
+ * @type {Array<ItemFields>}
1413
+ * @memberof ItemsApiGetItemsByUserId
1414
+ */
1415
+ readonly fields?: Array<ItemFields>;
1416
+ /**
1417
+ * Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
1418
+ * @type {Array<BaseItemKind>}
1419
+ * @memberof ItemsApiGetItemsByUserId
1420
+ */
1421
+ readonly excludeItemTypes?: Array<BaseItemKind>;
1422
+ /**
1423
+ * Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.
1424
+ * @type {Array<BaseItemKind>}
1425
+ * @memberof ItemsApiGetItemsByUserId
1426
+ */
1427
+ readonly includeItemTypes?: Array<BaseItemKind>;
1428
+ /**
1429
+ * Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.
1430
+ * @type {Array<ItemFilter>}
1431
+ * @memberof ItemsApiGetItemsByUserId
1432
+ */
1433
+ readonly filters?: Array<ItemFilter>;
1434
+ /**
1435
+ * Optional filter by items that are marked as favorite, or not.
1436
+ * @type {boolean}
1437
+ * @memberof ItemsApiGetItemsByUserId
1438
+ */
1439
+ readonly isFavorite?: boolean;
1440
+ /**
1441
+ * Optional filter by MediaType. Allows multiple, comma delimited.
1442
+ * @type {Array<string>}
1443
+ * @memberof ItemsApiGetItemsByUserId
1444
+ */
1445
+ readonly mediaTypes?: Array<string>;
1446
+ /**
1447
+ * Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
1448
+ * @type {Array<ImageType>}
1449
+ * @memberof ItemsApiGetItemsByUserId
1450
+ */
1451
+ readonly imageTypes?: Array<ImageType>;
1452
+ /**
1453
+ * 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.
1454
+ * @type {Array<string>}
1455
+ * @memberof ItemsApiGetItemsByUserId
1456
+ */
1457
+ readonly sortBy?: Array<string>;
1458
+ /**
1459
+ * Optional filter by items that are played, or not.
1460
+ * @type {boolean}
1461
+ * @memberof ItemsApiGetItemsByUserId
1462
+ */
1463
+ readonly isPlayed?: boolean;
1464
+ /**
1465
+ * Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
1466
+ * @type {Array<string>}
1467
+ * @memberof ItemsApiGetItemsByUserId
1468
+ */
1469
+ readonly genres?: Array<string>;
1470
+ /**
1471
+ * Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
1472
+ * @type {Array<string>}
1473
+ * @memberof ItemsApiGetItemsByUserId
1474
+ */
1475
+ readonly officialRatings?: Array<string>;
1476
+ /**
1477
+ * Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.
1478
+ * @type {Array<string>}
1479
+ * @memberof ItemsApiGetItemsByUserId
1480
+ */
1481
+ readonly tags?: Array<string>;
1482
+ /**
1483
+ * Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.
1484
+ * @type {Array<number>}
1485
+ * @memberof ItemsApiGetItemsByUserId
1486
+ */
1487
+ readonly years?: Array<number>;
1488
+ /**
1489
+ * Optional, include user data.
1490
+ * @type {boolean}
1491
+ * @memberof ItemsApiGetItemsByUserId
1492
+ */
1493
+ readonly enableUserData?: boolean;
1494
+ /**
1495
+ * Optional, the max number of images to return, per image type.
1496
+ * @type {number}
1497
+ * @memberof ItemsApiGetItemsByUserId
1498
+ */
1499
+ readonly imageTypeLimit?: number;
1500
+ /**
1501
+ * Optional. The image types to include in the output.
1502
+ * @type {Array<ImageType>}
1503
+ * @memberof ItemsApiGetItemsByUserId
1504
+ */
1505
+ readonly enableImageTypes?: Array<ImageType>;
1506
+ /**
1507
+ * Optional. If specified, results will be filtered to include only those containing the specified person.
1508
+ * @type {string}
1509
+ * @memberof ItemsApiGetItemsByUserId
1510
+ */
1511
+ readonly person?: string;
1512
+ /**
1513
+ * Optional. If specified, results will be filtered to include only those containing the specified person id.
1514
+ * @type {Array<string>}
1515
+ * @memberof ItemsApiGetItemsByUserId
1516
+ */
1517
+ readonly personIds?: Array<string>;
1518
+ /**
1519
+ * Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited.
1520
+ * @type {Array<string>}
1521
+ * @memberof ItemsApiGetItemsByUserId
1522
+ */
1523
+ readonly personTypes?: Array<string>;
1524
+ /**
1525
+ * Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.
1526
+ * @type {Array<string>}
1527
+ * @memberof ItemsApiGetItemsByUserId
1528
+ */
1529
+ readonly studios?: Array<string>;
1530
+ /**
1531
+ * Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited.
1532
+ * @type {Array<string>}
1533
+ * @memberof ItemsApiGetItemsByUserId
1534
+ */
1535
+ readonly artists?: Array<string>;
1536
+ /**
1537
+ * Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited.
1538
+ * @type {Array<string>}
1539
+ * @memberof ItemsApiGetItemsByUserId
1540
+ */
1541
+ readonly excludeArtistIds?: Array<string>;
1542
+ /**
1543
+ * Optional. If specified, results will be filtered to include only those containing the specified artist id.
1544
+ * @type {Array<string>}
1545
+ * @memberof ItemsApiGetItemsByUserId
1546
+ */
1547
+ readonly artistIds?: Array<string>;
1548
+ /**
1549
+ * Optional. If specified, results will be filtered to include only those containing the specified album artist id.
1550
+ * @type {Array<string>}
1551
+ * @memberof ItemsApiGetItemsByUserId
1552
+ */
1553
+ readonly albumArtistIds?: Array<string>;
1554
+ /**
1555
+ * Optional. If specified, results will be filtered to include only those containing the specified contributing artist id.
1556
+ * @type {Array<string>}
1557
+ * @memberof ItemsApiGetItemsByUserId
1558
+ */
1559
+ readonly contributingArtistIds?: Array<string>;
1560
+ /**
1561
+ * Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited.
1562
+ * @type {Array<string>}
1563
+ * @memberof ItemsApiGetItemsByUserId
1564
+ */
1565
+ readonly albums?: Array<string>;
1566
+ /**
1567
+ * Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited.
1568
+ * @type {Array<string>}
1569
+ * @memberof ItemsApiGetItemsByUserId
1570
+ */
1571
+ readonly albumIds?: Array<string>;
1572
+ /**
1573
+ * Optional. If specific items are needed, specify a list of item id\&#39;s to retrieve. This allows multiple, comma delimited.
1574
+ * @type {Array<string>}
1575
+ * @memberof ItemsApiGetItemsByUserId
1576
+ */
1577
+ readonly ids?: Array<string>;
1578
+ /**
1579
+ * Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimited.
1580
+ * @type {Array<VideoType>}
1581
+ * @memberof ItemsApiGetItemsByUserId
1582
+ */
1583
+ readonly videoTypes?: Array<VideoType>;
1584
+ /**
1585
+ * Optional filter by minimum official rating (PG, PG-13, TV-MA, etc).
1586
+ * @type {string}
1587
+ * @memberof ItemsApiGetItemsByUserId
1588
+ */
1589
+ readonly minOfficialRating?: string;
1590
+ /**
1591
+ * Optional filter by items that are locked.
1592
+ * @type {boolean}
1593
+ * @memberof ItemsApiGetItemsByUserId
1594
+ */
1595
+ readonly isLocked?: boolean;
1596
+ /**
1597
+ * Optional filter by items that are placeholders.
1598
+ * @type {boolean}
1599
+ * @memberof ItemsApiGetItemsByUserId
1600
+ */
1601
+ readonly isPlaceHolder?: boolean;
1602
+ /**
1603
+ * Optional filter by items that have official ratings.
1604
+ * @type {boolean}
1605
+ * @memberof ItemsApiGetItemsByUserId
1606
+ */
1607
+ readonly hasOfficialRating?: boolean;
1608
+ /**
1609
+ * Whether or not to hide items behind their boxsets.
1610
+ * @type {boolean}
1611
+ * @memberof ItemsApiGetItemsByUserId
1612
+ */
1613
+ readonly collapseBoxSetItems?: boolean;
1614
+ /**
1615
+ * Optional. Filter by the minimum width of the item.
1616
+ * @type {number}
1617
+ * @memberof ItemsApiGetItemsByUserId
1618
+ */
1619
+ readonly minWidth?: number;
1620
+ /**
1621
+ * Optional. Filter by the minimum height of the item.
1622
+ * @type {number}
1623
+ * @memberof ItemsApiGetItemsByUserId
1624
+ */
1625
+ readonly minHeight?: number;
1626
+ /**
1627
+ * Optional. Filter by the maximum width of the item.
1628
+ * @type {number}
1629
+ * @memberof ItemsApiGetItemsByUserId
1630
+ */
1631
+ readonly maxWidth?: number;
1632
+ /**
1633
+ * Optional. Filter by the maximum height of the item.
1634
+ * @type {number}
1635
+ * @memberof ItemsApiGetItemsByUserId
1636
+ */
1637
+ readonly maxHeight?: number;
1638
+ /**
1639
+ * Optional filter by items that are 3D, or not.
1640
+ * @type {boolean}
1641
+ * @memberof ItemsApiGetItemsByUserId
1642
+ */
1643
+ readonly is3D?: boolean;
1644
+ /**
1645
+ * Optional filter by Series Status. Allows multiple, comma delimited.
1646
+ * @type {Array<SeriesStatus>}
1647
+ * @memberof ItemsApiGetItemsByUserId
1648
+ */
1649
+ readonly seriesStatus?: Array<SeriesStatus>;
1650
+ /**
1651
+ * Optional filter by items whose name is sorted equally or greater than a given input string.
1652
+ * @type {string}
1653
+ * @memberof ItemsApiGetItemsByUserId
1654
+ */
1655
+ readonly nameStartsWithOrGreater?: string;
1656
+ /**
1657
+ * Optional filter by items whose name is sorted equally than a given input string.
1658
+ * @type {string}
1659
+ * @memberof ItemsApiGetItemsByUserId
1660
+ */
1661
+ readonly nameStartsWith?: string;
1662
+ /**
1663
+ * Optional filter by items whose name is equally or lesser than a given input string.
1664
+ * @type {string}
1665
+ * @memberof ItemsApiGetItemsByUserId
1666
+ */
1667
+ readonly nameLessThan?: string;
1668
+ /**
1669
+ * Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.
1670
+ * @type {Array<string>}
1671
+ * @memberof ItemsApiGetItemsByUserId
1672
+ */
1673
+ readonly studioIds?: Array<string>;
1674
+ /**
1675
+ * Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
1676
+ * @type {Array<string>}
1677
+ * @memberof ItemsApiGetItemsByUserId
1678
+ */
1679
+ readonly genreIds?: Array<string>;
1680
+ /**
1681
+ * Optional. Enable the total record count.
1682
+ * @type {boolean}
1683
+ * @memberof ItemsApiGetItemsByUserId
1684
+ */
1685
+ readonly enableTotalRecordCount?: boolean;
1686
+ /**
1687
+ * Optional, include image information in output.
1688
+ * @type {boolean}
1689
+ * @memberof ItemsApiGetItemsByUserId
1690
+ */
1691
+ readonly enableImages?: boolean;
1692
+ }
1693
+ /**
1694
+ * Request parameters for getResumeItems operation in ItemsApi.
1695
+ * @export
1696
+ * @interface ItemsApiGetResumeItemsRequest
1697
+ */
1698
+ export interface ItemsApiGetResumeItemsRequest {
1699
+ /**
1700
+ * The user id.
1701
+ * @type {string}
1702
+ * @memberof ItemsApiGetResumeItems
1703
+ */
1704
+ readonly userId: string;
1705
+ /**
1706
+ * The start index.
1707
+ * @type {number}
1708
+ * @memberof ItemsApiGetResumeItems
1709
+ */
1710
+ readonly startIndex?: number;
1711
+ /**
1712
+ * The item limit.
1713
+ * @type {number}
1714
+ * @memberof ItemsApiGetResumeItems
1715
+ */
1716
+ readonly limit?: number;
1717
+ /**
1718
+ * The search term.
1719
+ * @type {string}
1720
+ * @memberof ItemsApiGetResumeItems
1721
+ */
1722
+ readonly searchTerm?: string;
1723
+ /**
1724
+ * Specify this to localize the search to a specific item or folder. Omit to use the root.
1725
+ * @type {string}
1726
+ * @memberof ItemsApiGetResumeItems
1727
+ */
1728
+ readonly parentId?: string;
1729
+ /**
1730
+ * 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.
1731
+ * @type {Array<ItemFields>}
1732
+ * @memberof ItemsApiGetResumeItems
1733
+ */
1734
+ readonly fields?: Array<ItemFields>;
1735
+ /**
1736
+ * Optional. Filter by MediaType. Allows multiple, comma delimited.
1737
+ * @type {Array<string>}
1738
+ * @memberof ItemsApiGetResumeItems
1739
+ */
1740
+ readonly mediaTypes?: Array<string>;
1741
+ /**
1742
+ * Optional. Include user data.
1743
+ * @type {boolean}
1744
+ * @memberof ItemsApiGetResumeItems
1745
+ */
1746
+ readonly enableUserData?: boolean;
1747
+ /**
1748
+ * Optional. The max number of images to return, per image type.
1749
+ * @type {number}
1750
+ * @memberof ItemsApiGetResumeItems
1751
+ */
1752
+ readonly imageTypeLimit?: number;
1753
+ /**
1754
+ * Optional. The image types to include in the output.
1755
+ * @type {Array<ImageType>}
1756
+ * @memberof ItemsApiGetResumeItems
1757
+ */
1758
+ readonly enableImageTypes?: Array<ImageType>;
1759
+ /**
1760
+ * Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
1761
+ * @type {Array<BaseItemKind>}
1762
+ * @memberof ItemsApiGetResumeItems
1763
+ */
1764
+ readonly excludeItemTypes?: Array<BaseItemKind>;
1765
+ /**
1766
+ * Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.
1767
+ * @type {Array<BaseItemKind>}
1768
+ * @memberof ItemsApiGetResumeItems
1769
+ */
1770
+ readonly includeItemTypes?: Array<BaseItemKind>;
1771
+ /**
1772
+ * Optional. Enable the total record count.
1773
+ * @type {boolean}
1774
+ * @memberof ItemsApiGetResumeItems
1775
+ */
1776
+ readonly enableTotalRecordCount?: boolean;
1777
+ /**
1778
+ * Optional. Include image information in output.
1779
+ * @type {boolean}
1780
+ * @memberof ItemsApiGetResumeItems
1781
+ */
1782
+ readonly enableImages?: boolean;
1783
+ /**
1784
+ * Optional. Whether to exclude the currently active sessions.
1785
+ * @type {boolean}
1786
+ * @memberof ItemsApiGetResumeItems
1787
+ */
1788
+ readonly excludeActiveSessions?: boolean;
1789
+ }
1790
+ /**
1791
+ * ItemsApi - object-oriented interface
1792
+ * @export
1793
+ * @class ItemsApi
1794
+ * @extends {BaseAPI}
1795
+ */
1796
+ export declare class ItemsApi extends BaseAPI {
1797
+ /**
1798
+ *
1799
+ * @summary Gets items based on a query.
1800
+ * @param {ItemsApiGetItemsRequest} requestParameters Request parameters.
1801
+ * @param {*} [options] Override http request option.
1802
+ * @throws {RequiredError}
1803
+ * @memberof ItemsApi
1804
+ */
1805
+ getItems(requestParameters?: ItemsApiGetItemsRequest, options?: any): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any>>;
1806
+ /**
1807
+ *
1808
+ * @summary Gets items based on a query.
1809
+ * @param {ItemsApiGetItemsByUserIdRequest} requestParameters Request parameters.
1810
+ * @param {*} [options] Override http request option.
1811
+ * @throws {RequiredError}
1812
+ * @memberof ItemsApi
1813
+ */
1814
+ getItemsByUserId(requestParameters: ItemsApiGetItemsByUserIdRequest, options?: any): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any>>;
1815
+ /**
1816
+ *
1817
+ * @summary Gets items based on a query.
1818
+ * @param {ItemsApiGetResumeItemsRequest} requestParameters Request parameters.
1819
+ * @param {*} [options] Override http request option.
1820
+ * @throws {RequiredError}
1821
+ * @memberof ItemsApi
1822
+ */
1823
+ getResumeItems(requestParameters: ItemsApiGetResumeItemsRequest, options?: any): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any>>;
1824
+ }