twelvelabs-js 1.2.2 → 1.2.3

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 (573) hide show
  1. package/Client.d.ts +2 -0
  2. package/Client.js +4 -2
  3. package/README.md +20 -1
  4. package/api/client/requests/AnalyzeRequest.d.ts +1 -1
  5. package/api/client/requests/AnalyzeStreamRequest.d.ts +1 -1
  6. package/api/errors/ConflictError.d.ts +1 -2
  7. package/api/errors/index.d.ts +1 -1
  8. package/api/errors/index.js +1 -1
  9. package/api/resources/analyzeAsync/resources/tasks/client/Client.d.ts +39 -2
  10. package/api/resources/analyzeAsync/resources/tasks/client/Client.js +54 -13
  11. package/api/resources/analyzeAsync/resources/tasks/client/requests/CreateAsyncAnalyzeRequest.d.ts +74 -3
  12. package/api/resources/analyzeAsync/resources/tasks/client/requests/TasksListRequest.d.ts +26 -1
  13. package/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestAnalysisMode.d.ts +10 -0
  14. package/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestAnalysisMode.js +9 -0
  15. package/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestModelName.d.ts +13 -0
  16. package/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestModelName.js +10 -0
  17. package/api/resources/analyzeAsync/resources/tasks/types/TasksListRequestAnalysisMode.d.ts +7 -0
  18. package/api/resources/analyzeAsync/resources/tasks/types/TasksListRequestAnalysisMode.js +9 -0
  19. package/api/resources/analyzeAsync/resources/tasks/types/index.d.ts +3 -0
  20. package/api/resources/analyzeAsync/resources/tasks/types/index.js +3 -0
  21. package/api/resources/assets/client/Client.d.ts +17 -6
  22. package/api/resources/assets/client/Client.js +41 -13
  23. package/api/resources/assets/client/requests/AssetsCreateRequest.d.ts +13 -1
  24. package/api/resources/assets/client/requests/AssetsDeleteRequest.d.ts +17 -0
  25. package/api/resources/assets/client/requests/AssetsListRequest.d.ts +6 -1
  26. package/api/resources/assets/client/requests/index.d.ts +1 -0
  27. package/api/resources/assets/types/AssetsListResponse.d.ts +1 -1
  28. package/api/resources/embed/client/Client.js +1 -1
  29. package/api/resources/embed/resources/tasks/client/Client.d.ts +1 -1
  30. package/api/resources/embed/resources/tasks/client/Client.js +5 -5
  31. package/api/resources/embed/resources/v2/client/Client.js +1 -1
  32. package/api/resources/embed/resources/v2/resources/tasks/client/Client.d.ts +12 -2
  33. package/api/resources/embed/resources/v2/resources/tasks/client/Client.js +15 -5
  34. package/api/resources/entityCollections/client/Client.js +5 -5
  35. package/api/resources/entityCollections/resources/entities/client/Client.d.ts +16 -0
  36. package/api/resources/entityCollections/resources/entities/client/Client.js +100 -9
  37. package/api/resources/entityCollections/resources/entities/client/requests/EntitiesListByAssetRequest.d.ts +25 -0
  38. package/api/resources/entityCollections/resources/entities/client/requests/index.d.ts +1 -0
  39. package/api/resources/entityCollections/resources/entities/types/EntitiesListByAssetResponse.d.ts +9 -0
  40. package/api/resources/entityCollections/resources/entities/types/EntitiesListByAssetResponse.js +5 -0
  41. package/api/resources/entityCollections/resources/entities/types/index.d.ts +1 -0
  42. package/api/resources/entityCollections/resources/entities/types/index.js +1 -0
  43. package/api/resources/indexes/client/Client.js +5 -5
  44. package/api/resources/indexes/resources/indexedAssets/client/Client.d.ts +16 -5
  45. package/api/resources/indexes/resources/indexedAssets/client/Client.js +126 -15
  46. package/api/resources/indexes/resources/indexedAssets/client/requests/IndexedAssetsCreateRequest.d.ts +1 -1
  47. package/api/resources/indexes/resources/indexedAssets/client/requests/IndexedAssetsListByAssetRequest.d.ts +25 -0
  48. package/api/resources/indexes/resources/indexedAssets/client/requests/IndexedAssetsListByAssetRequest.js +5 -0
  49. package/api/resources/indexes/resources/indexedAssets/client/requests/IndexedAssetsListRequest.d.ts +15 -15
  50. package/api/resources/indexes/resources/indexedAssets/client/requests/index.d.ts +1 -0
  51. package/api/resources/indexes/resources/indexedAssets/types/IndexedAssetsCreateResponse.d.ts +2 -0
  52. package/api/resources/indexes/resources/indexedAssets/types/IndexedAssetsListByAssetResponse.d.ts +9 -0
  53. package/api/resources/indexes/resources/indexedAssets/types/IndexedAssetsListByAssetResponse.js +5 -0
  54. package/api/resources/indexes/resources/indexedAssets/types/index.d.ts +1 -0
  55. package/api/resources/indexes/resources/indexedAssets/types/index.js +1 -0
  56. package/api/resources/indexes/resources/videos/client/Client.d.ts +0 -5
  57. package/api/resources/indexes/resources/videos/client/Client.js +35 -15
  58. package/api/resources/indexes/resources/videos/client/requests/VideosListRequest.d.ts +15 -15
  59. package/api/resources/multipartUpload/client/Client.d.ts +2 -2
  60. package/api/resources/multipartUpload/client/Client.js +7 -7
  61. package/api/resources/multipartUpload/client/requests/CreateAssetUploadRequest.d.ts +12 -0
  62. package/api/resources/search/client/Client.js +2 -2
  63. package/api/resources/tasks/client/Client.js +4 -4
  64. package/api/resources/tasks/resources/transfers/client/Client.js +3 -3
  65. package/api/types/AnalyzeTaskResponse.d.ts +4 -0
  66. package/api/types/AnalyzeTaskResponseRequestParams.d.ts +21 -0
  67. package/api/types/AnalyzeTaskResponseRequestParams.js +5 -0
  68. package/api/types/AnalyzeTaskResponseRequestParamsAnalysisMode.d.ts +11 -0
  69. package/api/types/AnalyzeTaskResponseRequestParamsAnalysisMode.js +10 -0
  70. package/api/types/AnalyzeTaskResponseRequestParamsResponseFormat.d.ts +11 -0
  71. package/api/types/AnalyzeTaskResponseRequestParamsResponseFormat.js +5 -0
  72. package/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItem.d.ts +10 -0
  73. package/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItem.js +5 -0
  74. package/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItem.d.ts +11 -0
  75. package/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItem.js +5 -0
  76. package/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItemItems.d.ts +6 -0
  77. package/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItemItems.js +5 -0
  78. package/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemMediaSourcesItem.d.ts +9 -0
  79. package/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemMediaSourcesItem.js +5 -0
  80. package/api/types/AnalyzeTaskResponseRequestParamsResponseFormatType.d.ts +8 -0
  81. package/api/types/AnalyzeTaskResponseRequestParamsResponseFormatType.js +10 -0
  82. package/api/types/AnalyzeTaskResponseVideoSource.d.ts +19 -0
  83. package/api/types/AnalyzeTaskResponseVideoSource.js +5 -0
  84. package/api/types/AnalyzeTaskResponseVideoSourceSystemMetadata.d.ts +10 -0
  85. package/api/types/AnalyzeTaskResponseVideoSourceSystemMetadata.js +5 -0
  86. package/api/types/AnalyzeTaskResponseVideoSourceType.d.ts +13 -0
  87. package/api/types/AnalyzeTaskResponseVideoSourceType.js +12 -0
  88. package/api/types/AnalyzeTaskResult.d.ts +10 -1
  89. package/api/types/Asset.d.ts +5 -0
  90. package/api/types/AssetDetail.d.ts +11 -0
  91. package/api/types/AssetDetail.js +5 -0
  92. package/api/types/AssetHls.d.ts +21 -0
  93. package/api/types/AssetHls.js +5 -0
  94. package/api/types/AssetHlsStatus.d.ts +19 -0
  95. package/api/types/AssetHlsStatus.js +12 -0
  96. package/api/types/AssetMethod.d.ts +3 -1
  97. package/api/types/AssetMethod.js +1 -0
  98. package/api/types/AssetThumbnail.d.ts +21 -0
  99. package/api/types/AssetThumbnail.js +5 -0
  100. package/api/types/AssetThumbnailStatus.d.ts +19 -0
  101. package/api/types/AssetThumbnailStatus.js +12 -0
  102. package/api/types/AsyncResponseFormat.d.ts +89 -0
  103. package/api/types/AsyncResponseFormat.js +5 -0
  104. package/api/types/AsyncResponseFormatType.d.ts +13 -0
  105. package/api/types/AsyncResponseFormatType.js +10 -0
  106. package/api/types/ConflictErrorBody.d.ts +11 -0
  107. package/api/types/ConflictErrorBody.js +5 -0
  108. package/api/types/Entity.d.ts +2 -0
  109. package/api/types/IndexedAsset.d.ts +2 -0
  110. package/api/types/IndexedAssetSummary.d.ts +12 -0
  111. package/api/types/IndexedAssetSummary.js +5 -0
  112. package/api/types/IndexedAssetSummaryIndex.d.ts +12 -0
  113. package/api/types/IndexedAssetSummaryIndex.js +5 -0
  114. package/api/types/IndexedAssetsListRequestDuration.d.ts +7 -0
  115. package/api/types/IndexedAssetsListRequestDuration.js +5 -0
  116. package/api/types/IndexedAssetsListRequestFps.d.ts +7 -0
  117. package/api/types/IndexedAssetsListRequestFps.js +5 -0
  118. package/api/types/IndexedAssetsListRequestHeight.d.ts +7 -0
  119. package/api/types/IndexedAssetsListRequestHeight.js +5 -0
  120. package/api/types/IndexedAssetsListRequestSize.d.ts +7 -0
  121. package/api/types/IndexedAssetsListRequestSize.js +5 -0
  122. package/api/types/IndexedAssetsListRequestWidth.d.ts +7 -0
  123. package/api/types/IndexedAssetsListRequestWidth.js +5 -0
  124. package/api/types/InternalEntity.d.ts +23 -1
  125. package/api/types/MediaSource.d.ts +1 -1
  126. package/api/types/One.d.ts +1 -1
  127. package/api/types/SegmentDefinition.d.ts +17 -0
  128. package/api/types/SegmentDefinition.js +5 -0
  129. package/api/types/SegmentField.d.ts +19 -0
  130. package/api/types/SegmentField.js +5 -0
  131. package/api/types/SegmentFieldItems.d.ts +10 -0
  132. package/api/types/SegmentFieldItems.js +5 -0
  133. package/api/types/SegmentFieldItemsType.d.ts +10 -0
  134. package/api/types/SegmentFieldItemsType.js +12 -0
  135. package/api/types/SegmentFieldType.d.ts +14 -0
  136. package/api/types/SegmentFieldType.js +13 -0
  137. package/api/types/SmeMediaSource.d.ts +19 -0
  138. package/api/types/SmeMediaSource.js +5 -0
  139. package/api/types/SmeMediaSourceMediaType.d.ts +10 -0
  140. package/api/types/SmeMediaSourceMediaType.js +9 -0
  141. package/api/types/{ResponseFormat.d.ts → SyncResponseFormat.d.ts} +2 -2
  142. package/api/types/SyncResponseFormat.js +5 -0
  143. package/{dist/api/types/ResponseFormatType.d.ts → api/types/SyncResponseFormatType.d.ts} +2 -2
  144. package/{dist/api/types/ResponseFormatType.js → api/types/SyncResponseFormatType.js} +2 -2
  145. package/api/types/VideosListRequestDuration.d.ts +7 -0
  146. package/api/types/VideosListRequestDuration.js +5 -0
  147. package/api/types/VideosListRequestFps.d.ts +7 -0
  148. package/api/types/VideosListRequestFps.js +5 -0
  149. package/api/types/VideosListRequestHeight.d.ts +7 -0
  150. package/api/types/VideosListRequestHeight.js +5 -0
  151. package/api/types/VideosListRequestSize.d.ts +7 -0
  152. package/api/types/VideosListRequestSize.js +5 -0
  153. package/api/types/VideosListRequestWidth.d.ts +7 -0
  154. package/api/types/VideosListRequestWidth.js +5 -0
  155. package/api/types/index.d.ts +40 -2
  156. package/api/types/index.js +40 -2
  157. package/dist/Client.d.ts +2 -0
  158. package/dist/Client.js +4 -2
  159. package/dist/api/client/requests/AnalyzeRequest.d.ts +1 -1
  160. package/dist/api/client/requests/AnalyzeStreamRequest.d.ts +1 -1
  161. package/dist/api/errors/ConflictError.d.ts +1 -2
  162. package/dist/api/errors/index.d.ts +1 -1
  163. package/dist/api/errors/index.js +1 -1
  164. package/dist/api/resources/analyzeAsync/resources/tasks/client/Client.d.ts +39 -2
  165. package/dist/api/resources/analyzeAsync/resources/tasks/client/Client.js +54 -13
  166. package/dist/api/resources/analyzeAsync/resources/tasks/client/requests/CreateAsyncAnalyzeRequest.d.ts +74 -3
  167. package/dist/api/resources/analyzeAsync/resources/tasks/client/requests/TasksListRequest.d.ts +26 -1
  168. package/dist/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestAnalysisMode.d.ts +10 -0
  169. package/dist/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestAnalysisMode.js +9 -0
  170. package/dist/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestModelName.d.ts +13 -0
  171. package/dist/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestModelName.js +10 -0
  172. package/dist/api/resources/analyzeAsync/resources/tasks/types/TasksListRequestAnalysisMode.d.ts +7 -0
  173. package/dist/api/resources/analyzeAsync/resources/tasks/types/TasksListRequestAnalysisMode.js +9 -0
  174. package/dist/api/resources/analyzeAsync/resources/tasks/types/index.d.ts +3 -0
  175. package/dist/api/resources/analyzeAsync/resources/tasks/types/index.js +3 -0
  176. package/dist/api/resources/assets/client/Client.d.ts +17 -6
  177. package/dist/api/resources/assets/client/Client.js +41 -13
  178. package/dist/api/resources/assets/client/requests/AssetsCreateRequest.d.ts +13 -1
  179. package/dist/api/resources/assets/client/requests/AssetsDeleteRequest.d.ts +17 -0
  180. package/dist/api/resources/assets/client/requests/AssetsDeleteRequest.js +5 -0
  181. package/dist/api/resources/assets/client/requests/AssetsListRequest.d.ts +6 -1
  182. package/dist/api/resources/assets/client/requests/index.d.ts +1 -0
  183. package/dist/api/resources/assets/types/AssetsListResponse.d.ts +1 -1
  184. package/dist/api/resources/embed/client/Client.js +1 -1
  185. package/dist/api/resources/embed/resources/tasks/client/Client.d.ts +1 -1
  186. package/dist/api/resources/embed/resources/tasks/client/Client.js +5 -5
  187. package/dist/api/resources/embed/resources/v2/client/Client.js +1 -1
  188. package/dist/api/resources/embed/resources/v2/resources/tasks/client/Client.d.ts +12 -2
  189. package/dist/api/resources/embed/resources/v2/resources/tasks/client/Client.js +15 -5
  190. package/dist/api/resources/entityCollections/client/Client.js +5 -5
  191. package/dist/api/resources/entityCollections/resources/entities/client/Client.d.ts +16 -0
  192. package/dist/api/resources/entityCollections/resources/entities/client/Client.js +100 -9
  193. package/dist/api/resources/entityCollections/resources/entities/client/requests/EntitiesListByAssetRequest.d.ts +25 -0
  194. package/dist/api/resources/entityCollections/resources/entities/client/requests/EntitiesListByAssetRequest.js +5 -0
  195. package/dist/api/resources/entityCollections/resources/entities/client/requests/index.d.ts +1 -0
  196. package/dist/api/resources/entityCollections/resources/entities/types/EntitiesListByAssetResponse.d.ts +9 -0
  197. package/dist/api/resources/entityCollections/resources/entities/types/EntitiesListByAssetResponse.js +5 -0
  198. package/dist/api/resources/entityCollections/resources/entities/types/index.d.ts +1 -0
  199. package/dist/api/resources/entityCollections/resources/entities/types/index.js +1 -0
  200. package/dist/api/resources/indexes/client/Client.js +5 -5
  201. package/dist/api/resources/indexes/resources/indexedAssets/client/Client.d.ts +16 -5
  202. package/dist/api/resources/indexes/resources/indexedAssets/client/Client.js +126 -15
  203. package/dist/api/resources/indexes/resources/indexedAssets/client/requests/IndexedAssetsCreateRequest.d.ts +1 -1
  204. package/dist/api/resources/indexes/resources/indexedAssets/client/requests/IndexedAssetsListByAssetRequest.d.ts +25 -0
  205. package/dist/api/resources/indexes/resources/indexedAssets/client/requests/IndexedAssetsListByAssetRequest.js +5 -0
  206. package/dist/api/resources/indexes/resources/indexedAssets/client/requests/IndexedAssetsListRequest.d.ts +15 -15
  207. package/dist/api/resources/indexes/resources/indexedAssets/client/requests/index.d.ts +1 -0
  208. package/dist/api/resources/indexes/resources/indexedAssets/types/IndexedAssetsCreateResponse.d.ts +2 -0
  209. package/dist/api/resources/indexes/resources/indexedAssets/types/IndexedAssetsListByAssetResponse.d.ts +9 -0
  210. package/dist/api/resources/indexes/resources/indexedAssets/types/IndexedAssetsListByAssetResponse.js +5 -0
  211. package/dist/api/resources/indexes/resources/indexedAssets/types/index.d.ts +1 -0
  212. package/dist/api/resources/indexes/resources/indexedAssets/types/index.js +1 -0
  213. package/dist/api/resources/indexes/resources/videos/client/Client.d.ts +0 -5
  214. package/dist/api/resources/indexes/resources/videos/client/Client.js +35 -15
  215. package/dist/api/resources/indexes/resources/videos/client/requests/VideosListRequest.d.ts +15 -15
  216. package/dist/api/resources/multipartUpload/client/Client.d.ts +2 -2
  217. package/dist/api/resources/multipartUpload/client/Client.js +7 -7
  218. package/dist/api/resources/multipartUpload/client/requests/CreateAssetUploadRequest.d.ts +12 -0
  219. package/dist/api/resources/search/client/Client.js +2 -2
  220. package/dist/api/resources/tasks/client/Client.js +4 -4
  221. package/dist/api/resources/tasks/resources/transfers/client/Client.js +3 -3
  222. package/dist/api/types/AnalyzeTaskResponse.d.ts +4 -0
  223. package/dist/api/types/AnalyzeTaskResponseRequestParams.d.ts +21 -0
  224. package/dist/api/types/AnalyzeTaskResponseRequestParams.js +5 -0
  225. package/dist/api/types/AnalyzeTaskResponseRequestParamsAnalysisMode.d.ts +11 -0
  226. package/dist/api/types/AnalyzeTaskResponseRequestParamsAnalysisMode.js +10 -0
  227. package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormat.d.ts +11 -0
  228. package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormat.js +5 -0
  229. package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItem.d.ts +10 -0
  230. package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItem.js +5 -0
  231. package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItem.d.ts +11 -0
  232. package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItem.js +5 -0
  233. package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItemItems.d.ts +6 -0
  234. package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItemItems.js +5 -0
  235. package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemMediaSourcesItem.d.ts +9 -0
  236. package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemMediaSourcesItem.js +5 -0
  237. package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormatType.d.ts +8 -0
  238. package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormatType.js +10 -0
  239. package/dist/api/types/AnalyzeTaskResponseVideoSource.d.ts +19 -0
  240. package/dist/api/types/AnalyzeTaskResponseVideoSource.js +5 -0
  241. package/dist/api/types/AnalyzeTaskResponseVideoSourceSystemMetadata.d.ts +10 -0
  242. package/dist/api/types/AnalyzeTaskResponseVideoSourceSystemMetadata.js +5 -0
  243. package/dist/api/types/AnalyzeTaskResponseVideoSourceType.d.ts +13 -0
  244. package/dist/api/types/AnalyzeTaskResponseVideoSourceType.js +12 -0
  245. package/dist/api/types/AnalyzeTaskResult.d.ts +10 -1
  246. package/dist/api/types/Asset.d.ts +5 -0
  247. package/dist/api/types/AssetDetail.d.ts +11 -0
  248. package/dist/api/types/AssetDetail.js +5 -0
  249. package/dist/api/types/AssetHls.d.ts +21 -0
  250. package/dist/api/types/AssetHls.js +5 -0
  251. package/dist/api/types/AssetHlsStatus.d.ts +19 -0
  252. package/dist/api/types/AssetHlsStatus.js +12 -0
  253. package/dist/api/types/AssetMethod.d.ts +3 -1
  254. package/dist/api/types/AssetMethod.js +1 -0
  255. package/dist/api/types/AssetThumbnail.d.ts +21 -0
  256. package/dist/api/types/AssetThumbnail.js +5 -0
  257. package/dist/api/types/AssetThumbnailStatus.d.ts +19 -0
  258. package/dist/api/types/AssetThumbnailStatus.js +12 -0
  259. package/dist/api/types/AsyncResponseFormat.d.ts +89 -0
  260. package/dist/api/types/AsyncResponseFormat.js +5 -0
  261. package/dist/api/types/AsyncResponseFormatType.d.ts +13 -0
  262. package/dist/api/types/AsyncResponseFormatType.js +10 -0
  263. package/dist/api/types/ConflictErrorBody.d.ts +11 -0
  264. package/dist/api/types/ConflictErrorBody.js +5 -0
  265. package/dist/api/types/Entity.d.ts +2 -0
  266. package/dist/api/types/IndexedAsset.d.ts +2 -0
  267. package/dist/api/types/IndexedAssetSummary.d.ts +12 -0
  268. package/dist/api/types/IndexedAssetSummary.js +5 -0
  269. package/dist/api/types/IndexedAssetSummaryIndex.d.ts +12 -0
  270. package/dist/api/types/IndexedAssetSummaryIndex.js +5 -0
  271. package/dist/api/types/IndexedAssetsListRequestDuration.d.ts +7 -0
  272. package/dist/api/types/IndexedAssetsListRequestDuration.js +5 -0
  273. package/dist/api/types/IndexedAssetsListRequestFps.d.ts +7 -0
  274. package/dist/api/types/IndexedAssetsListRequestFps.js +5 -0
  275. package/dist/api/types/IndexedAssetsListRequestHeight.d.ts +7 -0
  276. package/dist/api/types/IndexedAssetsListRequestHeight.js +5 -0
  277. package/dist/api/types/IndexedAssetsListRequestSize.d.ts +7 -0
  278. package/dist/api/types/IndexedAssetsListRequestSize.js +5 -0
  279. package/dist/api/types/IndexedAssetsListRequestWidth.d.ts +7 -0
  280. package/dist/api/types/IndexedAssetsListRequestWidth.js +5 -0
  281. package/dist/api/types/InternalEntity.d.ts +23 -1
  282. package/dist/api/types/MediaSource.d.ts +1 -1
  283. package/dist/api/types/One.d.ts +1 -1
  284. package/dist/api/types/SegmentDefinition.d.ts +17 -0
  285. package/dist/api/types/SegmentDefinition.js +5 -0
  286. package/dist/api/types/SegmentField.d.ts +19 -0
  287. package/dist/api/types/SegmentField.js +5 -0
  288. package/dist/api/types/SegmentFieldItems.d.ts +10 -0
  289. package/dist/api/types/SegmentFieldItems.js +5 -0
  290. package/dist/api/types/SegmentFieldItemsType.d.ts +10 -0
  291. package/dist/api/types/SegmentFieldItemsType.js +12 -0
  292. package/dist/api/types/SegmentFieldType.d.ts +14 -0
  293. package/dist/api/types/SegmentFieldType.js +13 -0
  294. package/dist/api/types/SmeMediaSource.d.ts +19 -0
  295. package/dist/api/types/SmeMediaSource.js +5 -0
  296. package/dist/api/types/SmeMediaSourceMediaType.d.ts +10 -0
  297. package/dist/api/types/SmeMediaSourceMediaType.js +9 -0
  298. package/dist/api/types/{ResponseFormat.d.ts → SyncResponseFormat.d.ts} +2 -2
  299. package/dist/api/types/SyncResponseFormat.js +5 -0
  300. package/{api/types/ResponseFormatType.d.ts → dist/api/types/SyncResponseFormatType.d.ts} +2 -2
  301. package/{api/types/ResponseFormatType.js → dist/api/types/SyncResponseFormatType.js} +2 -2
  302. package/dist/api/types/VideosListRequestDuration.d.ts +7 -0
  303. package/dist/api/types/VideosListRequestDuration.js +5 -0
  304. package/dist/api/types/VideosListRequestFps.d.ts +7 -0
  305. package/dist/api/types/VideosListRequestFps.js +5 -0
  306. package/dist/api/types/VideosListRequestHeight.d.ts +7 -0
  307. package/dist/api/types/VideosListRequestHeight.js +5 -0
  308. package/dist/api/types/VideosListRequestSize.d.ts +7 -0
  309. package/dist/api/types/VideosListRequestSize.js +5 -0
  310. package/dist/api/types/VideosListRequestWidth.d.ts +7 -0
  311. package/dist/api/types/VideosListRequestWidth.js +5 -0
  312. package/dist/api/types/index.d.ts +40 -2
  313. package/dist/api/types/index.js +40 -2
  314. package/dist/serialization/client/requests/AnalyzeRequest.d.ts +2 -2
  315. package/dist/serialization/client/requests/AnalyzeRequest.js +2 -2
  316. package/dist/serialization/client/requests/AnalyzeStreamRequest.d.ts +2 -2
  317. package/dist/serialization/client/requests/AnalyzeStreamRequest.js +2 -2
  318. package/dist/serialization/resources/analyzeAsync/resources/tasks/client/requests/CreateAsyncAnalyzeRequest.d.ts +10 -6
  319. package/dist/serialization/resources/analyzeAsync/resources/tasks/client/requests/CreateAsyncAnalyzeRequest.js +10 -6
  320. package/dist/serialization/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestAnalysisMode.d.ts +10 -0
  321. package/dist/serialization/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestAnalysisMode.js +41 -0
  322. package/dist/serialization/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestModelName.d.ts +10 -0
  323. package/dist/serialization/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestModelName.js +41 -0
  324. package/dist/serialization/resources/analyzeAsync/resources/tasks/types/TasksListRequestAnalysisMode.d.ts +10 -0
  325. package/dist/serialization/resources/analyzeAsync/resources/tasks/types/TasksListRequestAnalysisMode.js +41 -0
  326. package/dist/serialization/resources/analyzeAsync/resources/tasks/types/index.d.ts +3 -0
  327. package/dist/serialization/resources/analyzeAsync/resources/tasks/types/index.js +3 -0
  328. package/dist/serialization/resources/assets/types/AssetsListResponse.d.ts +2 -2
  329. package/dist/serialization/resources/assets/types/AssetsListResponse.js +2 -2
  330. package/dist/serialization/resources/entityCollections/resources/entities/types/EntitiesListByAssetResponse.d.ts +15 -0
  331. package/dist/serialization/resources/entityCollections/resources/entities/types/EntitiesListByAssetResponse.js +46 -0
  332. package/dist/serialization/resources/entityCollections/resources/entities/types/index.d.ts +1 -0
  333. package/dist/serialization/resources/entityCollections/resources/entities/types/index.js +1 -0
  334. package/dist/serialization/resources/indexes/resources/indexedAssets/types/IndexedAssetsCreateResponse.d.ts +1 -0
  335. package/dist/serialization/resources/indexes/resources/indexedAssets/types/IndexedAssetsCreateResponse.js +1 -0
  336. package/dist/serialization/resources/indexes/resources/indexedAssets/types/IndexedAssetsListByAssetResponse.d.ts +15 -0
  337. package/dist/serialization/resources/indexes/resources/indexedAssets/types/IndexedAssetsListByAssetResponse.js +46 -0
  338. package/dist/serialization/resources/indexes/resources/indexedAssets/types/index.d.ts +1 -0
  339. package/dist/serialization/resources/indexes/resources/indexedAssets/types/index.js +1 -0
  340. package/dist/serialization/resources/multipartUpload/client/requests/CreateAssetUploadRequest.d.ts +2 -0
  341. package/dist/serialization/resources/multipartUpload/client/requests/CreateAssetUploadRequest.js +2 -0
  342. package/dist/serialization/types/AnalyzeTaskResponse.d.ts +4 -0
  343. package/dist/serialization/types/AnalyzeTaskResponse.js +4 -0
  344. package/dist/serialization/types/AnalyzeTaskResponseRequestParams.d.ts +19 -0
  345. package/dist/serialization/types/AnalyzeTaskResponseRequestParams.js +50 -0
  346. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsAnalysisMode.d.ts +10 -0
  347. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsAnalysisMode.js +41 -0
  348. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormat.d.ts +15 -0
  349. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormat.js +46 -0
  350. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItem.d.ts +17 -0
  351. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItem.js +52 -0
  352. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItem.d.ts +17 -0
  353. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItem.js +48 -0
  354. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItemItems.d.ts +12 -0
  355. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItemItems.js +43 -0
  356. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemMediaSourcesItem.d.ts +15 -0
  357. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemMediaSourcesItem.js +46 -0
  358. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatType.d.ts +10 -0
  359. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatType.js +41 -0
  360. package/dist/serialization/types/AnalyzeTaskResponseVideoSource.d.ts +18 -0
  361. package/dist/serialization/types/AnalyzeTaskResponseVideoSource.js +49 -0
  362. package/dist/serialization/types/AnalyzeTaskResponseVideoSourceSystemMetadata.d.ts +12 -0
  363. package/dist/serialization/types/AnalyzeTaskResponseVideoSourceSystemMetadata.js +43 -0
  364. package/dist/serialization/types/AnalyzeTaskResponseVideoSourceType.d.ts +10 -0
  365. package/dist/serialization/types/AnalyzeTaskResponseVideoSourceType.js +41 -0
  366. package/dist/serialization/types/AnalyzeTaskResult.d.ts +1 -2
  367. package/dist/serialization/types/AnalyzeTaskResult.js +1 -2
  368. package/dist/serialization/types/Asset.d.ts +2 -0
  369. package/dist/serialization/types/Asset.js +2 -0
  370. package/dist/serialization/types/AssetDetail.d.ts +16 -0
  371. package/dist/serialization/types/AssetDetail.js +49 -0
  372. package/dist/serialization/types/AssetHls.d.ts +14 -0
  373. package/dist/serialization/types/AssetHls.js +45 -0
  374. package/dist/serialization/types/AssetHlsStatus.d.ts +10 -0
  375. package/dist/serialization/types/AssetHlsStatus.js +41 -0
  376. package/dist/serialization/types/AssetMethod.d.ts +1 -1
  377. package/dist/serialization/types/AssetMethod.js +1 -1
  378. package/dist/serialization/types/AssetThumbnail.d.ts +14 -0
  379. package/dist/serialization/types/AssetThumbnail.js +45 -0
  380. package/dist/serialization/types/AssetThumbnailStatus.d.ts +10 -0
  381. package/dist/serialization/types/AssetThumbnailStatus.js +41 -0
  382. package/dist/serialization/types/AsyncResponseFormat.d.ts +16 -0
  383. package/dist/serialization/types/AsyncResponseFormat.js +47 -0
  384. package/dist/serialization/types/AsyncResponseFormatType.d.ts +10 -0
  385. package/dist/serialization/types/AsyncResponseFormatType.js +41 -0
  386. package/dist/serialization/types/ConflictErrorBody.d.ts +14 -0
  387. package/dist/serialization/types/ConflictErrorBody.js +45 -0
  388. package/dist/serialization/types/Entity.d.ts +1 -0
  389. package/dist/serialization/types/Entity.js +1 -0
  390. package/dist/serialization/types/IndexedAsset.d.ts +1 -0
  391. package/dist/serialization/types/IndexedAsset.js +1 -0
  392. package/dist/serialization/types/IndexedAssetSummary.d.ts +14 -0
  393. package/dist/serialization/types/IndexedAssetSummary.js +45 -0
  394. package/dist/serialization/types/IndexedAssetSummaryIndex.d.ts +13 -0
  395. package/dist/serialization/types/IndexedAssetSummaryIndex.js +44 -0
  396. package/dist/serialization/types/IndexedAssetsListRequestDuration.d.ts +13 -0
  397. package/dist/serialization/types/IndexedAssetsListRequestDuration.js +44 -0
  398. package/dist/serialization/types/IndexedAssetsListRequestFps.d.ts +13 -0
  399. package/dist/serialization/types/IndexedAssetsListRequestFps.js +44 -0
  400. package/dist/serialization/types/IndexedAssetsListRequestHeight.d.ts +13 -0
  401. package/dist/serialization/types/IndexedAssetsListRequestHeight.js +44 -0
  402. package/dist/serialization/types/IndexedAssetsListRequestSize.d.ts +13 -0
  403. package/dist/serialization/types/IndexedAssetsListRequestSize.js +44 -0
  404. package/dist/serialization/types/IndexedAssetsListRequestWidth.d.ts +13 -0
  405. package/dist/serialization/types/IndexedAssetsListRequestWidth.js +44 -0
  406. package/dist/serialization/types/InternalEntity.d.ts +10 -2
  407. package/dist/serialization/types/InternalEntity.js +11 -5
  408. package/dist/serialization/types/SegmentDefinition.d.ts +17 -0
  409. package/dist/serialization/types/SegmentDefinition.js +48 -0
  410. package/dist/serialization/types/SegmentField.d.ts +18 -0
  411. package/dist/serialization/types/SegmentField.js +49 -0
  412. package/dist/serialization/types/SegmentFieldItems.d.ts +13 -0
  413. package/dist/serialization/types/SegmentFieldItems.js +44 -0
  414. package/dist/serialization/types/SegmentFieldItemsType.d.ts +10 -0
  415. package/dist/serialization/types/SegmentFieldItemsType.js +41 -0
  416. package/dist/serialization/types/SegmentFieldType.d.ts +10 -0
  417. package/dist/serialization/types/SegmentFieldType.js +41 -0
  418. package/dist/serialization/types/SmeMediaSource.d.ts +17 -0
  419. package/dist/serialization/types/SmeMediaSource.js +48 -0
  420. package/dist/serialization/types/SmeMediaSourceMediaType.d.ts +10 -0
  421. package/dist/serialization/types/{ResponseFormatType.js → SmeMediaSourceMediaType.js} +2 -2
  422. package/dist/serialization/types/SyncResponseFormat.d.ts +14 -0
  423. package/{serialization/types/ResponseFormat.js → dist/serialization/types/SyncResponseFormat.js} +4 -4
  424. package/dist/serialization/types/{ResponseFormatType.d.ts → SyncResponseFormatType.d.ts} +2 -2
  425. package/dist/serialization/types/SyncResponseFormatType.js +41 -0
  426. package/dist/serialization/types/VideosListRequestDuration.d.ts +13 -0
  427. package/dist/serialization/types/VideosListRequestDuration.js +44 -0
  428. package/dist/serialization/types/VideosListRequestFps.d.ts +13 -0
  429. package/dist/serialization/types/VideosListRequestFps.js +44 -0
  430. package/dist/serialization/types/VideosListRequestHeight.d.ts +13 -0
  431. package/dist/serialization/types/VideosListRequestHeight.js +44 -0
  432. package/dist/serialization/types/VideosListRequestSize.d.ts +13 -0
  433. package/dist/serialization/types/VideosListRequestSize.js +44 -0
  434. package/dist/serialization/types/VideosListRequestWidth.d.ts +13 -0
  435. package/dist/serialization/types/VideosListRequestWidth.js +44 -0
  436. package/dist/serialization/types/index.d.ts +40 -2
  437. package/dist/serialization/types/index.js +40 -2
  438. package/dist/version.d.ts +1 -1
  439. package/dist/version.js +1 -1
  440. package/dist/wrapper/resources/IndexesVideosWrapper.js +29 -14
  441. package/package.json +1 -1
  442. package/reference.md +219 -35
  443. package/serialization/client/requests/AnalyzeRequest.d.ts +2 -2
  444. package/serialization/client/requests/AnalyzeRequest.js +2 -2
  445. package/serialization/client/requests/AnalyzeStreamRequest.d.ts +2 -2
  446. package/serialization/client/requests/AnalyzeStreamRequest.js +2 -2
  447. package/serialization/resources/analyzeAsync/resources/tasks/client/requests/CreateAsyncAnalyzeRequest.d.ts +10 -6
  448. package/serialization/resources/analyzeAsync/resources/tasks/client/requests/CreateAsyncAnalyzeRequest.js +10 -6
  449. package/serialization/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestAnalysisMode.d.ts +10 -0
  450. package/serialization/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestAnalysisMode.js +41 -0
  451. package/serialization/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestModelName.d.ts +10 -0
  452. package/serialization/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestModelName.js +41 -0
  453. package/serialization/resources/analyzeAsync/resources/tasks/types/TasksListRequestAnalysisMode.d.ts +10 -0
  454. package/serialization/resources/analyzeAsync/resources/tasks/types/TasksListRequestAnalysisMode.js +41 -0
  455. package/serialization/resources/analyzeAsync/resources/tasks/types/index.d.ts +3 -0
  456. package/serialization/resources/analyzeAsync/resources/tasks/types/index.js +3 -0
  457. package/serialization/resources/assets/types/AssetsListResponse.d.ts +2 -2
  458. package/serialization/resources/assets/types/AssetsListResponse.js +2 -2
  459. package/serialization/resources/entityCollections/resources/entities/types/EntitiesListByAssetResponse.d.ts +15 -0
  460. package/serialization/resources/entityCollections/resources/entities/types/EntitiesListByAssetResponse.js +46 -0
  461. package/serialization/resources/entityCollections/resources/entities/types/index.d.ts +1 -0
  462. package/serialization/resources/entityCollections/resources/entities/types/index.js +1 -0
  463. package/serialization/resources/indexes/resources/indexedAssets/types/IndexedAssetsCreateResponse.d.ts +1 -0
  464. package/serialization/resources/indexes/resources/indexedAssets/types/IndexedAssetsCreateResponse.js +1 -0
  465. package/serialization/resources/indexes/resources/indexedAssets/types/IndexedAssetsListByAssetResponse.d.ts +15 -0
  466. package/serialization/resources/indexes/resources/indexedAssets/types/IndexedAssetsListByAssetResponse.js +46 -0
  467. package/serialization/resources/indexes/resources/indexedAssets/types/index.d.ts +1 -0
  468. package/serialization/resources/indexes/resources/indexedAssets/types/index.js +1 -0
  469. package/serialization/resources/multipartUpload/client/requests/CreateAssetUploadRequest.d.ts +2 -0
  470. package/serialization/resources/multipartUpload/client/requests/CreateAssetUploadRequest.js +2 -0
  471. package/serialization/types/AnalyzeTaskResponse.d.ts +4 -0
  472. package/serialization/types/AnalyzeTaskResponse.js +4 -0
  473. package/serialization/types/AnalyzeTaskResponseRequestParams.d.ts +19 -0
  474. package/serialization/types/AnalyzeTaskResponseRequestParams.js +50 -0
  475. package/serialization/types/AnalyzeTaskResponseRequestParamsAnalysisMode.d.ts +10 -0
  476. package/serialization/types/AnalyzeTaskResponseRequestParamsAnalysisMode.js +41 -0
  477. package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormat.d.ts +15 -0
  478. package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormat.js +46 -0
  479. package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItem.d.ts +17 -0
  480. package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItem.js +52 -0
  481. package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItem.d.ts +17 -0
  482. package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItem.js +48 -0
  483. package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItemItems.d.ts +12 -0
  484. package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItemItems.js +43 -0
  485. package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemMediaSourcesItem.d.ts +15 -0
  486. package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemMediaSourcesItem.js +46 -0
  487. package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatType.d.ts +10 -0
  488. package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatType.js +41 -0
  489. package/serialization/types/AnalyzeTaskResponseVideoSource.d.ts +18 -0
  490. package/serialization/types/AnalyzeTaskResponseVideoSource.js +49 -0
  491. package/serialization/types/AnalyzeTaskResponseVideoSourceSystemMetadata.d.ts +12 -0
  492. package/serialization/types/AnalyzeTaskResponseVideoSourceSystemMetadata.js +43 -0
  493. package/serialization/types/AnalyzeTaskResponseVideoSourceType.d.ts +10 -0
  494. package/serialization/types/AnalyzeTaskResponseVideoSourceType.js +41 -0
  495. package/serialization/types/AnalyzeTaskResult.d.ts +1 -2
  496. package/serialization/types/AnalyzeTaskResult.js +1 -2
  497. package/serialization/types/Asset.d.ts +2 -0
  498. package/serialization/types/Asset.js +2 -0
  499. package/serialization/types/AssetDetail.d.ts +16 -0
  500. package/serialization/types/AssetDetail.js +49 -0
  501. package/serialization/types/AssetHls.d.ts +14 -0
  502. package/serialization/types/AssetHls.js +45 -0
  503. package/serialization/types/AssetHlsStatus.d.ts +10 -0
  504. package/serialization/types/AssetHlsStatus.js +41 -0
  505. package/serialization/types/AssetMethod.d.ts +1 -1
  506. package/serialization/types/AssetMethod.js +1 -1
  507. package/serialization/types/AssetThumbnail.d.ts +14 -0
  508. package/serialization/types/AssetThumbnail.js +45 -0
  509. package/serialization/types/AssetThumbnailStatus.d.ts +10 -0
  510. package/serialization/types/AssetThumbnailStatus.js +41 -0
  511. package/serialization/types/AsyncResponseFormat.d.ts +16 -0
  512. package/serialization/types/AsyncResponseFormat.js +47 -0
  513. package/serialization/types/AsyncResponseFormatType.d.ts +10 -0
  514. package/serialization/types/AsyncResponseFormatType.js +41 -0
  515. package/serialization/types/ConflictErrorBody.d.ts +14 -0
  516. package/serialization/types/ConflictErrorBody.js +45 -0
  517. package/serialization/types/Entity.d.ts +1 -0
  518. package/serialization/types/Entity.js +1 -0
  519. package/serialization/types/IndexedAsset.d.ts +1 -0
  520. package/serialization/types/IndexedAsset.js +1 -0
  521. package/serialization/types/IndexedAssetSummary.d.ts +14 -0
  522. package/serialization/types/IndexedAssetSummary.js +45 -0
  523. package/serialization/types/IndexedAssetSummaryIndex.d.ts +13 -0
  524. package/serialization/types/IndexedAssetSummaryIndex.js +44 -0
  525. package/serialization/types/IndexedAssetsListRequestDuration.d.ts +13 -0
  526. package/serialization/types/IndexedAssetsListRequestDuration.js +44 -0
  527. package/serialization/types/IndexedAssetsListRequestFps.d.ts +13 -0
  528. package/serialization/types/IndexedAssetsListRequestFps.js +44 -0
  529. package/serialization/types/IndexedAssetsListRequestHeight.d.ts +13 -0
  530. package/serialization/types/IndexedAssetsListRequestHeight.js +44 -0
  531. package/serialization/types/IndexedAssetsListRequestSize.d.ts +13 -0
  532. package/serialization/types/IndexedAssetsListRequestSize.js +44 -0
  533. package/serialization/types/IndexedAssetsListRequestWidth.d.ts +13 -0
  534. package/serialization/types/IndexedAssetsListRequestWidth.js +44 -0
  535. package/serialization/types/InternalEntity.d.ts +10 -2
  536. package/serialization/types/InternalEntity.js +11 -5
  537. package/serialization/types/SegmentDefinition.d.ts +17 -0
  538. package/serialization/types/SegmentDefinition.js +48 -0
  539. package/serialization/types/SegmentField.d.ts +18 -0
  540. package/serialization/types/SegmentField.js +49 -0
  541. package/serialization/types/SegmentFieldItems.d.ts +13 -0
  542. package/serialization/types/SegmentFieldItems.js +44 -0
  543. package/serialization/types/SegmentFieldItemsType.d.ts +10 -0
  544. package/serialization/types/SegmentFieldItemsType.js +41 -0
  545. package/serialization/types/SegmentFieldType.d.ts +10 -0
  546. package/serialization/types/SegmentFieldType.js +41 -0
  547. package/serialization/types/SmeMediaSource.d.ts +17 -0
  548. package/serialization/types/SmeMediaSource.js +48 -0
  549. package/serialization/types/SmeMediaSourceMediaType.d.ts +10 -0
  550. package/serialization/types/{ResponseFormatType.js → SmeMediaSourceMediaType.js} +2 -2
  551. package/serialization/types/SyncResponseFormat.d.ts +14 -0
  552. package/{dist/serialization/types/ResponseFormat.js → serialization/types/SyncResponseFormat.js} +4 -4
  553. package/serialization/types/{ResponseFormatType.d.ts → SyncResponseFormatType.d.ts} +2 -2
  554. package/serialization/types/SyncResponseFormatType.js +41 -0
  555. package/serialization/types/VideosListRequestDuration.d.ts +13 -0
  556. package/serialization/types/VideosListRequestDuration.js +44 -0
  557. package/serialization/types/VideosListRequestFps.d.ts +13 -0
  558. package/serialization/types/VideosListRequestFps.js +44 -0
  559. package/serialization/types/VideosListRequestHeight.d.ts +13 -0
  560. package/serialization/types/VideosListRequestHeight.js +44 -0
  561. package/serialization/types/VideosListRequestSize.d.ts +13 -0
  562. package/serialization/types/VideosListRequestSize.js +44 -0
  563. package/serialization/types/VideosListRequestWidth.d.ts +13 -0
  564. package/serialization/types/VideosListRequestWidth.js +44 -0
  565. package/serialization/types/index.d.ts +40 -2
  566. package/serialization/types/index.js +40 -2
  567. package/version.d.ts +1 -1
  568. package/version.js +1 -1
  569. package/wrapper/resources/IndexesVideosWrapper.js +29 -14
  570. package/dist/serialization/types/ResponseFormat.d.ts +0 -14
  571. package/serialization/types/ResponseFormat.d.ts +0 -14
  572. /package/api/{types/ResponseFormat.js → resources/assets/client/requests/AssetsDeleteRequest.js} +0 -0
  573. /package/{dist/api/types/ResponseFormat.js → api/resources/entityCollections/resources/entities/client/requests/EntitiesListByAssetRequest.js} +0 -0
@@ -72,14 +72,15 @@ class Assets {
72
72
  * @example
73
73
  * await client.assets.list({
74
74
  * page: 1,
75
- * pageLimit: 10
75
+ * pageLimit: 10,
76
+ * filename: "meeting"
76
77
  * })
77
78
  */
78
79
  list() {
79
80
  return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
80
81
  const list = core.HttpResponsePromise.interceptFunction((request) => __awaiter(this, void 0, void 0, function* () {
81
82
  var _a, _b;
82
- const { page, pageLimit, assetIds, assetTypes } = request;
83
+ const { page, pageLimit, assetIds, assetTypes, filename } = request;
83
84
  const _queryParams = {};
84
85
  if (page != null) {
85
86
  _queryParams["page"] = page.toString();
@@ -105,10 +106,13 @@ class Assets {
105
106
  _queryParams["asset_types"] = serializers.AssetsListRequestAssetTypesItem.jsonOrThrow(assetTypes, { unrecognizedObjectKeys: "strip" });
106
107
  }
107
108
  }
109
+ if (filename != null) {
110
+ _queryParams["filename"] = filename;
111
+ }
108
112
  const _response = yield core.fetcher({
109
113
  url: (0, url_join_1.default)((_b = (_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.TwelvelabsApiEnvironment.Default, "assets"),
110
114
  method: "GET",
111
- headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.2", "User-Agent": "twelvelabs-js/1.2.2", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
115
+ headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.3", "User-Agent": "twelvelabs-js/1.2.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
112
116
  contentType: "application/json",
113
117
  queryParameters: _queryParams,
114
118
  requestType: "json",
@@ -178,7 +182,7 @@ class Assets {
178
182
  * - **Local file**: Set the `method` parameter to `direct` and use the `file` parameter to specify the file.
179
183
  * - **Publicly accessible URL**: Set the `method` parameter to `url` and use the `url` parameter to specify the URL of your file.
180
184
  *
181
- * **File size**: 200MB maximum for local file uploads, 4GB maximum for URL uploads.
185
+ * **File size**: Up to 4 GB.
182
186
  *
183
187
  * **Additional requirements** depend on your workflow:
184
188
  * - **Search**: [Marengo requirements](/v1.3/docs/concepts/models/marengo#video-file-requirements)
@@ -217,11 +221,17 @@ class Assets {
217
221
  if (request.filename != null) {
218
222
  _request.append("filename", request.filename);
219
223
  }
224
+ if (request.enableHls != null) {
225
+ _request.append("enable_hls", request.enableHls.toString());
226
+ }
227
+ if (request.enableThumbnail != null) {
228
+ _request.append("enable_thumbnail", request.enableThumbnail.toString());
229
+ }
220
230
  const _maybeEncodedRequest = yield _request.getRequest();
221
231
  const _response = yield core.fetcher({
222
232
  url: (0, url_join_1.default)((_b = (_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.TwelvelabsApiEnvironment.Default, "assets"),
223
233
  method: "POST",
224
- headers: Object.assign(Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.2", "User-Agent": "twelvelabs-js/1.2.2", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), _maybeEncodedRequest.headers), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
234
+ headers: Object.assign(Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.3", "User-Agent": "twelvelabs-js/1.2.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), _maybeEncodedRequest.headers), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
225
235
  requestType: "file",
226
236
  duplex: _maybeEncodedRequest.duplex,
227
237
  body: _maybeEncodedRequest.body,
@@ -289,7 +299,7 @@ class Assets {
289
299
  const _response = yield core.fetcher({
290
300
  url: (0, url_join_1.default)((_b = (_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.TwelvelabsApiEnvironment.Default, `assets/${encodeURIComponent(assetId)}`),
291
301
  method: "GET",
292
- headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.2", "User-Agent": "twelvelabs-js/1.2.2", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
302
+ headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.3", "User-Agent": "twelvelabs-js/1.2.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
293
303
  contentType: "application/json",
294
304
  requestType: "json",
295
305
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -298,7 +308,7 @@ class Assets {
298
308
  });
299
309
  if (_response.ok) {
300
310
  return {
301
- data: serializers.Asset.parseOrThrow(_response.body, {
311
+ data: serializers.AssetDetail.parseOrThrow(_response.body, {
302
312
  unrecognizedObjectKeys: "passthrough",
303
313
  allowUnrecognizedUnionMembers: true,
304
314
  allowUnrecognizedEnumValues: true,
@@ -339,25 +349,41 @@ class Assets {
339
349
  /**
340
350
  * This method deletes the specified asset. This action cannot be undone.
341
351
  *
352
+ * By default, the platform checks whether any indexed assets reference the asset. If references exist, the platform rejects the request with a `409 Conflict` error. To skip this check and delete the asset anyway, set the `force` query parameter to `true`. The platform unlinks any entity associations.
353
+ *
354
+ * Before deleting, you can inspect existing references:
355
+ * - [`GET`](/v1.3/api-reference/index-content/list-indexed-assets-by-asset) `/assets/{asset_id}/indexed-assets` returns a list of the indexed assets that will block deletion unless the `force` query parameter is set to `true`.
356
+ * - [`GET`](/v1.3/api-reference/entities/list-entities-by-asset) `/assets/{asset_id}/entities` returns a list of the entities whose associations the platform will unlink.
357
+ *
342
358
  * @param {string} assetId - The unique identifier of the asset to delete.
359
+ * @param {TwelvelabsApi.AssetsDeleteRequest} request
343
360
  * @param {Assets.RequestOptions} requestOptions - Request-specific configuration.
344
361
  *
345
362
  * @throws {@link TwelvelabsApi.BadRequestError}
363
+ * @throws {@link TwelvelabsApi.ConflictError}
346
364
  *
347
365
  * @example
348
- * await client.assets.delete("6298d673f1090f1100476d4c")
366
+ * await client.assets.delete("6298d673f1090f1100476d4c", {
367
+ * force: true
368
+ * })
349
369
  */
350
- delete(assetId, requestOptions) {
351
- return core.HttpResponsePromise.fromPromise(this.__delete(assetId, requestOptions));
370
+ delete(assetId, request = {}, requestOptions) {
371
+ return core.HttpResponsePromise.fromPromise(this.__delete(assetId, request, requestOptions));
352
372
  }
353
- __delete(assetId, requestOptions) {
354
- return __awaiter(this, void 0, void 0, function* () {
373
+ __delete(assetId_1) {
374
+ return __awaiter(this, arguments, void 0, function* (assetId, request = {}, requestOptions) {
355
375
  var _a, _b;
376
+ const { force } = request;
377
+ const _queryParams = {};
378
+ if (force != null) {
379
+ _queryParams["force"] = force.toString();
380
+ }
356
381
  const _response = yield core.fetcher({
357
382
  url: (0, url_join_1.default)((_b = (_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.TwelvelabsApiEnvironment.Default, `assets/${encodeURIComponent(assetId)}`),
358
383
  method: "DELETE",
359
- headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.2", "User-Agent": "twelvelabs-js/1.2.2", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
384
+ headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.3", "User-Agent": "twelvelabs-js/1.2.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
360
385
  contentType: "application/json",
386
+ queryParameters: _queryParams,
361
387
  requestType: "json",
362
388
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
363
389
  maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
@@ -370,6 +396,8 @@ class Assets {
370
396
  switch (_response.error.statusCode) {
371
397
  case 400:
372
398
  throw new TwelvelabsApi.BadRequestError(_response.error.body, _response.rawResponse);
399
+ case 409:
400
+ throw new TwelvelabsApi.ConflictError(_response.error.body, _response.rawResponse);
373
401
  default:
374
402
  throw new errors.TwelvelabsApiError({
375
403
  statusCode: _response.error.statusCode,
@@ -16,9 +16,21 @@ export interface AssetsCreateRequest {
16
16
  /**
17
17
  * Specify this parameter to upload a file from a publicly accessible URL. This parameter is required when `method` is set to `url`.
18
18
  *
19
- * URL uploads have a maximum limit of 4GB.
19
+ * URL uploads have a maximum limit of 4 GB.
20
20
  */
21
21
  url?: string;
22
22
  /** The optional filename of the asset. If not provided, the platform will determine the filename from the file or URL. */
23
23
  filename?: string;
24
+ /**
25
+ * When set to `true`, the platform generates an HLS playlist and segments for streaming. Applicable to video and audio assets only.
26
+ *
27
+ * **Default**: `false`.
28
+ */
29
+ enableHls?: boolean;
30
+ /**
31
+ * When set to `true`, the platform generates thumbnail images from the uploaded content.
32
+ *
33
+ * **Default**: `false`.
34
+ */
35
+ enableThumbnail?: boolean;
24
36
  }
@@ -0,0 +1,17 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ /**
5
+ * @example
6
+ * {
7
+ * force: true
8
+ * }
9
+ */
10
+ export interface AssetsDeleteRequest {
11
+ /**
12
+ * When set to `true`, the platform deletes the asset even if indexed assets reference it. When set to `false` or omitted, the request fails with `409 Conflict` if references exist.
13
+ *
14
+ * **Default**: `false`.
15
+ */
16
+ force?: boolean;
17
+ }
@@ -6,7 +6,8 @@ import * as TwelvelabsApi from "../../../../index";
6
6
  * @example
7
7
  * {
8
8
  * page: 1,
9
- * pageLimit: 10
9
+ * pageLimit: 10,
10
+ * filename: "meeting"
10
11
  * }
11
12
  */
12
13
  export interface AssetsListRequest {
@@ -31,4 +32,8 @@ export interface AssetsListRequest {
31
32
  * Filters the response to include only assets of the specified types. Provide one or more asset types. When you specify multiple types, the platform returns all matching assets.
32
33
  */
33
34
  assetTypes?: TwelvelabsApi.AssetsListRequestAssetTypesItem | TwelvelabsApi.AssetsListRequestAssetTypesItem[];
35
+ /**
36
+ * Filters the response to include only assets whose filename contains the specified string. The match is case-insensitive and supports partial matching.
37
+ */
38
+ filename?: string;
34
39
  }
@@ -1,2 +1,3 @@
1
1
  export { type AssetsListRequest } from "./AssetsListRequest";
2
2
  export { type AssetsCreateRequest } from "./AssetsCreateRequest";
3
+ export { type AssetsDeleteRequest } from "./AssetsDeleteRequest";
@@ -4,6 +4,6 @@
4
4
  import * as TwelvelabsApi from "../../../index";
5
5
  export interface AssetsListResponse {
6
6
  /** An array containing the assets. */
7
- data?: TwelvelabsApi.Asset[];
7
+ data?: TwelvelabsApi.AssetDetail[];
8
8
  pageInfo?: TwelvelabsApi.PageInfo;
9
9
  }
@@ -141,7 +141,7 @@ class Embed {
141
141
  const _response = yield core.fetcher({
142
142
  url: (0, url_join_1.default)((_b = (_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.TwelvelabsApiEnvironment.Default, "embed"),
143
143
  method: "POST",
144
- headers: Object.assign(Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.2", "User-Agent": "twelvelabs-js/1.2.2", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), _maybeEncodedRequest.headers), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
144
+ headers: Object.assign(Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.3", "User-Agent": "twelvelabs-js/1.2.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), _maybeEncodedRequest.headers), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
145
145
  requestType: "file",
146
146
  duplex: _maybeEncodedRequest.duplex,
147
147
  body: _maybeEncodedRequest.body,
@@ -32,7 +32,7 @@ export declare class Tasks {
32
32
  * This method returns a list of the video embedding tasks in your account. The platform returns your video embedding tasks sorted by creation date, with the newest at the top of the list.
33
33
  *
34
34
  * <Note title="Notes">
35
- * - Video embeddings are stored for seven days
35
+ * - Video embeddings are stored for seven days.
36
36
  * - When you invoke this method without specifying the `started_at` and `ended_at` parameters, the platform returns all the video embedding tasks created within the last seven days.
37
37
  * </Note>
38
38
  *
@@ -66,7 +66,7 @@ class Tasks {
66
66
  * This method returns a list of the video embedding tasks in your account. The platform returns your video embedding tasks sorted by creation date, with the newest at the top of the list.
67
67
  *
68
68
  * <Note title="Notes">
69
- * - Video embeddings are stored for seven days
69
+ * - Video embeddings are stored for seven days.
70
70
  * - When you invoke this method without specifying the `started_at` and `ended_at` parameters, the platform returns all the video embedding tasks created within the last seven days.
71
71
  * </Note>
72
72
  *
@@ -108,7 +108,7 @@ class Tasks {
108
108
  const _response = yield core.fetcher({
109
109
  url: (0, url_join_1.default)((_b = (_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.TwelvelabsApiEnvironment.Default, "embed/tasks"),
110
110
  method: "GET",
111
- headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.2", "User-Agent": "twelvelabs-js/1.2.2", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
111
+ headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.3", "User-Agent": "twelvelabs-js/1.2.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
112
112
  contentType: "application/json",
113
113
  queryParameters: _queryParams,
114
114
  requestType: "json",
@@ -239,7 +239,7 @@ class Tasks {
239
239
  const _response = yield core.fetcher({
240
240
  url: (0, url_join_1.default)((_b = (_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.TwelvelabsApiEnvironment.Default, "embed/tasks"),
241
241
  method: "POST",
242
- headers: Object.assign(Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.2", "User-Agent": "twelvelabs-js/1.2.2", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), _maybeEncodedRequest.headers), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
242
+ headers: Object.assign(Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.3", "User-Agent": "twelvelabs-js/1.2.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), _maybeEncodedRequest.headers), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
243
243
  requestType: "file",
244
244
  duplex: _maybeEncodedRequest.duplex,
245
245
  body: _maybeEncodedRequest.body,
@@ -315,7 +315,7 @@ class Tasks {
315
315
  const _response = yield core.fetcher({
316
316
  url: (0, url_join_1.default)((_b = (_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.TwelvelabsApiEnvironment.Default, `embed/tasks/${encodeURIComponent(taskId)}/status`),
317
317
  method: "GET",
318
- headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.2", "User-Agent": "twelvelabs-js/1.2.2", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
318
+ headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.3", "User-Agent": "twelvelabs-js/1.2.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
319
319
  contentType: "application/json",
320
320
  requestType: "json",
321
321
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -398,7 +398,7 @@ class Tasks {
398
398
  const _response = yield core.fetcher({
399
399
  url: (0, url_join_1.default)((_b = (_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.TwelvelabsApiEnvironment.Default, `embed/tasks/${encodeURIComponent(taskId)}`),
400
400
  method: "GET",
401
- headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.2", "User-Agent": "twelvelabs-js/1.2.2", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
401
+ headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.3", "User-Agent": "twelvelabs-js/1.2.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
402
402
  contentType: "application/json",
403
403
  queryParameters: _queryParams,
404
404
  requestType: "json",
@@ -285,7 +285,7 @@ class V2 {
285
285
  const _response = yield core.fetcher({
286
286
  url: (0, url_join_1.default)((_b = (_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.TwelvelabsApiEnvironment.Default, "embed-v2"),
287
287
  method: "POST",
288
- headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.2", "User-Agent": "twelvelabs-js/1.2.2", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
288
+ headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.3", "User-Agent": "twelvelabs-js/1.2.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
289
289
  contentType: "application/json",
290
290
  requestType: "json",
291
291
  body: serializers.embed.CreateEmbeddingsRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -28,6 +28,11 @@ export declare class Tasks {
28
28
  /**
29
29
  * This method returns a list of the async embedding tasks in your account. The platform returns your async embedding tasks sorted by creation date, with the newest at the top of the list.
30
30
  *
31
+ * <Note title="Notes">
32
+ * - Embeddings are stored for seven days.
33
+ * - When you invoke this method without specifying the `started_at` and `ended_at` parameters, the platform returns all the async embedding tasks created within the last seven days.
34
+ * </Note>
35
+ *
31
36
  * @param {TwelvelabsApi.embed.v2.TasksListRequest} request
32
37
  * @param {Tasks.RequestOptions} requestOptions - Request-specific configuration.
33
38
  *
@@ -72,8 +77,9 @@ export declare class Tasks {
72
77
  * 2. Poll for the status of the task using the [`GET`](/v1.3/api-reference/create-embeddings-v2/retrieve-embeddings) method of the `/embed-v2/tasks/{task_id}` endpoint. Wait until the status is `ready`.
73
78
  * 3. Retrieve the embeddings from the response when the status is `ready` using the [`GET`](/v1.3/api-reference/create-embeddings-v2/retrieve-embeddings) method of the `/embed-v2/tasks/{task_id}` endpoint.
74
79
  *
75
- * <Note title="Note">
76
- * This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
80
+ * <Note title="Notes">
81
+ * - This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
82
+ * - Embeddings are stored for seven days.
77
83
  * </Note>
78
84
  *
79
85
  * @param {TwelvelabsApi.embed.v2.CreateAsyncEmbeddingRequest} request
@@ -150,6 +156,10 @@ export declare class Tasks {
150
156
  *
151
157
  * Invoke this method repeatedly until the `status` field is `ready`. When `status` is `ready`, use the embeddings from the response.
152
158
  *
159
+ * <Note title="Note">
160
+ * Embeddings are stored for seven days.
161
+ * </Note>
162
+ *
153
163
  * @param {string} taskId - The unique identifier of the embedding task.
154
164
  * @param {Tasks.RequestOptions} requestOptions - Request-specific configuration.
155
165
  *
@@ -62,6 +62,11 @@ class Tasks {
62
62
  /**
63
63
  * This method returns a list of the async embedding tasks in your account. The platform returns your async embedding tasks sorted by creation date, with the newest at the top of the list.
64
64
  *
65
+ * <Note title="Notes">
66
+ * - Embeddings are stored for seven days.
67
+ * - When you invoke this method without specifying the `started_at` and `ended_at` parameters, the platform returns all the async embedding tasks created within the last seven days.
68
+ * </Note>
69
+ *
65
70
  * @param {TwelvelabsApi.embed.v2.TasksListRequest} request
66
71
  * @param {Tasks.RequestOptions} requestOptions - Request-specific configuration.
67
72
  *
@@ -100,7 +105,7 @@ class Tasks {
100
105
  const _response = yield core.fetcher({
101
106
  url: (0, url_join_1.default)((_b = (_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.TwelvelabsApiEnvironment.Default, "embed-v2/tasks"),
102
107
  method: "GET",
103
- headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.2", "User-Agent": "twelvelabs-js/1.2.2", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
108
+ headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.3", "User-Agent": "twelvelabs-js/1.2.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
104
109
  contentType: "application/json",
105
110
  queryParameters: _queryParams,
106
111
  requestType: "json",
@@ -190,8 +195,9 @@ class Tasks {
190
195
  * 2. Poll for the status of the task using the [`GET`](/v1.3/api-reference/create-embeddings-v2/retrieve-embeddings) method of the `/embed-v2/tasks/{task_id}` endpoint. Wait until the status is `ready`.
191
196
  * 3. Retrieve the embeddings from the response when the status is `ready` using the [`GET`](/v1.3/api-reference/create-embeddings-v2/retrieve-embeddings) method of the `/embed-v2/tasks/{task_id}` endpoint.
192
197
  *
193
- * <Note title="Note">
194
- * This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
198
+ * <Note title="Notes">
199
+ * - This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
200
+ * - Embeddings are stored for seven days.
195
201
  * </Note>
196
202
  *
197
203
  * @param {TwelvelabsApi.embed.v2.CreateAsyncEmbeddingRequest} request
@@ -265,7 +271,7 @@ class Tasks {
265
271
  const _response = yield core.fetcher({
266
272
  url: (0, url_join_1.default)((_b = (_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.TwelvelabsApiEnvironment.Default, "embed-v2/tasks"),
267
273
  method: "POST",
268
- headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.2", "User-Agent": "twelvelabs-js/1.2.2", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
274
+ headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.3", "User-Agent": "twelvelabs-js/1.2.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
269
275
  contentType: "application/json",
270
276
  requestType: "json",
271
277
  body: serializers.embed.v2.CreateAsyncEmbeddingRequest.jsonOrThrow(request, {
@@ -327,6 +333,10 @@ class Tasks {
327
333
  *
328
334
  * Invoke this method repeatedly until the `status` field is `ready`. When `status` is `ready`, use the embeddings from the response.
329
335
  *
336
+ * <Note title="Note">
337
+ * Embeddings are stored for seven days.
338
+ * </Note>
339
+ *
330
340
  * @param {string} taskId - The unique identifier of the embedding task.
331
341
  * @param {Tasks.RequestOptions} requestOptions - Request-specific configuration.
332
342
  *
@@ -344,7 +354,7 @@ class Tasks {
344
354
  const _response = yield core.fetcher({
345
355
  url: (0, url_join_1.default)((_b = (_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.TwelvelabsApiEnvironment.Default, `embed-v2/tasks/${encodeURIComponent(taskId)}`),
346
356
  method: "GET",
347
- headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.2", "User-Agent": "twelvelabs-js/1.2.2", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
357
+ headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.3", "User-Agent": "twelvelabs-js/1.2.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
348
358
  contentType: "application/json",
349
359
  requestType: "json",
350
360
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -107,7 +107,7 @@ class EntityCollections {
107
107
  const _response = yield core.fetcher({
108
108
  url: (0, url_join_1.default)((_b = (_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.TwelvelabsApiEnvironment.Default, "entity-collections"),
109
109
  method: "GET",
110
- headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.2", "User-Agent": "twelvelabs-js/1.2.2", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
110
+ headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.3", "User-Agent": "twelvelabs-js/1.2.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
111
111
  contentType: "application/json",
112
112
  queryParameters: _queryParams,
113
113
  requestType: "json",
@@ -190,7 +190,7 @@ class EntityCollections {
190
190
  const _response = yield core.fetcher({
191
191
  url: (0, url_join_1.default)((_b = (_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.TwelvelabsApiEnvironment.Default, "entity-collections"),
192
192
  method: "POST",
193
- headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.2", "User-Agent": "twelvelabs-js/1.2.2", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
193
+ headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.3", "User-Agent": "twelvelabs-js/1.2.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
194
194
  contentType: "application/json",
195
195
  requestType: "json",
196
196
  body: serializers.EntityCollectionsCreateRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -258,7 +258,7 @@ class EntityCollections {
258
258
  const _response = yield core.fetcher({
259
259
  url: (0, url_join_1.default)((_b = (_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.TwelvelabsApiEnvironment.Default, `entity-collections/${encodeURIComponent(entityCollectionId)}`),
260
260
  method: "GET",
261
- headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.2", "User-Agent": "twelvelabs-js/1.2.2", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
261
+ headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.3", "User-Agent": "twelvelabs-js/1.2.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
262
262
  contentType: "application/json",
263
263
  requestType: "json",
264
264
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -325,7 +325,7 @@ class EntityCollections {
325
325
  const _response = yield core.fetcher({
326
326
  url: (0, url_join_1.default)((_b = (_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.TwelvelabsApiEnvironment.Default, `entity-collections/${encodeURIComponent(entityCollectionId)}`),
327
327
  method: "DELETE",
328
- headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.2", "User-Agent": "twelvelabs-js/1.2.2", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
328
+ headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.3", "User-Agent": "twelvelabs-js/1.2.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
329
329
  contentType: "application/json",
330
330
  requestType: "json",
331
331
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -385,7 +385,7 @@ class EntityCollections {
385
385
  const _response = yield core.fetcher({
386
386
  url: (0, url_join_1.default)((_b = (_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.TwelvelabsApiEnvironment.Default, `entity-collections/${encodeURIComponent(entityCollectionId)}`),
387
387
  method: "PATCH",
388
- headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.2", "User-Agent": "twelvelabs-js/1.2.2", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
388
+ headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.3", "User-Agent": "twelvelabs-js/1.2.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
389
389
  contentType: "application/json",
390
390
  requestType: "json",
391
391
  body: serializers.EntityCollectionsUpdateRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -25,6 +25,22 @@ export declare namespace Entities {
25
25
  export declare class Entities {
26
26
  protected readonly _options: Entities.Options;
27
27
  constructor(_options: Entities.Options);
28
+ /**
29
+ * This method returns a list of entities whose [`asset_ids`](/v1.3/api-reference/entities/entity-collections/entities/retrieve#response.body.asset_ids) array contains the specified asset.
30
+ *
31
+ * @param {string} assetId - The unique identifier of the asset.
32
+ * @param {TwelvelabsApi.entityCollections.EntitiesListByAssetRequest} request
33
+ * @param {Entities.RequestOptions} requestOptions - Request-specific configuration.
34
+ *
35
+ * @throws {@link TwelvelabsApi.BadRequestError}
36
+ *
37
+ * @example
38
+ * await client.entityCollections.entities.listByAsset("6298d673f1090f1100476d4c", {
39
+ * page: 1,
40
+ * pageLimit: 10
41
+ * })
42
+ */
43
+ listByAsset(assetId: string, request?: TwelvelabsApi.entityCollections.EntitiesListByAssetRequest, requestOptions?: Entities.RequestOptions): Promise<core.Page<TwelvelabsApi.Entity>>;
28
44
  /**
29
45
  * This method returns a list of the entities in the specified entity collection.
30
46
  *