@jellyfin/sdk 0.13.0 → 1.0.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 (760) hide show
  1. package/.nvmrc +1 -0
  2. package/.openapi-generator-ignore +2 -0
  3. package/CHANGELOG.md +24 -2
  4. package/README.md +52 -27
  5. package/eslint.config.mjs +118 -0
  6. package/lib/api.d.ts +30 -8
  7. package/lib/api.js +79 -14
  8. package/lib/constants.d.ts +11 -0
  9. package/lib/constants.js +13 -0
  10. package/lib/generated-client/api/{artists-api.d.ts → artist-api.d.ts} +38 -173
  11. package/lib/generated-client/api/{artists-api.js → artist-api.js} +39 -33
  12. package/lib/generated-client/api/audio-api.d.ts +295 -450
  13. package/lib/generated-client/api/audio-api.js +332 -64
  14. package/lib/generated-client/api/authentication-api.d.ts +517 -0
  15. package/lib/generated-client/api/authentication-api.js +870 -0
  16. package/lib/generated-client/api/backup-api.d.ts +0 -22
  17. package/lib/generated-client/api/backup-api.js +5 -11
  18. package/lib/generated-client/api/branding-api.d.ts +0 -9
  19. package/lib/generated-client/api/branding-api.js +4 -10
  20. package/lib/generated-client/api/{channels-api.d.ts → channel-api.d.ts} +32 -95
  21. package/lib/generated-client/api/{channels-api.js → channel-api.js} +35 -41
  22. package/lib/generated-client/api/collection-api.d.ts +0 -31
  23. package/lib/generated-client/api/collection-api.js +4 -10
  24. package/lib/generated-client/api/{devices-api.d.ts → device-api.d.ts} +48 -81
  25. package/lib/generated-client/api/{devices-api.js → device-api.js} +46 -54
  26. package/lib/generated-client/api/{display-preferences-api.d.ts → display-preference-api.d.ts} +20 -46
  27. package/lib/generated-client/api/{display-preferences-api.js → display-preference-api.js} +22 -28
  28. package/lib/generated-client/api/environment-api.d.ts +0 -60
  29. package/lib/generated-client/api/environment-api.js +6 -75
  30. package/lib/generated-client/api/filter-api.d.ts +0 -40
  31. package/lib/generated-client/api/filter-api.js +3 -9
  32. package/lib/generated-client/api/{genres-api.d.ts → genre-api.d.ts} +20 -72
  33. package/lib/generated-client/api/{genres-api.js → genre-api.js} +22 -28
  34. package/lib/generated-client/api/image-api.d.ts +4 -1007
  35. package/lib/generated-client/api/image-api.js +42 -48
  36. package/lib/generated-client/api/instant-mix-api.d.ts +8 -245
  37. package/lib/generated-client/api/instant-mix-api.js +16 -121
  38. package/lib/generated-client/api/item-lookup-api.d.ts +0 -65
  39. package/lib/generated-client/api/item-lookup-api.js +12 -18
  40. package/lib/generated-client/api/item-update-api.d.ts +0 -25
  41. package/lib/generated-client/api/item-update-api.js +4 -10
  42. package/lib/generated-client/api/library-api.d.ts +1239 -327
  43. package/lib/generated-client/api/library-api.js +1307 -95
  44. package/lib/generated-client/api/library-structure-api.d.ts +0 -62
  45. package/lib/generated-client/api/library-structure-api.js +9 -15
  46. package/lib/generated-client/api/live-tv-api.d.ts +0 -622
  47. package/lib/generated-client/api/live-tv-api.js +39 -320
  48. package/lib/generated-client/api/localization-api.d.ts +0 -10
  49. package/lib/generated-client/api/localization-api.js +5 -11
  50. package/lib/generated-client/api/{lyrics-api.d.ts → lyric-api.d.ts} +44 -89
  51. package/lib/generated-client/api/{lyrics-api.js → lyric-api.js} +42 -48
  52. package/lib/generated-client/api/media-info-api.d.ts +4 -91
  53. package/lib/generated-client/api/media-info-api.js +10 -16
  54. package/lib/generated-client/api/{media-segments-api.d.ts → media-segment-api.d.ts} +14 -27
  55. package/lib/generated-client/api/{media-segments-api.js → media-segment-api.js} +17 -23
  56. package/lib/generated-client/api/{movies-api.d.ts → movie-api.d.ts} +14 -33
  57. package/lib/generated-client/api/{movies-api.js → movie-api.js} +17 -23
  58. package/lib/generated-client/api/music-genre-api.d.ts +85 -0
  59. package/lib/generated-client/api/music-genre-api.js +121 -0
  60. package/lib/generated-client/api/{persons-api.d.ts → person-api.d.ts} +52 -64
  61. package/lib/generated-client/api/{persons-api.js → person-api.js} +51 -32
  62. package/lib/generated-client/api/{playlists-api.d.ts → playlist-api.d.ts} +86 -185
  63. package/lib/generated-client/api/{playlists-api.js → playlist-api.js} +80 -81
  64. package/lib/generated-client/api/plugin-api.d.ts +743 -0
  65. package/lib/generated-client/api/plugin-api.js +1186 -0
  66. package/lib/generated-client/api/remote-image-api.d.ts +0 -35
  67. package/lib/generated-client/api/remote-image-api.js +4 -10
  68. package/lib/generated-client/api/{scheduled-tasks-api.d.ts → scheduled-task-api.d.ts} +38 -73
  69. package/lib/generated-client/api/{scheduled-tasks-api.js → scheduled-task-api.js} +37 -43
  70. package/lib/generated-client/api/search-api.d.ts +0 -45
  71. package/lib/generated-client/api/search-api.js +2 -8
  72. package/lib/generated-client/api/session-api.d.ts +163 -181
  73. package/lib/generated-client/api/session-api.js +262 -123
  74. package/lib/generated-client/api/{tv-shows-api.d.ts → show-api.d.ts} +34 -156
  75. package/lib/generated-client/api/{tv-shows-api.js → show-api.js} +36 -47
  76. package/lib/generated-client/api/startup-api.d.ts +20 -25
  77. package/lib/generated-client/api/startup-api.js +28 -14
  78. package/lib/generated-client/api/{studios-api.d.ts → studio-api.d.ts} +20 -70
  79. package/lib/generated-client/api/{studios-api.js → studio-api.js} +22 -28
  80. package/lib/generated-client/api/subtitle-api.d.ts +0 -114
  81. package/lib/generated-client/api/subtitle-api.js +11 -17
  82. package/lib/generated-client/api/{suggestions-api.d.ts → suggestion-api.d.ts} +14 -35
  83. package/lib/generated-client/api/{suggestions-api.js → suggestion-api.js} +17 -23
  84. package/lib/generated-client/api/sync-play-api.d.ts +0 -96
  85. package/lib/generated-client/api/sync-play-api.js +23 -29
  86. package/lib/generated-client/api/system-api.d.ts +420 -20
  87. package/lib/generated-client/api/system-api.js +659 -18
  88. package/lib/generated-client/api/{trailers-api.d.ts → trailer-api.d.ts} +32 -193
  89. package/lib/generated-client/api/{trailers-api.js → trailer-api.js} +35 -27
  90. package/lib/generated-client/api/{trickplay-api.d.ts → trick-play-api.d.ts} +20 -46
  91. package/lib/generated-client/api/{trickplay-api.js → trick-play-api.js} +22 -28
  92. package/lib/generated-client/api/user-api.d.ts +0 -249
  93. package/lib/generated-client/api/user-api.js +11 -277
  94. package/lib/generated-client/api/user-data-api.d.ts +429 -0
  95. package/lib/generated-client/api/{user-library-api.js → user-data-api.js} +149 -324
  96. package/lib/generated-client/api/{user-views-api.d.ts → user-view-api.d.ts} +20 -42
  97. package/lib/generated-client/api/{user-views-api.js → user-view-api.js} +22 -28
  98. package/lib/generated-client/api/{videos-api.d.ts → video-api.d.ts} +111 -533
  99. package/lib/generated-client/api/{videos-api.js → video-api.js} +141 -101
  100. package/lib/generated-client/api/{years-api.d.ts → year-api.d.ts} +20 -66
  101. package/lib/generated-client/api/{years-api.js → year-api.js} +22 -28
  102. package/lib/generated-client/api.d.ts +23 -38
  103. package/lib/generated-client/base.d.ts +0 -24
  104. package/lib/generated-client/base.js +0 -15
  105. package/lib/generated-client/common.d.ts +4 -35
  106. package/lib/generated-client/common.js +15 -26
  107. package/lib/generated-client/configuration.d.ts +24 -17
  108. package/lib/generated-client/configuration.js +8 -2
  109. package/lib/generated-client/index.js +25 -39
  110. package/lib/generated-client/models/access-schedule.d.ts +0 -15
  111. package/lib/generated-client/models/activity-log-entry-message.d.ts +0 -11
  112. package/lib/generated-client/models/activity-log-entry-query-result.d.ts +0 -8
  113. package/lib/generated-client/models/activity-log-entry-start-message.d.ts +1 -10
  114. package/lib/generated-client/models/activity-log-entry-stop-message.d.ts +0 -7
  115. package/lib/generated-client/models/activity-log-entry.d.ts +0 -25
  116. package/lib/generated-client/models/activity-log-sort-by.d.ts +23 -0
  117. package/lib/generated-client/models/{architecture.d.ts → activity-log-sort-by.js} +13 -11
  118. package/lib/generated-client/models/add-virtual-folder-dto.d.ts +0 -7
  119. package/lib/generated-client/models/album-info-remote-search-query.d.ts +0 -19
  120. package/lib/generated-client/models/album-info.d.ts +1 -49
  121. package/lib/generated-client/models/all-theme-media-result.d.ts +0 -20
  122. package/lib/generated-client/models/artist-info-remote-search-query.d.ts +0 -19
  123. package/lib/generated-client/models/artist-info.d.ts +0 -44
  124. package/lib/generated-client/models/audio-spatial-format.d.ts +0 -2
  125. package/lib/generated-client/models/audio-spatial-format.js +0 -2
  126. package/lib/generated-client/models/authenticate-user-by-name.d.ts +0 -6
  127. package/lib/generated-client/models/authentication-info-query-result.d.ts +0 -8
  128. package/lib/generated-client/models/authentication-info.d.ts +0 -35
  129. package/lib/generated-client/models/authentication-result.d.ts +0 -16
  130. package/lib/generated-client/models/backup-manifest-dto.d.ts +5 -20
  131. package/lib/generated-client/models/backup-options-dto.d.ts +0 -10
  132. package/lib/generated-client/models/backup-restore-request-dto.d.ts +1 -5
  133. package/lib/generated-client/models/base-item-dto-image-blur-hashes.d.ts +14 -81
  134. package/lib/generated-client/models/base-item-dto-query-result.d.ts +0 -8
  135. package/lib/generated-client/models/base-item-dto.d.ts +6 -456
  136. package/lib/generated-client/models/base-item-kind.d.ts +0 -2
  137. package/lib/generated-client/models/base-item-kind.js +0 -2
  138. package/lib/generated-client/models/base-item-person-image-blur-hashes.d.ts +13 -80
  139. package/lib/generated-client/models/base-item-person.d.ts +0 -20
  140. package/lib/generated-client/models/book-info-remote-search-query.d.ts +0 -19
  141. package/lib/generated-client/models/book-info.d.ts +2 -40
  142. package/lib/generated-client/models/box-set-info-remote-search-query.d.ts +0 -19
  143. package/lib/generated-client/models/box-set-info.d.ts +1 -37
  144. package/lib/generated-client/models/branding-options-dto.d.ts +1 -9
  145. package/lib/generated-client/models/buffer-request-dto.d.ts +0 -10
  146. package/lib/generated-client/models/cast-receiver-application.d.ts +2 -8
  147. package/lib/generated-client/models/channel-features.d.ts +0 -29
  148. package/lib/generated-client/models/channel-item-sort-field.d.ts +0 -5
  149. package/lib/generated-client/models/channel-item-sort-field.js +0 -5
  150. package/lib/generated-client/models/channel-mapping-options-dto.d.ts +2 -12
  151. package/lib/generated-client/models/channel-media-content-type.d.ts +0 -5
  152. package/lib/generated-client/models/channel-media-content-type.js +0 -5
  153. package/lib/generated-client/models/channel-media-type.d.ts +0 -5
  154. package/lib/generated-client/models/channel-media-type.js +0 -5
  155. package/lib/generated-client/models/channel-type.d.ts +0 -2
  156. package/lib/generated-client/models/channel-type.js +0 -2
  157. package/lib/generated-client/models/chapter-info.d.ts +0 -18
  158. package/lib/generated-client/models/client-capabilities-dto.d.ts +0 -19
  159. package/lib/generated-client/models/client-log-document-response-dto.d.ts +0 -4
  160. package/lib/generated-client/models/codec-profile.d.ts +0 -17
  161. package/lib/generated-client/models/codec-type.d.ts +1 -3
  162. package/lib/generated-client/models/codec-type.js +1 -3
  163. package/lib/generated-client/models/collection-creation-result.d.ts +0 -10
  164. package/lib/generated-client/models/collection-type-options.d.ts +0 -2
  165. package/lib/generated-client/models/collection-type-options.js +0 -2
  166. package/lib/generated-client/models/collection-type.d.ts +0 -2
  167. package/lib/generated-client/models/collection-type.js +0 -2
  168. package/lib/generated-client/models/configuration-page-info.d.ts +0 -14
  169. package/lib/generated-client/models/container-profile.d.ts +0 -13
  170. package/lib/generated-client/models/country-info.d.ts +0 -10
  171. package/lib/generated-client/models/create-playlist-dto.d.ts +1 -18
  172. package/lib/generated-client/models/create-user-by-name.d.ts +0 -6
  173. package/lib/generated-client/models/culture-dto.d.ts +0 -15
  174. package/lib/generated-client/models/custom-database-option.d.ts +2 -8
  175. package/lib/generated-client/models/custom-database-options.d.ts +3 -13
  176. package/lib/generated-client/models/database-configuration-options.d.ts +1 -15
  177. package/lib/generated-client/models/database-locking-behavior-types.d.ts +0 -2
  178. package/lib/generated-client/models/database-locking-behavior-types.js +0 -2
  179. package/lib/generated-client/models/day-of-week.d.ts +0 -5
  180. package/lib/generated-client/models/day-of-week.js +0 -5
  181. package/lib/generated-client/models/day-pattern.d.ts +1 -3
  182. package/lib/generated-client/models/day-pattern.js +1 -3
  183. package/lib/generated-client/models/default-directory-browser-info-dto.d.ts +0 -4
  184. package/lib/generated-client/models/deinterlace-method.d.ts +0 -2
  185. package/lib/generated-client/models/deinterlace-method.js +0 -2
  186. package/lib/generated-client/models/device-info-dto-query-result.d.ts +0 -8
  187. package/lib/generated-client/models/device-info-dto.d.ts +0 -27
  188. package/lib/generated-client/models/device-options-dto.d.ts +0 -8
  189. package/lib/generated-client/models/device-profile.d.ts +1 -25
  190. package/lib/generated-client/models/direct-play-profile.d.ts +0 -13
  191. package/lib/generated-client/models/display-preferences-dto.d.ts +0 -36
  192. package/lib/generated-client/models/dlna-profile-type.d.ts +0 -5
  193. package/lib/generated-client/models/dlna-profile-type.js +0 -5
  194. package/lib/generated-client/models/down-mix-stereo-algorithms.d.ts +0 -2
  195. package/lib/generated-client/models/down-mix-stereo-algorithms.js +0 -2
  196. package/lib/generated-client/models/dynamic-day-of-week.d.ts +0 -2
  197. package/lib/generated-client/models/dynamic-day-of-week.js +0 -2
  198. package/lib/generated-client/models/embedded-subtitle-options.d.ts +0 -2
  199. package/lib/generated-client/models/embedded-subtitle-options.js +0 -2
  200. package/lib/generated-client/models/encoder-preset.d.ts +0 -2
  201. package/lib/generated-client/models/encoder-preset.js +0 -2
  202. package/lib/generated-client/models/encoding-context.d.ts +1 -3
  203. package/lib/generated-client/models/encoding-context.js +1 -3
  204. package/lib/generated-client/models/encoding-options.d.ts +6 -117
  205. package/lib/generated-client/models/end-point-info.d.ts +0 -15
  206. package/lib/generated-client/models/external-id-info.d.ts +0 -11
  207. package/lib/generated-client/models/external-id-media-type.d.ts +0 -2
  208. package/lib/generated-client/models/external-id-media-type.js +0 -2
  209. package/lib/generated-client/models/external-url.d.ts +0 -9
  210. package/lib/generated-client/models/extra-type.d.ts +0 -5
  211. package/lib/generated-client/models/extra-type.js +0 -5
  212. package/lib/generated-client/models/file-system-entry-info.d.ts +0 -11
  213. package/lib/generated-client/models/file-system-entry-type.d.ts +0 -2
  214. package/lib/generated-client/models/file-system-entry-type.js +0 -2
  215. package/lib/generated-client/models/folder-storage-dto.d.ts +1 -13
  216. package/lib/generated-client/models/font-file.d.ts +0 -10
  217. package/lib/generated-client/models/force-keep-alive-message.d.ts +0 -11
  218. package/lib/generated-client/models/forgot-password-action.d.ts +0 -5
  219. package/lib/generated-client/models/forgot-password-action.js +0 -5
  220. package/lib/generated-client/models/forgot-password-dto.d.ts +0 -4
  221. package/lib/generated-client/models/forgot-password-pin-dto.d.ts +0 -4
  222. package/lib/generated-client/models/forgot-password-result.d.ts +0 -14
  223. package/lib/generated-client/models/general-command-message.d.ts +0 -14
  224. package/lib/generated-client/models/general-command-type.d.ts +0 -2
  225. package/lib/generated-client/models/general-command-type.js +0 -2
  226. package/lib/generated-client/models/general-command.d.ts +1 -21
  227. package/lib/generated-client/models/get-programs-dto.d.ts +0 -56
  228. package/lib/generated-client/models/group-info-dto.d.ts +0 -15
  229. package/lib/generated-client/models/group-queue-mode.d.ts +0 -2
  230. package/lib/generated-client/models/group-queue-mode.js +0 -2
  231. package/lib/generated-client/models/group-repeat-mode.d.ts +0 -2
  232. package/lib/generated-client/models/group-repeat-mode.js +0 -2
  233. package/lib/generated-client/models/group-shuffle-mode.d.ts +0 -2
  234. package/lib/generated-client/models/group-shuffle-mode.js +0 -2
  235. package/lib/generated-client/models/group-state-type.d.ts +0 -2
  236. package/lib/generated-client/models/group-state-type.js +0 -2
  237. package/lib/generated-client/models/group-state-update.d.ts +0 -12
  238. package/lib/generated-client/models/group-update-type.d.ts +0 -2
  239. package/lib/generated-client/models/group-update-type.js +0 -2
  240. package/lib/generated-client/models/group-update.d.ts +0 -1
  241. package/lib/generated-client/models/guide-info.d.ts +0 -9
  242. package/lib/generated-client/models/hardware-acceleration-type.d.ts +0 -2
  243. package/lib/generated-client/models/hardware-acceleration-type.js +0 -2
  244. package/lib/generated-client/models/{notification-level.d.ts → hls-audio-seek-strategy.d.ts} +5 -8
  245. package/lib/generated-client/models/{transcoding-info.js → hls-audio-seek-strategy.js} +8 -2
  246. package/lib/generated-client/models/ignore-wait-request-dto.d.ts +0 -4
  247. package/lib/generated-client/models/image-format.d.ts +0 -2
  248. package/lib/generated-client/models/image-format.js +0 -2
  249. package/lib/generated-client/models/image-info.d.ts +0 -21
  250. package/lib/generated-client/models/image-option.d.ts +0 -14
  251. package/lib/generated-client/models/image-orientation.d.ts +0 -5
  252. package/lib/generated-client/models/image-orientation.js +0 -5
  253. package/lib/generated-client/models/image-provider-info.d.ts +0 -6
  254. package/lib/generated-client/models/image-resolution.d.ts +0 -2
  255. package/lib/generated-client/models/image-resolution.js +0 -2
  256. package/lib/generated-client/models/image-saving-convention.d.ts +1 -3
  257. package/lib/generated-client/models/image-saving-convention.js +1 -3
  258. package/lib/generated-client/models/image-type.d.ts +0 -2
  259. package/lib/generated-client/models/image-type.js +0 -2
  260. package/lib/generated-client/models/inbound-keep-alive-message.d.ts +0 -7
  261. package/lib/generated-client/models/inbound-web-socket-message.d.ts +0 -1
  262. package/lib/generated-client/models/index.d.ts +2 -2
  263. package/lib/generated-client/models/index.js +2 -1
  264. package/lib/generated-client/models/installation-info.d.ts +0 -19
  265. package/lib/generated-client/models/iplugin.d.ts +0 -16
  266. package/lib/generated-client/models/iso-type.d.ts +0 -2
  267. package/lib/generated-client/models/iso-type.js +0 -2
  268. package/lib/generated-client/models/item-counts.d.ts +0 -26
  269. package/lib/generated-client/models/item-fields.d.ts +0 -2
  270. package/lib/generated-client/models/item-fields.js +0 -2
  271. package/lib/generated-client/models/item-filter.d.ts +0 -2
  272. package/lib/generated-client/models/item-filter.js +0 -2
  273. package/lib/generated-client/models/item-sort-by.d.ts +0 -2
  274. package/lib/generated-client/models/item-sort-by.js +0 -2
  275. package/lib/generated-client/models/join-group-request-dto.d.ts +0 -4
  276. package/lib/generated-client/models/keep-until.d.ts +0 -5
  277. package/lib/generated-client/models/keep-until.js +0 -5
  278. package/lib/generated-client/models/library-changed-message.d.ts +0 -14
  279. package/lib/generated-client/models/library-option-info-dto.d.ts +0 -6
  280. package/lib/generated-client/models/library-options-result-dto.d.ts +0 -14
  281. package/lib/generated-client/models/library-options.d.ts +0 -207
  282. package/lib/generated-client/models/library-storage-dto.d.ts +3 -11
  283. package/lib/generated-client/models/library-type-options-dto.d.ts +4 -12
  284. package/lib/generated-client/models/library-update-info.d.ts +0 -22
  285. package/lib/generated-client/models/listings-provider-info.d.ts +0 -95
  286. package/lib/generated-client/models/live-stream-response.d.ts +0 -10
  287. package/lib/generated-client/models/live-tv-info.d.ts +0 -11
  288. package/lib/generated-client/models/live-tv-options.d.ts +0 -80
  289. package/lib/generated-client/models/live-tv-service-info.d.ts +0 -24
  290. package/lib/generated-client/models/live-tv-service-status.d.ts +1 -3
  291. package/lib/generated-client/models/live-tv-service-status.js +1 -3
  292. package/lib/generated-client/models/localization-option.d.ts +0 -15
  293. package/lib/generated-client/models/location-type.d.ts +0 -2
  294. package/lib/generated-client/models/location-type.js +0 -2
  295. package/lib/generated-client/models/log-file.d.ts +1 -14
  296. package/lib/generated-client/models/log-level.d.ts +0 -5
  297. package/lib/generated-client/models/log-level.js +0 -5
  298. package/lib/generated-client/models/lyric-dto.d.ts +0 -9
  299. package/lib/generated-client/models/lyric-line-cue.d.ts +0 -10
  300. package/lib/generated-client/models/lyric-line.d.ts +0 -8
  301. package/lib/generated-client/models/lyric-metadata.d.ts +0 -22
  302. package/lib/generated-client/models/media-attachment.d.ts +0 -16
  303. package/lib/generated-client/models/media-path-dto.d.ts +0 -11
  304. package/lib/generated-client/models/media-path-info.d.ts +0 -10
  305. package/lib/generated-client/models/media-protocol.d.ts +0 -5
  306. package/lib/generated-client/models/media-protocol.js +0 -5
  307. package/lib/generated-client/models/media-segment-dto-query-result.d.ts +0 -8
  308. package/lib/generated-client/models/media-segment-dto.d.ts +0 -15
  309. package/lib/generated-client/models/media-segment-type.d.ts +0 -2
  310. package/lib/generated-client/models/media-segment-type.js +0 -2
  311. package/lib/generated-client/models/media-source-info.d.ts +1 -228
  312. package/lib/generated-client/models/media-source-type.d.ts +1 -3
  313. package/lib/generated-client/models/media-source-type.js +1 -3
  314. package/lib/generated-client/models/media-stream-protocol.d.ts +1 -3
  315. package/lib/generated-client/models/media-stream-protocol.js +1 -3
  316. package/lib/generated-client/models/media-stream-type.d.ts +0 -2
  317. package/lib/generated-client/models/media-stream-type.js +0 -2
  318. package/lib/generated-client/models/media-stream.d.ts +7 -176
  319. package/lib/generated-client/models/media-type.d.ts +0 -2
  320. package/lib/generated-client/models/media-type.js +0 -2
  321. package/lib/generated-client/models/media-update-info-dto.d.ts +0 -4
  322. package/lib/generated-client/models/media-update-info-path-dto.d.ts +1 -7
  323. package/lib/generated-client/models/media-url.d.ts +0 -15
  324. package/lib/generated-client/models/message-command.d.ts +4 -12
  325. package/lib/generated-client/models/metadata-configuration.d.ts +0 -10
  326. package/lib/generated-client/models/metadata-editor-info.d.ts +0 -17
  327. package/lib/generated-client/models/metadata-field.d.ts +0 -2
  328. package/lib/generated-client/models/metadata-field.js +0 -2
  329. package/lib/generated-client/models/metadata-options.d.ts +0 -37
  330. package/lib/generated-client/models/metadata-refresh-mode.d.ts +0 -5
  331. package/lib/generated-client/models/metadata-refresh-mode.js +0 -5
  332. package/lib/generated-client/models/move-playlist-item-request-dto.d.ts +0 -6
  333. package/lib/generated-client/models/movie-info-remote-search-query.d.ts +0 -19
  334. package/lib/generated-client/models/movie-info.d.ts +1 -37
  335. package/lib/generated-client/models/music-video-info-remote-search-query.d.ts +0 -19
  336. package/lib/generated-client/models/music-video-info.d.ts +0 -44
  337. package/lib/generated-client/models/name-guid-pair.d.ts +0 -15
  338. package/lib/generated-client/models/name-id-pair.d.ts +0 -9
  339. package/lib/generated-client/models/name-value-pair.d.ts +0 -9
  340. package/lib/generated-client/models/network-configuration.d.ts +1 -49
  341. package/lib/generated-client/models/new-group-request-dto.d.ts +0 -4
  342. package/lib/generated-client/models/next-item-request-dto.d.ts +0 -4
  343. package/lib/generated-client/models/open-live-stream-dto.d.ts +0 -33
  344. package/lib/generated-client/models/outbound-keep-alive-message.d.ts +0 -9
  345. package/lib/generated-client/models/outbound-web-socket-message.d.ts +0 -1
  346. package/lib/generated-client/models/package-info.d.ts +1 -19
  347. package/lib/generated-client/models/parental-rating-score.d.ts +0 -6
  348. package/lib/generated-client/models/parental-rating.d.ts +0 -11
  349. package/lib/generated-client/models/path-substitution.d.ts +0 -6
  350. package/lib/generated-client/models/person-kind.d.ts +1 -2
  351. package/lib/generated-client/models/person-kind.js +2 -3
  352. package/lib/generated-client/models/person-lookup-info-remote-search-query.d.ts +0 -19
  353. package/lib/generated-client/models/person-lookup-info.d.ts +1 -37
  354. package/lib/generated-client/models/pin-redeem-result.d.ts +0 -9
  355. package/lib/generated-client/models/ping-request-dto.d.ts +0 -4
  356. package/lib/generated-client/models/play-access.d.ts +1 -3
  357. package/lib/generated-client/models/play-access.js +1 -3
  358. package/lib/generated-client/models/play-command.d.ts +0 -2
  359. package/lib/generated-client/models/play-command.js +0 -2
  360. package/lib/generated-client/models/play-message.d.ts +0 -14
  361. package/lib/generated-client/models/play-method.d.ts +1 -3
  362. package/lib/generated-client/models/play-method.js +1 -3
  363. package/lib/generated-client/models/play-queue-update-reason.d.ts +0 -2
  364. package/lib/generated-client/models/play-queue-update-reason.js +0 -2
  365. package/lib/generated-client/models/play-queue-update.d.ts +0 -27
  366. package/lib/generated-client/models/play-request-dto.d.ts +0 -8
  367. package/lib/generated-client/models/play-request.d.ts +0 -33
  368. package/lib/generated-client/models/playback-error-code.d.ts +1 -3
  369. package/lib/generated-client/models/playback-error-code.js +1 -3
  370. package/lib/generated-client/models/playback-info-dto.d.ts +0 -37
  371. package/lib/generated-client/models/playback-info-response.d.ts +0 -11
  372. package/lib/generated-client/models/playback-order.d.ts +0 -2
  373. package/lib/generated-client/models/playback-order.js +0 -2
  374. package/lib/generated-client/models/playback-progress-info.d.ts +0 -71
  375. package/lib/generated-client/models/playback-request-type.d.ts +0 -2
  376. package/lib/generated-client/models/playback-request-type.js +0 -2
  377. package/lib/generated-client/models/playback-start-info.d.ts +0 -71
  378. package/lib/generated-client/models/playback-stop-info.d.ts +0 -36
  379. package/lib/generated-client/models/player-state-info.d.ts +0 -38
  380. package/lib/generated-client/models/playlist-creation-result.d.ts +0 -10
  381. package/lib/generated-client/models/playlist-dto.d.ts +2 -10
  382. package/lib/generated-client/models/playlist-user-permissions.d.ts +0 -6
  383. package/lib/generated-client/models/playstate-command.d.ts +0 -2
  384. package/lib/generated-client/models/playstate-command.js +0 -2
  385. package/lib/generated-client/models/playstate-message.d.ts +0 -14
  386. package/lib/generated-client/models/playstate-request.d.ts +2 -13
  387. package/lib/generated-client/models/plugin-info.d.ts +0 -21
  388. package/lib/generated-client/models/plugin-installation-cancelled-message.d.ts +0 -14
  389. package/lib/generated-client/models/plugin-installation-completed-message.d.ts +0 -14
  390. package/lib/generated-client/models/plugin-installation-failed-message.d.ts +0 -14
  391. package/lib/generated-client/models/plugin-installing-message.d.ts +0 -14
  392. package/lib/generated-client/models/plugin-status.d.ts +0 -2
  393. package/lib/generated-client/models/plugin-status.js +0 -2
  394. package/lib/generated-client/models/plugin-uninstalled-message.d.ts +0 -14
  395. package/lib/generated-client/models/previous-item-request-dto.d.ts +0 -4
  396. package/lib/generated-client/models/problem-details.d.ts +0 -30
  397. package/lib/generated-client/models/process-priority-class.d.ts +0 -5
  398. package/lib/generated-client/models/process-priority-class.js +0 -5
  399. package/lib/generated-client/models/profile-condition-type.d.ts +0 -5
  400. package/lib/generated-client/models/profile-condition-type.js +0 -5
  401. package/lib/generated-client/models/profile-condition-value.d.ts +1 -5
  402. package/lib/generated-client/models/profile-condition-value.js +2 -6
  403. package/lib/generated-client/models/profile-condition.d.ts +0 -25
  404. package/lib/generated-client/models/program-audio.d.ts +0 -5
  405. package/lib/generated-client/models/program-audio.js +0 -5
  406. package/lib/generated-client/models/public-system-info.d.ts +0 -19
  407. package/lib/generated-client/models/query-filters-legacy.d.ts +0 -25
  408. package/lib/generated-client/models/query-filters.d.ts +3 -15
  409. package/lib/generated-client/models/queue-item.d.ts +3 -9
  410. package/lib/generated-client/models/queue-request-dto.d.ts +0 -9
  411. package/lib/generated-client/models/quick-connect-dto.d.ts +0 -4
  412. package/lib/generated-client/models/quick-connect-result.d.ts +0 -18
  413. package/lib/generated-client/models/rating-type.d.ts +1 -3
  414. package/lib/generated-client/models/rating-type.js +1 -3
  415. package/lib/generated-client/models/ready-request-dto.d.ts +0 -10
  416. package/lib/generated-client/models/recommendation-dto.d.ts +0 -25
  417. package/lib/generated-client/models/recommendation-type.d.ts +0 -5
  418. package/lib/generated-client/models/recommendation-type.js +0 -5
  419. package/lib/generated-client/models/recording-status.d.ts +0 -5
  420. package/lib/generated-client/models/recording-status.js +0 -5
  421. package/lib/generated-client/models/refresh-progress-message.d.ts +0 -11
  422. package/lib/generated-client/models/remote-image-info.d.ts +0 -28
  423. package/lib/generated-client/models/remote-image-result.d.ts +0 -8
  424. package/lib/generated-client/models/remote-lyric-info-dto.d.ts +3 -14
  425. package/lib/generated-client/models/remote-search-result.d.ts +3 -59
  426. package/lib/generated-client/models/remote-subtitle-info.d.ts +0 -85
  427. package/lib/generated-client/models/remove-from-playlist-request-dto.d.ts +0 -8
  428. package/lib/generated-client/models/repeat-mode.d.ts +1 -3
  429. package/lib/generated-client/models/repeat-mode.js +1 -3
  430. package/lib/generated-client/models/repository-info.d.ts +0 -8
  431. package/lib/generated-client/models/restart-required-message.d.ts +0 -9
  432. package/lib/generated-client/models/scheduled-task-ended-message.d.ts +0 -14
  433. package/lib/generated-client/models/scheduled-tasks-info-message.d.ts +0 -11
  434. package/lib/generated-client/models/scheduled-tasks-info-start-message.d.ts +1 -10
  435. package/lib/generated-client/models/scheduled-tasks-info-stop-message.d.ts +0 -7
  436. package/lib/generated-client/models/scroll-direction.d.ts +0 -2
  437. package/lib/generated-client/models/scroll-direction.js +0 -2
  438. package/lib/generated-client/models/search-hint-result.d.ts +0 -6
  439. package/lib/generated-client/models/search-hint.d.ts +0 -66
  440. package/lib/generated-client/models/seek-request-dto.d.ts +0 -4
  441. package/lib/generated-client/models/send-command-type.d.ts +0 -2
  442. package/lib/generated-client/models/send-command-type.js +0 -2
  443. package/lib/generated-client/models/send-command.d.ts +0 -17
  444. package/lib/generated-client/models/series-info-remote-search-query.d.ts +0 -19
  445. package/lib/generated-client/models/series-info.d.ts +1 -37
  446. package/lib/generated-client/models/series-status.d.ts +0 -2
  447. package/lib/generated-client/models/series-status.js +0 -2
  448. package/lib/generated-client/models/series-timer-cancelled-message.d.ts +0 -14
  449. package/lib/generated-client/models/series-timer-created-message.d.ts +0 -14
  450. package/lib/generated-client/models/series-timer-info-dto-query-result.d.ts +0 -8
  451. package/lib/generated-client/models/series-timer-info-dto.d.ts +1 -91
  452. package/lib/generated-client/models/server-configuration.d.ts +3 -180
  453. package/lib/generated-client/models/server-discovery-info.d.ts +0 -10
  454. package/lib/generated-client/models/server-restarting-message.d.ts +0 -9
  455. package/lib/generated-client/models/server-shutting-down-message.d.ts +0 -9
  456. package/lib/generated-client/models/session-info-dto.d.ts +1 -80
  457. package/lib/generated-client/models/session-message-type.d.ts +0 -2
  458. package/lib/generated-client/models/session-message-type.js +0 -2
  459. package/lib/generated-client/models/session-user-info.d.ts +0 -6
  460. package/lib/generated-client/models/sessions-message.d.ts +0 -11
  461. package/lib/generated-client/models/sessions-start-message.d.ts +1 -10
  462. package/lib/generated-client/models/sessions-stop-message.d.ts +0 -7
  463. package/lib/generated-client/models/set-channel-mapping-dto.d.ts +0 -8
  464. package/lib/generated-client/models/set-playlist-item-request-dto.d.ts +0 -4
  465. package/lib/generated-client/models/set-repeat-mode-request-dto.d.ts +0 -7
  466. package/lib/generated-client/models/set-shuffle-mode-request-dto.d.ts +0 -7
  467. package/lib/generated-client/models/song-info.d.ts +0 -54
  468. package/lib/generated-client/models/sort-order.d.ts +0 -2
  469. package/lib/generated-client/models/sort-order.js +0 -2
  470. package/lib/generated-client/models/special-view-option-dto.d.ts +0 -6
  471. package/lib/generated-client/models/startup-configuration-dto.d.ts +0 -10
  472. package/lib/generated-client/models/startup-remote-access-dto.d.ts +0 -11
  473. package/lib/generated-client/models/startup-user-dto.d.ts +0 -6
  474. package/lib/generated-client/models/subtitle-delivery-method.d.ts +0 -2
  475. package/lib/generated-client/models/subtitle-delivery-method.js +0 -2
  476. package/lib/generated-client/models/subtitle-playback-mode.d.ts +0 -2
  477. package/lib/generated-client/models/subtitle-playback-mode.js +0 -2
  478. package/lib/generated-client/models/subtitle-profile.d.ts +0 -15
  479. package/lib/generated-client/models/sync-play-command-message.d.ts +0 -14
  480. package/lib/generated-client/models/sync-play-group-does-not-exist-update.d.ts +0 -14
  481. package/lib/generated-client/models/sync-play-group-joined-update.d.ts +0 -17
  482. package/lib/generated-client/models/sync-play-group-left-update.d.ts +0 -14
  483. package/lib/generated-client/models/sync-play-group-update-message.d.ts +0 -14
  484. package/lib/generated-client/models/sync-play-library-access-denied-update.d.ts +0 -14
  485. package/lib/generated-client/models/sync-play-not-in-group-update.d.ts +0 -14
  486. package/lib/generated-client/models/sync-play-play-queue-update.d.ts +0 -17
  487. package/lib/generated-client/models/sync-play-queue-item.d.ts +0 -6
  488. package/lib/generated-client/models/sync-play-state-update.d.ts +0 -17
  489. package/lib/generated-client/models/sync-play-user-access-type.d.ts +0 -2
  490. package/lib/generated-client/models/sync-play-user-access-type.js +0 -2
  491. package/lib/generated-client/models/sync-play-user-joined-update.d.ts +0 -14
  492. package/lib/generated-client/models/sync-play-user-left-update.d.ts +0 -14
  493. package/lib/generated-client/models/system-info.d.ts +0 -62
  494. package/lib/generated-client/models/system-storage-dto.d.ts +8 -47
  495. package/lib/generated-client/models/task-completion-status.d.ts +0 -2
  496. package/lib/generated-client/models/task-completion-status.js +0 -2
  497. package/lib/generated-client/models/task-info.d.ts +0 -28
  498. package/lib/generated-client/models/task-result.d.ts +0 -21
  499. package/lib/generated-client/models/task-state.d.ts +0 -2
  500. package/lib/generated-client/models/task-state.js +0 -2
  501. package/lib/generated-client/models/task-trigger-info-type.d.ts +0 -2
  502. package/lib/generated-client/models/task-trigger-info-type.js +0 -2
  503. package/lib/generated-client/models/task-trigger-info.d.ts +0 -18
  504. package/lib/generated-client/models/theme-media-result.d.ts +0 -10
  505. package/lib/generated-client/models/timer-cancelled-message.d.ts +0 -14
  506. package/lib/generated-client/models/timer-created-message.d.ts +0 -14
  507. package/lib/generated-client/models/timer-event-info.d.ts +0 -15
  508. package/lib/generated-client/models/timer-info-dto-query-result.d.ts +0 -8
  509. package/lib/generated-client/models/timer-info-dto.d.ts +0 -76
  510. package/lib/generated-client/models/tonemapping-algorithm.d.ts +0 -2
  511. package/lib/generated-client/models/tonemapping-algorithm.js +0 -2
  512. package/lib/generated-client/models/tonemapping-mode.d.ts +0 -2
  513. package/lib/generated-client/models/tonemapping-mode.js +0 -2
  514. package/lib/generated-client/models/tonemapping-range.d.ts +0 -2
  515. package/lib/generated-client/models/tonemapping-range.js +0 -2
  516. package/lib/generated-client/models/trailer-info-remote-search-query.d.ts +0 -19
  517. package/lib/generated-client/models/trailer-info.d.ts +1 -37
  518. package/lib/generated-client/models/transcode-reason.d.ts +1 -5
  519. package/lib/generated-client/models/transcode-reason.js +2 -6
  520. package/lib/generated-client/models/transcode-seek-info.d.ts +1 -3
  521. package/lib/generated-client/models/transcode-seek-info.js +1 -3
  522. package/lib/generated-client/models/transcoding-info.d.ts +2 -34
  523. package/lib/generated-client/models/transcoding-profile.d.ts +3 -50
  524. package/lib/generated-client/models/transport-stream-timestamp.d.ts +1 -3
  525. package/lib/generated-client/models/transport-stream-timestamp.js +1 -3
  526. package/lib/generated-client/models/trickplay-info-dto.d.ts +0 -16
  527. package/lib/generated-client/models/trickplay-options.d.ts +1 -33
  528. package/lib/generated-client/models/trickplay-scan-behavior.d.ts +0 -2
  529. package/lib/generated-client/models/trickplay-scan-behavior.js +0 -2
  530. package/lib/generated-client/models/tuner-channel-mapping.d.ts +0 -25
  531. package/lib/generated-client/models/tuner-host-info.d.ts +0 -85
  532. package/lib/generated-client/models/type-options.d.ts +2 -35
  533. package/lib/generated-client/models/unrated-item.d.ts +0 -2
  534. package/lib/generated-client/models/unrated-item.js +0 -2
  535. package/lib/generated-client/models/update-library-options-dto.d.ts +0 -9
  536. package/lib/generated-client/models/update-media-path-request-dto.d.ts +0 -9
  537. package/lib/generated-client/models/update-playlist-dto.d.ts +0 -10
  538. package/lib/generated-client/models/update-playlist-user-dto.d.ts +0 -4
  539. package/lib/generated-client/models/update-user-item-data-dto.d.ts +0 -24
  540. package/lib/generated-client/models/update-user-password.d.ts +0 -10
  541. package/lib/generated-client/models/upload-subtitle-dto.d.ts +0 -12
  542. package/lib/generated-client/models/user-configuration.d.ts +0 -70
  543. package/lib/generated-client/models/user-data-change-info.d.ts +1 -7
  544. package/lib/generated-client/models/user-data-changed-message.d.ts +0 -14
  545. package/lib/generated-client/models/user-deleted-message.d.ts +0 -11
  546. package/lib/generated-client/models/user-dto.d.ts +6 -40
  547. package/lib/generated-client/models/user-item-data-dto.d.ts +1 -25
  548. package/lib/generated-client/models/user-policy.d.ts +0 -201
  549. package/lib/generated-client/models/user-updated-message.d.ts +0 -14
  550. package/lib/generated-client/models/utc-time-response.d.ts +0 -6
  551. package/lib/generated-client/models/validate-path-dto.d.ts +0 -8
  552. package/lib/generated-client/models/version-info.d.ts +0 -20
  553. package/lib/generated-client/models/video-range-type.d.ts +0 -2
  554. package/lib/generated-client/models/video-range-type.js +0 -2
  555. package/lib/generated-client/models/video-range.d.ts +0 -2
  556. package/lib/generated-client/models/video-range.js +0 -2
  557. package/lib/generated-client/models/video-type.d.ts +0 -2
  558. package/lib/generated-client/models/video-type.js +0 -2
  559. package/lib/generated-client/models/video3-dformat.d.ts +0 -5
  560. package/lib/generated-client/models/video3-dformat.js +0 -5
  561. package/lib/generated-client/models/virtual-folder-info.d.ts +0 -30
  562. package/lib/generated-client/models/web-socket-message.d.ts +0 -1
  563. package/lib/generated-client/models/xbmc-metadata-options.d.ts +0 -30
  564. package/lib/index.js +1 -1
  565. package/lib/models/api/image-request-parameters.d.ts +1 -1
  566. package/lib/models/device-info.d.ts +1 -0
  567. package/lib/utils/api/{videos-api.d.ts → artist-api.d.ts} +2 -2
  568. package/lib/utils/api/{movies-api.js → artist-api.js} +4 -4
  569. package/lib/utils/api/authentication-api.d.ts +8 -0
  570. package/lib/utils/api/authentication-api.js +35 -0
  571. package/lib/utils/api/{tmdb-api.d.ts → backup-api.d.ts} +2 -2
  572. package/lib/utils/api/backup-api.js +13 -0
  573. package/lib/utils/api/{artists-api.d.ts → channel-api.d.ts} +2 -2
  574. package/lib/utils/api/{artists-api.js → channel-api.js} +4 -4
  575. package/lib/utils/api/{movies-api.d.ts → device-api.d.ts} +2 -2
  576. package/lib/utils/api/{lyrics-api.js → device-api.js} +4 -4
  577. package/lib/utils/api/display-preference-api.d.ts +8 -0
  578. package/lib/utils/api/display-preference-api.js +12 -0
  579. package/lib/utils/api/{items-api.d.ts → genre-api.d.ts} +2 -2
  580. package/lib/utils/api/{items-api.js → genre-api.js} +4 -4
  581. package/lib/utils/api/index.d.ts +24 -38
  582. package/lib/utils/api/index.js +24 -38
  583. package/lib/utils/api/library-api.d.ts +14 -2
  584. package/lib/utils/api/library-api.js +17 -1
  585. package/lib/utils/api/{years-api.d.ts → lyric-api.d.ts} +2 -2
  586. package/lib/utils/api/{years-api.js → lyric-api.js} +4 -4
  587. package/lib/utils/api/{activity-log-api.d.ts → media-segment-api.d.ts} +2 -2
  588. package/lib/utils/api/{quick-connect-api.js → media-segment-api.js} +4 -4
  589. package/lib/utils/api/movie-api.d.ts +8 -0
  590. package/lib/utils/api/movie-api.js +12 -0
  591. package/lib/utils/api/{dynamic-hls-api.d.ts → music-genre-api.d.ts} +2 -2
  592. package/lib/utils/api/{dynamic-hls-api.js → music-genre-api.js} +4 -4
  593. package/lib/utils/api/{genres-api.d.ts → person-api.d.ts} +2 -2
  594. package/lib/utils/api/{genres-api.js → person-api.js} +4 -4
  595. package/lib/utils/api/{trailers-api.d.ts → playlist-api.d.ts} +2 -2
  596. package/lib/utils/api/{channels-api.js → playlist-api.js} +4 -4
  597. package/lib/utils/api/{lyrics-api.d.ts → plugin-api.d.ts} +2 -2
  598. package/lib/utils/api/{videos-api.js → plugin-api.js} +4 -4
  599. package/lib/utils/api/scheduled-task-api.d.ts +8 -0
  600. package/lib/utils/api/{configuration-api.js → scheduled-task-api.js} +4 -4
  601. package/lib/utils/api/session-api.js +3 -1
  602. package/lib/utils/api/show-api.d.ts +8 -0
  603. package/lib/utils/api/{tmdb-api.js → show-api.js} +4 -4
  604. package/lib/utils/api/studio-api.d.ts +8 -0
  605. package/lib/utils/api/studio-api.js +12 -0
  606. package/lib/utils/api/{hls-segment-api.d.ts → suggestion-api.d.ts} +2 -2
  607. package/lib/utils/api/{hls-segment-api.js → suggestion-api.js} +4 -4
  608. package/lib/utils/api/{package-api.d.ts → trailer-api.d.ts} +2 -2
  609. package/lib/utils/api/{devices-api.js → trailer-api.js} +4 -4
  610. package/lib/utils/api/{dashboard-api.d.ts → trick-play-api.d.ts} +2 -2
  611. package/lib/utils/api/{dashboard-api.js → trick-play-api.js} +4 -4
  612. package/lib/utils/api/user-api.js +1 -26
  613. package/lib/utils/api/{api-key-api.d.ts → user-data-api.d.ts} +2 -2
  614. package/lib/utils/api/{time-sync-api.js → user-data-api.js} +4 -4
  615. package/lib/utils/api/{channels-api.d.ts → user-view-api.d.ts} +2 -2
  616. package/lib/utils/api/{trailers-api.js → user-view-api.js} +4 -4
  617. package/lib/utils/api/video-api.d.ts +8 -0
  618. package/lib/utils/api/video-api.js +12 -0
  619. package/lib/utils/api/year-api.d.ts +8 -0
  620. package/lib/utils/api/year-api.js +12 -0
  621. package/lib/utils/index.js +2 -2
  622. package/lib/utils/url/index.d.ts +1 -0
  623. package/lib/utils/url/index.js +4 -1
  624. package/lib/utils/versioning.d.ts +12 -1
  625. package/lib/utils/versioning.js +44 -13
  626. package/lib/versions.d.ts +1 -1
  627. package/lib/versions.js +1 -1
  628. package/lib/websocket/constants.d.ts +24 -0
  629. package/lib/websocket/constants.js +42 -0
  630. package/lib/websocket/index.d.ts +8 -0
  631. package/lib/websocket/index.js +3 -0
  632. package/lib/{utils/api/client-log-api.d.ts → websocket/models.d.ts} +6 -3
  633. package/lib/websocket/models.js +16 -0
  634. package/lib/websocket/types.d.ts +37 -0
  635. package/lib/websocket/types.js +42 -0
  636. package/lib/websocket/websocket-service.d.ts +142 -0
  637. package/lib/websocket/websocket-service.js +296 -0
  638. package/package.json +20 -17
  639. package/lib/generated-client/api/activity-log-api.d.ts +0 -110
  640. package/lib/generated-client/api/activity-log-api.js +0 -135
  641. package/lib/generated-client/api/api-key-api.d.ts +0 -161
  642. package/lib/generated-client/api/api-key-api.js +0 -245
  643. package/lib/generated-client/api/client-log-api.d.ts +0 -86
  644. package/lib/generated-client/api/client-log-api.js +0 -117
  645. package/lib/generated-client/api/configuration-api.d.ts +0 -292
  646. package/lib/generated-client/api/configuration-api.js +0 -442
  647. package/lib/generated-client/api/dashboard-api.d.ts +0 -132
  648. package/lib/generated-client/api/dashboard-api.js +0 -182
  649. package/lib/generated-client/api/dlna-api.d.ts +0 -292
  650. package/lib/generated-client/api/dlna-server-api.d.ts +0 -784
  651. package/lib/generated-client/api/dynamic-hls-api.d.ts +0 -4261
  652. package/lib/generated-client/api/dynamic-hls-api.js +0 -3025
  653. package/lib/generated-client/api/hls-segment-api.d.ts +0 -325
  654. package/lib/generated-client/api/hls-segment-api.js +0 -415
  655. package/lib/generated-client/api/image-by-name-api.d.ts +0 -292
  656. package/lib/generated-client/api/item-refresh-api.d.ts +0 -126
  657. package/lib/generated-client/api/item-refresh-api.js +0 -143
  658. package/lib/generated-client/api/items-api.d.ts +0 -1052
  659. package/lib/generated-client/api/items-api.js +0 -835
  660. package/lib/generated-client/api/music-genres-api.d.ts +0 -286
  661. package/lib/generated-client/api/music-genres-api.js +0 -278
  662. package/lib/generated-client/api/notifications-api.d.ts +0 -332
  663. package/lib/generated-client/api/package-api.d.ts +0 -315
  664. package/lib/generated-client/api/package-api.js +0 -455
  665. package/lib/generated-client/api/playstate-api.d.ts +0 -679
  666. package/lib/generated-client/api/playstate-api.js +0 -789
  667. package/lib/generated-client/api/plugins-api.d.ts +0 -473
  668. package/lib/generated-client/api/plugins-api.js +0 -663
  669. package/lib/generated-client/api/quick-connect-api.d.ts +0 -198
  670. package/lib/generated-client/api/quick-connect-api.js +0 -305
  671. package/lib/generated-client/api/time-sync-api.d.ts +0 -69
  672. package/lib/generated-client/api/time-sync-api.js +0 -109
  673. package/lib/generated-client/api/tmdb-api.d.ts +0 -69
  674. package/lib/generated-client/api/tmdb-api.js +0 -111
  675. package/lib/generated-client/api/universal-audio-api.d.ts +0 -420
  676. package/lib/generated-client/api/universal-audio-api.js +0 -364
  677. package/lib/generated-client/api/user-library-api.d.ts +0 -657
  678. package/lib/generated-client/api/video-attachments-api.d.ts +0 -101
  679. package/lib/generated-client/api/video-attachments-api.js +0 -126
  680. package/lib/generated-client/models/admin-notification-dto.d.ts +0 -42
  681. package/lib/generated-client/models/base-item.d.ts +0 -84
  682. package/lib/generated-client/models/branding-options.d.ts +0 -35
  683. package/lib/generated-client/models/client-capabilities.d.ts +0 -76
  684. package/lib/generated-client/models/config-image-types.d.ts +0 -59
  685. package/lib/generated-client/models/control-response.d.ts +0 -37
  686. package/lib/generated-client/models/device-identification.d.ts +0 -72
  687. package/lib/generated-client/models/device-info-query-result.d.ts +0 -36
  688. package/lib/generated-client/models/device-info.d.ts +0 -84
  689. package/lib/generated-client/models/device-options.d.ts +0 -35
  690. package/lib/generated-client/models/device-profile-info.d.ts +0 -36
  691. package/lib/generated-client/models/device-profile-type.d.ts +0 -20
  692. package/lib/generated-client/models/dlna-options.d.ts +0 -83
  693. package/lib/generated-client/models/ffmpeg-location.d.ts +0 -22
  694. package/lib/generated-client/models/group-info-dto-group-update.d.ts +0 -37
  695. package/lib/generated-client/models/group-state-update-group-update.d.ts +0 -37
  696. package/lib/generated-client/models/hardware-encoding-type.d.ts +0 -25
  697. package/lib/generated-client/models/header-match-type.d.ts +0 -21
  698. package/lib/generated-client/models/http-header-info.d.ts +0 -36
  699. package/lib/generated-client/models/image-by-name-info.d.ts +0 -47
  700. package/lib/generated-client/models/media-encoder-path-dto.d.ts +0 -29
  701. package/lib/generated-client/models/notification-dto.d.ts +0 -66
  702. package/lib/generated-client/models/notification-option.d.ts +0 -54
  703. package/lib/generated-client/models/notification-options.d.ts +0 -24
  704. package/lib/generated-client/models/notification-result-dto.d.ts +0 -30
  705. package/lib/generated-client/models/notification-type-info.d.ts +0 -47
  706. package/lib/generated-client/models/notifications-summary-dto.d.ts +0 -30
  707. package/lib/generated-client/models/object-group-update.d.ts +0 -36
  708. package/lib/generated-client/models/play-queue-update-group-update.d.ts +0 -37
  709. package/lib/generated-client/models/response-profile.d.ts +0 -61
  710. package/lib/generated-client/models/send-to-user-type.d.ts +0 -21
  711. package/lib/generated-client/models/session-info.d.ts +0 -199
  712. package/lib/generated-client/models/string-group-update.d.ts +0 -36
  713. package/lib/generated-client/models/subtitle-options.d.ts +0 -71
  714. package/lib/generated-client/models/sync-play-group-update-command-message.d.ts +0 -37
  715. package/lib/generated-client/models/trickplay-info.d.ts +0 -65
  716. package/lib/generated-client/models/update-user-easy-password.d.ts +0 -35
  717. package/lib/generated-client/models/wake-on-lan-info.d.ts +0 -29
  718. package/lib/generated-client/models/xml-attribute.d.ts +0 -29
  719. package/lib/utils/api/activity-log-api.js +0 -12
  720. package/lib/utils/api/api-key-api.js +0 -12
  721. package/lib/utils/api/client-log-api.js +0 -12
  722. package/lib/utils/api/configuration-api.d.ts +0 -8
  723. package/lib/utils/api/devices-api.d.ts +0 -8
  724. package/lib/utils/api/display-preferences-api.d.ts +0 -8
  725. package/lib/utils/api/display-preferences-api.js +0 -12
  726. package/lib/utils/api/item-refresh-api.d.ts +0 -8
  727. package/lib/utils/api/item-refresh-api.js +0 -12
  728. package/lib/utils/api/media-segments-api.d.ts +0 -8
  729. package/lib/utils/api/media-segments-api.js +0 -12
  730. package/lib/utils/api/music-genres-api.d.ts +0 -8
  731. package/lib/utils/api/music-genres-api.js +0 -12
  732. package/lib/utils/api/package-api.js +0 -12
  733. package/lib/utils/api/persons-api.d.ts +0 -8
  734. package/lib/utils/api/persons-api.js +0 -12
  735. package/lib/utils/api/playlists-api.d.ts +0 -8
  736. package/lib/utils/api/playlists-api.js +0 -12
  737. package/lib/utils/api/playstate-api.d.ts +0 -8
  738. package/lib/utils/api/playstate-api.js +0 -12
  739. package/lib/utils/api/plugins-api.d.ts +0 -8
  740. package/lib/utils/api/plugins-api.js +0 -12
  741. package/lib/utils/api/quick-connect-api.d.ts +0 -8
  742. package/lib/utils/api/scheduled-tasks-api.d.ts +0 -8
  743. package/lib/utils/api/scheduled-tasks-api.js +0 -12
  744. package/lib/utils/api/studios-api.d.ts +0 -8
  745. package/lib/utils/api/studios-api.js +0 -12
  746. package/lib/utils/api/suggestions-api.d.ts +0 -8
  747. package/lib/utils/api/suggestions-api.js +0 -12
  748. package/lib/utils/api/time-sync-api.d.ts +0 -8
  749. package/lib/utils/api/trickplay-api.d.ts +0 -8
  750. package/lib/utils/api/trickplay-api.js +0 -12
  751. package/lib/utils/api/tv-shows-api.d.ts +0 -8
  752. package/lib/utils/api/tv-shows-api.js +0 -12
  753. package/lib/utils/api/universal-audio-api.d.ts +0 -8
  754. package/lib/utils/api/universal-audio-api.js +0 -12
  755. package/lib/utils/api/user-library-api.d.ts +0 -8
  756. package/lib/utils/api/user-library-api.js +0 -12
  757. package/lib/utils/api/user-views-api.d.ts +0 -8
  758. package/lib/utils/api/user-views-api.js +0 -12
  759. package/lib/utils/api/video-attachments-api.d.ts +0 -8
  760. package/lib/utils/api/video-attachments-api.js +0 -12
@@ -21,10 +21,9 @@ import type { ItemSortBy } from '../models';
21
21
  import type { MediaType } from '../models';
22
22
  import type { SortOrder } from '../models';
23
23
  /**
24
- * ArtistsApi - axios parameter creator
25
- * @export
24
+ * ArtistApi - axios parameter creator
26
25
  */
27
- export declare const ArtistsApiAxiosParamCreator: (configuration?: Configuration) => {
26
+ export declare const ArtistApiAxiosParamCreator: (configuration?: Configuration) => {
28
27
  /**
29
28
  *
30
29
  * @summary Gets all album artists from a given item, folder, or the entire library.
@@ -61,6 +60,7 @@ export declare const ArtistsApiAxiosParamCreator: (configuration?: Configuration
61
60
  * @param {boolean} [enableImages] Optional, include image information in output.
62
61
  * @param {boolean} [enableTotalRecordCount] Total record count.
63
62
  * @param {*} [options] Override http request option.
63
+ * @deprecated
64
64
  * @throws {RequiredError}
65
65
  */
66
66
  getAlbumArtists: (minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<MediaType>, genres?: Array<string>, genreIds?: Array<string>, officialRatings?: Array<string>, tags?: Array<string>, years?: Array<number>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, person?: string, personIds?: Array<string>, personTypes?: Array<string>, studios?: Array<string>, studioIds?: Array<string>, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array<ItemSortBy>, sortOrder?: Array<SortOrder>, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
@@ -70,6 +70,7 @@ export declare const ArtistsApiAxiosParamCreator: (configuration?: Configuration
70
70
  * @param {string} name Studio name.
71
71
  * @param {string} [userId] Optional. Filter by user id, and attach user data.
72
72
  * @param {*} [options] Override http request option.
73
+ * @deprecated
73
74
  * @throws {RequiredError}
74
75
  */
75
76
  getArtistByName: (name: string, userId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
@@ -109,15 +110,15 @@ export declare const ArtistsApiAxiosParamCreator: (configuration?: Configuration
109
110
  * @param {boolean} [enableImages] Optional, include image information in output.
110
111
  * @param {boolean} [enableTotalRecordCount] Total record count.
111
112
  * @param {*} [options] Override http request option.
113
+ * @deprecated
112
114
  * @throws {RequiredError}
113
115
  */
114
116
  getArtists: (minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<MediaType>, genres?: Array<string>, genreIds?: Array<string>, officialRatings?: Array<string>, tags?: Array<string>, years?: Array<number>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, person?: string, personIds?: Array<string>, personTypes?: Array<string>, studios?: Array<string>, studioIds?: Array<string>, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array<ItemSortBy>, sortOrder?: Array<SortOrder>, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
115
117
  };
116
118
  /**
117
- * ArtistsApi - functional programming interface
118
- * @export
119
+ * ArtistApi - functional programming interface
119
120
  */
120
- export declare const ArtistsApiFp: (configuration?: Configuration) => {
121
+ export declare const ArtistApiFp: (configuration?: Configuration) => {
121
122
  /**
122
123
  *
123
124
  * @summary Gets all album artists from a given item, folder, or the entire library.
@@ -154,6 +155,7 @@ export declare const ArtistsApiFp: (configuration?: Configuration) => {
154
155
  * @param {boolean} [enableImages] Optional, include image information in output.
155
156
  * @param {boolean} [enableTotalRecordCount] Total record count.
156
157
  * @param {*} [options] Override http request option.
158
+ * @deprecated
157
159
  * @throws {RequiredError}
158
160
  */
159
161
  getAlbumArtists(minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<MediaType>, genres?: Array<string>, genreIds?: Array<string>, officialRatings?: Array<string>, tags?: Array<string>, years?: Array<number>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, person?: string, personIds?: Array<string>, personTypes?: Array<string>, studios?: Array<string>, studioIds?: Array<string>, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array<ItemSortBy>, sortOrder?: Array<SortOrder>, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>;
@@ -163,6 +165,7 @@ export declare const ArtistsApiFp: (configuration?: Configuration) => {
163
165
  * @param {string} name Studio name.
164
166
  * @param {string} [userId] Optional. Filter by user id, and attach user data.
165
167
  * @param {*} [options] Override http request option.
168
+ * @deprecated
166
169
  * @throws {RequiredError}
167
170
  */
168
171
  getArtistByName(name: string, userId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>;
@@ -202,489 +205,351 @@ export declare const ArtistsApiFp: (configuration?: Configuration) => {
202
205
  * @param {boolean} [enableImages] Optional, include image information in output.
203
206
  * @param {boolean} [enableTotalRecordCount] Total record count.
204
207
  * @param {*} [options] Override http request option.
208
+ * @deprecated
205
209
  * @throws {RequiredError}
206
210
  */
207
211
  getArtists(minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<MediaType>, genres?: Array<string>, genreIds?: Array<string>, officialRatings?: Array<string>, tags?: Array<string>, years?: Array<number>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, person?: string, personIds?: Array<string>, personTypes?: Array<string>, studios?: Array<string>, studioIds?: Array<string>, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array<ItemSortBy>, sortOrder?: Array<SortOrder>, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>;
208
212
  };
209
213
  /**
210
- * ArtistsApi - factory interface
211
- * @export
214
+ * ArtistApi - factory interface
212
215
  */
213
- export declare const ArtistsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
216
+ export declare const ArtistApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
214
217
  /**
215
218
  *
216
219
  * @summary Gets all album artists from a given item, folder, or the entire library.
217
- * @param {ArtistsApiGetAlbumArtistsRequest} requestParameters Request parameters.
220
+ * @param {ArtistApiGetAlbumArtistsRequest} requestParameters Request parameters.
218
221
  * @param {*} [options] Override http request option.
222
+ * @deprecated
219
223
  * @throws {RequiredError}
220
224
  */
221
- getAlbumArtists(requestParameters?: ArtistsApiGetAlbumArtistsRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDtoQueryResult>;
225
+ getAlbumArtists(requestParameters?: ArtistApiGetAlbumArtistsRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDtoQueryResult>;
222
226
  /**
223
227
  *
224
228
  * @summary Gets an artist by name.
225
- * @param {ArtistsApiGetArtistByNameRequest} requestParameters Request parameters.
229
+ * @param {ArtistApiGetArtistByNameRequest} requestParameters Request parameters.
226
230
  * @param {*} [options] Override http request option.
231
+ * @deprecated
227
232
  * @throws {RequiredError}
228
233
  */
229
- getArtistByName(requestParameters: ArtistsApiGetArtistByNameRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDto>;
234
+ getArtistByName(requestParameters: ArtistApiGetArtistByNameRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDto>;
230
235
  /**
231
236
  *
232
237
  * @summary Gets all artists from a given item, folder, or the entire library.
233
- * @param {ArtistsApiGetArtistsRequest} requestParameters Request parameters.
238
+ * @param {ArtistApiGetArtistsRequest} requestParameters Request parameters.
234
239
  * @param {*} [options] Override http request option.
240
+ * @deprecated
235
241
  * @throws {RequiredError}
236
242
  */
237
- getArtists(requestParameters?: ArtistsApiGetArtistsRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDtoQueryResult>;
243
+ getArtists(requestParameters?: ArtistApiGetArtistsRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDtoQueryResult>;
238
244
  };
239
245
  /**
240
- * Request parameters for getAlbumArtists operation in ArtistsApi.
241
- * @export
242
- * @interface ArtistsApiGetAlbumArtistsRequest
246
+ * Request parameters for getAlbumArtists operation in ArtistApi.
243
247
  */
244
- export interface ArtistsApiGetAlbumArtistsRequest {
248
+ export interface ArtistApiGetAlbumArtistsRequest {
245
249
  /**
246
250
  * Optional filter by minimum community rating.
247
- * @type {number}
248
- * @memberof ArtistsApiGetAlbumArtists
249
251
  */
250
252
  readonly minCommunityRating?: number;
251
253
  /**
252
254
  * Optional. The record index to start at. All items with a lower index will be dropped from the results.
253
- * @type {number}
254
- * @memberof ArtistsApiGetAlbumArtists
255
255
  */
256
256
  readonly startIndex?: number;
257
257
  /**
258
258
  * Optional. The maximum number of records to return.
259
- * @type {number}
260
- * @memberof ArtistsApiGetAlbumArtists
261
259
  */
262
260
  readonly limit?: number;
263
261
  /**
264
262
  * Optional. Search term.
265
- * @type {string}
266
- * @memberof ArtistsApiGetAlbumArtists
267
263
  */
268
264
  readonly searchTerm?: string;
269
265
  /**
270
266
  * Specify this to localize the search to a specific item or folder. Omit to use the root.
271
- * @type {string}
272
- * @memberof ArtistsApiGetAlbumArtists
273
267
  */
274
268
  readonly parentId?: string;
275
269
  /**
276
270
  * Optional. Specify additional fields of information to return in the output.
277
- * @type {Array<ItemFields>}
278
- * @memberof ArtistsApiGetAlbumArtists
279
271
  */
280
272
  readonly fields?: Array<ItemFields>;
281
273
  /**
282
274
  * Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited.
283
- * @type {Array<BaseItemKind>}
284
- * @memberof ArtistsApiGetAlbumArtists
285
275
  */
286
276
  readonly excludeItemTypes?: Array<BaseItemKind>;
287
277
  /**
288
278
  * Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
289
- * @type {Array<BaseItemKind>}
290
- * @memberof ArtistsApiGetAlbumArtists
291
279
  */
292
280
  readonly includeItemTypes?: Array<BaseItemKind>;
293
281
  /**
294
282
  * Optional. Specify additional filters to apply.
295
- * @type {Array<ItemFilter>}
296
- * @memberof ArtistsApiGetAlbumArtists
297
283
  */
298
284
  readonly filters?: Array<ItemFilter>;
299
285
  /**
300
286
  * Optional filter by items that are marked as favorite, or not.
301
- * @type {boolean}
302
- * @memberof ArtistsApiGetAlbumArtists
303
287
  */
304
288
  readonly isFavorite?: boolean;
305
289
  /**
306
290
  * Optional filter by MediaType. Allows multiple, comma delimited.
307
- * @type {Array<MediaType>}
308
- * @memberof ArtistsApiGetAlbumArtists
309
291
  */
310
292
  readonly mediaTypes?: Array<MediaType>;
311
293
  /**
312
294
  * Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
313
- * @type {Array<string>}
314
- * @memberof ArtistsApiGetAlbumArtists
315
295
  */
316
296
  readonly genres?: Array<string>;
317
297
  /**
318
298
  * Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
319
- * @type {Array<string>}
320
- * @memberof ArtistsApiGetAlbumArtists
321
299
  */
322
300
  readonly genreIds?: Array<string>;
323
301
  /**
324
302
  * Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
325
- * @type {Array<string>}
326
- * @memberof ArtistsApiGetAlbumArtists
327
303
  */
328
304
  readonly officialRatings?: Array<string>;
329
305
  /**
330
306
  * Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.
331
- * @type {Array<string>}
332
- * @memberof ArtistsApiGetAlbumArtists
333
307
  */
334
308
  readonly tags?: Array<string>;
335
309
  /**
336
310
  * Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.
337
- * @type {Array<number>}
338
- * @memberof ArtistsApiGetAlbumArtists
339
311
  */
340
312
  readonly years?: Array<number>;
341
313
  /**
342
314
  * Optional, include user data.
343
- * @type {boolean}
344
- * @memberof ArtistsApiGetAlbumArtists
345
315
  */
346
316
  readonly enableUserData?: boolean;
347
317
  /**
348
318
  * Optional, the max number of images to return, per image type.
349
- * @type {number}
350
- * @memberof ArtistsApiGetAlbumArtists
351
319
  */
352
320
  readonly imageTypeLimit?: number;
353
321
  /**
354
322
  * Optional. The image types to include in the output.
355
- * @type {Array<ImageType>}
356
- * @memberof ArtistsApiGetAlbumArtists
357
323
  */
358
324
  readonly enableImageTypes?: Array<ImageType>;
359
325
  /**
360
326
  * Optional. If specified, results will be filtered to include only those containing the specified person.
361
- * @type {string}
362
- * @memberof ArtistsApiGetAlbumArtists
363
327
  */
364
328
  readonly person?: string;
365
329
  /**
366
330
  * Optional. If specified, results will be filtered to include only those containing the specified person ids.
367
- * @type {Array<string>}
368
- * @memberof ArtistsApiGetAlbumArtists
369
331
  */
370
332
  readonly personIds?: Array<string>;
371
333
  /**
372
334
  * Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited.
373
- * @type {Array<string>}
374
- * @memberof ArtistsApiGetAlbumArtists
375
335
  */
376
336
  readonly personTypes?: Array<string>;
377
337
  /**
378
338
  * Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.
379
- * @type {Array<string>}
380
- * @memberof ArtistsApiGetAlbumArtists
381
339
  */
382
340
  readonly studios?: Array<string>;
383
341
  /**
384
342
  * Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.
385
- * @type {Array<string>}
386
- * @memberof ArtistsApiGetAlbumArtists
387
343
  */
388
344
  readonly studioIds?: Array<string>;
389
345
  /**
390
346
  * User id.
391
- * @type {string}
392
- * @memberof ArtistsApiGetAlbumArtists
393
347
  */
394
348
  readonly userId?: string;
395
349
  /**
396
350
  * Optional filter by items whose name is sorted equally or greater than a given input string.
397
- * @type {string}
398
- * @memberof ArtistsApiGetAlbumArtists
399
351
  */
400
352
  readonly nameStartsWithOrGreater?: string;
401
353
  /**
402
354
  * Optional filter by items whose name is sorted equally than a given input string.
403
- * @type {string}
404
- * @memberof ArtistsApiGetAlbumArtists
405
355
  */
406
356
  readonly nameStartsWith?: string;
407
357
  /**
408
358
  * Optional filter by items whose name is equally or lesser than a given input string.
409
- * @type {string}
410
- * @memberof ArtistsApiGetAlbumArtists
411
359
  */
412
360
  readonly nameLessThan?: string;
413
361
  /**
414
362
  * Optional. Specify one or more sort orders, comma delimited.
415
- * @type {Array<ItemSortBy>}
416
- * @memberof ArtistsApiGetAlbumArtists
417
363
  */
418
364
  readonly sortBy?: Array<ItemSortBy>;
419
365
  /**
420
366
  * Sort Order - Ascending,Descending.
421
- * @type {Array<SortOrder>}
422
- * @memberof ArtistsApiGetAlbumArtists
423
367
  */
424
368
  readonly sortOrder?: Array<SortOrder>;
425
369
  /**
426
370
  * Optional, include image information in output.
427
- * @type {boolean}
428
- * @memberof ArtistsApiGetAlbumArtists
429
371
  */
430
372
  readonly enableImages?: boolean;
431
373
  /**
432
374
  * Total record count.
433
- * @type {boolean}
434
- * @memberof ArtistsApiGetAlbumArtists
435
375
  */
436
376
  readonly enableTotalRecordCount?: boolean;
437
377
  }
438
378
  /**
439
- * Request parameters for getArtistByName operation in ArtistsApi.
440
- * @export
441
- * @interface ArtistsApiGetArtistByNameRequest
379
+ * Request parameters for getArtistByName operation in ArtistApi.
442
380
  */
443
- export interface ArtistsApiGetArtistByNameRequest {
381
+ export interface ArtistApiGetArtistByNameRequest {
444
382
  /**
445
383
  * Studio name.
446
- * @type {string}
447
- * @memberof ArtistsApiGetArtistByName
448
384
  */
449
385
  readonly name: string;
450
386
  /**
451
387
  * Optional. Filter by user id, and attach user data.
452
- * @type {string}
453
- * @memberof ArtistsApiGetArtistByName
454
388
  */
455
389
  readonly userId?: string;
456
390
  }
457
391
  /**
458
- * Request parameters for getArtists operation in ArtistsApi.
459
- * @export
460
- * @interface ArtistsApiGetArtistsRequest
392
+ * Request parameters for getArtists operation in ArtistApi.
461
393
  */
462
- export interface ArtistsApiGetArtistsRequest {
394
+ export interface ArtistApiGetArtistsRequest {
463
395
  /**
464
396
  * Optional filter by minimum community rating.
465
- * @type {number}
466
- * @memberof ArtistsApiGetArtists
467
397
  */
468
398
  readonly minCommunityRating?: number;
469
399
  /**
470
400
  * Optional. The record index to start at. All items with a lower index will be dropped from the results.
471
- * @type {number}
472
- * @memberof ArtistsApiGetArtists
473
401
  */
474
402
  readonly startIndex?: number;
475
403
  /**
476
404
  * Optional. The maximum number of records to return.
477
- * @type {number}
478
- * @memberof ArtistsApiGetArtists
479
405
  */
480
406
  readonly limit?: number;
481
407
  /**
482
408
  * Optional. Search term.
483
- * @type {string}
484
- * @memberof ArtistsApiGetArtists
485
409
  */
486
410
  readonly searchTerm?: string;
487
411
  /**
488
412
  * Specify this to localize the search to a specific item or folder. Omit to use the root.
489
- * @type {string}
490
- * @memberof ArtistsApiGetArtists
491
413
  */
492
414
  readonly parentId?: string;
493
415
  /**
494
416
  * Optional. Specify additional fields of information to return in the output.
495
- * @type {Array<ItemFields>}
496
- * @memberof ArtistsApiGetArtists
497
417
  */
498
418
  readonly fields?: Array<ItemFields>;
499
419
  /**
500
420
  * Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited.
501
- * @type {Array<BaseItemKind>}
502
- * @memberof ArtistsApiGetArtists
503
421
  */
504
422
  readonly excludeItemTypes?: Array<BaseItemKind>;
505
423
  /**
506
424
  * Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
507
- * @type {Array<BaseItemKind>}
508
- * @memberof ArtistsApiGetArtists
509
425
  */
510
426
  readonly includeItemTypes?: Array<BaseItemKind>;
511
427
  /**
512
428
  * Optional. Specify additional filters to apply.
513
- * @type {Array<ItemFilter>}
514
- * @memberof ArtistsApiGetArtists
515
429
  */
516
430
  readonly filters?: Array<ItemFilter>;
517
431
  /**
518
432
  * Optional filter by items that are marked as favorite, or not.
519
- * @type {boolean}
520
- * @memberof ArtistsApiGetArtists
521
433
  */
522
434
  readonly isFavorite?: boolean;
523
435
  /**
524
436
  * Optional filter by MediaType. Allows multiple, comma delimited.
525
- * @type {Array<MediaType>}
526
- * @memberof ArtistsApiGetArtists
527
437
  */
528
438
  readonly mediaTypes?: Array<MediaType>;
529
439
  /**
530
440
  * Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
531
- * @type {Array<string>}
532
- * @memberof ArtistsApiGetArtists
533
441
  */
534
442
  readonly genres?: Array<string>;
535
443
  /**
536
444
  * Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
537
- * @type {Array<string>}
538
- * @memberof ArtistsApiGetArtists
539
445
  */
540
446
  readonly genreIds?: Array<string>;
541
447
  /**
542
448
  * Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
543
- * @type {Array<string>}
544
- * @memberof ArtistsApiGetArtists
545
449
  */
546
450
  readonly officialRatings?: Array<string>;
547
451
  /**
548
452
  * Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.
549
- * @type {Array<string>}
550
- * @memberof ArtistsApiGetArtists
551
453
  */
552
454
  readonly tags?: Array<string>;
553
455
  /**
554
456
  * Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.
555
- * @type {Array<number>}
556
- * @memberof ArtistsApiGetArtists
557
457
  */
558
458
  readonly years?: Array<number>;
559
459
  /**
560
460
  * Optional, include user data.
561
- * @type {boolean}
562
- * @memberof ArtistsApiGetArtists
563
461
  */
564
462
  readonly enableUserData?: boolean;
565
463
  /**
566
464
  * Optional, the max number of images to return, per image type.
567
- * @type {number}
568
- * @memberof ArtistsApiGetArtists
569
465
  */
570
466
  readonly imageTypeLimit?: number;
571
467
  /**
572
468
  * Optional. The image types to include in the output.
573
- * @type {Array<ImageType>}
574
- * @memberof ArtistsApiGetArtists
575
469
  */
576
470
  readonly enableImageTypes?: Array<ImageType>;
577
471
  /**
578
472
  * Optional. If specified, results will be filtered to include only those containing the specified person.
579
- * @type {string}
580
- * @memberof ArtistsApiGetArtists
581
473
  */
582
474
  readonly person?: string;
583
475
  /**
584
476
  * Optional. If specified, results will be filtered to include only those containing the specified person ids.
585
- * @type {Array<string>}
586
- * @memberof ArtistsApiGetArtists
587
477
  */
588
478
  readonly personIds?: Array<string>;
589
479
  /**
590
480
  * Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited.
591
- * @type {Array<string>}
592
- * @memberof ArtistsApiGetArtists
593
481
  */
594
482
  readonly personTypes?: Array<string>;
595
483
  /**
596
484
  * Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.
597
- * @type {Array<string>}
598
- * @memberof ArtistsApiGetArtists
599
485
  */
600
486
  readonly studios?: Array<string>;
601
487
  /**
602
488
  * Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.
603
- * @type {Array<string>}
604
- * @memberof ArtistsApiGetArtists
605
489
  */
606
490
  readonly studioIds?: Array<string>;
607
491
  /**
608
492
  * User id.
609
- * @type {string}
610
- * @memberof ArtistsApiGetArtists
611
493
  */
612
494
  readonly userId?: string;
613
495
  /**
614
496
  * Optional filter by items whose name is sorted equally or greater than a given input string.
615
- * @type {string}
616
- * @memberof ArtistsApiGetArtists
617
497
  */
618
498
  readonly nameStartsWithOrGreater?: string;
619
499
  /**
620
500
  * Optional filter by items whose name is sorted equally than a given input string.
621
- * @type {string}
622
- * @memberof ArtistsApiGetArtists
623
501
  */
624
502
  readonly nameStartsWith?: string;
625
503
  /**
626
504
  * Optional filter by items whose name is equally or lesser than a given input string.
627
- * @type {string}
628
- * @memberof ArtistsApiGetArtists
629
505
  */
630
506
  readonly nameLessThan?: string;
631
507
  /**
632
508
  * Optional. Specify one or more sort orders, comma delimited.
633
- * @type {Array<ItemSortBy>}
634
- * @memberof ArtistsApiGetArtists
635
509
  */
636
510
  readonly sortBy?: Array<ItemSortBy>;
637
511
  /**
638
512
  * Sort Order - Ascending,Descending.
639
- * @type {Array<SortOrder>}
640
- * @memberof ArtistsApiGetArtists
641
513
  */
642
514
  readonly sortOrder?: Array<SortOrder>;
643
515
  /**
644
516
  * Optional, include image information in output.
645
- * @type {boolean}
646
- * @memberof ArtistsApiGetArtists
647
517
  */
648
518
  readonly enableImages?: boolean;
649
519
  /**
650
520
  * Total record count.
651
- * @type {boolean}
652
- * @memberof ArtistsApiGetArtists
653
521
  */
654
522
  readonly enableTotalRecordCount?: boolean;
655
523
  }
656
524
  /**
657
- * ArtistsApi - object-oriented interface
658
- * @export
659
- * @class ArtistsApi
660
- * @extends {BaseAPI}
525
+ * ArtistApi - object-oriented interface
661
526
  */
662
- export declare class ArtistsApi extends BaseAPI {
527
+ export declare class ArtistApi extends BaseAPI {
663
528
  /**
664
529
  *
665
530
  * @summary Gets all album artists from a given item, folder, or the entire library.
666
- * @param {ArtistsApiGetAlbumArtistsRequest} requestParameters Request parameters.
531
+ * @param {ArtistApiGetAlbumArtistsRequest} requestParameters Request parameters.
667
532
  * @param {*} [options] Override http request option.
533
+ * @deprecated
668
534
  * @throws {RequiredError}
669
- * @memberof ArtistsApi
670
535
  */
671
- getAlbumArtists(requestParameters?: ArtistsApiGetAlbumArtistsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any, {}>>;
536
+ getAlbumArtists(requestParameters?: ArtistApiGetAlbumArtistsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any, {}>>;
672
537
  /**
673
538
  *
674
539
  * @summary Gets an artist by name.
675
- * @param {ArtistsApiGetArtistByNameRequest} requestParameters Request parameters.
540
+ * @param {ArtistApiGetArtistByNameRequest} requestParameters Request parameters.
676
541
  * @param {*} [options] Override http request option.
542
+ * @deprecated
677
543
  * @throws {RequiredError}
678
- * @memberof ArtistsApi
679
544
  */
680
- getArtistByName(requestParameters: ArtistsApiGetArtistByNameRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDto, any, {}>>;
545
+ getArtistByName(requestParameters: ArtistApiGetArtistByNameRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDto, any, {}>>;
681
546
  /**
682
547
  *
683
548
  * @summary Gets all artists from a given item, folder, or the entire library.
684
- * @param {ArtistsApiGetArtistsRequest} requestParameters Request parameters.
549
+ * @param {ArtistApiGetArtistsRequest} requestParameters Request parameters.
685
550
  * @param {*} [options] Override http request option.
551
+ * @deprecated
686
552
  * @throws {RequiredError}
687
- * @memberof ArtistsApi
688
553
  */
689
- getArtists(requestParameters?: ArtistsApiGetArtistsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any, {}>>;
554
+ getArtists(requestParameters?: ArtistApiGetArtistsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any, {}>>;
690
555
  }