newscatcher-catchall-sdk 1.5.1 → 3.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 (371) hide show
  1. package/README.md +12 -2
  2. package/dist/cjs/BaseClient.d.ts +3 -0
  3. package/dist/cjs/BaseClient.js +17 -2
  4. package/dist/cjs/Client.d.ts +6 -0
  5. package/dist/cjs/Client.js +10 -0
  6. package/dist/cjs/api/resources/datasets/client/Client.d.ts +32 -32
  7. package/dist/cjs/api/resources/datasets/client/Client.js +59 -66
  8. package/dist/cjs/api/resources/datasets/client/requests/ListDatasetEntitiesRequest.d.ts +28 -0
  9. package/dist/cjs/api/resources/datasets/client/requests/ListDatasetsRequest.d.ts +4 -2
  10. package/dist/cjs/api/resources/datasets/client/requests/index.d.ts +1 -1
  11. package/dist/cjs/api/resources/entities/client/Client.d.ts +3 -7
  12. package/dist/cjs/api/resources/entities/client/Client.js +3 -7
  13. package/dist/cjs/api/resources/index.d.ts +5 -0
  14. package/dist/cjs/api/resources/index.js +6 -1
  15. package/dist/cjs/api/resources/jobs/client/Client.d.ts +23 -5
  16. package/dist/cjs/api/resources/jobs/client/Client.js +65 -6
  17. package/dist/cjs/api/resources/jobs/client/requests/GetUserJobsRequest.d.ts +5 -2
  18. package/dist/cjs/api/resources/jobs/client/requests/SubmitRequestDto.d.ts +11 -1
  19. package/dist/cjs/api/resources/jobs/client/requests/ValidateQueryRequestDto.d.ts +10 -0
  20. package/dist/cjs/api/resources/jobs/client/requests/ValidateQueryRequestDto.js +3 -0
  21. package/dist/cjs/api/resources/jobs/client/requests/index.d.ts +1 -0
  22. package/dist/cjs/api/resources/monitors/client/Client.d.ts +7 -16
  23. package/dist/cjs/api/resources/monitors/client/Client.js +9 -17
  24. package/dist/cjs/api/resources/monitors/client/requests/CreateMonitorRequestDto.d.ts +17 -14
  25. package/dist/cjs/api/resources/monitors/client/requests/ListMonitorsRequest.d.ts +5 -2
  26. package/dist/cjs/api/resources/monitors/client/requests/UpdateMonitorRequestDto.d.ts +7 -10
  27. package/dist/cjs/api/resources/monitors/types/DisableMonitorResponse.d.ts +1 -1
  28. package/dist/cjs/api/resources/monitors/types/EnableMonitorResponse.d.ts +1 -1
  29. package/dist/cjs/api/resources/projects/client/Client.d.ts +178 -0
  30. package/dist/cjs/api/resources/projects/client/Client.js +626 -0
  31. package/dist/cjs/api/resources/projects/client/index.d.ts +1 -0
  32. package/dist/cjs/api/resources/projects/client/index.js +17 -0
  33. package/dist/cjs/api/resources/projects/client/requests/AddResourceRequestDto.d.ts +17 -0
  34. package/dist/cjs/api/resources/projects/client/requests/AddResourceRequestDto.js +3 -0
  35. package/dist/cjs/api/resources/projects/client/requests/CreateProjectRequestDto.d.ts +13 -0
  36. package/dist/cjs/api/resources/projects/client/requests/CreateProjectRequestDto.js +3 -0
  37. package/dist/cjs/api/resources/projects/client/requests/DeleteProjectRequest.d.ts +12 -0
  38. package/dist/cjs/api/resources/projects/client/requests/DeleteProjectRequest.js +3 -0
  39. package/dist/cjs/api/resources/projects/client/requests/GetProjectOverviewRequest.d.ts +10 -0
  40. package/dist/cjs/api/resources/projects/client/requests/GetProjectOverviewRequest.js +3 -0
  41. package/dist/cjs/api/resources/projects/client/requests/GetProjectRequest.d.ts +10 -0
  42. package/dist/cjs/api/resources/projects/client/requests/GetProjectRequest.js +3 -0
  43. package/dist/cjs/api/resources/projects/client/requests/ListProjectResourcesRequest.d.ts +16 -0
  44. package/dist/cjs/api/resources/projects/client/requests/ListProjectResourcesRequest.js +3 -0
  45. package/dist/cjs/api/resources/projects/client/requests/ListProjectsRequest.d.ts +16 -0
  46. package/dist/cjs/api/resources/projects/client/requests/ListProjectsRequest.js +3 -0
  47. package/dist/cjs/api/resources/projects/client/requests/RemoveResourceFromProjectRequest.d.ts +16 -0
  48. package/dist/cjs/api/resources/projects/client/requests/RemoveResourceFromProjectRequest.js +3 -0
  49. package/dist/cjs/api/resources/projects/client/requests/UpdateProjectRequestDto.d.ts +15 -0
  50. package/dist/cjs/api/resources/projects/client/requests/UpdateProjectRequestDto.js +3 -0
  51. package/dist/cjs/api/resources/projects/client/requests/index.d.ts +9 -0
  52. package/dist/cjs/api/resources/projects/client/requests/index.js +2 -0
  53. package/dist/cjs/api/resources/projects/exports.d.ts +2 -0
  54. package/dist/cjs/api/resources/projects/exports.js +21 -0
  55. package/dist/cjs/api/resources/projects/index.d.ts +1 -0
  56. package/dist/cjs/api/resources/projects/index.js +17 -0
  57. package/dist/cjs/api/resources/webhooks/client/Client.d.ts +231 -0
  58. package/dist/cjs/api/resources/webhooks/client/Client.js +779 -0
  59. package/dist/cjs/api/resources/webhooks/client/index.d.ts +1 -0
  60. package/dist/cjs/api/resources/webhooks/client/index.js +17 -0
  61. package/dist/cjs/api/resources/webhooks/client/requests/AssignWebhookResourceRequestDto.d.ts +17 -0
  62. package/dist/cjs/api/resources/webhooks/client/requests/AssignWebhookResourceRequestDto.js +3 -0
  63. package/dist/cjs/api/resources/webhooks/client/requests/CreateWebhookRequestDto.d.ts +42 -0
  64. package/dist/cjs/api/resources/webhooks/client/requests/CreateWebhookRequestDto.js +3 -0
  65. package/dist/cjs/api/resources/webhooks/client/requests/DeleteWebhookRequest.d.ts +10 -0
  66. package/dist/cjs/api/resources/webhooks/client/requests/DeleteWebhookRequest.js +3 -0
  67. package/dist/cjs/api/resources/webhooks/client/requests/GetWebhookDeliveryHistoryRequest.d.ts +18 -0
  68. package/dist/cjs/api/resources/webhooks/client/requests/GetWebhookDeliveryHistoryRequest.js +3 -0
  69. package/dist/cjs/api/resources/webhooks/client/requests/GetWebhookRequest.d.ts +10 -0
  70. package/dist/cjs/api/resources/webhooks/client/requests/GetWebhookRequest.js +3 -0
  71. package/dist/cjs/api/resources/webhooks/client/requests/ListWebhookResourcesRequest.d.ts +16 -0
  72. package/dist/cjs/api/resources/webhooks/client/requests/ListWebhookResourcesRequest.js +3 -0
  73. package/dist/cjs/api/resources/webhooks/client/requests/ListWebhooksForResourceRequest.d.ts +19 -0
  74. package/dist/cjs/api/resources/webhooks/client/requests/ListWebhooksForResourceRequest.js +3 -0
  75. package/dist/cjs/api/resources/webhooks/client/requests/ListWebhooksRequest.d.ts +12 -0
  76. package/dist/cjs/api/resources/webhooks/client/requests/ListWebhooksRequest.js +3 -0
  77. package/dist/cjs/api/resources/webhooks/client/requests/RemoveWebhookResourceRequest.d.ts +16 -0
  78. package/dist/cjs/api/resources/webhooks/client/requests/RemoveWebhookResourceRequest.js +3 -0
  79. package/dist/cjs/api/resources/webhooks/client/requests/TestWebhookRequestDto.d.ts +19 -0
  80. package/dist/cjs/api/resources/webhooks/client/requests/TestWebhookRequestDto.js +3 -0
  81. package/dist/cjs/api/resources/webhooks/client/requests/UpdateWebhookRequestDto.d.ts +30 -0
  82. package/dist/cjs/api/resources/webhooks/client/requests/UpdateWebhookRequestDto.js +3 -0
  83. package/dist/cjs/api/resources/webhooks/client/requests/index.d.ts +11 -0
  84. package/dist/cjs/api/resources/webhooks/client/requests/index.js +2 -0
  85. package/dist/cjs/api/resources/webhooks/exports.d.ts +2 -0
  86. package/dist/cjs/api/resources/webhooks/exports.js +21 -0
  87. package/dist/cjs/api/resources/webhooks/index.d.ts +2 -0
  88. package/dist/cjs/api/resources/webhooks/index.js +18 -0
  89. package/dist/cjs/api/resources/webhooks/types/CreateWebhookRequestDtoAuth.d.ts +19 -0
  90. package/dist/cjs/api/resources/webhooks/types/CreateWebhookRequestDtoAuth.js +3 -0
  91. package/dist/cjs/api/resources/webhooks/types/UpdateWebhookRequestDtoAuth.d.ts +16 -0
  92. package/dist/cjs/api/resources/webhooks/types/UpdateWebhookRequestDtoAuth.js +3 -0
  93. package/dist/cjs/api/resources/webhooks/types/index.d.ts +2 -0
  94. package/dist/cjs/api/resources/webhooks/types/index.js +18 -0
  95. package/dist/cjs/api/types/AddResourceResponseDto.d.ts +9 -0
  96. package/dist/cjs/api/types/AddResourceResponseDto.js +3 -0
  97. package/dist/cjs/api/types/ApiKeyAuthDto.d.ts +6 -0
  98. package/dist/cjs/api/types/ApiKeyAuthDto.js +3 -0
  99. package/dist/cjs/api/types/AssignWebhookResourceResponseDto.d.ts +11 -0
  100. package/dist/cjs/api/types/AssignWebhookResourceResponseDto.js +3 -0
  101. package/dist/cjs/api/types/BasicAuthDto.d.ts +6 -0
  102. package/dist/cjs/api/types/BasicAuthDto.js +3 -0
  103. package/dist/cjs/api/types/BearerAuthDto.d.ts +4 -0
  104. package/dist/cjs/api/types/BearerAuthDto.js +3 -0
  105. package/dist/cjs/api/types/ConnectedEntity.d.ts +12 -9
  106. package/dist/cjs/api/types/CreateProjectResponseDto.d.ts +10 -0
  107. package/dist/cjs/api/types/CreateProjectResponseDto.js +3 -0
  108. package/dist/cjs/api/types/CreateWebhookResponseDto.d.ts +9 -0
  109. package/dist/cjs/api/types/CreateWebhookResponseDto.js +3 -0
  110. package/dist/cjs/api/types/DeleteJobResponseDto.d.ts +1 -1
  111. package/dist/cjs/api/types/DeleteMonitorResponseDto.d.ts +1 -1
  112. package/dist/cjs/api/types/DeliveryHistoryItemDto.d.ts +25 -0
  113. package/dist/cjs/api/types/DeliveryHistoryItemDto.js +3 -0
  114. package/dist/cjs/api/types/DeliveryHistoryResponseDto.d.ts +17 -0
  115. package/dist/cjs/api/types/DeliveryHistoryResponseDto.js +3 -0
  116. package/dist/cjs/api/types/DeliveryMode.d.ts +11 -0
  117. package/dist/cjs/api/types/DeliveryMode.js +14 -0
  118. package/dist/cjs/api/types/DeliveryStatus.d.ts +6 -0
  119. package/dist/cjs/api/types/DeliveryStatus.js +9 -0
  120. package/dist/cjs/api/types/GetWebhookResponseDto.d.ts +9 -0
  121. package/dist/cjs/api/types/GetWebhookResponseDto.js +3 -0
  122. package/dist/cjs/api/types/HttpMethod.d.ts +9 -0
  123. package/dist/cjs/api/types/HttpMethod.js +12 -0
  124. package/dist/cjs/api/types/IssueType.d.ts +25 -0
  125. package/dist/cjs/api/types/IssueType.js +28 -0
  126. package/dist/cjs/api/types/JobStep.d.ts +1 -1
  127. package/dist/cjs/api/types/ListWebhookResourcesResponseDto.d.ts +13 -0
  128. package/dist/cjs/api/types/ListWebhookResourcesResponseDto.js +3 -0
  129. package/dist/cjs/api/types/ListWebhooksResponseDto.d.ts +13 -0
  130. package/dist/cjs/api/types/ListWebhooksResponseDto.js +3 -0
  131. package/dist/cjs/api/types/MappableResourceType.d.ts +7 -0
  132. package/dist/cjs/api/types/MappableResourceType.js +10 -0
  133. package/dist/cjs/api/types/MonitorListItemDto.d.ts +1 -1
  134. package/dist/cjs/api/types/MonitorStatusHistoryResponseDto.d.ts +1 -1
  135. package/dist/cjs/api/types/ProjectListResponseDto.d.ts +13 -0
  136. package/dist/cjs/api/types/ProjectListResponseDto.js +3 -0
  137. package/dist/cjs/api/types/ProjectOverviewCountsDto.d.ts +4 -0
  138. package/dist/cjs/api/types/ProjectOverviewCountsDto.js +3 -0
  139. package/dist/cjs/api/types/ProjectOverviewResponseDto.d.ts +18 -0
  140. package/dist/cjs/api/types/ProjectOverviewResponseDto.js +3 -0
  141. package/dist/cjs/api/types/ProjectResourceDto.d.ts +18 -0
  142. package/dist/cjs/api/types/ProjectResourceDto.js +3 -0
  143. package/dist/cjs/api/types/ProjectResourceListResponseDto.d.ts +13 -0
  144. package/dist/cjs/api/types/ProjectResourceListResponseDto.js +3 -0
  145. package/dist/cjs/api/types/ProjectResourceType.d.ts +8 -0
  146. package/dist/cjs/api/types/ProjectResourceType.js +11 -0
  147. package/dist/cjs/api/types/ProjectResponseDto.d.ts +18 -0
  148. package/dist/cjs/api/types/ProjectResponseDto.js +3 -0
  149. package/dist/cjs/api/types/ProjectSummaryDto.d.ts +17 -0
  150. package/dist/cjs/api/types/ProjectSummaryDto.js +3 -0
  151. package/dist/cjs/api/types/QueryStatus.d.ts +13 -0
  152. package/dist/cjs/api/types/QueryStatus.js +16 -0
  153. package/dist/cjs/api/types/RemoveResourceResponseDto.d.ts +6 -0
  154. package/dist/cjs/api/types/RemoveResourceResponseDto.js +3 -0
  155. package/dist/cjs/api/types/ResourceItemDto.d.ts +6 -0
  156. package/dist/cjs/api/types/ResourceItemDto.js +3 -0
  157. package/dist/cjs/api/types/ResourceResultDto.d.ts +12 -0
  158. package/dist/cjs/api/types/ResourceResultDto.js +3 -0
  159. package/dist/cjs/api/types/Suggestion.d.ts +12 -0
  160. package/dist/cjs/api/types/Suggestion.js +3 -0
  161. package/dist/cjs/api/types/TestWebhookResponseDto.d.ts +10 -0
  162. package/dist/cjs/api/types/TestWebhookResponseDto.js +3 -0
  163. package/dist/cjs/api/types/UpdateProjectResponseDto.d.ts +8 -0
  164. package/dist/cjs/api/types/UpdateProjectResponseDto.js +3 -0
  165. package/dist/cjs/api/types/UpdateWebhookResponseDto.d.ts +9 -0
  166. package/dist/cjs/api/types/UpdateWebhookResponseDto.js +3 -0
  167. package/dist/cjs/api/types/ValidateQueryResponseDto.d.ts +18 -0
  168. package/dist/cjs/api/types/ValidateQueryResponseDto.js +3 -0
  169. package/dist/cjs/api/types/WebhookResourceMappingResponseDto.d.ts +12 -0
  170. package/dist/cjs/api/types/WebhookResourceMappingResponseDto.js +3 -0
  171. package/dist/cjs/api/types/WebhookResponseDto.d.ts +28 -0
  172. package/dist/cjs/api/types/WebhookResponseDto.js +3 -0
  173. package/dist/cjs/api/types/WebhookType.d.ts +17 -0
  174. package/dist/cjs/api/types/WebhookType.js +20 -0
  175. package/dist/cjs/api/types/index.d.ts +37 -0
  176. package/dist/cjs/api/types/index.js +37 -0
  177. package/dist/cjs/core/auth/AuthProvider.d.ts +1 -0
  178. package/dist/cjs/core/auth/AuthProvider.js +7 -0
  179. package/dist/cjs/core/auth/index.d.ts +1 -1
  180. package/dist/cjs/core/auth/index.js +3 -1
  181. package/dist/cjs/core/fetcher/requestWithRetries.js +4 -1
  182. package/dist/cjs/version.d.ts +1 -1
  183. package/dist/cjs/version.js +1 -1
  184. package/dist/esm/BaseClient.d.mts +3 -0
  185. package/dist/esm/BaseClient.mjs +17 -2
  186. package/dist/esm/Client.d.mts +6 -0
  187. package/dist/esm/Client.mjs +10 -0
  188. package/dist/esm/api/resources/datasets/client/Client.d.mts +32 -32
  189. package/dist/esm/api/resources/datasets/client/Client.mjs +59 -66
  190. package/dist/esm/api/resources/datasets/client/requests/ListDatasetEntitiesRequest.d.mts +28 -0
  191. package/dist/esm/api/resources/datasets/client/requests/ListDatasetsRequest.d.mts +4 -2
  192. package/dist/esm/api/resources/datasets/client/requests/index.d.mts +1 -1
  193. package/dist/esm/api/resources/entities/client/Client.d.mts +3 -7
  194. package/dist/esm/api/resources/entities/client/Client.mjs +3 -7
  195. package/dist/esm/api/resources/index.d.mts +5 -0
  196. package/dist/esm/api/resources/index.mjs +5 -0
  197. package/dist/esm/api/resources/jobs/client/Client.d.mts +23 -5
  198. package/dist/esm/api/resources/jobs/client/Client.mjs +65 -6
  199. package/dist/esm/api/resources/jobs/client/requests/GetUserJobsRequest.d.mts +5 -2
  200. package/dist/esm/api/resources/jobs/client/requests/SubmitRequestDto.d.mts +11 -1
  201. package/dist/esm/api/resources/jobs/client/requests/ValidateQueryRequestDto.d.mts +10 -0
  202. package/dist/esm/api/resources/jobs/client/requests/ValidateQueryRequestDto.mjs +2 -0
  203. package/dist/esm/api/resources/jobs/client/requests/index.d.mts +1 -0
  204. package/dist/esm/api/resources/monitors/client/Client.d.mts +7 -16
  205. package/dist/esm/api/resources/monitors/client/Client.mjs +9 -17
  206. package/dist/esm/api/resources/monitors/client/requests/CreateMonitorRequestDto.d.mts +17 -14
  207. package/dist/esm/api/resources/monitors/client/requests/ListMonitorsRequest.d.mts +5 -2
  208. package/dist/esm/api/resources/monitors/client/requests/UpdateMonitorRequestDto.d.mts +7 -10
  209. package/dist/esm/api/resources/monitors/types/DisableMonitorResponse.d.mts +1 -1
  210. package/dist/esm/api/resources/monitors/types/EnableMonitorResponse.d.mts +1 -1
  211. package/dist/esm/api/resources/projects/client/Client.d.mts +178 -0
  212. package/dist/esm/api/resources/projects/client/Client.mjs +589 -0
  213. package/dist/esm/api/resources/projects/client/index.d.mts +1 -0
  214. package/dist/esm/api/resources/projects/client/index.mjs +1 -0
  215. package/dist/esm/api/resources/projects/client/requests/AddResourceRequestDto.d.mts +17 -0
  216. package/dist/esm/api/resources/projects/client/requests/AddResourceRequestDto.mjs +2 -0
  217. package/dist/esm/api/resources/projects/client/requests/CreateProjectRequestDto.d.mts +13 -0
  218. package/dist/esm/api/resources/projects/client/requests/CreateProjectRequestDto.mjs +2 -0
  219. package/dist/esm/api/resources/projects/client/requests/DeleteProjectRequest.d.mts +12 -0
  220. package/dist/esm/api/resources/projects/client/requests/DeleteProjectRequest.mjs +2 -0
  221. package/dist/esm/api/resources/projects/client/requests/GetProjectOverviewRequest.d.mts +10 -0
  222. package/dist/esm/api/resources/projects/client/requests/GetProjectOverviewRequest.mjs +2 -0
  223. package/dist/esm/api/resources/projects/client/requests/GetProjectRequest.d.mts +10 -0
  224. package/dist/esm/api/resources/projects/client/requests/GetProjectRequest.mjs +2 -0
  225. package/dist/esm/api/resources/projects/client/requests/ListProjectResourcesRequest.d.mts +16 -0
  226. package/dist/esm/api/resources/projects/client/requests/ListProjectResourcesRequest.mjs +2 -0
  227. package/dist/esm/api/resources/projects/client/requests/ListProjectsRequest.d.mts +16 -0
  228. package/dist/esm/api/resources/projects/client/requests/ListProjectsRequest.mjs +2 -0
  229. package/dist/esm/api/resources/projects/client/requests/RemoveResourceFromProjectRequest.d.mts +16 -0
  230. package/dist/esm/api/resources/projects/client/requests/RemoveResourceFromProjectRequest.mjs +2 -0
  231. package/dist/esm/api/resources/projects/client/requests/UpdateProjectRequestDto.d.mts +15 -0
  232. package/dist/esm/api/resources/projects/client/requests/UpdateProjectRequestDto.mjs +2 -0
  233. package/dist/esm/api/resources/projects/client/requests/index.d.mts +9 -0
  234. package/dist/esm/api/resources/projects/client/requests/index.mjs +1 -0
  235. package/dist/esm/api/resources/projects/exports.d.mts +2 -0
  236. package/dist/esm/api/resources/projects/exports.mjs +3 -0
  237. package/dist/esm/api/resources/projects/index.d.mts +1 -0
  238. package/dist/esm/api/resources/projects/index.mjs +1 -0
  239. package/dist/esm/api/resources/webhooks/client/Client.d.mts +231 -0
  240. package/dist/esm/api/resources/webhooks/client/Client.mjs +742 -0
  241. package/dist/esm/api/resources/webhooks/client/index.d.mts +1 -0
  242. package/dist/esm/api/resources/webhooks/client/index.mjs +1 -0
  243. package/dist/esm/api/resources/webhooks/client/requests/AssignWebhookResourceRequestDto.d.mts +17 -0
  244. package/dist/esm/api/resources/webhooks/client/requests/AssignWebhookResourceRequestDto.mjs +2 -0
  245. package/dist/esm/api/resources/webhooks/client/requests/CreateWebhookRequestDto.d.mts +42 -0
  246. package/dist/esm/api/resources/webhooks/client/requests/CreateWebhookRequestDto.mjs +2 -0
  247. package/dist/esm/api/resources/webhooks/client/requests/DeleteWebhookRequest.d.mts +10 -0
  248. package/dist/esm/api/resources/webhooks/client/requests/DeleteWebhookRequest.mjs +2 -0
  249. package/dist/esm/api/resources/webhooks/client/requests/GetWebhookDeliveryHistoryRequest.d.mts +18 -0
  250. package/dist/esm/api/resources/webhooks/client/requests/GetWebhookDeliveryHistoryRequest.mjs +2 -0
  251. package/dist/esm/api/resources/webhooks/client/requests/GetWebhookRequest.d.mts +10 -0
  252. package/dist/esm/api/resources/webhooks/client/requests/GetWebhookRequest.mjs +2 -0
  253. package/dist/esm/api/resources/webhooks/client/requests/ListWebhookResourcesRequest.d.mts +16 -0
  254. package/dist/esm/api/resources/webhooks/client/requests/ListWebhookResourcesRequest.mjs +2 -0
  255. package/dist/esm/api/resources/webhooks/client/requests/ListWebhooksForResourceRequest.d.mts +19 -0
  256. package/dist/esm/api/resources/webhooks/client/requests/ListWebhooksForResourceRequest.mjs +2 -0
  257. package/dist/esm/api/resources/webhooks/client/requests/ListWebhooksRequest.d.mts +12 -0
  258. package/dist/esm/api/resources/webhooks/client/requests/ListWebhooksRequest.mjs +2 -0
  259. package/dist/esm/api/resources/webhooks/client/requests/RemoveWebhookResourceRequest.d.mts +16 -0
  260. package/dist/esm/api/resources/webhooks/client/requests/RemoveWebhookResourceRequest.mjs +2 -0
  261. package/dist/esm/api/resources/webhooks/client/requests/TestWebhookRequestDto.d.mts +19 -0
  262. package/dist/esm/api/resources/webhooks/client/requests/TestWebhookRequestDto.mjs +2 -0
  263. package/dist/esm/api/resources/webhooks/client/requests/UpdateWebhookRequestDto.d.mts +30 -0
  264. package/dist/esm/api/resources/webhooks/client/requests/UpdateWebhookRequestDto.mjs +2 -0
  265. package/dist/esm/api/resources/webhooks/client/requests/index.d.mts +11 -0
  266. package/dist/esm/api/resources/webhooks/client/requests/index.mjs +1 -0
  267. package/dist/esm/api/resources/webhooks/exports.d.mts +2 -0
  268. package/dist/esm/api/resources/webhooks/exports.mjs +3 -0
  269. package/dist/esm/api/resources/webhooks/index.d.mts +2 -0
  270. package/dist/esm/api/resources/webhooks/index.mjs +2 -0
  271. package/dist/esm/api/resources/webhooks/types/CreateWebhookRequestDtoAuth.d.mts +19 -0
  272. package/dist/esm/api/resources/webhooks/types/CreateWebhookRequestDtoAuth.mjs +2 -0
  273. package/dist/esm/api/resources/webhooks/types/UpdateWebhookRequestDtoAuth.d.mts +16 -0
  274. package/dist/esm/api/resources/webhooks/types/UpdateWebhookRequestDtoAuth.mjs +2 -0
  275. package/dist/esm/api/resources/webhooks/types/index.d.mts +2 -0
  276. package/dist/esm/api/resources/webhooks/types/index.mjs +2 -0
  277. package/dist/esm/api/types/AddResourceResponseDto.d.mts +9 -0
  278. package/dist/esm/api/types/AddResourceResponseDto.mjs +2 -0
  279. package/dist/esm/api/types/ApiKeyAuthDto.d.mts +6 -0
  280. package/dist/esm/api/types/ApiKeyAuthDto.mjs +2 -0
  281. package/dist/esm/api/types/AssignWebhookResourceResponseDto.d.mts +11 -0
  282. package/dist/esm/api/types/AssignWebhookResourceResponseDto.mjs +2 -0
  283. package/dist/esm/api/types/BasicAuthDto.d.mts +6 -0
  284. package/dist/esm/api/types/BasicAuthDto.mjs +2 -0
  285. package/dist/esm/api/types/BearerAuthDto.d.mts +4 -0
  286. package/dist/esm/api/types/BearerAuthDto.mjs +2 -0
  287. package/dist/esm/api/types/ConnectedEntity.d.mts +12 -9
  288. package/dist/esm/api/types/CreateProjectResponseDto.d.mts +10 -0
  289. package/dist/esm/api/types/CreateProjectResponseDto.mjs +2 -0
  290. package/dist/esm/api/types/CreateWebhookResponseDto.d.mts +9 -0
  291. package/dist/esm/api/types/CreateWebhookResponseDto.mjs +2 -0
  292. package/dist/esm/api/types/DeleteJobResponseDto.d.mts +1 -1
  293. package/dist/esm/api/types/DeleteMonitorResponseDto.d.mts +1 -1
  294. package/dist/esm/api/types/DeliveryHistoryItemDto.d.mts +25 -0
  295. package/dist/esm/api/types/DeliveryHistoryItemDto.mjs +2 -0
  296. package/dist/esm/api/types/DeliveryHistoryResponseDto.d.mts +17 -0
  297. package/dist/esm/api/types/DeliveryHistoryResponseDto.mjs +2 -0
  298. package/dist/esm/api/types/DeliveryMode.d.mts +11 -0
  299. package/dist/esm/api/types/DeliveryMode.mjs +11 -0
  300. package/dist/esm/api/types/DeliveryStatus.d.mts +6 -0
  301. package/dist/esm/api/types/DeliveryStatus.mjs +6 -0
  302. package/dist/esm/api/types/GetWebhookResponseDto.d.mts +9 -0
  303. package/dist/esm/api/types/GetWebhookResponseDto.mjs +2 -0
  304. package/dist/esm/api/types/HttpMethod.d.mts +9 -0
  305. package/dist/esm/api/types/HttpMethod.mjs +9 -0
  306. package/dist/esm/api/types/IssueType.d.mts +25 -0
  307. package/dist/esm/api/types/IssueType.mjs +25 -0
  308. package/dist/esm/api/types/JobStep.d.mts +1 -1
  309. package/dist/esm/api/types/ListWebhookResourcesResponseDto.d.mts +13 -0
  310. package/dist/esm/api/types/ListWebhookResourcesResponseDto.mjs +2 -0
  311. package/dist/esm/api/types/ListWebhooksResponseDto.d.mts +13 -0
  312. package/dist/esm/api/types/ListWebhooksResponseDto.mjs +2 -0
  313. package/dist/esm/api/types/MappableResourceType.d.mts +7 -0
  314. package/dist/esm/api/types/MappableResourceType.mjs +7 -0
  315. package/dist/esm/api/types/MonitorListItemDto.d.mts +1 -1
  316. package/dist/esm/api/types/MonitorStatusHistoryResponseDto.d.mts +1 -1
  317. package/dist/esm/api/types/ProjectListResponseDto.d.mts +13 -0
  318. package/dist/esm/api/types/ProjectListResponseDto.mjs +2 -0
  319. package/dist/esm/api/types/ProjectOverviewCountsDto.d.mts +4 -0
  320. package/dist/esm/api/types/ProjectOverviewCountsDto.mjs +2 -0
  321. package/dist/esm/api/types/ProjectOverviewResponseDto.d.mts +18 -0
  322. package/dist/esm/api/types/ProjectOverviewResponseDto.mjs +2 -0
  323. package/dist/esm/api/types/ProjectResourceDto.d.mts +18 -0
  324. package/dist/esm/api/types/ProjectResourceDto.mjs +2 -0
  325. package/dist/esm/api/types/ProjectResourceListResponseDto.d.mts +13 -0
  326. package/dist/esm/api/types/ProjectResourceListResponseDto.mjs +2 -0
  327. package/dist/esm/api/types/ProjectResourceType.d.mts +8 -0
  328. package/dist/esm/api/types/ProjectResourceType.mjs +8 -0
  329. package/dist/esm/api/types/ProjectResponseDto.d.mts +18 -0
  330. package/dist/esm/api/types/ProjectResponseDto.mjs +2 -0
  331. package/dist/esm/api/types/ProjectSummaryDto.d.mts +17 -0
  332. package/dist/esm/api/types/ProjectSummaryDto.mjs +2 -0
  333. package/dist/esm/api/types/QueryStatus.d.mts +13 -0
  334. package/dist/esm/api/types/QueryStatus.mjs +13 -0
  335. package/dist/esm/api/types/RemoveResourceResponseDto.d.mts +6 -0
  336. package/dist/esm/api/types/RemoveResourceResponseDto.mjs +2 -0
  337. package/dist/esm/api/types/ResourceItemDto.d.mts +6 -0
  338. package/dist/esm/api/types/ResourceItemDto.mjs +2 -0
  339. package/dist/esm/api/types/ResourceResultDto.d.mts +12 -0
  340. package/dist/esm/api/types/ResourceResultDto.mjs +2 -0
  341. package/dist/esm/api/types/Suggestion.d.mts +12 -0
  342. package/dist/esm/api/types/Suggestion.mjs +2 -0
  343. package/dist/esm/api/types/TestWebhookResponseDto.d.mts +10 -0
  344. package/dist/esm/api/types/TestWebhookResponseDto.mjs +2 -0
  345. package/dist/esm/api/types/UpdateProjectResponseDto.d.mts +8 -0
  346. package/dist/esm/api/types/UpdateProjectResponseDto.mjs +2 -0
  347. package/dist/esm/api/types/UpdateWebhookResponseDto.d.mts +9 -0
  348. package/dist/esm/api/types/UpdateWebhookResponseDto.mjs +2 -0
  349. package/dist/esm/api/types/ValidateQueryResponseDto.d.mts +18 -0
  350. package/dist/esm/api/types/ValidateQueryResponseDto.mjs +2 -0
  351. package/dist/esm/api/types/WebhookResourceMappingResponseDto.d.mts +12 -0
  352. package/dist/esm/api/types/WebhookResourceMappingResponseDto.mjs +2 -0
  353. package/dist/esm/api/types/WebhookResponseDto.d.mts +28 -0
  354. package/dist/esm/api/types/WebhookResponseDto.mjs +2 -0
  355. package/dist/esm/api/types/WebhookType.d.mts +17 -0
  356. package/dist/esm/api/types/WebhookType.mjs +17 -0
  357. package/dist/esm/api/types/index.d.mts +37 -0
  358. package/dist/esm/api/types/index.mjs +37 -0
  359. package/dist/esm/core/auth/AuthProvider.d.mts +1 -0
  360. package/dist/esm/core/auth/AuthProvider.mjs +6 -1
  361. package/dist/esm/core/auth/index.d.mts +1 -1
  362. package/dist/esm/core/auth/index.mjs +1 -0
  363. package/dist/esm/core/fetcher/requestWithRetries.mjs +4 -1
  364. package/dist/esm/version.d.mts +1 -1
  365. package/dist/esm/version.mjs +1 -1
  366. package/package.json +24 -2
  367. package/reference.md +1614 -223
  368. package/dist/cjs/api/resources/datasets/client/requests/ListEntitiesInDatasetRequest.d.ts +0 -21
  369. package/dist/esm/api/resources/datasets/client/requests/ListEntitiesInDatasetRequest.d.mts +0 -21
  370. /package/dist/cjs/api/resources/datasets/client/requests/{ListEntitiesInDatasetRequest.js → ListDatasetEntitiesRequest.js} +0 -0
  371. /package/dist/esm/api/resources/datasets/client/requests/{ListEntitiesInDatasetRequest.mjs → ListDatasetEntitiesRequest.mjs} +0 -0
package/reference.md CHANGED
@@ -27,7 +27,9 @@ Returns all jobs created by the authenticated user.
27
27
  <dd>
28
28
 
29
29
  ```typescript
30
- await client.jobs.getUserJobs();
30
+ await client.jobs.getUserJobs({
31
+ project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04"
32
+ });
31
33
 
32
34
  ```
33
35
  </dd>
@@ -59,6 +61,73 @@ await client.jobs.getUserJobs();
59
61
  </dl>
60
62
 
61
63
 
64
+ </dd>
65
+ </dl>
66
+ </details>
67
+
68
+ <details><summary><code>client.jobs.<a href="/src/api/resources/jobs/client/Client.ts">validateQuery</a>({ ...params }) -> CatchAllApi.ValidateQueryResponseDto</code></summary>
69
+ <dl>
70
+ <dd>
71
+
72
+ #### 📝 Description
73
+
74
+ <dl>
75
+ <dd>
76
+
77
+ <dl>
78
+ <dd>
79
+
80
+ Checks whether a query is well-formed and likely to produce good results before submitting a job.
81
+
82
+ Returns a quality assessment with a status level, identified issues, and actionable suggestions.
83
+ </dd>
84
+ </dl>
85
+ </dd>
86
+ </dl>
87
+
88
+ #### 🔌 Usage
89
+
90
+ <dl>
91
+ <dd>
92
+
93
+ <dl>
94
+ <dd>
95
+
96
+ ```typescript
97
+ await client.jobs.validateQuery({
98
+ query: "Series B funding rounds for SaaS startups"
99
+ });
100
+
101
+ ```
102
+ </dd>
103
+ </dl>
104
+ </dd>
105
+ </dl>
106
+
107
+ #### ⚙️ Parameters
108
+
109
+ <dl>
110
+ <dd>
111
+
112
+ <dl>
113
+ <dd>
114
+
115
+ **request:** `CatchAllApi.ValidateQueryRequestDto`
116
+
117
+ </dd>
118
+ </dl>
119
+
120
+ <dl>
121
+ <dd>
122
+
123
+ **requestOptions:** `JobsClient.RequestOptions`
124
+
125
+ </dd>
126
+ </dl>
127
+ </dd>
128
+ </dl>
129
+
130
+
62
131
  </dd>
63
132
  </dl>
64
133
  </details>
@@ -407,11 +476,9 @@ await client.jobs.continueJob({
407
476
  <dl>
408
477
  <dd>
409
478
 
410
- Soft-deletes a job. The job is flagged as deleted and no longer
411
- appears in list results. The underlying data is retained.
479
+ Soft-deletes a job. The job is flagged as deleted and no longer appears in list results. The underlying data is retained.
412
480
 
413
- Only the job owner can delete a job. Returns `404` if the job is not
414
- found or does not belong to the authenticated user.
481
+ Only the job owner can delete a job. Returns `404` if the job is not found or does not belong to the authenticated user.
415
482
 
416
483
  Deleting an already-deleted job returns `200`.
417
484
  </dd>
@@ -494,7 +561,9 @@ Returns all monitors created by the authenticated user.
494
561
  <dd>
495
562
 
496
563
  ```typescript
497
- await client.monitors.listMonitors();
564
+ await client.monitors.listMonitors({
565
+ project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04"
566
+ });
498
567
 
499
568
  ```
500
569
  </dd>
@@ -559,14 +628,9 @@ Create a scheduled monitor based on a reference job.
559
628
  ```typescript
560
629
  await client.monitors.createMonitor({
561
630
  reference_job_id: "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c",
562
- schedule: "every day at 12 PM UTC",
563
- webhook: {
564
- url: "https://your-endpoint.com/webhook",
565
- method: "POST",
566
- headers: {
567
- "Authorization": "Bearer your_token_here"
568
- }
569
- },
631
+ schedule: "every day at 12 PM",
632
+ timezone: "UTC",
633
+ webhook_ids: ["a1b2c3d4-e5f6-7890-abcd-ef1234567890"],
570
634
  limit: 10,
571
635
  backfill: true
572
636
  });
@@ -1032,13 +1096,7 @@ Update the webhook configuration for an existing monitor.
1032
1096
  ```typescript
1033
1097
  await client.monitors.updateMonitor({
1034
1098
  monitor_id: "monitor_id",
1035
- webhook: {
1036
- url: "https://new-endpoint.com/webhook",
1037
- method: "POST",
1038
- headers: {
1039
- "Authorization": "Bearer new_token_xyz"
1040
- }
1041
- }
1099
+ webhook_ids: ["a1b2c3d4-e5f6-7890-abcd-ef1234567890"]
1042
1100
  });
1043
1101
 
1044
1102
  ```
@@ -1075,8 +1133,8 @@ await client.monitors.updateMonitor({
1075
1133
  </dl>
1076
1134
  </details>
1077
1135
 
1078
- ## Entities
1079
- <details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">listEntities</a>({ ...params }) -> CatchAllApi.EntityListResponse</code></summary>
1136
+ ## Webhooks
1137
+ <details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">listWebhooks</a>({ ...params }) -> CatchAllApi.ListWebhooksResponseDto</code></summary>
1080
1138
  <dl>
1081
1139
  <dd>
1082
1140
 
@@ -1088,9 +1146,7 @@ await client.monitors.updateMonitor({
1088
1146
  <dl>
1089
1147
  <dd>
1090
1148
 
1091
- Returns a paginated list of entities belonging to the authenticated
1092
- organization. Supports filtering by status and entity type, and
1093
- sorting by name, status, or creation date.
1149
+ Returns a paginated list of webhooks belonging to the organization.
1094
1150
  </dd>
1095
1151
  </dl>
1096
1152
  </dd>
@@ -1105,9 +1161,7 @@ sorting by name, status, or creation date.
1105
1161
  <dd>
1106
1162
 
1107
1163
  ```typescript
1108
- await client.entities.listEntities({
1109
- search: "NewsCatcher"
1110
- });
1164
+ await client.webhooks.listWebhooks();
1111
1165
 
1112
1166
  ```
1113
1167
  </dd>
@@ -1123,7 +1177,7 @@ await client.entities.listEntities({
1123
1177
  <dl>
1124
1178
  <dd>
1125
1179
 
1126
- **request:** `CatchAllApi.ListEntitiesRequest`
1180
+ **request:** `CatchAllApi.ListWebhooksRequest`
1127
1181
 
1128
1182
  </dd>
1129
1183
  </dl>
@@ -1131,7 +1185,7 @@ await client.entities.listEntities({
1131
1185
  <dl>
1132
1186
  <dd>
1133
1187
 
1134
- **requestOptions:** `EntitiesClient.RequestOptions`
1188
+ **requestOptions:** `WebhooksClient.RequestOptions`
1135
1189
 
1136
1190
  </dd>
1137
1191
  </dl>
@@ -1143,7 +1197,7 @@ await client.entities.listEntities({
1143
1197
  </dl>
1144
1198
  </details>
1145
1199
 
1146
- <details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">createEntity</a>({ ...params }) -> CatchAllApi.CreateEntityResponse</code></summary>
1200
+ <details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">createWebhook</a>({ ...params }) -> CatchAllApi.CreateWebhookResponseDto</code></summary>
1147
1201
  <dl>
1148
1202
  <dd>
1149
1203
 
@@ -1155,12 +1209,7 @@ await client.entities.listEntities({
1155
1209
  <dl>
1156
1210
  <dd>
1157
1211
 
1158
- Creates a new company entity and begins background enrichment.
1159
-
1160
- The entity status starts as `pending` and transitions to `ready` once
1161
- enrichment completes. Provide as much identifying information as
1162
- possible — `domain` is the highest-signal field because it is
1163
- unambiguous.
1212
+ Creates a new webhook endpoint for the organization.
1164
1213
  </dd>
1165
1214
  </dl>
1166
1215
  </dd>
@@ -1175,17 +1224,11 @@ unambiguous.
1175
1224
  <dd>
1176
1225
 
1177
1226
  ```typescript
1178
- await client.entities.createEntity({
1179
- name: "NewsCatcher",
1180
- entity_type: "company",
1181
- description: "AI-powered news data provider",
1182
- additional_attributes: {
1183
- company_attributes: {
1184
- domain: "newscatcherapi.com",
1185
- key_persons: ["Artem Bugara", "Maksym Sugonyaka"],
1186
- alternative_names: ["NC", "NewsCatcher API"]
1187
- }
1188
- }
1227
+ await client.webhooks.createWebhook({
1228
+ name: "Layoffs Alert",
1229
+ url: "https://hooks.slack.com/services/T000/B000/xxx",
1230
+ type: "slack",
1231
+ delivery_mode: "full"
1189
1232
  });
1190
1233
 
1191
1234
  ```
@@ -1202,7 +1245,7 @@ await client.entities.createEntity({
1202
1245
  <dl>
1203
1246
  <dd>
1204
1247
 
1205
- **request:** `CatchAllApi.CreateEntityRequest`
1248
+ **request:** `CatchAllApi.CreateWebhookRequestDto`
1206
1249
 
1207
1250
  </dd>
1208
1251
  </dl>
@@ -1210,7 +1253,7 @@ await client.entities.createEntity({
1210
1253
  <dl>
1211
1254
  <dd>
1212
1255
 
1213
- **requestOptions:** `EntitiesClient.RequestOptions`
1256
+ **requestOptions:** `WebhooksClient.RequestOptions`
1214
1257
 
1215
1258
  </dd>
1216
1259
  </dl>
@@ -1222,7 +1265,7 @@ await client.entities.createEntity({
1222
1265
  </dl>
1223
1266
  </details>
1224
1267
 
1225
- <details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">createEntitiesBatch</a>({ ...params }) -> CatchAllApi.CreateEntitiesBatchResponse</code></summary>
1268
+ <details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">getWebhook</a>({ ...params }) -> CatchAllApi.GetWebhookResponseDto</code></summary>
1226
1269
  <dl>
1227
1270
  <dd>
1228
1271
 
@@ -1234,11 +1277,7 @@ await client.entities.createEntity({
1234
1277
  <dl>
1235
1278
  <dd>
1236
1279
 
1237
- Creates multiple entities in a single request. Each entity is
1238
- processed independently — a failure in one does not affect others.
1239
-
1240
- Returns an array of `{id, status}` objects in the same order as
1241
- the input array.
1280
+ Returns the full configuration of a single webhook by ID.
1242
1281
  </dd>
1243
1282
  </dl>
1244
1283
  </dd>
@@ -1253,29 +1292,8 @@ the input array.
1253
1292
  <dd>
1254
1293
 
1255
1294
  ```typescript
1256
- await client.entities.createEntitiesBatch({
1257
- entities: [{
1258
- name: "OpenAI",
1259
- entity_type: "company",
1260
- description: "Artificial intelligence research company",
1261
- additional_attributes: {
1262
- company_attributes: {
1263
- domain: "openai.com",
1264
- key_persons: ["Sam Altman"],
1265
- alternative_names: ["Open AI"]
1266
- }
1267
- }
1268
- }, {
1269
- name: "Stripe",
1270
- entity_type: "company",
1271
- description: "Online payment processing platform",
1272
- additional_attributes: {
1273
- company_attributes: {
1274
- domain: "stripe.com",
1275
- key_persons: ["Patrick Collison", "John Collison"]
1276
- }
1277
- }
1278
- }]
1295
+ await client.webhooks.getWebhook({
1296
+ webhook_id: "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
1279
1297
  });
1280
1298
 
1281
1299
  ```
@@ -1292,7 +1310,7 @@ await client.entities.createEntitiesBatch({
1292
1310
  <dl>
1293
1311
  <dd>
1294
1312
 
1295
- **request:** `CatchAllApi.CreateEntitiesBatchRequest`
1313
+ **request:** `CatchAllApi.GetWebhookRequest`
1296
1314
 
1297
1315
  </dd>
1298
1316
  </dl>
@@ -1300,7 +1318,7 @@ await client.entities.createEntitiesBatch({
1300
1318
  <dl>
1301
1319
  <dd>
1302
1320
 
1303
- **requestOptions:** `EntitiesClient.RequestOptions`
1321
+ **requestOptions:** `WebhooksClient.RequestOptions`
1304
1322
 
1305
1323
  </dd>
1306
1324
  </dl>
@@ -1312,7 +1330,7 @@ await client.entities.createEntitiesBatch({
1312
1330
  </dl>
1313
1331
  </details>
1314
1332
 
1315
- <details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">getEntity</a>({ ...params }) -> CatchAllApi.EntityResponse</code></summary>
1333
+ <details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">deleteWebhook</a>({ ...params }) -> void</code></summary>
1316
1334
  <dl>
1317
1335
  <dd>
1318
1336
 
@@ -1324,7 +1342,9 @@ await client.entities.createEntitiesBatch({
1324
1342
  <dl>
1325
1343
  <dd>
1326
1344
 
1327
- Returns a single entity by ID with all attributes and current status.
1345
+ Permanently deletes a webhook and removes all resource assignments.
1346
+
1347
+ Assigned jobs and monitors no longer trigger delivery to this webhook. This operation cannot be undone.
1328
1348
  </dd>
1329
1349
  </dl>
1330
1350
  </dd>
@@ -1339,8 +1359,8 @@ Returns a single entity by ID with all attributes and current status.
1339
1359
  <dd>
1340
1360
 
1341
1361
  ```typescript
1342
- await client.entities.getEntity({
1343
- entity_id: "854198fa-f702-49db-a381-0427fa87f173"
1362
+ await client.webhooks.deleteWebhook({
1363
+ webhook_id: "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
1344
1364
  });
1345
1365
 
1346
1366
  ```
@@ -1357,7 +1377,7 @@ await client.entities.getEntity({
1357
1377
  <dl>
1358
1378
  <dd>
1359
1379
 
1360
- **request:** `CatchAllApi.GetEntityRequest`
1380
+ **request:** `CatchAllApi.DeleteWebhookRequest`
1361
1381
 
1362
1382
  </dd>
1363
1383
  </dl>
@@ -1365,7 +1385,7 @@ await client.entities.getEntity({
1365
1385
  <dl>
1366
1386
  <dd>
1367
1387
 
1368
- **requestOptions:** `EntitiesClient.RequestOptions`
1388
+ **requestOptions:** `WebhooksClient.RequestOptions`
1369
1389
 
1370
1390
  </dd>
1371
1391
  </dl>
@@ -1377,7 +1397,7 @@ await client.entities.getEntity({
1377
1397
  </dl>
1378
1398
  </details>
1379
1399
 
1380
- <details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">deleteEntity</a>({ ...params }) -> void</code></summary>
1400
+ <details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">updateWebhook</a>({ ...params }) -> CatchAllApi.UpdateWebhookResponseDto</code></summary>
1381
1401
  <dl>
1382
1402
  <dd>
1383
1403
 
@@ -1389,8 +1409,7 @@ await client.entities.getEntity({
1389
1409
  <dl>
1390
1410
  <dd>
1391
1411
 
1392
- Permanently deletes an entity. The entity is removed from all
1393
- datasets and the search index. This operation cannot be undone.
1412
+ Updates one or more fields of an existing webhook.
1394
1413
  </dd>
1395
1414
  </dl>
1396
1415
  </dd>
@@ -1405,8 +1424,10 @@ datasets and the search index. This operation cannot be undone.
1405
1424
  <dd>
1406
1425
 
1407
1426
  ```typescript
1408
- await client.entities.deleteEntity({
1409
- entity_id: "854198fa-f702-49db-a381-0427fa87f173"
1427
+ await client.webhooks.updateWebhook({
1428
+ webhook_id: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
1429
+ name: "Layoffs Alert (EU)",
1430
+ is_active: false
1410
1431
  });
1411
1432
 
1412
1433
  ```
@@ -1423,7 +1444,7 @@ await client.entities.deleteEntity({
1423
1444
  <dl>
1424
1445
  <dd>
1425
1446
 
1426
- **request:** `CatchAllApi.DeleteEntityRequest`
1447
+ **request:** `CatchAllApi.UpdateWebhookRequestDto`
1427
1448
 
1428
1449
  </dd>
1429
1450
  </dl>
@@ -1431,7 +1452,7 @@ await client.entities.deleteEntity({
1431
1452
  <dl>
1432
1453
  <dd>
1433
1454
 
1434
- **requestOptions:** `EntitiesClient.RequestOptions`
1455
+ **requestOptions:** `WebhooksClient.RequestOptions`
1435
1456
 
1436
1457
  </dd>
1437
1458
  </dl>
@@ -1443,7 +1464,7 @@ await client.entities.deleteEntity({
1443
1464
  </dl>
1444
1465
  </details>
1445
1466
 
1446
- <details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">updateEntity</a>({ ...params }) -> CatchAllApi.EntityResponse</code></summary>
1467
+ <details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">testWebhook</a>({ ...params }) -> CatchAllApi.TestWebhookResponseDto</code></summary>
1447
1468
  <dl>
1448
1469
  <dd>
1449
1470
 
@@ -1455,7 +1476,9 @@ await client.entities.deleteEntity({
1455
1476
  <dl>
1456
1477
  <dd>
1457
1478
 
1458
- Updates one or more fields of an existing entity.
1479
+ Sends a test HTTP request to the webhook URL using the webhook's configured method, headers, and auth. Returns the response from the target endpoint.
1480
+
1481
+ Use this to verify URL reachability and authentication before attaching the webhook to a live job or monitor.
1459
1482
  </dd>
1460
1483
  </dl>
1461
1484
  </dd>
@@ -1470,13 +1493,11 @@ Updates one or more fields of an existing entity.
1470
1493
  <dd>
1471
1494
 
1472
1495
  ```typescript
1473
- await client.entities.updateEntity({
1474
- entity_id: "854198fa-f702-49db-a381-0427fa87f173",
1475
- description: "Updated description",
1476
- additional_attributes: {
1477
- company_attributes: {
1478
- alternative_names: ["NC", "NewsCatcher API", "NCA"]
1479
- }
1496
+ await client.webhooks.testWebhook({
1497
+ webhook_id: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
1498
+ payload: {
1499
+ "test": true,
1500
+ "message": "CatchAll webhook test"
1480
1501
  }
1481
1502
  });
1482
1503
 
@@ -1494,7 +1515,7 @@ await client.entities.updateEntity({
1494
1515
  <dl>
1495
1516
  <dd>
1496
1517
 
1497
- **request:** `CatchAllApi.UpdateEntityRequest`
1518
+ **request:** `CatchAllApi.TestWebhookRequestDto`
1498
1519
 
1499
1520
  </dd>
1500
1521
  </dl>
@@ -1502,7 +1523,7 @@ await client.entities.updateEntity({
1502
1523
  <dl>
1503
1524
  <dd>
1504
1525
 
1505
- **requestOptions:** `EntitiesClient.RequestOptions`
1526
+ **requestOptions:** `WebhooksClient.RequestOptions`
1506
1527
 
1507
1528
  </dd>
1508
1529
  </dl>
@@ -1514,8 +1535,7 @@ await client.entities.updateEntity({
1514
1535
  </dl>
1515
1536
  </details>
1516
1537
 
1517
- ## Datasets
1518
- <details><summary><code>client.datasets.<a href="/src/api/resources/datasets/client/Client.ts">listDatasets</a>({ ...params }) -> CatchAllApi.DatasetListResponse</code></summary>
1538
+ <details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">listWebhookResources</a>({ ...params }) -> CatchAllApi.ListWebhookResourcesResponseDto</code></summary>
1519
1539
  <dl>
1520
1540
  <dd>
1521
1541
 
@@ -1527,9 +1547,7 @@ await client.entities.updateEntity({
1527
1547
  <dl>
1528
1548
  <dd>
1529
1549
 
1530
- Returns a paginated list of datasets belonging to the authenticated
1531
- organization. Supports filtering by status and sorting by name,
1532
- status, or creation date.
1550
+ Returns a paginated list of resources currently assigned to this webhook.
1533
1551
  </dd>
1534
1552
  </dl>
1535
1553
  </dd>
@@ -1544,8 +1562,8 @@ status, or creation date.
1544
1562
  <dd>
1545
1563
 
1546
1564
  ```typescript
1547
- await client.datasets.listDatasets({
1548
- search: "Portfolio"
1565
+ await client.webhooks.listWebhookResources({
1566
+ webhook_id: "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
1549
1567
  });
1550
1568
 
1551
1569
  ```
@@ -1562,7 +1580,7 @@ await client.datasets.listDatasets({
1562
1580
  <dl>
1563
1581
  <dd>
1564
1582
 
1565
- **request:** `CatchAllApi.ListDatasetsRequest`
1583
+ **request:** `CatchAllApi.ListWebhookResourcesRequest`
1566
1584
 
1567
1585
  </dd>
1568
1586
  </dl>
@@ -1570,7 +1588,7 @@ await client.datasets.listDatasets({
1570
1588
  <dl>
1571
1589
  <dd>
1572
1590
 
1573
- **requestOptions:** `DatasetsClient.RequestOptions`
1591
+ **requestOptions:** `WebhooksClient.RequestOptions`
1574
1592
 
1575
1593
  </dd>
1576
1594
  </dl>
@@ -1582,7 +1600,7 @@ await client.datasets.listDatasets({
1582
1600
  </dl>
1583
1601
  </details>
1584
1602
 
1585
- <details><summary><code>client.datasets.<a href="/src/api/resources/datasets/client/Client.ts">createDataset</a>({ ...params }) -> CatchAllApi.DatasetResponse</code></summary>
1603
+ <details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">assignWebhookResource</a>({ ...params }) -> CatchAllApi.AssignWebhookResourceResponseDto</code></summary>
1586
1604
  <dl>
1587
1605
  <dd>
1588
1606
 
@@ -1594,14 +1612,11 @@ await client.datasets.listDatasets({
1594
1612
  <dl>
1595
1613
  <dd>
1596
1614
 
1597
- Creates a new dataset from a list of existing entity IDs.
1598
-
1599
- If any of the provided entity IDs do not exist or do not belong to
1600
- your organization, the request fails with `400`. All entity IDs must
1601
- be valid before the dataset is created.
1615
+ Attaches a job, monitor, or monitor group to the webhook. When the
1616
+ resource completes, the webhook receives a delivery.
1602
1617
 
1603
- To create a dataset and entities in one step, use the [`Create dataset from CSV`](https://www.newscatcherapi.com/docs/web-search-api/api-reference/datasets/create-dataset-from-csv)
1604
- endpoint instead.
1618
+ A single webhook can be assigned to multiple resources. Each resource
1619
+ can have up to 5 webhooks assigned.
1605
1620
  </dd>
1606
1621
  </dl>
1607
1622
  </dd>
@@ -1616,10 +1631,10 @@ endpoint instead.
1616
1631
  <dd>
1617
1632
 
1618
1633
  ```typescript
1619
- await client.datasets.createDataset({
1620
- name: "My Portfolio",
1621
- description: "Companies in our investment portfolio",
1622
- entity_ids: ["854198fa-f702-49db-a381-0427fa87f173", "a1b2c3d4-e5f6-7890-abcd-ef1234567890"]
1634
+ await client.webhooks.assignWebhookResource({
1635
+ webhook_id: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
1636
+ resource_type: "monitor",
1637
+ resource_id: "3fec5b07-8786-46d7-9486-d43ff67eccd4"
1623
1638
  });
1624
1639
 
1625
1640
  ```
@@ -1636,7 +1651,7 @@ await client.datasets.createDataset({
1636
1651
  <dl>
1637
1652
  <dd>
1638
1653
 
1639
- **request:** `CatchAllApi.CreateDatasetRequest`
1654
+ **request:** `CatchAllApi.AssignWebhookResourceRequestDto`
1640
1655
 
1641
1656
  </dd>
1642
1657
  </dl>
@@ -1644,7 +1659,7 @@ await client.datasets.createDataset({
1644
1659
  <dl>
1645
1660
  <dd>
1646
1661
 
1647
- **requestOptions:** `DatasetsClient.RequestOptions`
1662
+ **requestOptions:** `WebhooksClient.RequestOptions`
1648
1663
 
1649
1664
  </dd>
1650
1665
  </dl>
@@ -1656,7 +1671,7 @@ await client.datasets.createDataset({
1656
1671
  </dl>
1657
1672
  </details>
1658
1673
 
1659
- <details><summary><code>client.datasets.<a href="/src/api/resources/datasets/client/Client.ts">createDatasetFromCsv</a>({ ...params }) -> CatchAllApi.CreateDatasetCsvResponse</code></summary>
1674
+ <details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">removeWebhookResource</a>({ ...params }) -> void</code></summary>
1660
1675
  <dl>
1661
1676
  <dd>
1662
1677
 
@@ -1668,20 +1683,9 @@ await client.datasets.createDataset({
1668
1683
  <dl>
1669
1684
  <dd>
1670
1685
 
1671
- Creates a new dataset by uploading a CSV file. Each row in the CSV
1672
- becomes an entity. The `name` column is required; all other columns
1673
- are optional.
1674
-
1675
- **CSV format:**
1676
- ```csv
1677
- name,description,domain,alternative_names,key_persons
1678
- NewsCatcher,"AI-powered news data provider",newscatcherapi.com,"NC;NewsCatcher API","Artem Bugara;Maksym Sugonyaka"
1679
- OpenAI,"Artificial intelligence research company",openai.com,"Open AI","Sam Altman"
1680
- ```
1681
-
1682
- Use semicolons (`;`) to separate multiple values in `alternative_names` and `key_persons`. Rows with empty `name` are skipped and reported in `validation_report`.
1686
+ Detaches a resource from this webhook. Completions of the resource no longer trigger delivery to this webhook.
1683
1687
 
1684
- **Note**: The response shape differs from the JSON dataset creation endpoint: it returns `dataset_id` (not `id`) and includes a `validation_report` with details on skipped rows.
1688
+ The webhook and the resource itself are not deleted.
1685
1689
  </dd>
1686
1690
  </dl>
1687
1691
  </dd>
@@ -1696,9 +1700,10 @@ Use semicolons (`;`) to separate multiple values in `alternative_names` and `key
1696
1700
  <dd>
1697
1701
 
1698
1702
  ```typescript
1699
- await client.datasets.createDatasetFromCsv({
1700
- file: fs.createReadStream("/path/to/your/file"),
1701
- name: "name"
1703
+ await client.webhooks.removeWebhookResource({
1704
+ webhook_id: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
1705
+ resource_type: "job",
1706
+ resource_id: "3fec5b07-8786-46d7-9486-d43ff67eccd4"
1702
1707
  });
1703
1708
 
1704
1709
  ```
@@ -1715,7 +1720,7 @@ await client.datasets.createDatasetFromCsv({
1715
1720
  <dl>
1716
1721
  <dd>
1717
1722
 
1718
- **request:** `CatchAllApi.CreateDatasetFromCsvRequest`
1723
+ **request:** `CatchAllApi.RemoveWebhookResourceRequest`
1719
1724
 
1720
1725
  </dd>
1721
1726
  </dl>
@@ -1723,7 +1728,7 @@ await client.datasets.createDatasetFromCsv({
1723
1728
  <dl>
1724
1729
  <dd>
1725
1730
 
1726
- **requestOptions:** `DatasetsClient.RequestOptions`
1731
+ **requestOptions:** `WebhooksClient.RequestOptions`
1727
1732
 
1728
1733
  </dd>
1729
1734
  </dl>
@@ -1735,7 +1740,7 @@ await client.datasets.createDatasetFromCsv({
1735
1740
  </dl>
1736
1741
  </details>
1737
1742
 
1738
- <details><summary><code>client.datasets.<a href="/src/api/resources/datasets/client/Client.ts">getDataset</a>({ ...params }) -> CatchAllApi.DatasetResponse</code></summary>
1743
+ <details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">listWebhooksForResource</a>({ ...params }) -> CatchAllApi.ListWebhooksResponseDto</code></summary>
1739
1744
  <dl>
1740
1745
  <dd>
1741
1746
 
@@ -1747,7 +1752,7 @@ await client.datasets.createDatasetFromCsv({
1747
1752
  <dl>
1748
1753
  <dd>
1749
1754
 
1750
- Returns a single dataset by ID including entity count and current status.
1755
+ Returns all webhooks currently assigned to the given resource.
1751
1756
  </dd>
1752
1757
  </dl>
1753
1758
  </dd>
@@ -1762,8 +1767,9 @@ Returns a single dataset by ID including entity count and current status.
1762
1767
  <dd>
1763
1768
 
1764
1769
  ```typescript
1765
- await client.datasets.getDataset({
1766
- dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2"
1770
+ await client.webhooks.listWebhooksForResource({
1771
+ resource_type: "job",
1772
+ resource_id: "3fec5b07-8786-46d7-9486-d43ff67eccd4"
1767
1773
  });
1768
1774
 
1769
1775
  ```
@@ -1780,7 +1786,7 @@ await client.datasets.getDataset({
1780
1786
  <dl>
1781
1787
  <dd>
1782
1788
 
1783
- **request:** `CatchAllApi.GetDatasetRequest`
1789
+ **request:** `CatchAllApi.ListWebhooksForResourceRequest`
1784
1790
 
1785
1791
  </dd>
1786
1792
  </dl>
@@ -1788,7 +1794,7 @@ await client.datasets.getDataset({
1788
1794
  <dl>
1789
1795
  <dd>
1790
1796
 
1791
- **requestOptions:** `DatasetsClient.RequestOptions`
1797
+ **requestOptions:** `WebhooksClient.RequestOptions`
1792
1798
 
1793
1799
  </dd>
1794
1800
  </dl>
@@ -1800,7 +1806,7 @@ await client.datasets.getDataset({
1800
1806
  </dl>
1801
1807
  </details>
1802
1808
 
1803
- <details><summary><code>client.datasets.<a href="/src/api/resources/datasets/client/Client.ts">deleteDataset</a>({ ...params }) -> void</code></summary>
1809
+ <details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">getWebhookDeliveryHistory</a>({ ...params }) -> CatchAllApi.DeliveryHistoryResponseDto</code></summary>
1804
1810
  <dl>
1805
1811
  <dd>
1806
1812
 
@@ -1812,9 +1818,9 @@ await client.datasets.getDataset({
1812
1818
  <dl>
1813
1819
  <dd>
1814
1820
 
1815
- Permanently deletes a dataset. The entities within the dataset are
1816
- not deleted — only the dataset itself. This operation cannot be
1817
- undone.
1821
+ Returns a paginated delivery log for a given resource, ordered by timestamp descending.
1822
+
1823
+ Each record shows the webhook dispatched, the HTTP status code returned, delivery outcome, and any error or warning messages. Use this to debug failed deliveries or audit dispatch activity.
1818
1824
  </dd>
1819
1825
  </dl>
1820
1826
  </dd>
@@ -1829,8 +1835,9 @@ undone.
1829
1835
  <dd>
1830
1836
 
1831
1837
  ```typescript
1832
- await client.datasets.deleteDataset({
1833
- dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2"
1838
+ await client.webhooks.getWebhookDeliveryHistory({
1839
+ resource_type: "job",
1840
+ resource_id: "3fec5b07-8786-46d7-9486-d43ff67eccd4"
1834
1841
  });
1835
1842
 
1836
1843
  ```
@@ -1847,7 +1854,7 @@ await client.datasets.deleteDataset({
1847
1854
  <dl>
1848
1855
  <dd>
1849
1856
 
1850
- **request:** `CatchAllApi.DeleteDatasetRequest`
1857
+ **request:** `CatchAllApi.GetWebhookDeliveryHistoryRequest`
1851
1858
 
1852
1859
  </dd>
1853
1860
  </dl>
@@ -1855,7 +1862,7 @@ await client.datasets.deleteDataset({
1855
1862
  <dl>
1856
1863
  <dd>
1857
1864
 
1858
- **requestOptions:** `DatasetsClient.RequestOptions`
1865
+ **requestOptions:** `WebhooksClient.RequestOptions`
1859
1866
 
1860
1867
  </dd>
1861
1868
  </dl>
@@ -1867,7 +1874,8 @@ await client.datasets.deleteDataset({
1867
1874
  </dl>
1868
1875
  </details>
1869
1876
 
1870
- <details><summary><code>client.datasets.<a href="/src/api/resources/datasets/client/Client.ts">updateDataset</a>({ ...params }) -> CatchAllApi.DatasetResponse</code></summary>
1877
+ ## Entities
1878
+ <details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">listEntities</a>({ ...params }) -> CatchAllApi.EntityListResponse</code></summary>
1871
1879
  <dl>
1872
1880
  <dd>
1873
1881
 
@@ -1879,7 +1887,7 @@ await client.datasets.deleteDataset({
1879
1887
  <dl>
1880
1888
  <dd>
1881
1889
 
1882
- Updates the name or description of a dataset.
1890
+ Returns a paginated list of entities belonging to the authenticated organization. Supports filtering by status and entity type, and sorting by name, status, or creation date.
1883
1891
  </dd>
1884
1892
  </dl>
1885
1893
  </dd>
@@ -1894,10 +1902,8 @@ Updates the name or description of a dataset.
1894
1902
  <dd>
1895
1903
 
1896
1904
  ```typescript
1897
- await client.datasets.updateDataset({
1898
- dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2",
1899
- name: "My Portfolio (updated)",
1900
- description: "Updated Q1 2026 watchlist"
1905
+ await client.entities.listEntities({
1906
+ search: "NewsCatcher"
1901
1907
  });
1902
1908
 
1903
1909
  ```
@@ -1914,7 +1920,7 @@ await client.datasets.updateDataset({
1914
1920
  <dl>
1915
1921
  <dd>
1916
1922
 
1917
- **request:** `CatchAllApi.UpdateDatasetRequest`
1923
+ **request:** `CatchAllApi.ListEntitiesRequest`
1918
1924
 
1919
1925
  </dd>
1920
1926
  </dl>
@@ -1922,7 +1928,7 @@ await client.datasets.updateDataset({
1922
1928
  <dl>
1923
1929
  <dd>
1924
1930
 
1925
- **requestOptions:** `DatasetsClient.RequestOptions`
1931
+ **requestOptions:** `EntitiesClient.RequestOptions`
1926
1932
 
1927
1933
  </dd>
1928
1934
  </dl>
@@ -1934,7 +1940,7 @@ await client.datasets.updateDataset({
1934
1940
  </dl>
1935
1941
  </details>
1936
1942
 
1937
- <details><summary><code>client.datasets.<a href="/src/api/resources/datasets/client/Client.ts">listEntitiesInDataset</a>({ ...params }) -> CatchAllApi.DatasetEntityListResponse</code></summary>
1943
+ <details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">createEntity</a>({ ...params }) -> CatchAllApi.CreateEntityResponse</code></summary>
1938
1944
  <dl>
1939
1945
  <dd>
1940
1946
 
@@ -1946,7 +1952,12 @@ await client.datasets.updateDataset({
1946
1952
  <dl>
1947
1953
  <dd>
1948
1954
 
1949
- Returns a paginated list of entities in a dataset. Supports filtering by status and entity type.
1955
+ Creates a new company entity and begins background enrichment.
1956
+
1957
+ The entity status starts as `pending` and transitions to `ready` once
1958
+ enrichment completes. Provide as much identifying information as
1959
+ possible — `domain` is the highest-signal field because it is
1960
+ unambiguous.
1950
1961
  </dd>
1951
1962
  </dl>
1952
1963
  </dd>
@@ -1961,8 +1972,17 @@ Returns a paginated list of entities in a dataset. Supports filtering by status
1961
1972
  <dd>
1962
1973
 
1963
1974
  ```typescript
1964
- await client.datasets.listEntitiesInDataset({
1965
- dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2"
1975
+ await client.entities.createEntity({
1976
+ name: "NewsCatcher",
1977
+ entity_type: "company",
1978
+ description: "AI-powered news data provider",
1979
+ additional_attributes: {
1980
+ company_attributes: {
1981
+ domain: "newscatcherapi.com",
1982
+ key_persons: ["Artem Bugara", "Maksym Sugonyaka"],
1983
+ alternative_names: ["NC", "NewsCatcher API"]
1984
+ }
1985
+ }
1966
1986
  });
1967
1987
 
1968
1988
  ```
@@ -1979,7 +1999,7 @@ await client.datasets.listEntitiesInDataset({
1979
1999
  <dl>
1980
2000
  <dd>
1981
2001
 
1982
- **request:** `CatchAllApi.ListEntitiesInDatasetRequest`
2002
+ **request:** `CatchAllApi.CreateEntityRequest`
1983
2003
 
1984
2004
  </dd>
1985
2005
  </dl>
@@ -1987,7 +2007,7 @@ await client.datasets.listEntitiesInDataset({
1987
2007
  <dl>
1988
2008
  <dd>
1989
2009
 
1990
- **requestOptions:** `DatasetsClient.RequestOptions`
2010
+ **requestOptions:** `EntitiesClient.RequestOptions`
1991
2011
 
1992
2012
  </dd>
1993
2013
  </dl>
@@ -1999,7 +2019,7 @@ await client.datasets.listEntitiesInDataset({
1999
2019
  </dl>
2000
2020
  </details>
2001
2021
 
2002
- <details><summary><code>client.datasets.<a href="/src/api/resources/datasets/client/Client.ts">addEntitiesToDataset</a>({ ...params }) -> CatchAllApi.ManageEntitiesResponse</code></summary>
2022
+ <details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">createEntitiesBatch</a>({ ...params }) -> CatchAllApi.CreateEntitiesBatchResponse</code></summary>
2003
2023
  <dl>
2004
2024
  <dd>
2005
2025
 
@@ -2011,7 +2031,9 @@ await client.datasets.listEntitiesInDataset({
2011
2031
  <dl>
2012
2032
  <dd>
2013
2033
 
2014
- Adds one or more existing entities to a dataset. Returns the number of entities added.
2034
+ Creates multiple entities in a single request. Each entity is processed independently — a failure in one does not affect others.
2035
+
2036
+ Returns an array of `{id, status}` objects in the same order as the input array.
2015
2037
  </dd>
2016
2038
  </dl>
2017
2039
  </dd>
@@ -2026,28 +2048,46 @@ Adds one or more existing entities to a dataset. Returns the number of entities
2026
2048
  <dd>
2027
2049
 
2028
2050
  ```typescript
2029
- await client.datasets.addEntitiesToDataset({
2030
- dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2",
2031
- body: {
2032
- entity_ids: ["854198fa-f702-49db-a381-0427fa87f173"]
2033
- }
2034
- });
2035
-
2036
- ```
2037
- </dd>
2038
- </dl>
2039
- </dd>
2040
- </dl>
2041
-
2042
- #### ⚙️ Parameters
2043
-
2044
- <dl>
2045
- <dd>
2046
-
2051
+ await client.entities.createEntitiesBatch({
2052
+ entities: [{
2053
+ name: "OpenAI",
2054
+ entity_type: "company",
2055
+ description: "Artificial intelligence research company",
2056
+ additional_attributes: {
2057
+ company_attributes: {
2058
+ domain: "openai.com",
2059
+ key_persons: ["Sam Altman"],
2060
+ alternative_names: ["Open AI"]
2061
+ }
2062
+ }
2063
+ }, {
2064
+ name: "Stripe",
2065
+ entity_type: "company",
2066
+ description: "Online payment processing platform",
2067
+ additional_attributes: {
2068
+ company_attributes: {
2069
+ domain: "stripe.com",
2070
+ key_persons: ["Patrick Collison", "John Collison"]
2071
+ }
2072
+ }
2073
+ }]
2074
+ });
2075
+
2076
+ ```
2077
+ </dd>
2078
+ </dl>
2079
+ </dd>
2080
+ </dl>
2081
+
2082
+ #### ⚙️ Parameters
2083
+
2047
2084
  <dl>
2048
2085
  <dd>
2049
2086
 
2050
- **request:** `CatchAllApi.AddEntitiesToDatasetRequest`
2087
+ <dl>
2088
+ <dd>
2089
+
2090
+ **request:** `CatchAllApi.CreateEntitiesBatchRequest`
2051
2091
 
2052
2092
  </dd>
2053
2093
  </dl>
@@ -2055,7 +2095,7 @@ await client.datasets.addEntitiesToDataset({
2055
2095
  <dl>
2056
2096
  <dd>
2057
2097
 
2058
- **requestOptions:** `DatasetsClient.RequestOptions`
2098
+ **requestOptions:** `EntitiesClient.RequestOptions`
2059
2099
 
2060
2100
  </dd>
2061
2101
  </dl>
@@ -2067,7 +2107,7 @@ await client.datasets.addEntitiesToDataset({
2067
2107
  </dl>
2068
2108
  </details>
2069
2109
 
2070
- <details><summary><code>client.datasets.<a href="/src/api/resources/datasets/client/Client.ts">removeEntitiesFromDataset</a>({ ...params }) -> CatchAllApi.ManageEntitiesResponse</code></summary>
2110
+ <details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">getEntity</a>({ ...params }) -> CatchAllApi.EntityResponse</code></summary>
2071
2111
  <dl>
2072
2112
  <dd>
2073
2113
 
@@ -2079,9 +2119,7 @@ await client.datasets.addEntitiesToDataset({
2079
2119
  <dl>
2080
2120
  <dd>
2081
2121
 
2082
- Removes one or more entities from a dataset. The entities themselves
2083
- are not deleted — they are only removed from this dataset. Returns
2084
- the number of entities removed.
2122
+ Returns a single entity by ID with all attributes and current status.
2085
2123
  </dd>
2086
2124
  </dl>
2087
2125
  </dd>
@@ -2096,10 +2134,144 @@ the number of entities removed.
2096
2134
  <dd>
2097
2135
 
2098
2136
  ```typescript
2099
- await client.datasets.removeEntitiesFromDataset({
2100
- dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2",
2101
- body: {
2102
- entity_ids: ["854198fa-f702-49db-a381-0427fa87f173"]
2137
+ await client.entities.getEntity({
2138
+ entity_id: "854198fa-f702-49db-a381-0427fa87f173"
2139
+ });
2140
+
2141
+ ```
2142
+ </dd>
2143
+ </dl>
2144
+ </dd>
2145
+ </dl>
2146
+
2147
+ #### ⚙️ Parameters
2148
+
2149
+ <dl>
2150
+ <dd>
2151
+
2152
+ <dl>
2153
+ <dd>
2154
+
2155
+ **request:** `CatchAllApi.GetEntityRequest`
2156
+
2157
+ </dd>
2158
+ </dl>
2159
+
2160
+ <dl>
2161
+ <dd>
2162
+
2163
+ **requestOptions:** `EntitiesClient.RequestOptions`
2164
+
2165
+ </dd>
2166
+ </dl>
2167
+ </dd>
2168
+ </dl>
2169
+
2170
+
2171
+ </dd>
2172
+ </dl>
2173
+ </details>
2174
+
2175
+ <details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">deleteEntity</a>({ ...params }) -> void</code></summary>
2176
+ <dl>
2177
+ <dd>
2178
+
2179
+ #### 📝 Description
2180
+
2181
+ <dl>
2182
+ <dd>
2183
+
2184
+ <dl>
2185
+ <dd>
2186
+
2187
+ Permanently deletes an entity. The entity is removed from all
2188
+ datasets and the search index. This operation cannot be undone.
2189
+ </dd>
2190
+ </dl>
2191
+ </dd>
2192
+ </dl>
2193
+
2194
+ #### 🔌 Usage
2195
+
2196
+ <dl>
2197
+ <dd>
2198
+
2199
+ <dl>
2200
+ <dd>
2201
+
2202
+ ```typescript
2203
+ await client.entities.deleteEntity({
2204
+ entity_id: "854198fa-f702-49db-a381-0427fa87f173"
2205
+ });
2206
+
2207
+ ```
2208
+ </dd>
2209
+ </dl>
2210
+ </dd>
2211
+ </dl>
2212
+
2213
+ #### ⚙️ Parameters
2214
+
2215
+ <dl>
2216
+ <dd>
2217
+
2218
+ <dl>
2219
+ <dd>
2220
+
2221
+ **request:** `CatchAllApi.DeleteEntityRequest`
2222
+
2223
+ </dd>
2224
+ </dl>
2225
+
2226
+ <dl>
2227
+ <dd>
2228
+
2229
+ **requestOptions:** `EntitiesClient.RequestOptions`
2230
+
2231
+ </dd>
2232
+ </dl>
2233
+ </dd>
2234
+ </dl>
2235
+
2236
+
2237
+ </dd>
2238
+ </dl>
2239
+ </details>
2240
+
2241
+ <details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">updateEntity</a>({ ...params }) -> CatchAllApi.EntityResponse</code></summary>
2242
+ <dl>
2243
+ <dd>
2244
+
2245
+ #### 📝 Description
2246
+
2247
+ <dl>
2248
+ <dd>
2249
+
2250
+ <dl>
2251
+ <dd>
2252
+
2253
+ Updates one or more fields of an existing entity.
2254
+ </dd>
2255
+ </dl>
2256
+ </dd>
2257
+ </dl>
2258
+
2259
+ #### 🔌 Usage
2260
+
2261
+ <dl>
2262
+ <dd>
2263
+
2264
+ <dl>
2265
+ <dd>
2266
+
2267
+ ```typescript
2268
+ await client.entities.updateEntity({
2269
+ entity_id: "854198fa-f702-49db-a381-0427fa87f173",
2270
+ description: "Updated description",
2271
+ additional_attributes: {
2272
+ company_attributes: {
2273
+ alternative_names: ["NC", "NewsCatcher API", "NCA"]
2274
+ }
2103
2275
  }
2104
2276
  });
2105
2277
 
@@ -2117,7 +2289,7 @@ await client.datasets.removeEntitiesFromDataset({
2117
2289
  <dl>
2118
2290
  <dd>
2119
2291
 
2120
- **request:** `CatchAllApi.RemoveEntitiesFromDatasetRequest`
2292
+ **request:** `CatchAllApi.UpdateEntityRequest`
2121
2293
 
2122
2294
  </dd>
2123
2295
  </dl>
@@ -2125,7 +2297,7 @@ await client.datasets.removeEntitiesFromDataset({
2125
2297
  <dl>
2126
2298
  <dd>
2127
2299
 
2128
- **requestOptions:** `DatasetsClient.RequestOptions`
2300
+ **requestOptions:** `EntitiesClient.RequestOptions`
2129
2301
 
2130
2302
  </dd>
2131
2303
  </dl>
@@ -2137,7 +2309,8 @@ await client.datasets.removeEntitiesFromDataset({
2137
2309
  </dl>
2138
2310
  </details>
2139
2311
 
2140
- <details><summary><code>client.datasets.<a href="/src/api/resources/datasets/client/Client.ts">getDatasetStatusHistory</a>({ ...params }) -> CatchAllApi.DatasetStatusHistoryResponse</code></summary>
2312
+ ## Datasets
2313
+ <details><summary><code>client.datasets.<a href="/src/api/resources/datasets/client/Client.ts">listDatasets</a>({ ...params }) -> CatchAllApi.DatasetListResponse</code></summary>
2141
2314
  <dl>
2142
2315
  <dd>
2143
2316
 
@@ -2149,8 +2322,7 @@ await client.datasets.removeEntitiesFromDataset({
2149
2322
  <dl>
2150
2323
  <dd>
2151
2324
 
2152
- Returns the full status change history for a dataset, ordered
2153
- chronologically from oldest to newest.
2325
+ Returns a paginated list of datasets belonging to the authenticated organization. Supports filtering by status and sorting by name, status, or creation date.
2154
2326
  </dd>
2155
2327
  </dl>
2156
2328
  </dd>
@@ -2165,8 +2337,9 @@ chronologically from oldest to newest.
2165
2337
  <dd>
2166
2338
 
2167
2339
  ```typescript
2168
- await client.datasets.getDatasetStatusHistory({
2169
- dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2"
2340
+ await client.datasets.listDatasets({
2341
+ search: "Portfolio",
2342
+ project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04"
2170
2343
  });
2171
2344
 
2172
2345
  ```
@@ -2183,7 +2356,7 @@ await client.datasets.getDatasetStatusHistory({
2183
2356
  <dl>
2184
2357
  <dd>
2185
2358
 
2186
- **request:** `CatchAllApi.GetDatasetStatusHistoryRequest`
2359
+ **request:** `CatchAllApi.ListDatasetsRequest`
2187
2360
 
2188
2361
  </dd>
2189
2362
  </dl>
@@ -2203,7 +2376,7 @@ await client.datasets.getDatasetStatusHistory({
2203
2376
  </dl>
2204
2377
  </details>
2205
2378
 
2206
- <details><summary><code>client.datasets.<a href="/src/api/resources/datasets/client/Client.ts">uploadCsvToDataset</a>({ ...params }) -> CatchAllApi.UploadCsvToDatasetResponse</code></summary>
2379
+ <details><summary><code>client.datasets.<a href="/src/api/resources/datasets/client/Client.ts">createDataset</a>({ ...params }) -> CatchAllApi.DatasetResponse</code></summary>
2207
2380
  <dl>
2208
2381
  <dd>
2209
2382
 
@@ -2215,11 +2388,14 @@ await client.datasets.getDatasetStatusHistory({
2215
2388
  <dl>
2216
2389
  <dd>
2217
2390
 
2218
- Appends new companies to an existing dataset by uploading a CSV file.
2219
- Uses the same CSV format as the dataset creation endpoint.
2391
+ Creates a new dataset from a list of existing entity IDs.
2392
+
2393
+ If any of the provided entity IDs do not exist or do not belong to
2394
+ your organization, the request fails with `400`. All entity IDs must
2395
+ be valid before the dataset is created.
2220
2396
 
2221
- The response omits `dataset_name` compared to the create-from-CSV
2222
- endpoint since the dataset already exists.
2397
+ To create a dataset and entities in one step, use the [`Create dataset from CSV`](https://www.newscatcherapi.com/docs/web-search-api/api-reference/datasets/create-dataset-from-csv)
2398
+ endpoint instead.
2223
2399
  </dd>
2224
2400
  </dl>
2225
2401
  </dd>
@@ -2234,9 +2410,10 @@ endpoint since the dataset already exists.
2234
2410
  <dd>
2235
2411
 
2236
2412
  ```typescript
2237
- await client.datasets.uploadCsvToDataset({
2238
- file: fs.createReadStream("/path/to/your/file"),
2239
- dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2"
2413
+ await client.datasets.createDataset({
2414
+ name: "My Portfolio",
2415
+ description: "Companies in our investment portfolio",
2416
+ entity_ids: ["854198fa-f702-49db-a381-0427fa87f173", "a1b2c3d4-e5f6-7890-abcd-ef1234567890"]
2240
2417
  });
2241
2418
 
2242
2419
  ```
@@ -2253,7 +2430,7 @@ await client.datasets.uploadCsvToDataset({
2253
2430
  <dl>
2254
2431
  <dd>
2255
2432
 
2256
- **request:** `CatchAllApi.UploadCsvToDatasetRequest`
2433
+ **request:** `CatchAllApi.CreateDatasetRequest`
2257
2434
 
2258
2435
  </dd>
2259
2436
  </dl>
@@ -2269,6 +2446,1220 @@ await client.datasets.uploadCsvToDataset({
2269
2446
  </dl>
2270
2447
 
2271
2448
 
2449
+ </dd>
2450
+ </dl>
2451
+ </details>
2452
+
2453
+ <details><summary><code>client.datasets.<a href="/src/api/resources/datasets/client/Client.ts">createDatasetFromCsv</a>({ ...params }) -> CatchAllApi.CreateDatasetCsvResponse</code></summary>
2454
+ <dl>
2455
+ <dd>
2456
+
2457
+ #### 📝 Description
2458
+
2459
+ <dl>
2460
+ <dd>
2461
+
2462
+ <dl>
2463
+ <dd>
2464
+
2465
+ Creates a new dataset by uploading a CSV file. Each row in the CSV becomes an entity. The `name` and `domain`columns are required; all other columns are optional.
2466
+
2467
+ **CSV format:**
2468
+ ```csv
2469
+ name,description,domain,alternative_names,key_persons
2470
+ NewsCatcher,"AI-powered news data provider",newscatcherapi.com,"NC;NewsCatcher API","Artem Bugara;Maksym Sugonyaka"
2471
+ OpenAI,"Artificial intelligence research company",openai.com,"Open AI","Sam Altman"
2472
+ ```
2473
+
2474
+ Use semicolons (`;`) to separate multiple values in `alternative_names` and `key_persons`. Rows with empty `name` are skipped and reported in `validation_report`.
2475
+
2476
+ **Note**: The response shape differs from the JSON dataset creation endpoint: it returns `dataset_id` (not `id`) and includes a `validation_report` with details on skipped rows.
2477
+ </dd>
2478
+ </dl>
2479
+ </dd>
2480
+ </dl>
2481
+
2482
+ #### 🔌 Usage
2483
+
2484
+ <dl>
2485
+ <dd>
2486
+
2487
+ <dl>
2488
+ <dd>
2489
+
2490
+ ```typescript
2491
+ await client.datasets.createDatasetFromCsv({
2492
+ file: fs.createReadStream("/path/to/your/file"),
2493
+ name: "name"
2494
+ });
2495
+
2496
+ ```
2497
+ </dd>
2498
+ </dl>
2499
+ </dd>
2500
+ </dl>
2501
+
2502
+ #### ⚙️ Parameters
2503
+
2504
+ <dl>
2505
+ <dd>
2506
+
2507
+ <dl>
2508
+ <dd>
2509
+
2510
+ **request:** `CatchAllApi.CreateDatasetFromCsvRequest`
2511
+
2512
+ </dd>
2513
+ </dl>
2514
+
2515
+ <dl>
2516
+ <dd>
2517
+
2518
+ **requestOptions:** `DatasetsClient.RequestOptions`
2519
+
2520
+ </dd>
2521
+ </dl>
2522
+ </dd>
2523
+ </dl>
2524
+
2525
+
2526
+ </dd>
2527
+ </dl>
2528
+ </details>
2529
+
2530
+ <details><summary><code>client.datasets.<a href="/src/api/resources/datasets/client/Client.ts">getDataset</a>({ ...params }) -> CatchAllApi.DatasetResponse</code></summary>
2531
+ <dl>
2532
+ <dd>
2533
+
2534
+ #### 📝 Description
2535
+
2536
+ <dl>
2537
+ <dd>
2538
+
2539
+ <dl>
2540
+ <dd>
2541
+
2542
+ Returns a single dataset by ID including entity count and current status.
2543
+ </dd>
2544
+ </dl>
2545
+ </dd>
2546
+ </dl>
2547
+
2548
+ #### 🔌 Usage
2549
+
2550
+ <dl>
2551
+ <dd>
2552
+
2553
+ <dl>
2554
+ <dd>
2555
+
2556
+ ```typescript
2557
+ await client.datasets.getDataset({
2558
+ dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2"
2559
+ });
2560
+
2561
+ ```
2562
+ </dd>
2563
+ </dl>
2564
+ </dd>
2565
+ </dl>
2566
+
2567
+ #### ⚙️ Parameters
2568
+
2569
+ <dl>
2570
+ <dd>
2571
+
2572
+ <dl>
2573
+ <dd>
2574
+
2575
+ **request:** `CatchAllApi.GetDatasetRequest`
2576
+
2577
+ </dd>
2578
+ </dl>
2579
+
2580
+ <dl>
2581
+ <dd>
2582
+
2583
+ **requestOptions:** `DatasetsClient.RequestOptions`
2584
+
2585
+ </dd>
2586
+ </dl>
2587
+ </dd>
2588
+ </dl>
2589
+
2590
+
2591
+ </dd>
2592
+ </dl>
2593
+ </details>
2594
+
2595
+ <details><summary><code>client.datasets.<a href="/src/api/resources/datasets/client/Client.ts">deleteDataset</a>({ ...params }) -> void</code></summary>
2596
+ <dl>
2597
+ <dd>
2598
+
2599
+ #### 📝 Description
2600
+
2601
+ <dl>
2602
+ <dd>
2603
+
2604
+ <dl>
2605
+ <dd>
2606
+
2607
+ Permanently deletes a dataset. The entities within the dataset are
2608
+ not deleted — only the dataset itself. This operation cannot be
2609
+ undone.
2610
+ </dd>
2611
+ </dl>
2612
+ </dd>
2613
+ </dl>
2614
+
2615
+ #### 🔌 Usage
2616
+
2617
+ <dl>
2618
+ <dd>
2619
+
2620
+ <dl>
2621
+ <dd>
2622
+
2623
+ ```typescript
2624
+ await client.datasets.deleteDataset({
2625
+ dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2"
2626
+ });
2627
+
2628
+ ```
2629
+ </dd>
2630
+ </dl>
2631
+ </dd>
2632
+ </dl>
2633
+
2634
+ #### ⚙️ Parameters
2635
+
2636
+ <dl>
2637
+ <dd>
2638
+
2639
+ <dl>
2640
+ <dd>
2641
+
2642
+ **request:** `CatchAllApi.DeleteDatasetRequest`
2643
+
2644
+ </dd>
2645
+ </dl>
2646
+
2647
+ <dl>
2648
+ <dd>
2649
+
2650
+ **requestOptions:** `DatasetsClient.RequestOptions`
2651
+
2652
+ </dd>
2653
+ </dl>
2654
+ </dd>
2655
+ </dl>
2656
+
2657
+
2658
+ </dd>
2659
+ </dl>
2660
+ </details>
2661
+
2662
+ <details><summary><code>client.datasets.<a href="/src/api/resources/datasets/client/Client.ts">updateDataset</a>({ ...params }) -> CatchAllApi.DatasetResponse</code></summary>
2663
+ <dl>
2664
+ <dd>
2665
+
2666
+ #### 📝 Description
2667
+
2668
+ <dl>
2669
+ <dd>
2670
+
2671
+ <dl>
2672
+ <dd>
2673
+
2674
+ Updates the name or description of a dataset.
2675
+ </dd>
2676
+ </dl>
2677
+ </dd>
2678
+ </dl>
2679
+
2680
+ #### 🔌 Usage
2681
+
2682
+ <dl>
2683
+ <dd>
2684
+
2685
+ <dl>
2686
+ <dd>
2687
+
2688
+ ```typescript
2689
+ await client.datasets.updateDataset({
2690
+ dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2",
2691
+ name: "My Portfolio (updated)",
2692
+ description: "Updated Q1 2026 watchlist"
2693
+ });
2694
+
2695
+ ```
2696
+ </dd>
2697
+ </dl>
2698
+ </dd>
2699
+ </dl>
2700
+
2701
+ #### ⚙️ Parameters
2702
+
2703
+ <dl>
2704
+ <dd>
2705
+
2706
+ <dl>
2707
+ <dd>
2708
+
2709
+ **request:** `CatchAllApi.UpdateDatasetRequest`
2710
+
2711
+ </dd>
2712
+ </dl>
2713
+
2714
+ <dl>
2715
+ <dd>
2716
+
2717
+ **requestOptions:** `DatasetsClient.RequestOptions`
2718
+
2719
+ </dd>
2720
+ </dl>
2721
+ </dd>
2722
+ </dl>
2723
+
2724
+
2725
+ </dd>
2726
+ </dl>
2727
+ </details>
2728
+
2729
+ <details><summary><code>client.datasets.<a href="/src/api/resources/datasets/client/Client.ts">addEntitiesToDataset</a>({ ...params }) -> CatchAllApi.ManageEntitiesResponse</code></summary>
2730
+ <dl>
2731
+ <dd>
2732
+
2733
+ #### 📝 Description
2734
+
2735
+ <dl>
2736
+ <dd>
2737
+
2738
+ <dl>
2739
+ <dd>
2740
+
2741
+ Adds one or more existing entities to a dataset. Returns the number of entities added.
2742
+ </dd>
2743
+ </dl>
2744
+ </dd>
2745
+ </dl>
2746
+
2747
+ #### 🔌 Usage
2748
+
2749
+ <dl>
2750
+ <dd>
2751
+
2752
+ <dl>
2753
+ <dd>
2754
+
2755
+ ```typescript
2756
+ await client.datasets.addEntitiesToDataset({
2757
+ dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2",
2758
+ body: {
2759
+ entity_ids: ["854198fa-f702-49db-a381-0427fa87f173"]
2760
+ }
2761
+ });
2762
+
2763
+ ```
2764
+ </dd>
2765
+ </dl>
2766
+ </dd>
2767
+ </dl>
2768
+
2769
+ #### ⚙️ Parameters
2770
+
2771
+ <dl>
2772
+ <dd>
2773
+
2774
+ <dl>
2775
+ <dd>
2776
+
2777
+ **request:** `CatchAllApi.AddEntitiesToDatasetRequest`
2778
+
2779
+ </dd>
2780
+ </dl>
2781
+
2782
+ <dl>
2783
+ <dd>
2784
+
2785
+ **requestOptions:** `DatasetsClient.RequestOptions`
2786
+
2787
+ </dd>
2788
+ </dl>
2789
+ </dd>
2790
+ </dl>
2791
+
2792
+
2793
+ </dd>
2794
+ </dl>
2795
+ </details>
2796
+
2797
+ <details><summary><code>client.datasets.<a href="/src/api/resources/datasets/client/Client.ts">removeEntitiesFromDataset</a>({ ...params }) -> CatchAllApi.ManageEntitiesResponse</code></summary>
2798
+ <dl>
2799
+ <dd>
2800
+
2801
+ #### 📝 Description
2802
+
2803
+ <dl>
2804
+ <dd>
2805
+
2806
+ <dl>
2807
+ <dd>
2808
+
2809
+ Removes one or more entities from a dataset. The entities themselves are not deleted — they are only removed from this dataset. Returns the number of entities removed.
2810
+ </dd>
2811
+ </dl>
2812
+ </dd>
2813
+ </dl>
2814
+
2815
+ #### 🔌 Usage
2816
+
2817
+ <dl>
2818
+ <dd>
2819
+
2820
+ <dl>
2821
+ <dd>
2822
+
2823
+ ```typescript
2824
+ await client.datasets.removeEntitiesFromDataset({
2825
+ dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2",
2826
+ body: {
2827
+ entity_ids: ["854198fa-f702-49db-a381-0427fa87f173"]
2828
+ }
2829
+ });
2830
+
2831
+ ```
2832
+ </dd>
2833
+ </dl>
2834
+ </dd>
2835
+ </dl>
2836
+
2837
+ #### ⚙️ Parameters
2838
+
2839
+ <dl>
2840
+ <dd>
2841
+
2842
+ <dl>
2843
+ <dd>
2844
+
2845
+ **request:** `CatchAllApi.RemoveEntitiesFromDatasetRequest`
2846
+
2847
+ </dd>
2848
+ </dl>
2849
+
2850
+ <dl>
2851
+ <dd>
2852
+
2853
+ **requestOptions:** `DatasetsClient.RequestOptions`
2854
+
2855
+ </dd>
2856
+ </dl>
2857
+ </dd>
2858
+ </dl>
2859
+
2860
+
2861
+ </dd>
2862
+ </dl>
2863
+ </details>
2864
+
2865
+ <details><summary><code>client.datasets.<a href="/src/api/resources/datasets/client/Client.ts">listEntitiesInDataset</a>({ ...params }) -> CatchAllApi.DatasetEntityListResponse</code></summary>
2866
+ <dl>
2867
+ <dd>
2868
+
2869
+ #### 📝 Description
2870
+
2871
+ <dl>
2872
+ <dd>
2873
+
2874
+ <dl>
2875
+ <dd>
2876
+
2877
+ Returns a paginated list of entities in a dataset. Supports filtering by status, entity type, and name search.
2878
+ </dd>
2879
+ </dl>
2880
+ </dd>
2881
+ </dl>
2882
+
2883
+ #### 🔌 Usage
2884
+
2885
+ <dl>
2886
+ <dd>
2887
+
2888
+ <dl>
2889
+ <dd>
2890
+
2891
+ ```typescript
2892
+ await client.datasets.listEntitiesInDataset({
2893
+ dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2",
2894
+ page: 1,
2895
+ page_size: 100,
2896
+ search: "OpenAI",
2897
+ status: "ready",
2898
+ entity_type: "company",
2899
+ sort_by: "created_at",
2900
+ sort_order: "desc"
2901
+ });
2902
+
2903
+ ```
2904
+ </dd>
2905
+ </dl>
2906
+ </dd>
2907
+ </dl>
2908
+
2909
+ #### ⚙️ Parameters
2910
+
2911
+ <dl>
2912
+ <dd>
2913
+
2914
+ <dl>
2915
+ <dd>
2916
+
2917
+ **request:** `CatchAllApi.ListDatasetEntitiesRequest`
2918
+
2919
+ </dd>
2920
+ </dl>
2921
+
2922
+ <dl>
2923
+ <dd>
2924
+
2925
+ **requestOptions:** `DatasetsClient.RequestOptions`
2926
+
2927
+ </dd>
2928
+ </dl>
2929
+ </dd>
2930
+ </dl>
2931
+
2932
+
2933
+ </dd>
2934
+ </dl>
2935
+ </details>
2936
+
2937
+ <details><summary><code>client.datasets.<a href="/src/api/resources/datasets/client/Client.ts">getDatasetStatusHistory</a>({ ...params }) -> CatchAllApi.DatasetStatusHistoryResponse</code></summary>
2938
+ <dl>
2939
+ <dd>
2940
+
2941
+ #### 📝 Description
2942
+
2943
+ <dl>
2944
+ <dd>
2945
+
2946
+ <dl>
2947
+ <dd>
2948
+
2949
+ Returns the full status change history for a dataset, ordered chronologically from oldest to newest.
2950
+ </dd>
2951
+ </dl>
2952
+ </dd>
2953
+ </dl>
2954
+
2955
+ #### 🔌 Usage
2956
+
2957
+ <dl>
2958
+ <dd>
2959
+
2960
+ <dl>
2961
+ <dd>
2962
+
2963
+ ```typescript
2964
+ await client.datasets.getDatasetStatusHistory({
2965
+ dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2"
2966
+ });
2967
+
2968
+ ```
2969
+ </dd>
2970
+ </dl>
2971
+ </dd>
2972
+ </dl>
2973
+
2974
+ #### ⚙️ Parameters
2975
+
2976
+ <dl>
2977
+ <dd>
2978
+
2979
+ <dl>
2980
+ <dd>
2981
+
2982
+ **request:** `CatchAllApi.GetDatasetStatusHistoryRequest`
2983
+
2984
+ </dd>
2985
+ </dl>
2986
+
2987
+ <dl>
2988
+ <dd>
2989
+
2990
+ **requestOptions:** `DatasetsClient.RequestOptions`
2991
+
2992
+ </dd>
2993
+ </dl>
2994
+ </dd>
2995
+ </dl>
2996
+
2997
+
2998
+ </dd>
2999
+ </dl>
3000
+ </details>
3001
+
3002
+ <details><summary><code>client.datasets.<a href="/src/api/resources/datasets/client/Client.ts">uploadCsvToDataset</a>({ ...params }) -> CatchAllApi.UploadCsvToDatasetResponse</code></summary>
3003
+ <dl>
3004
+ <dd>
3005
+
3006
+ #### 📝 Description
3007
+
3008
+ <dl>
3009
+ <dd>
3010
+
3011
+ <dl>
3012
+ <dd>
3013
+
3014
+ Appends new companies to an existing dataset by uploading a CSV file. Uses the same CSV format as the dataset creation endpoint.
3015
+
3016
+ The response omits `dataset_name` compared to the create-from-CSV endpoint since the dataset already exists.
3017
+ </dd>
3018
+ </dl>
3019
+ </dd>
3020
+ </dl>
3021
+
3022
+ #### 🔌 Usage
3023
+
3024
+ <dl>
3025
+ <dd>
3026
+
3027
+ <dl>
3028
+ <dd>
3029
+
3030
+ ```typescript
3031
+ await client.datasets.uploadCsvToDataset({
3032
+ file: fs.createReadStream("/path/to/your/file"),
3033
+ dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2"
3034
+ });
3035
+
3036
+ ```
3037
+ </dd>
3038
+ </dl>
3039
+ </dd>
3040
+ </dl>
3041
+
3042
+ #### ⚙️ Parameters
3043
+
3044
+ <dl>
3045
+ <dd>
3046
+
3047
+ <dl>
3048
+ <dd>
3049
+
3050
+ **request:** `CatchAllApi.UploadCsvToDatasetRequest`
3051
+
3052
+ </dd>
3053
+ </dl>
3054
+
3055
+ <dl>
3056
+ <dd>
3057
+
3058
+ **requestOptions:** `DatasetsClient.RequestOptions`
3059
+
3060
+ </dd>
3061
+ </dl>
3062
+ </dd>
3063
+ </dl>
3064
+
3065
+
3066
+ </dd>
3067
+ </dl>
3068
+ </details>
3069
+
3070
+ ## Projects
3071
+ <details><summary><code>client.projects.<a href="/src/api/resources/projects/client/Client.ts">listProjects</a>({ ...params }) -> CatchAllApi.ProjectListResponseDto</code></summary>
3072
+ <dl>
3073
+ <dd>
3074
+
3075
+ #### 📝 Description
3076
+
3077
+ <dl>
3078
+ <dd>
3079
+
3080
+ <dl>
3081
+ <dd>
3082
+
3083
+ Returns all projects visible to the authenticated user.
3084
+ </dd>
3085
+ </dl>
3086
+ </dd>
3087
+ </dl>
3088
+
3089
+ #### 🔌 Usage
3090
+
3091
+ <dl>
3092
+ <dd>
3093
+
3094
+ <dl>
3095
+ <dd>
3096
+
3097
+ ```typescript
3098
+ await client.projects.listProjects({
3099
+ search: "M&A"
3100
+ });
3101
+
3102
+ ```
3103
+ </dd>
3104
+ </dl>
3105
+ </dd>
3106
+ </dl>
3107
+
3108
+ #### ⚙️ Parameters
3109
+
3110
+ <dl>
3111
+ <dd>
3112
+
3113
+ <dl>
3114
+ <dd>
3115
+
3116
+ **request:** `CatchAllApi.ListProjectsRequest`
3117
+
3118
+ </dd>
3119
+ </dl>
3120
+
3121
+ <dl>
3122
+ <dd>
3123
+
3124
+ **requestOptions:** `ProjectsClient.RequestOptions`
3125
+
3126
+ </dd>
3127
+ </dl>
3128
+ </dd>
3129
+ </dl>
3130
+
3131
+
3132
+ </dd>
3133
+ </dl>
3134
+ </details>
3135
+
3136
+ <details><summary><code>client.projects.<a href="/src/api/resources/projects/client/Client.ts">createProject</a>({ ...params }) -> CatchAllApi.CreateProjectResponseDto</code></summary>
3137
+ <dl>
3138
+ <dd>
3139
+
3140
+ #### 📝 Description
3141
+
3142
+ <dl>
3143
+ <dd>
3144
+
3145
+ <dl>
3146
+ <dd>
3147
+
3148
+ Creates a new project.
3149
+ </dd>
3150
+ </dl>
3151
+ </dd>
3152
+ </dl>
3153
+
3154
+ #### 🔌 Usage
3155
+
3156
+ <dl>
3157
+ <dd>
3158
+
3159
+ <dl>
3160
+ <dd>
3161
+
3162
+ ```typescript
3163
+ await client.projects.createProject({
3164
+ name: "AI M&A Tracking",
3165
+ description: "Tracks AI-related M&A activity for our investment team."
3166
+ });
3167
+
3168
+ ```
3169
+ </dd>
3170
+ </dl>
3171
+ </dd>
3172
+ </dl>
3173
+
3174
+ #### ⚙️ Parameters
3175
+
3176
+ <dl>
3177
+ <dd>
3178
+
3179
+ <dl>
3180
+ <dd>
3181
+
3182
+ **request:** `CatchAllApi.CreateProjectRequestDto`
3183
+
3184
+ </dd>
3185
+ </dl>
3186
+
3187
+ <dl>
3188
+ <dd>
3189
+
3190
+ **requestOptions:** `ProjectsClient.RequestOptions`
3191
+
3192
+ </dd>
3193
+ </dl>
3194
+ </dd>
3195
+ </dl>
3196
+
3197
+
3198
+ </dd>
3199
+ </dl>
3200
+ </details>
3201
+
3202
+ <details><summary><code>client.projects.<a href="/src/api/resources/projects/client/Client.ts">getProject</a>({ ...params }) -> CatchAllApi.ProjectResponseDto</code></summary>
3203
+ <dl>
3204
+ <dd>
3205
+
3206
+ #### 📝 Description
3207
+
3208
+ <dl>
3209
+ <dd>
3210
+
3211
+ <dl>
3212
+ <dd>
3213
+
3214
+ Returns a single project by ID.
3215
+ </dd>
3216
+ </dl>
3217
+ </dd>
3218
+ </dl>
3219
+
3220
+ #### 🔌 Usage
3221
+
3222
+ <dl>
3223
+ <dd>
3224
+
3225
+ <dl>
3226
+ <dd>
3227
+
3228
+ ```typescript
3229
+ await client.projects.getProject({
3230
+ project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04"
3231
+ });
3232
+
3233
+ ```
3234
+ </dd>
3235
+ </dl>
3236
+ </dd>
3237
+ </dl>
3238
+
3239
+ #### ⚙️ Parameters
3240
+
3241
+ <dl>
3242
+ <dd>
3243
+
3244
+ <dl>
3245
+ <dd>
3246
+
3247
+ **request:** `CatchAllApi.GetProjectRequest`
3248
+
3249
+ </dd>
3250
+ </dl>
3251
+
3252
+ <dl>
3253
+ <dd>
3254
+
3255
+ **requestOptions:** `ProjectsClient.RequestOptions`
3256
+
3257
+ </dd>
3258
+ </dl>
3259
+ </dd>
3260
+ </dl>
3261
+
3262
+
3263
+ </dd>
3264
+ </dl>
3265
+ </details>
3266
+
3267
+ <details><summary><code>client.projects.<a href="/src/api/resources/projects/client/Client.ts">deleteProject</a>({ ...params }) -> void</code></summary>
3268
+ <dl>
3269
+ <dd>
3270
+
3271
+ #### 📝 Description
3272
+
3273
+ <dl>
3274
+ <dd>
3275
+
3276
+ <dl>
3277
+ <dd>
3278
+
3279
+ Deletes a project. By default, assigned resources are unassigned but not deleted.
3280
+ </dd>
3281
+ </dl>
3282
+ </dd>
3283
+ </dl>
3284
+
3285
+ #### 🔌 Usage
3286
+
3287
+ <dl>
3288
+ <dd>
3289
+
3290
+ <dl>
3291
+ <dd>
3292
+
3293
+ ```typescript
3294
+ await client.projects.deleteProject({
3295
+ project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04"
3296
+ });
3297
+
3298
+ ```
3299
+ </dd>
3300
+ </dl>
3301
+ </dd>
3302
+ </dl>
3303
+
3304
+ #### ⚙️ Parameters
3305
+
3306
+ <dl>
3307
+ <dd>
3308
+
3309
+ <dl>
3310
+ <dd>
3311
+
3312
+ **request:** `CatchAllApi.DeleteProjectRequest`
3313
+
3314
+ </dd>
3315
+ </dl>
3316
+
3317
+ <dl>
3318
+ <dd>
3319
+
3320
+ **requestOptions:** `ProjectsClient.RequestOptions`
3321
+
3322
+ </dd>
3323
+ </dl>
3324
+ </dd>
3325
+ </dl>
3326
+
3327
+
3328
+ </dd>
3329
+ </dl>
3330
+ </details>
3331
+
3332
+ <details><summary><code>client.projects.<a href="/src/api/resources/projects/client/Client.ts">updateProject</a>({ ...params }) -> CatchAllApi.UpdateProjectResponseDto</code></summary>
3333
+ <dl>
3334
+ <dd>
3335
+
3336
+ #### 📝 Description
3337
+
3338
+ <dl>
3339
+ <dd>
3340
+
3341
+ <dl>
3342
+ <dd>
3343
+
3344
+ Updates the name or description of an existing project.
3345
+ </dd>
3346
+ </dl>
3347
+ </dd>
3348
+ </dl>
3349
+
3350
+ #### 🔌 Usage
3351
+
3352
+ <dl>
3353
+ <dd>
3354
+
3355
+ <dl>
3356
+ <dd>
3357
+
3358
+ ```typescript
3359
+ await client.projects.updateProject({
3360
+ project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04",
3361
+ name: "AI M&A Tracking (Q2 2026)"
3362
+ });
3363
+
3364
+ ```
3365
+ </dd>
3366
+ </dl>
3367
+ </dd>
3368
+ </dl>
3369
+
3370
+ #### ⚙️ Parameters
3371
+
3372
+ <dl>
3373
+ <dd>
3374
+
3375
+ <dl>
3376
+ <dd>
3377
+
3378
+ **request:** `CatchAllApi.UpdateProjectRequestDto`
3379
+
3380
+ </dd>
3381
+ </dl>
3382
+
3383
+ <dl>
3384
+ <dd>
3385
+
3386
+ **requestOptions:** `ProjectsClient.RequestOptions`
3387
+
3388
+ </dd>
3389
+ </dl>
3390
+ </dd>
3391
+ </dl>
3392
+
3393
+
3394
+ </dd>
3395
+ </dl>
3396
+ </details>
3397
+
3398
+ <details><summary><code>client.projects.<a href="/src/api/resources/projects/client/Client.ts">getProjectOverview</a>({ ...params }) -> CatchAllApi.ProjectOverviewResponseDto</code></summary>
3399
+ <dl>
3400
+ <dd>
3401
+
3402
+ #### 📝 Description
3403
+
3404
+ <dl>
3405
+ <dd>
3406
+
3407
+ <dl>
3408
+ <dd>
3409
+
3410
+ Returns resource counts for a project, grouped by type and status.
3411
+
3412
+ For `jobs` and `monitors`, counts are broken down by status (for example, `completed`, `failed`). For `datasets` and `monitor_groups`, only a `total` count is returned.
3413
+ </dd>
3414
+ </dl>
3415
+ </dd>
3416
+ </dl>
3417
+
3418
+ #### 🔌 Usage
3419
+
3420
+ <dl>
3421
+ <dd>
3422
+
3423
+ <dl>
3424
+ <dd>
3425
+
3426
+ ```typescript
3427
+ await client.projects.getProjectOverview({
3428
+ project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04"
3429
+ });
3430
+
3431
+ ```
3432
+ </dd>
3433
+ </dl>
3434
+ </dd>
3435
+ </dl>
3436
+
3437
+ #### ⚙️ Parameters
3438
+
3439
+ <dl>
3440
+ <dd>
3441
+
3442
+ <dl>
3443
+ <dd>
3444
+
3445
+ **request:** `CatchAllApi.GetProjectOverviewRequest`
3446
+
3447
+ </dd>
3448
+ </dl>
3449
+
3450
+ <dl>
3451
+ <dd>
3452
+
3453
+ **requestOptions:** `ProjectsClient.RequestOptions`
3454
+
3455
+ </dd>
3456
+ </dl>
3457
+ </dd>
3458
+ </dl>
3459
+
3460
+
3461
+ </dd>
3462
+ </dl>
3463
+ </details>
3464
+
3465
+ <details><summary><code>client.projects.<a href="/src/api/resources/projects/client/Client.ts">listProjectResources</a>({ ...params }) -> CatchAllApi.ProjectResourceListResponseDto</code></summary>
3466
+ <dl>
3467
+ <dd>
3468
+
3469
+ #### 📝 Description
3470
+
3471
+ <dl>
3472
+ <dd>
3473
+
3474
+ <dl>
3475
+ <dd>
3476
+
3477
+ Returns all resources assigned to a project, with optional filtering by type.
3478
+ </dd>
3479
+ </dl>
3480
+ </dd>
3481
+ </dl>
3482
+
3483
+ #### 🔌 Usage
3484
+
3485
+ <dl>
3486
+ <dd>
3487
+
3488
+ <dl>
3489
+ <dd>
3490
+
3491
+ ```typescript
3492
+ await client.projects.listProjectResources({
3493
+ project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04"
3494
+ });
3495
+
3496
+ ```
3497
+ </dd>
3498
+ </dl>
3499
+ </dd>
3500
+ </dl>
3501
+
3502
+ #### ⚙️ Parameters
3503
+
3504
+ <dl>
3505
+ <dd>
3506
+
3507
+ <dl>
3508
+ <dd>
3509
+
3510
+ **request:** `CatchAllApi.ListProjectResourcesRequest`
3511
+
3512
+ </dd>
3513
+ </dl>
3514
+
3515
+ <dl>
3516
+ <dd>
3517
+
3518
+ **requestOptions:** `ProjectsClient.RequestOptions`
3519
+
3520
+ </dd>
3521
+ </dl>
3522
+ </dd>
3523
+ </dl>
3524
+
3525
+
3526
+ </dd>
3527
+ </dl>
3528
+ </details>
3529
+
3530
+ <details><summary><code>client.projects.<a href="/src/api/resources/projects/client/Client.ts">addResourceToProject</a>({ ...params }) -> CatchAllApi.AddResourceResponseDto</code></summary>
3531
+ <dl>
3532
+ <dd>
3533
+
3534
+ #### 📝 Description
3535
+
3536
+ <dl>
3537
+ <dd>
3538
+
3539
+ <dl>
3540
+ <dd>
3541
+
3542
+ Assigns one or more existing resources to a project in a single request.
3543
+ </dd>
3544
+ </dl>
3545
+ </dd>
3546
+ </dl>
3547
+
3548
+ #### 🔌 Usage
3549
+
3550
+ <dl>
3551
+ <dd>
3552
+
3553
+ <dl>
3554
+ <dd>
3555
+
3556
+ ```typescript
3557
+ await client.projects.addResourceToProject({
3558
+ project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04",
3559
+ resources: [{
3560
+ resource_type: "job",
3561
+ resource_id: "48421e16-1f50-4048-b62c-d3bc0789d30d"
3562
+ }]
3563
+ });
3564
+
3565
+ ```
3566
+ </dd>
3567
+ </dl>
3568
+ </dd>
3569
+ </dl>
3570
+
3571
+ #### ⚙️ Parameters
3572
+
3573
+ <dl>
3574
+ <dd>
3575
+
3576
+ <dl>
3577
+ <dd>
3578
+
3579
+ **request:** `CatchAllApi.AddResourceRequestDto`
3580
+
3581
+ </dd>
3582
+ </dl>
3583
+
3584
+ <dl>
3585
+ <dd>
3586
+
3587
+ **requestOptions:** `ProjectsClient.RequestOptions`
3588
+
3589
+ </dd>
3590
+ </dl>
3591
+ </dd>
3592
+ </dl>
3593
+
3594
+
3595
+ </dd>
3596
+ </dl>
3597
+ </details>
3598
+
3599
+ <details><summary><code>client.projects.<a href="/src/api/resources/projects/client/Client.ts">removeResourceFromProject</a>({ ...params }) -> CatchAllApi.RemoveResourceResponseDto</code></summary>
3600
+ <dl>
3601
+ <dd>
3602
+
3603
+ #### 📝 Description
3604
+
3605
+ <dl>
3606
+ <dd>
3607
+
3608
+ <dl>
3609
+ <dd>
3610
+
3611
+ Removes a resource from a project. The resource itself is not
3612
+ deleted — it becomes unassigned and continues to exist.
3613
+ </dd>
3614
+ </dl>
3615
+ </dd>
3616
+ </dl>
3617
+
3618
+ #### 🔌 Usage
3619
+
3620
+ <dl>
3621
+ <dd>
3622
+
3623
+ <dl>
3624
+ <dd>
3625
+
3626
+ ```typescript
3627
+ await client.projects.removeResourceFromProject({
3628
+ project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04",
3629
+ resource_type: "job",
3630
+ resource_id: "48421e16-1f50-4048-b62c-d3bc0789d30d"
3631
+ });
3632
+
3633
+ ```
3634
+ </dd>
3635
+ </dl>
3636
+ </dd>
3637
+ </dl>
3638
+
3639
+ #### ⚙️ Parameters
3640
+
3641
+ <dl>
3642
+ <dd>
3643
+
3644
+ <dl>
3645
+ <dd>
3646
+
3647
+ **request:** `CatchAllApi.RemoveResourceFromProjectRequest`
3648
+
3649
+ </dd>
3650
+ </dl>
3651
+
3652
+ <dl>
3653
+ <dd>
3654
+
3655
+ **requestOptions:** `ProjectsClient.RequestOptions`
3656
+
3657
+ </dd>
3658
+ </dl>
3659
+ </dd>
3660
+ </dl>
3661
+
3662
+
2272
3663
  </dd>
2273
3664
  </dl>
2274
3665
  </details>