newscatcher-catchall-sdk 2.0.0 → 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.
- package/README.md +1 -0
- package/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/Client.d.ts +6 -0
- package/dist/cjs/Client.js +10 -0
- package/dist/cjs/api/resources/datasets/client/Client.d.ts +2 -1
- package/dist/cjs/api/resources/datasets/client/Client.js +4 -2
- package/dist/cjs/api/resources/datasets/client/requests/ListDatasetsRequest.d.ts +4 -1
- package/dist/cjs/api/resources/index.d.ts +5 -0
- package/dist/cjs/api/resources/index.js +6 -1
- package/dist/cjs/api/resources/jobs/client/Client.d.ts +21 -1
- package/dist/cjs/api/resources/jobs/client/Client.js +63 -2
- package/dist/cjs/api/resources/jobs/client/requests/GetUserJobsRequest.d.ts +5 -1
- package/dist/cjs/api/resources/jobs/client/requests/SubmitRequestDto.d.ts +4 -0
- package/dist/cjs/api/resources/jobs/client/requests/ValidateQueryRequestDto.d.ts +10 -0
- package/dist/cjs/api/resources/jobs/client/requests/ValidateQueryRequestDto.js +3 -0
- package/dist/cjs/api/resources/jobs/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/monitors/client/Client.d.ts +5 -15
- package/dist/cjs/api/resources/monitors/client/Client.js +7 -16
- package/dist/cjs/api/resources/monitors/client/requests/CreateMonitorRequestDto.d.ts +10 -10
- package/dist/cjs/api/resources/monitors/client/requests/ListMonitorsRequest.d.ts +5 -1
- package/dist/cjs/api/resources/monitors/client/requests/UpdateMonitorRequestDto.d.ts +7 -10
- package/dist/cjs/api/resources/monitors/types/DisableMonitorResponse.d.ts +1 -1
- package/dist/cjs/api/resources/monitors/types/EnableMonitorResponse.d.ts +1 -1
- package/dist/cjs/api/resources/projects/client/Client.d.ts +178 -0
- package/dist/cjs/api/resources/projects/client/Client.js +626 -0
- package/dist/cjs/api/resources/projects/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/projects/client/index.js +17 -0
- package/dist/cjs/api/resources/projects/client/requests/AddResourceRequestDto.d.ts +17 -0
- package/dist/cjs/api/resources/projects/client/requests/AddResourceRequestDto.js +3 -0
- package/dist/cjs/api/resources/projects/client/requests/CreateProjectRequestDto.d.ts +13 -0
- package/dist/cjs/api/resources/projects/client/requests/CreateProjectRequestDto.js +3 -0
- package/dist/cjs/api/resources/projects/client/requests/DeleteProjectRequest.d.ts +12 -0
- package/dist/cjs/api/resources/projects/client/requests/DeleteProjectRequest.js +3 -0
- package/dist/cjs/api/resources/projects/client/requests/GetProjectOverviewRequest.d.ts +10 -0
- package/dist/cjs/api/resources/projects/client/requests/GetProjectOverviewRequest.js +3 -0
- package/dist/cjs/api/resources/projects/client/requests/GetProjectRequest.d.ts +10 -0
- package/dist/cjs/api/resources/projects/client/requests/GetProjectRequest.js +3 -0
- package/dist/cjs/api/resources/projects/client/requests/ListProjectResourcesRequest.d.ts +16 -0
- package/dist/cjs/api/resources/projects/client/requests/ListProjectResourcesRequest.js +3 -0
- package/dist/cjs/api/resources/projects/client/requests/ListProjectsRequest.d.ts +16 -0
- package/dist/cjs/api/resources/projects/client/requests/ListProjectsRequest.js +3 -0
- package/dist/cjs/api/resources/projects/client/requests/RemoveResourceFromProjectRequest.d.ts +16 -0
- package/dist/cjs/api/resources/projects/client/requests/RemoveResourceFromProjectRequest.js +3 -0
- package/dist/cjs/api/resources/projects/client/requests/UpdateProjectRequestDto.d.ts +15 -0
- package/dist/cjs/api/resources/projects/client/requests/UpdateProjectRequestDto.js +3 -0
- package/dist/cjs/api/resources/projects/client/requests/index.d.ts +9 -0
- package/dist/cjs/api/resources/projects/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/projects/exports.d.ts +2 -0
- package/dist/cjs/api/resources/projects/exports.js +21 -0
- package/dist/cjs/api/resources/projects/index.d.ts +1 -0
- package/dist/cjs/api/resources/projects/index.js +17 -0
- package/dist/cjs/api/resources/webhooks/client/Client.d.ts +231 -0
- package/dist/cjs/api/resources/webhooks/client/Client.js +779 -0
- package/dist/cjs/api/resources/webhooks/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/webhooks/client/index.js +17 -0
- package/dist/cjs/api/resources/webhooks/client/requests/AssignWebhookResourceRequestDto.d.ts +17 -0
- package/dist/cjs/api/resources/webhooks/client/requests/AssignWebhookResourceRequestDto.js +3 -0
- package/dist/cjs/api/resources/webhooks/client/requests/CreateWebhookRequestDto.d.ts +42 -0
- package/dist/cjs/api/resources/webhooks/client/requests/CreateWebhookRequestDto.js +3 -0
- package/dist/cjs/api/resources/webhooks/client/requests/DeleteWebhookRequest.d.ts +10 -0
- package/dist/cjs/api/resources/webhooks/client/requests/DeleteWebhookRequest.js +3 -0
- package/dist/cjs/api/resources/webhooks/client/requests/GetWebhookDeliveryHistoryRequest.d.ts +18 -0
- package/dist/cjs/api/resources/webhooks/client/requests/GetWebhookDeliveryHistoryRequest.js +3 -0
- package/dist/cjs/api/resources/webhooks/client/requests/GetWebhookRequest.d.ts +10 -0
- package/dist/cjs/api/resources/webhooks/client/requests/GetWebhookRequest.js +3 -0
- package/dist/cjs/api/resources/webhooks/client/requests/ListWebhookResourcesRequest.d.ts +16 -0
- package/dist/cjs/api/resources/webhooks/client/requests/ListWebhookResourcesRequest.js +3 -0
- package/dist/cjs/api/resources/webhooks/client/requests/ListWebhooksForResourceRequest.d.ts +19 -0
- package/dist/cjs/api/resources/webhooks/client/requests/ListWebhooksForResourceRequest.js +3 -0
- package/dist/cjs/api/resources/webhooks/client/requests/ListWebhooksRequest.d.ts +12 -0
- package/dist/cjs/api/resources/webhooks/client/requests/ListWebhooksRequest.js +3 -0
- package/dist/cjs/api/resources/webhooks/client/requests/RemoveWebhookResourceRequest.d.ts +16 -0
- package/dist/cjs/api/resources/webhooks/client/requests/RemoveWebhookResourceRequest.js +3 -0
- package/dist/cjs/api/resources/webhooks/client/requests/TestWebhookRequestDto.d.ts +19 -0
- package/dist/cjs/api/resources/webhooks/client/requests/TestWebhookRequestDto.js +3 -0
- package/dist/cjs/api/resources/webhooks/client/requests/UpdateWebhookRequestDto.d.ts +30 -0
- package/dist/cjs/api/resources/webhooks/client/requests/UpdateWebhookRequestDto.js +3 -0
- package/dist/cjs/api/resources/webhooks/client/requests/index.d.ts +11 -0
- package/dist/cjs/api/resources/webhooks/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/webhooks/exports.d.ts +2 -0
- package/dist/cjs/api/resources/webhooks/exports.js +21 -0
- package/dist/cjs/api/resources/webhooks/index.d.ts +2 -0
- package/dist/cjs/api/resources/webhooks/index.js +18 -0
- package/dist/cjs/api/resources/webhooks/types/CreateWebhookRequestDtoAuth.d.ts +19 -0
- package/dist/cjs/api/resources/webhooks/types/CreateWebhookRequestDtoAuth.js +3 -0
- package/dist/cjs/api/resources/webhooks/types/UpdateWebhookRequestDtoAuth.d.ts +16 -0
- package/dist/cjs/api/resources/webhooks/types/UpdateWebhookRequestDtoAuth.js +3 -0
- package/dist/cjs/api/resources/webhooks/types/index.d.ts +2 -0
- package/dist/cjs/api/resources/webhooks/types/index.js +18 -0
- package/dist/cjs/api/types/AddResourceResponseDto.d.ts +9 -0
- package/dist/cjs/api/types/AddResourceResponseDto.js +3 -0
- package/dist/cjs/api/types/ApiKeyAuthDto.d.ts +6 -0
- package/dist/cjs/api/types/ApiKeyAuthDto.js +3 -0
- package/dist/cjs/api/types/AssignWebhookResourceResponseDto.d.ts +11 -0
- package/dist/cjs/api/types/AssignWebhookResourceResponseDto.js +3 -0
- package/dist/cjs/api/types/BasicAuthDto.d.ts +6 -0
- package/dist/cjs/api/types/BasicAuthDto.js +3 -0
- package/dist/cjs/api/types/BearerAuthDto.d.ts +4 -0
- package/dist/cjs/api/types/BearerAuthDto.js +3 -0
- package/dist/cjs/api/types/ConnectedEntity.d.ts +1 -1
- package/dist/cjs/api/types/CreateProjectResponseDto.d.ts +10 -0
- package/dist/cjs/api/types/CreateProjectResponseDto.js +3 -0
- package/dist/cjs/api/types/CreateWebhookResponseDto.d.ts +9 -0
- package/dist/cjs/api/types/CreateWebhookResponseDto.js +3 -0
- package/dist/cjs/api/types/DeleteJobResponseDto.d.ts +1 -1
- package/dist/cjs/api/types/DeleteMonitorResponseDto.d.ts +1 -1
- package/dist/cjs/api/types/DeliveryHistoryItemDto.d.ts +25 -0
- package/dist/cjs/api/types/DeliveryHistoryItemDto.js +3 -0
- package/dist/cjs/api/types/DeliveryHistoryResponseDto.d.ts +17 -0
- package/dist/cjs/api/types/DeliveryHistoryResponseDto.js +3 -0
- package/dist/cjs/api/types/DeliveryMode.d.ts +11 -0
- package/dist/cjs/api/types/DeliveryMode.js +14 -0
- package/dist/cjs/api/types/DeliveryStatus.d.ts +6 -0
- package/dist/cjs/api/types/DeliveryStatus.js +9 -0
- package/dist/cjs/api/types/GetWebhookResponseDto.d.ts +9 -0
- package/dist/cjs/api/types/GetWebhookResponseDto.js +3 -0
- package/dist/cjs/api/types/HttpMethod.d.ts +9 -0
- package/dist/cjs/api/types/HttpMethod.js +12 -0
- package/dist/cjs/api/types/IssueType.d.ts +25 -0
- package/dist/cjs/api/types/IssueType.js +28 -0
- package/dist/cjs/api/types/JobStep.d.ts +1 -1
- package/dist/cjs/api/types/ListWebhookResourcesResponseDto.d.ts +13 -0
- package/dist/cjs/api/types/ListWebhookResourcesResponseDto.js +3 -0
- package/dist/cjs/api/types/ListWebhooksResponseDto.d.ts +13 -0
- package/dist/cjs/api/types/ListWebhooksResponseDto.js +3 -0
- package/dist/cjs/api/types/MappableResourceType.d.ts +7 -0
- package/dist/cjs/api/types/MappableResourceType.js +10 -0
- package/dist/cjs/api/types/MonitorListItemDto.d.ts +1 -1
- package/dist/cjs/api/types/MonitorStatusHistoryResponseDto.d.ts +1 -1
- package/dist/cjs/api/types/ProjectListResponseDto.d.ts +13 -0
- package/dist/cjs/api/types/ProjectListResponseDto.js +3 -0
- package/dist/cjs/api/types/ProjectOverviewCountsDto.d.ts +4 -0
- package/dist/cjs/api/types/ProjectOverviewCountsDto.js +3 -0
- package/dist/cjs/api/types/ProjectOverviewResponseDto.d.ts +18 -0
- package/dist/cjs/api/types/ProjectOverviewResponseDto.js +3 -0
- package/dist/cjs/api/types/ProjectResourceDto.d.ts +18 -0
- package/dist/cjs/api/types/ProjectResourceDto.js +3 -0
- package/dist/cjs/api/types/ProjectResourceListResponseDto.d.ts +13 -0
- package/dist/cjs/api/types/ProjectResourceListResponseDto.js +3 -0
- package/dist/cjs/api/types/ProjectResourceType.d.ts +8 -0
- package/dist/cjs/api/types/ProjectResourceType.js +11 -0
- package/dist/cjs/api/types/ProjectResponseDto.d.ts +18 -0
- package/dist/cjs/api/types/ProjectResponseDto.js +3 -0
- package/dist/cjs/api/types/ProjectSummaryDto.d.ts +17 -0
- package/dist/cjs/api/types/ProjectSummaryDto.js +3 -0
- package/dist/cjs/api/types/QueryStatus.d.ts +13 -0
- package/dist/cjs/api/types/QueryStatus.js +16 -0
- package/dist/cjs/api/types/RemoveResourceResponseDto.d.ts +6 -0
- package/dist/cjs/api/types/RemoveResourceResponseDto.js +3 -0
- package/dist/cjs/api/types/ResourceItemDto.d.ts +6 -0
- package/dist/cjs/api/types/ResourceItemDto.js +3 -0
- package/dist/cjs/api/types/ResourceResultDto.d.ts +12 -0
- package/dist/cjs/api/types/ResourceResultDto.js +3 -0
- package/dist/cjs/api/types/Suggestion.d.ts +12 -0
- package/dist/cjs/api/types/Suggestion.js +3 -0
- package/dist/cjs/api/types/TestWebhookResponseDto.d.ts +10 -0
- package/dist/cjs/api/types/TestWebhookResponseDto.js +3 -0
- package/dist/cjs/api/types/UpdateProjectResponseDto.d.ts +8 -0
- package/dist/cjs/api/types/UpdateProjectResponseDto.js +3 -0
- package/dist/cjs/api/types/UpdateWebhookResponseDto.d.ts +9 -0
- package/dist/cjs/api/types/UpdateWebhookResponseDto.js +3 -0
- package/dist/cjs/api/types/ValidateQueryResponseDto.d.ts +18 -0
- package/dist/cjs/api/types/ValidateQueryResponseDto.js +3 -0
- package/dist/cjs/api/types/WebhookResourceMappingResponseDto.d.ts +12 -0
- package/dist/cjs/api/types/WebhookResourceMappingResponseDto.js +3 -0
- package/dist/cjs/api/types/WebhookResponseDto.d.ts +28 -0
- package/dist/cjs/api/types/WebhookResponseDto.js +3 -0
- package/dist/cjs/api/types/WebhookType.d.ts +17 -0
- package/dist/cjs/api/types/WebhookType.js +20 -0
- package/dist/cjs/api/types/index.d.ts +37 -0
- package/dist/cjs/api/types/index.js +37 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/Client.d.mts +6 -0
- package/dist/esm/Client.mjs +10 -0
- package/dist/esm/api/resources/datasets/client/Client.d.mts +2 -1
- package/dist/esm/api/resources/datasets/client/Client.mjs +4 -2
- package/dist/esm/api/resources/datasets/client/requests/ListDatasetsRequest.d.mts +4 -1
- package/dist/esm/api/resources/index.d.mts +5 -0
- package/dist/esm/api/resources/index.mjs +5 -0
- package/dist/esm/api/resources/jobs/client/Client.d.mts +21 -1
- package/dist/esm/api/resources/jobs/client/Client.mjs +63 -2
- package/dist/esm/api/resources/jobs/client/requests/GetUserJobsRequest.d.mts +5 -1
- package/dist/esm/api/resources/jobs/client/requests/SubmitRequestDto.d.mts +4 -0
- package/dist/esm/api/resources/jobs/client/requests/ValidateQueryRequestDto.d.mts +10 -0
- package/dist/esm/api/resources/jobs/client/requests/ValidateQueryRequestDto.mjs +2 -0
- package/dist/esm/api/resources/jobs/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/monitors/client/Client.d.mts +5 -15
- package/dist/esm/api/resources/monitors/client/Client.mjs +7 -16
- package/dist/esm/api/resources/monitors/client/requests/CreateMonitorRequestDto.d.mts +10 -10
- package/dist/esm/api/resources/monitors/client/requests/ListMonitorsRequest.d.mts +5 -1
- package/dist/esm/api/resources/monitors/client/requests/UpdateMonitorRequestDto.d.mts +7 -10
- package/dist/esm/api/resources/monitors/types/DisableMonitorResponse.d.mts +1 -1
- package/dist/esm/api/resources/monitors/types/EnableMonitorResponse.d.mts +1 -1
- package/dist/esm/api/resources/projects/client/Client.d.mts +178 -0
- package/dist/esm/api/resources/projects/client/Client.mjs +589 -0
- package/dist/esm/api/resources/projects/client/index.d.mts +1 -0
- package/dist/esm/api/resources/projects/client/index.mjs +1 -0
- package/dist/esm/api/resources/projects/client/requests/AddResourceRequestDto.d.mts +17 -0
- package/dist/esm/api/resources/projects/client/requests/AddResourceRequestDto.mjs +2 -0
- package/dist/esm/api/resources/projects/client/requests/CreateProjectRequestDto.d.mts +13 -0
- package/dist/esm/api/resources/projects/client/requests/CreateProjectRequestDto.mjs +2 -0
- package/dist/esm/api/resources/projects/client/requests/DeleteProjectRequest.d.mts +12 -0
- package/dist/esm/api/resources/projects/client/requests/DeleteProjectRequest.mjs +2 -0
- package/dist/esm/api/resources/projects/client/requests/GetProjectOverviewRequest.d.mts +10 -0
- package/dist/esm/api/resources/projects/client/requests/GetProjectOverviewRequest.mjs +2 -0
- package/dist/esm/api/resources/projects/client/requests/GetProjectRequest.d.mts +10 -0
- package/dist/esm/api/resources/projects/client/requests/GetProjectRequest.mjs +2 -0
- package/dist/esm/api/resources/projects/client/requests/ListProjectResourcesRequest.d.mts +16 -0
- package/dist/esm/api/resources/projects/client/requests/ListProjectResourcesRequest.mjs +2 -0
- package/dist/esm/api/resources/projects/client/requests/ListProjectsRequest.d.mts +16 -0
- package/dist/esm/api/resources/projects/client/requests/ListProjectsRequest.mjs +2 -0
- package/dist/esm/api/resources/projects/client/requests/RemoveResourceFromProjectRequest.d.mts +16 -0
- package/dist/esm/api/resources/projects/client/requests/RemoveResourceFromProjectRequest.mjs +2 -0
- package/dist/esm/api/resources/projects/client/requests/UpdateProjectRequestDto.d.mts +15 -0
- package/dist/esm/api/resources/projects/client/requests/UpdateProjectRequestDto.mjs +2 -0
- package/dist/esm/api/resources/projects/client/requests/index.d.mts +9 -0
- package/dist/esm/api/resources/projects/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/projects/exports.d.mts +2 -0
- package/dist/esm/api/resources/projects/exports.mjs +3 -0
- package/dist/esm/api/resources/projects/index.d.mts +1 -0
- package/dist/esm/api/resources/projects/index.mjs +1 -0
- package/dist/esm/api/resources/webhooks/client/Client.d.mts +231 -0
- package/dist/esm/api/resources/webhooks/client/Client.mjs +742 -0
- package/dist/esm/api/resources/webhooks/client/index.d.mts +1 -0
- package/dist/esm/api/resources/webhooks/client/index.mjs +1 -0
- package/dist/esm/api/resources/webhooks/client/requests/AssignWebhookResourceRequestDto.d.mts +17 -0
- package/dist/esm/api/resources/webhooks/client/requests/AssignWebhookResourceRequestDto.mjs +2 -0
- package/dist/esm/api/resources/webhooks/client/requests/CreateWebhookRequestDto.d.mts +42 -0
- package/dist/esm/api/resources/webhooks/client/requests/CreateWebhookRequestDto.mjs +2 -0
- package/dist/esm/api/resources/webhooks/client/requests/DeleteWebhookRequest.d.mts +10 -0
- package/dist/esm/api/resources/webhooks/client/requests/DeleteWebhookRequest.mjs +2 -0
- package/dist/esm/api/resources/webhooks/client/requests/GetWebhookDeliveryHistoryRequest.d.mts +18 -0
- package/dist/esm/api/resources/webhooks/client/requests/GetWebhookDeliveryHistoryRequest.mjs +2 -0
- package/dist/esm/api/resources/webhooks/client/requests/GetWebhookRequest.d.mts +10 -0
- package/dist/esm/api/resources/webhooks/client/requests/GetWebhookRequest.mjs +2 -0
- package/dist/esm/api/resources/webhooks/client/requests/ListWebhookResourcesRequest.d.mts +16 -0
- package/dist/esm/api/resources/webhooks/client/requests/ListWebhookResourcesRequest.mjs +2 -0
- package/dist/esm/api/resources/webhooks/client/requests/ListWebhooksForResourceRequest.d.mts +19 -0
- package/dist/esm/api/resources/webhooks/client/requests/ListWebhooksForResourceRequest.mjs +2 -0
- package/dist/esm/api/resources/webhooks/client/requests/ListWebhooksRequest.d.mts +12 -0
- package/dist/esm/api/resources/webhooks/client/requests/ListWebhooksRequest.mjs +2 -0
- package/dist/esm/api/resources/webhooks/client/requests/RemoveWebhookResourceRequest.d.mts +16 -0
- package/dist/esm/api/resources/webhooks/client/requests/RemoveWebhookResourceRequest.mjs +2 -0
- package/dist/esm/api/resources/webhooks/client/requests/TestWebhookRequestDto.d.mts +19 -0
- package/dist/esm/api/resources/webhooks/client/requests/TestWebhookRequestDto.mjs +2 -0
- package/dist/esm/api/resources/webhooks/client/requests/UpdateWebhookRequestDto.d.mts +30 -0
- package/dist/esm/api/resources/webhooks/client/requests/UpdateWebhookRequestDto.mjs +2 -0
- package/dist/esm/api/resources/webhooks/client/requests/index.d.mts +11 -0
- package/dist/esm/api/resources/webhooks/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/webhooks/exports.d.mts +2 -0
- package/dist/esm/api/resources/webhooks/exports.mjs +3 -0
- package/dist/esm/api/resources/webhooks/index.d.mts +2 -0
- package/dist/esm/api/resources/webhooks/index.mjs +2 -0
- package/dist/esm/api/resources/webhooks/types/CreateWebhookRequestDtoAuth.d.mts +19 -0
- package/dist/esm/api/resources/webhooks/types/CreateWebhookRequestDtoAuth.mjs +2 -0
- package/dist/esm/api/resources/webhooks/types/UpdateWebhookRequestDtoAuth.d.mts +16 -0
- package/dist/esm/api/resources/webhooks/types/UpdateWebhookRequestDtoAuth.mjs +2 -0
- package/dist/esm/api/resources/webhooks/types/index.d.mts +2 -0
- package/dist/esm/api/resources/webhooks/types/index.mjs +2 -0
- package/dist/esm/api/types/AddResourceResponseDto.d.mts +9 -0
- package/dist/esm/api/types/AddResourceResponseDto.mjs +2 -0
- package/dist/esm/api/types/ApiKeyAuthDto.d.mts +6 -0
- package/dist/esm/api/types/ApiKeyAuthDto.mjs +2 -0
- package/dist/esm/api/types/AssignWebhookResourceResponseDto.d.mts +11 -0
- package/dist/esm/api/types/AssignWebhookResourceResponseDto.mjs +2 -0
- package/dist/esm/api/types/BasicAuthDto.d.mts +6 -0
- package/dist/esm/api/types/BasicAuthDto.mjs +2 -0
- package/dist/esm/api/types/BearerAuthDto.d.mts +4 -0
- package/dist/esm/api/types/BearerAuthDto.mjs +2 -0
- package/dist/esm/api/types/ConnectedEntity.d.mts +1 -1
- package/dist/esm/api/types/CreateProjectResponseDto.d.mts +10 -0
- package/dist/esm/api/types/CreateProjectResponseDto.mjs +2 -0
- package/dist/esm/api/types/CreateWebhookResponseDto.d.mts +9 -0
- package/dist/esm/api/types/CreateWebhookResponseDto.mjs +2 -0
- package/dist/esm/api/types/DeleteJobResponseDto.d.mts +1 -1
- package/dist/esm/api/types/DeleteMonitorResponseDto.d.mts +1 -1
- package/dist/esm/api/types/DeliveryHistoryItemDto.d.mts +25 -0
- package/dist/esm/api/types/DeliveryHistoryItemDto.mjs +2 -0
- package/dist/esm/api/types/DeliveryHistoryResponseDto.d.mts +17 -0
- package/dist/esm/api/types/DeliveryHistoryResponseDto.mjs +2 -0
- package/dist/esm/api/types/DeliveryMode.d.mts +11 -0
- package/dist/esm/api/types/DeliveryMode.mjs +11 -0
- package/dist/esm/api/types/DeliveryStatus.d.mts +6 -0
- package/dist/esm/api/types/DeliveryStatus.mjs +6 -0
- package/dist/esm/api/types/GetWebhookResponseDto.d.mts +9 -0
- package/dist/esm/api/types/GetWebhookResponseDto.mjs +2 -0
- package/dist/esm/api/types/HttpMethod.d.mts +9 -0
- package/dist/esm/api/types/HttpMethod.mjs +9 -0
- package/dist/esm/api/types/IssueType.d.mts +25 -0
- package/dist/esm/api/types/IssueType.mjs +25 -0
- package/dist/esm/api/types/JobStep.d.mts +1 -1
- package/dist/esm/api/types/ListWebhookResourcesResponseDto.d.mts +13 -0
- package/dist/esm/api/types/ListWebhookResourcesResponseDto.mjs +2 -0
- package/dist/esm/api/types/ListWebhooksResponseDto.d.mts +13 -0
- package/dist/esm/api/types/ListWebhooksResponseDto.mjs +2 -0
- package/dist/esm/api/types/MappableResourceType.d.mts +7 -0
- package/dist/esm/api/types/MappableResourceType.mjs +7 -0
- package/dist/esm/api/types/MonitorListItemDto.d.mts +1 -1
- package/dist/esm/api/types/MonitorStatusHistoryResponseDto.d.mts +1 -1
- package/dist/esm/api/types/ProjectListResponseDto.d.mts +13 -0
- package/dist/esm/api/types/ProjectListResponseDto.mjs +2 -0
- package/dist/esm/api/types/ProjectOverviewCountsDto.d.mts +4 -0
- package/dist/esm/api/types/ProjectOverviewCountsDto.mjs +2 -0
- package/dist/esm/api/types/ProjectOverviewResponseDto.d.mts +18 -0
- package/dist/esm/api/types/ProjectOverviewResponseDto.mjs +2 -0
- package/dist/esm/api/types/ProjectResourceDto.d.mts +18 -0
- package/dist/esm/api/types/ProjectResourceDto.mjs +2 -0
- package/dist/esm/api/types/ProjectResourceListResponseDto.d.mts +13 -0
- package/dist/esm/api/types/ProjectResourceListResponseDto.mjs +2 -0
- package/dist/esm/api/types/ProjectResourceType.d.mts +8 -0
- package/dist/esm/api/types/ProjectResourceType.mjs +8 -0
- package/dist/esm/api/types/ProjectResponseDto.d.mts +18 -0
- package/dist/esm/api/types/ProjectResponseDto.mjs +2 -0
- package/dist/esm/api/types/ProjectSummaryDto.d.mts +17 -0
- package/dist/esm/api/types/ProjectSummaryDto.mjs +2 -0
- package/dist/esm/api/types/QueryStatus.d.mts +13 -0
- package/dist/esm/api/types/QueryStatus.mjs +13 -0
- package/dist/esm/api/types/RemoveResourceResponseDto.d.mts +6 -0
- package/dist/esm/api/types/RemoveResourceResponseDto.mjs +2 -0
- package/dist/esm/api/types/ResourceItemDto.d.mts +6 -0
- package/dist/esm/api/types/ResourceItemDto.mjs +2 -0
- package/dist/esm/api/types/ResourceResultDto.d.mts +12 -0
- package/dist/esm/api/types/ResourceResultDto.mjs +2 -0
- package/dist/esm/api/types/Suggestion.d.mts +12 -0
- package/dist/esm/api/types/Suggestion.mjs +2 -0
- package/dist/esm/api/types/TestWebhookResponseDto.d.mts +10 -0
- package/dist/esm/api/types/TestWebhookResponseDto.mjs +2 -0
- package/dist/esm/api/types/UpdateProjectResponseDto.d.mts +8 -0
- package/dist/esm/api/types/UpdateProjectResponseDto.mjs +2 -0
- package/dist/esm/api/types/UpdateWebhookResponseDto.d.mts +9 -0
- package/dist/esm/api/types/UpdateWebhookResponseDto.mjs +2 -0
- package/dist/esm/api/types/ValidateQueryResponseDto.d.mts +18 -0
- package/dist/esm/api/types/ValidateQueryResponseDto.mjs +2 -0
- package/dist/esm/api/types/WebhookResourceMappingResponseDto.d.mts +12 -0
- package/dist/esm/api/types/WebhookResourceMappingResponseDto.mjs +2 -0
- package/dist/esm/api/types/WebhookResponseDto.d.mts +28 -0
- package/dist/esm/api/types/WebhookResponseDto.mjs +2 -0
- package/dist/esm/api/types/WebhookType.d.mts +17 -0
- package/dist/esm/api/types/WebhookType.mjs +17 -0
- package/dist/esm/api/types/index.d.mts +37 -0
- package/dist/esm/api/types/index.mjs +37 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +23 -1
- package/reference.md +1599 -201
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>
|
|
@@ -492,7 +561,9 @@ Returns all monitors created by the authenticated user.
|
|
|
492
561
|
<dd>
|
|
493
562
|
|
|
494
563
|
```typescript
|
|
495
|
-
await client.monitors.listMonitors(
|
|
564
|
+
await client.monitors.listMonitors({
|
|
565
|
+
project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04"
|
|
566
|
+
});
|
|
496
567
|
|
|
497
568
|
```
|
|
498
569
|
</dd>
|
|
@@ -559,13 +630,7 @@ await client.monitors.createMonitor({
|
|
|
559
630
|
reference_job_id: "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c",
|
|
560
631
|
schedule: "every day at 12 PM",
|
|
561
632
|
timezone: "UTC",
|
|
562
|
-
|
|
563
|
-
url: "https://your-endpoint.com/webhook",
|
|
564
|
-
method: "POST",
|
|
565
|
-
headers: {
|
|
566
|
-
"Authorization": "Bearer your_token_here"
|
|
567
|
-
}
|
|
568
|
-
},
|
|
633
|
+
webhook_ids: ["a1b2c3d4-e5f6-7890-abcd-ef1234567890"],
|
|
569
634
|
limit: 10,
|
|
570
635
|
backfill: true
|
|
571
636
|
});
|
|
@@ -1031,13 +1096,7 @@ Update the webhook configuration for an existing monitor.
|
|
|
1031
1096
|
```typescript
|
|
1032
1097
|
await client.monitors.updateMonitor({
|
|
1033
1098
|
monitor_id: "monitor_id",
|
|
1034
|
-
|
|
1035
|
-
url: "https://new-endpoint.com/webhook",
|
|
1036
|
-
method: "POST",
|
|
1037
|
-
headers: {
|
|
1038
|
-
"Authorization": "Bearer new_token_xyz"
|
|
1039
|
-
}
|
|
1040
|
-
}
|
|
1099
|
+
webhook_ids: ["a1b2c3d4-e5f6-7890-abcd-ef1234567890"]
|
|
1041
1100
|
});
|
|
1042
1101
|
|
|
1043
1102
|
```
|
|
@@ -1074,8 +1133,8 @@ await client.monitors.updateMonitor({
|
|
|
1074
1133
|
</dl>
|
|
1075
1134
|
</details>
|
|
1076
1135
|
|
|
1077
|
-
##
|
|
1078
|
-
<details><summary><code>client.
|
|
1136
|
+
## Webhooks
|
|
1137
|
+
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">listWebhooks</a>({ ...params }) -> CatchAllApi.ListWebhooksResponseDto</code></summary>
|
|
1079
1138
|
<dl>
|
|
1080
1139
|
<dd>
|
|
1081
1140
|
|
|
@@ -1087,7 +1146,7 @@ await client.monitors.updateMonitor({
|
|
|
1087
1146
|
<dl>
|
|
1088
1147
|
<dd>
|
|
1089
1148
|
|
|
1090
|
-
Returns a paginated list of
|
|
1149
|
+
Returns a paginated list of webhooks belonging to the organization.
|
|
1091
1150
|
</dd>
|
|
1092
1151
|
</dl>
|
|
1093
1152
|
</dd>
|
|
@@ -1102,9 +1161,7 @@ Returns a paginated list of entities belonging to the authenticated organization
|
|
|
1102
1161
|
<dd>
|
|
1103
1162
|
|
|
1104
1163
|
```typescript
|
|
1105
|
-
await client.
|
|
1106
|
-
search: "NewsCatcher"
|
|
1107
|
-
});
|
|
1164
|
+
await client.webhooks.listWebhooks();
|
|
1108
1165
|
|
|
1109
1166
|
```
|
|
1110
1167
|
</dd>
|
|
@@ -1120,7 +1177,7 @@ await client.entities.listEntities({
|
|
|
1120
1177
|
<dl>
|
|
1121
1178
|
<dd>
|
|
1122
1179
|
|
|
1123
|
-
**request:** `CatchAllApi.
|
|
1180
|
+
**request:** `CatchAllApi.ListWebhooksRequest`
|
|
1124
1181
|
|
|
1125
1182
|
</dd>
|
|
1126
1183
|
</dl>
|
|
@@ -1128,7 +1185,7 @@ await client.entities.listEntities({
|
|
|
1128
1185
|
<dl>
|
|
1129
1186
|
<dd>
|
|
1130
1187
|
|
|
1131
|
-
**requestOptions:** `
|
|
1188
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
1132
1189
|
|
|
1133
1190
|
</dd>
|
|
1134
1191
|
</dl>
|
|
@@ -1140,7 +1197,7 @@ await client.entities.listEntities({
|
|
|
1140
1197
|
</dl>
|
|
1141
1198
|
</details>
|
|
1142
1199
|
|
|
1143
|
-
<details><summary><code>client.
|
|
1200
|
+
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">createWebhook</a>({ ...params }) -> CatchAllApi.CreateWebhookResponseDto</code></summary>
|
|
1144
1201
|
<dl>
|
|
1145
1202
|
<dd>
|
|
1146
1203
|
|
|
@@ -1152,12 +1209,7 @@ await client.entities.listEntities({
|
|
|
1152
1209
|
<dl>
|
|
1153
1210
|
<dd>
|
|
1154
1211
|
|
|
1155
|
-
Creates a new
|
|
1156
|
-
|
|
1157
|
-
The entity status starts as `pending` and transitions to `ready` once
|
|
1158
|
-
enrichment completes. Provide as much identifying information as
|
|
1159
|
-
possible — `domain` is the highest-signal field because it is
|
|
1160
|
-
unambiguous.
|
|
1212
|
+
Creates a new webhook endpoint for the organization.
|
|
1161
1213
|
</dd>
|
|
1162
1214
|
</dl>
|
|
1163
1215
|
</dd>
|
|
@@ -1172,17 +1224,11 @@ unambiguous.
|
|
|
1172
1224
|
<dd>
|
|
1173
1225
|
|
|
1174
1226
|
```typescript
|
|
1175
|
-
await client.
|
|
1176
|
-
name: "
|
|
1177
|
-
|
|
1178
|
-
|
|
1179
|
-
|
|
1180
|
-
company_attributes: {
|
|
1181
|
-
domain: "newscatcherapi.com",
|
|
1182
|
-
key_persons: ["Artem Bugara", "Maksym Sugonyaka"],
|
|
1183
|
-
alternative_names: ["NC", "NewsCatcher API"]
|
|
1184
|
-
}
|
|
1185
|
-
}
|
|
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"
|
|
1186
1232
|
});
|
|
1187
1233
|
|
|
1188
1234
|
```
|
|
@@ -1199,7 +1245,7 @@ await client.entities.createEntity({
|
|
|
1199
1245
|
<dl>
|
|
1200
1246
|
<dd>
|
|
1201
1247
|
|
|
1202
|
-
**request:** `CatchAllApi.
|
|
1248
|
+
**request:** `CatchAllApi.CreateWebhookRequestDto`
|
|
1203
1249
|
|
|
1204
1250
|
</dd>
|
|
1205
1251
|
</dl>
|
|
@@ -1207,7 +1253,7 @@ await client.entities.createEntity({
|
|
|
1207
1253
|
<dl>
|
|
1208
1254
|
<dd>
|
|
1209
1255
|
|
|
1210
|
-
**requestOptions:** `
|
|
1256
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
1211
1257
|
|
|
1212
1258
|
</dd>
|
|
1213
1259
|
</dl>
|
|
@@ -1219,7 +1265,7 @@ await client.entities.createEntity({
|
|
|
1219
1265
|
</dl>
|
|
1220
1266
|
</details>
|
|
1221
1267
|
|
|
1222
|
-
<details><summary><code>client.
|
|
1268
|
+
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">getWebhook</a>({ ...params }) -> CatchAllApi.GetWebhookResponseDto</code></summary>
|
|
1223
1269
|
<dl>
|
|
1224
1270
|
<dd>
|
|
1225
1271
|
|
|
@@ -1231,9 +1277,7 @@ await client.entities.createEntity({
|
|
|
1231
1277
|
<dl>
|
|
1232
1278
|
<dd>
|
|
1233
1279
|
|
|
1234
|
-
|
|
1235
|
-
|
|
1236
|
-
Returns an array of `{id, status}` objects in the same order as the input array.
|
|
1280
|
+
Returns the full configuration of a single webhook by ID.
|
|
1237
1281
|
</dd>
|
|
1238
1282
|
</dl>
|
|
1239
1283
|
</dd>
|
|
@@ -1248,29 +1292,8 @@ Returns an array of `{id, status}` objects in the same order as the input array.
|
|
|
1248
1292
|
<dd>
|
|
1249
1293
|
|
|
1250
1294
|
```typescript
|
|
1251
|
-
await client.
|
|
1252
|
-
|
|
1253
|
-
name: "OpenAI",
|
|
1254
|
-
entity_type: "company",
|
|
1255
|
-
description: "Artificial intelligence research company",
|
|
1256
|
-
additional_attributes: {
|
|
1257
|
-
company_attributes: {
|
|
1258
|
-
domain: "openai.com",
|
|
1259
|
-
key_persons: ["Sam Altman"],
|
|
1260
|
-
alternative_names: ["Open AI"]
|
|
1261
|
-
}
|
|
1262
|
-
}
|
|
1263
|
-
}, {
|
|
1264
|
-
name: "Stripe",
|
|
1265
|
-
entity_type: "company",
|
|
1266
|
-
description: "Online payment processing platform",
|
|
1267
|
-
additional_attributes: {
|
|
1268
|
-
company_attributes: {
|
|
1269
|
-
domain: "stripe.com",
|
|
1270
|
-
key_persons: ["Patrick Collison", "John Collison"]
|
|
1271
|
-
}
|
|
1272
|
-
}
|
|
1273
|
-
}]
|
|
1295
|
+
await client.webhooks.getWebhook({
|
|
1296
|
+
webhook_id: "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
|
|
1274
1297
|
});
|
|
1275
1298
|
|
|
1276
1299
|
```
|
|
@@ -1287,7 +1310,7 @@ await client.entities.createEntitiesBatch({
|
|
|
1287
1310
|
<dl>
|
|
1288
1311
|
<dd>
|
|
1289
1312
|
|
|
1290
|
-
**request:** `CatchAllApi.
|
|
1313
|
+
**request:** `CatchAllApi.GetWebhookRequest`
|
|
1291
1314
|
|
|
1292
1315
|
</dd>
|
|
1293
1316
|
</dl>
|
|
@@ -1295,7 +1318,7 @@ await client.entities.createEntitiesBatch({
|
|
|
1295
1318
|
<dl>
|
|
1296
1319
|
<dd>
|
|
1297
1320
|
|
|
1298
|
-
**requestOptions:** `
|
|
1321
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
1299
1322
|
|
|
1300
1323
|
</dd>
|
|
1301
1324
|
</dl>
|
|
@@ -1307,7 +1330,7 @@ await client.entities.createEntitiesBatch({
|
|
|
1307
1330
|
</dl>
|
|
1308
1331
|
</details>
|
|
1309
1332
|
|
|
1310
|
-
<details><summary><code>client.
|
|
1333
|
+
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">deleteWebhook</a>({ ...params }) -> void</code></summary>
|
|
1311
1334
|
<dl>
|
|
1312
1335
|
<dd>
|
|
1313
1336
|
|
|
@@ -1319,7 +1342,9 @@ await client.entities.createEntitiesBatch({
|
|
|
1319
1342
|
<dl>
|
|
1320
1343
|
<dd>
|
|
1321
1344
|
|
|
1322
|
-
|
|
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.
|
|
1323
1348
|
</dd>
|
|
1324
1349
|
</dl>
|
|
1325
1350
|
</dd>
|
|
@@ -1334,8 +1359,8 @@ Returns a single entity by ID with all attributes and current status.
|
|
|
1334
1359
|
<dd>
|
|
1335
1360
|
|
|
1336
1361
|
```typescript
|
|
1337
|
-
await client.
|
|
1338
|
-
|
|
1362
|
+
await client.webhooks.deleteWebhook({
|
|
1363
|
+
webhook_id: "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
|
|
1339
1364
|
});
|
|
1340
1365
|
|
|
1341
1366
|
```
|
|
@@ -1352,7 +1377,7 @@ await client.entities.getEntity({
|
|
|
1352
1377
|
<dl>
|
|
1353
1378
|
<dd>
|
|
1354
1379
|
|
|
1355
|
-
**request:** `CatchAllApi.
|
|
1380
|
+
**request:** `CatchAllApi.DeleteWebhookRequest`
|
|
1356
1381
|
|
|
1357
1382
|
</dd>
|
|
1358
1383
|
</dl>
|
|
@@ -1360,7 +1385,7 @@ await client.entities.getEntity({
|
|
|
1360
1385
|
<dl>
|
|
1361
1386
|
<dd>
|
|
1362
1387
|
|
|
1363
|
-
**requestOptions:** `
|
|
1388
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
1364
1389
|
|
|
1365
1390
|
</dd>
|
|
1366
1391
|
</dl>
|
|
@@ -1372,7 +1397,7 @@ await client.entities.getEntity({
|
|
|
1372
1397
|
</dl>
|
|
1373
1398
|
</details>
|
|
1374
1399
|
|
|
1375
|
-
<details><summary><code>client.
|
|
1400
|
+
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">updateWebhook</a>({ ...params }) -> CatchAllApi.UpdateWebhookResponseDto</code></summary>
|
|
1376
1401
|
<dl>
|
|
1377
1402
|
<dd>
|
|
1378
1403
|
|
|
@@ -1384,8 +1409,7 @@ await client.entities.getEntity({
|
|
|
1384
1409
|
<dl>
|
|
1385
1410
|
<dd>
|
|
1386
1411
|
|
|
1387
|
-
|
|
1388
|
-
datasets and the search index. This operation cannot be undone.
|
|
1412
|
+
Updates one or more fields of an existing webhook.
|
|
1389
1413
|
</dd>
|
|
1390
1414
|
</dl>
|
|
1391
1415
|
</dd>
|
|
@@ -1400,8 +1424,10 @@ datasets and the search index. This operation cannot be undone.
|
|
|
1400
1424
|
<dd>
|
|
1401
1425
|
|
|
1402
1426
|
```typescript
|
|
1403
|
-
await client.
|
|
1404
|
-
|
|
1427
|
+
await client.webhooks.updateWebhook({
|
|
1428
|
+
webhook_id: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
|
1429
|
+
name: "Layoffs Alert (EU)",
|
|
1430
|
+
is_active: false
|
|
1405
1431
|
});
|
|
1406
1432
|
|
|
1407
1433
|
```
|
|
@@ -1418,7 +1444,7 @@ await client.entities.deleteEntity({
|
|
|
1418
1444
|
<dl>
|
|
1419
1445
|
<dd>
|
|
1420
1446
|
|
|
1421
|
-
**request:** `CatchAllApi.
|
|
1447
|
+
**request:** `CatchAllApi.UpdateWebhookRequestDto`
|
|
1422
1448
|
|
|
1423
1449
|
</dd>
|
|
1424
1450
|
</dl>
|
|
@@ -1426,7 +1452,7 @@ await client.entities.deleteEntity({
|
|
|
1426
1452
|
<dl>
|
|
1427
1453
|
<dd>
|
|
1428
1454
|
|
|
1429
|
-
**requestOptions:** `
|
|
1455
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
1430
1456
|
|
|
1431
1457
|
</dd>
|
|
1432
1458
|
</dl>
|
|
@@ -1438,7 +1464,7 @@ await client.entities.deleteEntity({
|
|
|
1438
1464
|
</dl>
|
|
1439
1465
|
</details>
|
|
1440
1466
|
|
|
1441
|
-
<details><summary><code>client.
|
|
1467
|
+
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">testWebhook</a>({ ...params }) -> CatchAllApi.TestWebhookResponseDto</code></summary>
|
|
1442
1468
|
<dl>
|
|
1443
1469
|
<dd>
|
|
1444
1470
|
|
|
@@ -1450,7 +1476,9 @@ await client.entities.deleteEntity({
|
|
|
1450
1476
|
<dl>
|
|
1451
1477
|
<dd>
|
|
1452
1478
|
|
|
1453
|
-
|
|
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.
|
|
1454
1482
|
</dd>
|
|
1455
1483
|
</dl>
|
|
1456
1484
|
</dd>
|
|
@@ -1465,13 +1493,11 @@ Updates one or more fields of an existing entity.
|
|
|
1465
1493
|
<dd>
|
|
1466
1494
|
|
|
1467
1495
|
```typescript
|
|
1468
|
-
await client.
|
|
1469
|
-
|
|
1470
|
-
|
|
1471
|
-
|
|
1472
|
-
|
|
1473
|
-
alternative_names: ["NC", "NewsCatcher API", "NCA"]
|
|
1474
|
-
}
|
|
1496
|
+
await client.webhooks.testWebhook({
|
|
1497
|
+
webhook_id: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
|
1498
|
+
payload: {
|
|
1499
|
+
"test": true,
|
|
1500
|
+
"message": "CatchAll webhook test"
|
|
1475
1501
|
}
|
|
1476
1502
|
});
|
|
1477
1503
|
|
|
@@ -1489,7 +1515,7 @@ await client.entities.updateEntity({
|
|
|
1489
1515
|
<dl>
|
|
1490
1516
|
<dd>
|
|
1491
1517
|
|
|
1492
|
-
**request:** `CatchAllApi.
|
|
1518
|
+
**request:** `CatchAllApi.TestWebhookRequestDto`
|
|
1493
1519
|
|
|
1494
1520
|
</dd>
|
|
1495
1521
|
</dl>
|
|
@@ -1497,7 +1523,7 @@ await client.entities.updateEntity({
|
|
|
1497
1523
|
<dl>
|
|
1498
1524
|
<dd>
|
|
1499
1525
|
|
|
1500
|
-
**requestOptions:** `
|
|
1526
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
1501
1527
|
|
|
1502
1528
|
</dd>
|
|
1503
1529
|
</dl>
|
|
@@ -1509,8 +1535,7 @@ await client.entities.updateEntity({
|
|
|
1509
1535
|
</dl>
|
|
1510
1536
|
</details>
|
|
1511
1537
|
|
|
1512
|
-
|
|
1513
|
-
<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>
|
|
1514
1539
|
<dl>
|
|
1515
1540
|
<dd>
|
|
1516
1541
|
|
|
@@ -1522,7 +1547,7 @@ await client.entities.updateEntity({
|
|
|
1522
1547
|
<dl>
|
|
1523
1548
|
<dd>
|
|
1524
1549
|
|
|
1525
|
-
Returns a paginated list of
|
|
1550
|
+
Returns a paginated list of resources currently assigned to this webhook.
|
|
1526
1551
|
</dd>
|
|
1527
1552
|
</dl>
|
|
1528
1553
|
</dd>
|
|
@@ -1537,8 +1562,8 @@ Returns a paginated list of datasets belonging to the authenticated organization
|
|
|
1537
1562
|
<dd>
|
|
1538
1563
|
|
|
1539
1564
|
```typescript
|
|
1540
|
-
await client.
|
|
1541
|
-
|
|
1565
|
+
await client.webhooks.listWebhookResources({
|
|
1566
|
+
webhook_id: "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
|
|
1542
1567
|
});
|
|
1543
1568
|
|
|
1544
1569
|
```
|
|
@@ -1555,7 +1580,7 @@ await client.datasets.listDatasets({
|
|
|
1555
1580
|
<dl>
|
|
1556
1581
|
<dd>
|
|
1557
1582
|
|
|
1558
|
-
**request:** `CatchAllApi.
|
|
1583
|
+
**request:** `CatchAllApi.ListWebhookResourcesRequest`
|
|
1559
1584
|
|
|
1560
1585
|
</dd>
|
|
1561
1586
|
</dl>
|
|
@@ -1563,7 +1588,7 @@ await client.datasets.listDatasets({
|
|
|
1563
1588
|
<dl>
|
|
1564
1589
|
<dd>
|
|
1565
1590
|
|
|
1566
|
-
**requestOptions:** `
|
|
1591
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
1567
1592
|
|
|
1568
1593
|
</dd>
|
|
1569
1594
|
</dl>
|
|
@@ -1575,7 +1600,7 @@ await client.datasets.listDatasets({
|
|
|
1575
1600
|
</dl>
|
|
1576
1601
|
</details>
|
|
1577
1602
|
|
|
1578
|
-
<details><summary><code>client.
|
|
1603
|
+
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">assignWebhookResource</a>({ ...params }) -> CatchAllApi.AssignWebhookResourceResponseDto</code></summary>
|
|
1579
1604
|
<dl>
|
|
1580
1605
|
<dd>
|
|
1581
1606
|
|
|
@@ -1587,14 +1612,11 @@ await client.datasets.listDatasets({
|
|
|
1587
1612
|
<dl>
|
|
1588
1613
|
<dd>
|
|
1589
1614
|
|
|
1590
|
-
|
|
1591
|
-
|
|
1592
|
-
If any of the provided entity IDs do not exist or do not belong to
|
|
1593
|
-
your organization, the request fails with `400`. All entity IDs must
|
|
1594
|
-
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.
|
|
1595
1617
|
|
|
1596
|
-
|
|
1597
|
-
|
|
1618
|
+
A single webhook can be assigned to multiple resources. Each resource
|
|
1619
|
+
can have up to 5 webhooks assigned.
|
|
1598
1620
|
</dd>
|
|
1599
1621
|
</dl>
|
|
1600
1622
|
</dd>
|
|
@@ -1609,10 +1631,10 @@ endpoint instead.
|
|
|
1609
1631
|
<dd>
|
|
1610
1632
|
|
|
1611
1633
|
```typescript
|
|
1612
|
-
await client.
|
|
1613
|
-
|
|
1614
|
-
|
|
1615
|
-
|
|
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"
|
|
1616
1638
|
});
|
|
1617
1639
|
|
|
1618
1640
|
```
|
|
@@ -1629,7 +1651,7 @@ await client.datasets.createDataset({
|
|
|
1629
1651
|
<dl>
|
|
1630
1652
|
<dd>
|
|
1631
1653
|
|
|
1632
|
-
**request:** `CatchAllApi.
|
|
1654
|
+
**request:** `CatchAllApi.AssignWebhookResourceRequestDto`
|
|
1633
1655
|
|
|
1634
1656
|
</dd>
|
|
1635
1657
|
</dl>
|
|
@@ -1637,7 +1659,7 @@ await client.datasets.createDataset({
|
|
|
1637
1659
|
<dl>
|
|
1638
1660
|
<dd>
|
|
1639
1661
|
|
|
1640
|
-
**requestOptions:** `
|
|
1662
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
1641
1663
|
|
|
1642
1664
|
</dd>
|
|
1643
1665
|
</dl>
|
|
@@ -1649,7 +1671,7 @@ await client.datasets.createDataset({
|
|
|
1649
1671
|
</dl>
|
|
1650
1672
|
</details>
|
|
1651
1673
|
|
|
1652
|
-
<details><summary><code>client.
|
|
1674
|
+
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">removeWebhookResource</a>({ ...params }) -> void</code></summary>
|
|
1653
1675
|
<dl>
|
|
1654
1676
|
<dd>
|
|
1655
1677
|
|
|
@@ -1661,18 +1683,9 @@ await client.datasets.createDataset({
|
|
|
1661
1683
|
<dl>
|
|
1662
1684
|
<dd>
|
|
1663
1685
|
|
|
1664
|
-
|
|
1665
|
-
|
|
1666
|
-
**CSV format:**
|
|
1667
|
-
```csv
|
|
1668
|
-
name,description,domain,alternative_names,key_persons
|
|
1669
|
-
NewsCatcher,"AI-powered news data provider",newscatcherapi.com,"NC;NewsCatcher API","Artem Bugara;Maksym Sugonyaka"
|
|
1670
|
-
OpenAI,"Artificial intelligence research company",openai.com,"Open AI","Sam Altman"
|
|
1671
|
-
```
|
|
1672
|
-
|
|
1673
|
-
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.
|
|
1674
1687
|
|
|
1675
|
-
|
|
1688
|
+
The webhook and the resource itself are not deleted.
|
|
1676
1689
|
</dd>
|
|
1677
1690
|
</dl>
|
|
1678
1691
|
</dd>
|
|
@@ -1687,9 +1700,10 @@ Use semicolons (`;`) to separate multiple values in `alternative_names` and `key
|
|
|
1687
1700
|
<dd>
|
|
1688
1701
|
|
|
1689
1702
|
```typescript
|
|
1690
|
-
await client.
|
|
1691
|
-
|
|
1692
|
-
|
|
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"
|
|
1693
1707
|
});
|
|
1694
1708
|
|
|
1695
1709
|
```
|
|
@@ -1706,7 +1720,7 @@ await client.datasets.createDatasetFromCsv({
|
|
|
1706
1720
|
<dl>
|
|
1707
1721
|
<dd>
|
|
1708
1722
|
|
|
1709
|
-
**request:** `CatchAllApi.
|
|
1723
|
+
**request:** `CatchAllApi.RemoveWebhookResourceRequest`
|
|
1710
1724
|
|
|
1711
1725
|
</dd>
|
|
1712
1726
|
</dl>
|
|
@@ -1714,7 +1728,7 @@ await client.datasets.createDatasetFromCsv({
|
|
|
1714
1728
|
<dl>
|
|
1715
1729
|
<dd>
|
|
1716
1730
|
|
|
1717
|
-
**requestOptions:** `
|
|
1731
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
1718
1732
|
|
|
1719
1733
|
</dd>
|
|
1720
1734
|
</dl>
|
|
@@ -1726,7 +1740,7 @@ await client.datasets.createDatasetFromCsv({
|
|
|
1726
1740
|
</dl>
|
|
1727
1741
|
</details>
|
|
1728
1742
|
|
|
1729
|
-
<details><summary><code>client.
|
|
1743
|
+
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">listWebhooksForResource</a>({ ...params }) -> CatchAllApi.ListWebhooksResponseDto</code></summary>
|
|
1730
1744
|
<dl>
|
|
1731
1745
|
<dd>
|
|
1732
1746
|
|
|
@@ -1738,7 +1752,7 @@ await client.datasets.createDatasetFromCsv({
|
|
|
1738
1752
|
<dl>
|
|
1739
1753
|
<dd>
|
|
1740
1754
|
|
|
1741
|
-
Returns
|
|
1755
|
+
Returns all webhooks currently assigned to the given resource.
|
|
1742
1756
|
</dd>
|
|
1743
1757
|
</dl>
|
|
1744
1758
|
</dd>
|
|
@@ -1753,8 +1767,9 @@ Returns a single dataset by ID including entity count and current status.
|
|
|
1753
1767
|
<dd>
|
|
1754
1768
|
|
|
1755
1769
|
```typescript
|
|
1756
|
-
await client.
|
|
1757
|
-
|
|
1770
|
+
await client.webhooks.listWebhooksForResource({
|
|
1771
|
+
resource_type: "job",
|
|
1772
|
+
resource_id: "3fec5b07-8786-46d7-9486-d43ff67eccd4"
|
|
1758
1773
|
});
|
|
1759
1774
|
|
|
1760
1775
|
```
|
|
@@ -1771,7 +1786,7 @@ await client.datasets.getDataset({
|
|
|
1771
1786
|
<dl>
|
|
1772
1787
|
<dd>
|
|
1773
1788
|
|
|
1774
|
-
**request:** `CatchAllApi.
|
|
1789
|
+
**request:** `CatchAllApi.ListWebhooksForResourceRequest`
|
|
1775
1790
|
|
|
1776
1791
|
</dd>
|
|
1777
1792
|
</dl>
|
|
@@ -1779,7 +1794,7 @@ await client.datasets.getDataset({
|
|
|
1779
1794
|
<dl>
|
|
1780
1795
|
<dd>
|
|
1781
1796
|
|
|
1782
|
-
**requestOptions:** `
|
|
1797
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
1783
1798
|
|
|
1784
1799
|
</dd>
|
|
1785
1800
|
</dl>
|
|
@@ -1791,7 +1806,7 @@ await client.datasets.getDataset({
|
|
|
1791
1806
|
</dl>
|
|
1792
1807
|
</details>
|
|
1793
1808
|
|
|
1794
|
-
<details><summary><code>client.
|
|
1809
|
+
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">getWebhookDeliveryHistory</a>({ ...params }) -> CatchAllApi.DeliveryHistoryResponseDto</code></summary>
|
|
1795
1810
|
<dl>
|
|
1796
1811
|
<dd>
|
|
1797
1812
|
|
|
@@ -1803,9 +1818,9 @@ await client.datasets.getDataset({
|
|
|
1803
1818
|
<dl>
|
|
1804
1819
|
<dd>
|
|
1805
1820
|
|
|
1806
|
-
|
|
1807
|
-
|
|
1808
|
-
|
|
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.
|
|
1809
1824
|
</dd>
|
|
1810
1825
|
</dl>
|
|
1811
1826
|
</dd>
|
|
@@ -1820,8 +1835,9 @@ undone.
|
|
|
1820
1835
|
<dd>
|
|
1821
1836
|
|
|
1822
1837
|
```typescript
|
|
1823
|
-
await client.
|
|
1824
|
-
|
|
1838
|
+
await client.webhooks.getWebhookDeliveryHistory({
|
|
1839
|
+
resource_type: "job",
|
|
1840
|
+
resource_id: "3fec5b07-8786-46d7-9486-d43ff67eccd4"
|
|
1825
1841
|
});
|
|
1826
1842
|
|
|
1827
1843
|
```
|
|
@@ -1838,7 +1854,7 @@ await client.datasets.deleteDataset({
|
|
|
1838
1854
|
<dl>
|
|
1839
1855
|
<dd>
|
|
1840
1856
|
|
|
1841
|
-
**request:** `CatchAllApi.
|
|
1857
|
+
**request:** `CatchAllApi.GetWebhookDeliveryHistoryRequest`
|
|
1842
1858
|
|
|
1843
1859
|
</dd>
|
|
1844
1860
|
</dl>
|
|
@@ -1846,7 +1862,7 @@ await client.datasets.deleteDataset({
|
|
|
1846
1862
|
<dl>
|
|
1847
1863
|
<dd>
|
|
1848
1864
|
|
|
1849
|
-
**requestOptions:** `
|
|
1865
|
+
**requestOptions:** `WebhooksClient.RequestOptions`
|
|
1850
1866
|
|
|
1851
1867
|
</dd>
|
|
1852
1868
|
</dl>
|
|
@@ -1858,7 +1874,8 @@ await client.datasets.deleteDataset({
|
|
|
1858
1874
|
</dl>
|
|
1859
1875
|
</details>
|
|
1860
1876
|
|
|
1861
|
-
|
|
1877
|
+
## Entities
|
|
1878
|
+
<details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">listEntities</a>({ ...params }) -> CatchAllApi.EntityListResponse</code></summary>
|
|
1862
1879
|
<dl>
|
|
1863
1880
|
<dd>
|
|
1864
1881
|
|
|
@@ -1870,7 +1887,7 @@ await client.datasets.deleteDataset({
|
|
|
1870
1887
|
<dl>
|
|
1871
1888
|
<dd>
|
|
1872
1889
|
|
|
1873
|
-
|
|
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.
|
|
1874
1891
|
</dd>
|
|
1875
1892
|
</dl>
|
|
1876
1893
|
</dd>
|
|
@@ -1885,10 +1902,8 @@ Updates the name or description of a dataset.
|
|
|
1885
1902
|
<dd>
|
|
1886
1903
|
|
|
1887
1904
|
```typescript
|
|
1888
|
-
await client.
|
|
1889
|
-
|
|
1890
|
-
name: "My Portfolio (updated)",
|
|
1891
|
-
description: "Updated Q1 2026 watchlist"
|
|
1905
|
+
await client.entities.listEntities({
|
|
1906
|
+
search: "NewsCatcher"
|
|
1892
1907
|
});
|
|
1893
1908
|
|
|
1894
1909
|
```
|
|
@@ -1905,7 +1920,7 @@ await client.datasets.updateDataset({
|
|
|
1905
1920
|
<dl>
|
|
1906
1921
|
<dd>
|
|
1907
1922
|
|
|
1908
|
-
**request:** `CatchAllApi.
|
|
1923
|
+
**request:** `CatchAllApi.ListEntitiesRequest`
|
|
1909
1924
|
|
|
1910
1925
|
</dd>
|
|
1911
1926
|
</dl>
|
|
@@ -1913,7 +1928,7 @@ await client.datasets.updateDataset({
|
|
|
1913
1928
|
<dl>
|
|
1914
1929
|
<dd>
|
|
1915
1930
|
|
|
1916
|
-
**requestOptions:** `
|
|
1931
|
+
**requestOptions:** `EntitiesClient.RequestOptions`
|
|
1917
1932
|
|
|
1918
1933
|
</dd>
|
|
1919
1934
|
</dl>
|
|
@@ -1925,7 +1940,7 @@ await client.datasets.updateDataset({
|
|
|
1925
1940
|
</dl>
|
|
1926
1941
|
</details>
|
|
1927
1942
|
|
|
1928
|
-
<details><summary><code>client.
|
|
1943
|
+
<details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">createEntity</a>({ ...params }) -> CatchAllApi.CreateEntityResponse</code></summary>
|
|
1929
1944
|
<dl>
|
|
1930
1945
|
<dd>
|
|
1931
1946
|
|
|
@@ -1937,7 +1952,12 @@ await client.datasets.updateDataset({
|
|
|
1937
1952
|
<dl>
|
|
1938
1953
|
<dd>
|
|
1939
1954
|
|
|
1940
|
-
|
|
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.
|
|
1941
1961
|
</dd>
|
|
1942
1962
|
</dl>
|
|
1943
1963
|
</dd>
|
|
@@ -1952,10 +1972,16 @@ Adds one or more existing entities to a dataset. Returns the number of entities
|
|
|
1952
1972
|
<dd>
|
|
1953
1973
|
|
|
1954
1974
|
```typescript
|
|
1955
|
-
await client.
|
|
1956
|
-
|
|
1957
|
-
|
|
1958
|
-
|
|
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
|
+
}
|
|
1959
1985
|
}
|
|
1960
1986
|
});
|
|
1961
1987
|
|
|
@@ -1973,7 +1999,7 @@ await client.datasets.addEntitiesToDataset({
|
|
|
1973
1999
|
<dl>
|
|
1974
2000
|
<dd>
|
|
1975
2001
|
|
|
1976
|
-
**request:** `CatchAllApi.
|
|
2002
|
+
**request:** `CatchAllApi.CreateEntityRequest`
|
|
1977
2003
|
|
|
1978
2004
|
</dd>
|
|
1979
2005
|
</dl>
|
|
@@ -1981,7 +2007,7 @@ await client.datasets.addEntitiesToDataset({
|
|
|
1981
2007
|
<dl>
|
|
1982
2008
|
<dd>
|
|
1983
2009
|
|
|
1984
|
-
**requestOptions:** `
|
|
2010
|
+
**requestOptions:** `EntitiesClient.RequestOptions`
|
|
1985
2011
|
|
|
1986
2012
|
</dd>
|
|
1987
2013
|
</dl>
|
|
@@ -1993,7 +2019,7 @@ await client.datasets.addEntitiesToDataset({
|
|
|
1993
2019
|
</dl>
|
|
1994
2020
|
</details>
|
|
1995
2021
|
|
|
1996
|
-
<details><summary><code>client.
|
|
2022
|
+
<details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">createEntitiesBatch</a>({ ...params }) -> CatchAllApi.CreateEntitiesBatchResponse</code></summary>
|
|
1997
2023
|
<dl>
|
|
1998
2024
|
<dd>
|
|
1999
2025
|
|
|
@@ -2005,7 +2031,9 @@ await client.datasets.addEntitiesToDataset({
|
|
|
2005
2031
|
<dl>
|
|
2006
2032
|
<dd>
|
|
2007
2033
|
|
|
2008
|
-
|
|
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.
|
|
2009
2037
|
</dd>
|
|
2010
2038
|
</dl>
|
|
2011
2039
|
</dd>
|
|
@@ -2020,13 +2048,31 @@ Removes one or more entities from a dataset. The entities themselves are not del
|
|
|
2020
2048
|
<dd>
|
|
2021
2049
|
|
|
2022
2050
|
```typescript
|
|
2023
|
-
await client.
|
|
2024
|
-
|
|
2025
|
-
|
|
2026
|
-
|
|
2027
|
-
|
|
2028
|
-
|
|
2029
|
-
|
|
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
|
+
|
|
2030
2076
|
```
|
|
2031
2077
|
</dd>
|
|
2032
2078
|
</dl>
|
|
@@ -2041,7 +2087,7 @@ await client.datasets.removeEntitiesFromDataset({
|
|
|
2041
2087
|
<dl>
|
|
2042
2088
|
<dd>
|
|
2043
2089
|
|
|
2044
|
-
**request:** `CatchAllApi.
|
|
2090
|
+
**request:** `CatchAllApi.CreateEntitiesBatchRequest`
|
|
2045
2091
|
|
|
2046
2092
|
</dd>
|
|
2047
2093
|
</dl>
|
|
@@ -2049,7 +2095,7 @@ await client.datasets.removeEntitiesFromDataset({
|
|
|
2049
2095
|
<dl>
|
|
2050
2096
|
<dd>
|
|
2051
2097
|
|
|
2052
|
-
**requestOptions:** `
|
|
2098
|
+
**requestOptions:** `EntitiesClient.RequestOptions`
|
|
2053
2099
|
|
|
2054
2100
|
</dd>
|
|
2055
2101
|
</dl>
|
|
@@ -2061,7 +2107,7 @@ await client.datasets.removeEntitiesFromDataset({
|
|
|
2061
2107
|
</dl>
|
|
2062
2108
|
</details>
|
|
2063
2109
|
|
|
2064
|
-
<details><summary><code>client.
|
|
2110
|
+
<details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">getEntity</a>({ ...params }) -> CatchAllApi.EntityResponse</code></summary>
|
|
2065
2111
|
<dl>
|
|
2066
2112
|
<dd>
|
|
2067
2113
|
|
|
@@ -2073,7 +2119,7 @@ await client.datasets.removeEntitiesFromDataset({
|
|
|
2073
2119
|
<dl>
|
|
2074
2120
|
<dd>
|
|
2075
2121
|
|
|
2076
|
-
Returns a
|
|
2122
|
+
Returns a single entity by ID with all attributes and current status.
|
|
2077
2123
|
</dd>
|
|
2078
2124
|
</dl>
|
|
2079
2125
|
</dd>
|
|
@@ -2088,15 +2134,8 @@ Returns a paginated list of entities in a dataset. Supports filtering by status,
|
|
|
2088
2134
|
<dd>
|
|
2089
2135
|
|
|
2090
2136
|
```typescript
|
|
2091
|
-
await client.
|
|
2092
|
-
|
|
2093
|
-
page: 1,
|
|
2094
|
-
page_size: 100,
|
|
2095
|
-
search: "OpenAI",
|
|
2096
|
-
status: "ready",
|
|
2097
|
-
entity_type: "company",
|
|
2098
|
-
sort_by: "created_at",
|
|
2099
|
-
sort_order: "desc"
|
|
2137
|
+
await client.entities.getEntity({
|
|
2138
|
+
entity_id: "854198fa-f702-49db-a381-0427fa87f173"
|
|
2100
2139
|
});
|
|
2101
2140
|
|
|
2102
2141
|
```
|
|
@@ -2113,7 +2152,7 @@ await client.datasets.listEntitiesInDataset({
|
|
|
2113
2152
|
<dl>
|
|
2114
2153
|
<dd>
|
|
2115
2154
|
|
|
2116
|
-
**request:** `CatchAllApi.
|
|
2155
|
+
**request:** `CatchAllApi.GetEntityRequest`
|
|
2117
2156
|
|
|
2118
2157
|
</dd>
|
|
2119
2158
|
</dl>
|
|
@@ -2121,7 +2160,7 @@ await client.datasets.listEntitiesInDataset({
|
|
|
2121
2160
|
<dl>
|
|
2122
2161
|
<dd>
|
|
2123
2162
|
|
|
2124
|
-
**requestOptions:** `
|
|
2163
|
+
**requestOptions:** `EntitiesClient.RequestOptions`
|
|
2125
2164
|
|
|
2126
2165
|
</dd>
|
|
2127
2166
|
</dl>
|
|
@@ -2133,7 +2172,7 @@ await client.datasets.listEntitiesInDataset({
|
|
|
2133
2172
|
</dl>
|
|
2134
2173
|
</details>
|
|
2135
2174
|
|
|
2136
|
-
<details><summary><code>client.
|
|
2175
|
+
<details><summary><code>client.entities.<a href="/src/api/resources/entities/client/Client.ts">deleteEntity</a>({ ...params }) -> void</code></summary>
|
|
2137
2176
|
<dl>
|
|
2138
2177
|
<dd>
|
|
2139
2178
|
|
|
@@ -2145,7 +2184,8 @@ await client.datasets.listEntitiesInDataset({
|
|
|
2145
2184
|
<dl>
|
|
2146
2185
|
<dd>
|
|
2147
2186
|
|
|
2148
|
-
|
|
2187
|
+
Permanently deletes an entity. The entity is removed from all
|
|
2188
|
+
datasets and the search index. This operation cannot be undone.
|
|
2149
2189
|
</dd>
|
|
2150
2190
|
</dl>
|
|
2151
2191
|
</dd>
|
|
@@ -2160,8 +2200,8 @@ Returns the full status change history for a dataset, ordered chronologically fr
|
|
|
2160
2200
|
<dd>
|
|
2161
2201
|
|
|
2162
2202
|
```typescript
|
|
2163
|
-
await client.
|
|
2164
|
-
|
|
2203
|
+
await client.entities.deleteEntity({
|
|
2204
|
+
entity_id: "854198fa-f702-49db-a381-0427fa87f173"
|
|
2165
2205
|
});
|
|
2166
2206
|
|
|
2167
2207
|
```
|
|
@@ -2178,7 +2218,145 @@ await client.datasets.getDatasetStatusHistory({
|
|
|
2178
2218
|
<dl>
|
|
2179
2219
|
<dd>
|
|
2180
2220
|
|
|
2181
|
-
**request:** `CatchAllApi.
|
|
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
|
+
}
|
|
2275
|
+
}
|
|
2276
|
+
});
|
|
2277
|
+
|
|
2278
|
+
```
|
|
2279
|
+
</dd>
|
|
2280
|
+
</dl>
|
|
2281
|
+
</dd>
|
|
2282
|
+
</dl>
|
|
2283
|
+
|
|
2284
|
+
#### ⚙️ Parameters
|
|
2285
|
+
|
|
2286
|
+
<dl>
|
|
2287
|
+
<dd>
|
|
2288
|
+
|
|
2289
|
+
<dl>
|
|
2290
|
+
<dd>
|
|
2291
|
+
|
|
2292
|
+
**request:** `CatchAllApi.UpdateEntityRequest`
|
|
2293
|
+
|
|
2294
|
+
</dd>
|
|
2295
|
+
</dl>
|
|
2296
|
+
|
|
2297
|
+
<dl>
|
|
2298
|
+
<dd>
|
|
2299
|
+
|
|
2300
|
+
**requestOptions:** `EntitiesClient.RequestOptions`
|
|
2301
|
+
|
|
2302
|
+
</dd>
|
|
2303
|
+
</dl>
|
|
2304
|
+
</dd>
|
|
2305
|
+
</dl>
|
|
2306
|
+
|
|
2307
|
+
|
|
2308
|
+
</dd>
|
|
2309
|
+
</dl>
|
|
2310
|
+
</details>
|
|
2311
|
+
|
|
2312
|
+
## Datasets
|
|
2313
|
+
<details><summary><code>client.datasets.<a href="/src/api/resources/datasets/client/Client.ts">listDatasets</a>({ ...params }) -> CatchAllApi.DatasetListResponse</code></summary>
|
|
2314
|
+
<dl>
|
|
2315
|
+
<dd>
|
|
2316
|
+
|
|
2317
|
+
#### 📝 Description
|
|
2318
|
+
|
|
2319
|
+
<dl>
|
|
2320
|
+
<dd>
|
|
2321
|
+
|
|
2322
|
+
<dl>
|
|
2323
|
+
<dd>
|
|
2324
|
+
|
|
2325
|
+
Returns a paginated list of datasets belonging to the authenticated organization. Supports filtering by status and sorting by name, status, or creation date.
|
|
2326
|
+
</dd>
|
|
2327
|
+
</dl>
|
|
2328
|
+
</dd>
|
|
2329
|
+
</dl>
|
|
2330
|
+
|
|
2331
|
+
#### 🔌 Usage
|
|
2332
|
+
|
|
2333
|
+
<dl>
|
|
2334
|
+
<dd>
|
|
2335
|
+
|
|
2336
|
+
<dl>
|
|
2337
|
+
<dd>
|
|
2338
|
+
|
|
2339
|
+
```typescript
|
|
2340
|
+
await client.datasets.listDatasets({
|
|
2341
|
+
search: "Portfolio",
|
|
2342
|
+
project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04"
|
|
2343
|
+
});
|
|
2344
|
+
|
|
2345
|
+
```
|
|
2346
|
+
</dd>
|
|
2347
|
+
</dl>
|
|
2348
|
+
</dd>
|
|
2349
|
+
</dl>
|
|
2350
|
+
|
|
2351
|
+
#### ⚙️ Parameters
|
|
2352
|
+
|
|
2353
|
+
<dl>
|
|
2354
|
+
<dd>
|
|
2355
|
+
|
|
2356
|
+
<dl>
|
|
2357
|
+
<dd>
|
|
2358
|
+
|
|
2359
|
+
**request:** `CatchAllApi.ListDatasetsRequest`
|
|
2182
2360
|
|
|
2183
2361
|
</dd>
|
|
2184
2362
|
</dl>
|
|
@@ -2198,7 +2376,7 @@ await client.datasets.getDatasetStatusHistory({
|
|
|
2198
2376
|
</dl>
|
|
2199
2377
|
</details>
|
|
2200
2378
|
|
|
2201
|
-
<details><summary><code>client.datasets.<a href="/src/api/resources/datasets/client/Client.ts">
|
|
2379
|
+
<details><summary><code>client.datasets.<a href="/src/api/resources/datasets/client/Client.ts">createDataset</a>({ ...params }) -> CatchAllApi.DatasetResponse</code></summary>
|
|
2202
2380
|
<dl>
|
|
2203
2381
|
<dd>
|
|
2204
2382
|
|
|
@@ -2210,9 +2388,14 @@ await client.datasets.getDatasetStatusHistory({
|
|
|
2210
2388
|
<dl>
|
|
2211
2389
|
<dd>
|
|
2212
2390
|
|
|
2213
|
-
|
|
2391
|
+
Creates a new dataset from a list of existing entity IDs.
|
|
2214
2392
|
|
|
2215
|
-
|
|
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.
|
|
2396
|
+
|
|
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.
|
|
2216
2399
|
</dd>
|
|
2217
2400
|
</dl>
|
|
2218
2401
|
</dd>
|
|
@@ -2227,9 +2410,10 @@ The response omits `dataset_name` compared to the create-from-CSV endpoint since
|
|
|
2227
2410
|
<dd>
|
|
2228
2411
|
|
|
2229
2412
|
```typescript
|
|
2230
|
-
await client.datasets.
|
|
2231
|
-
|
|
2232
|
-
|
|
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"]
|
|
2233
2417
|
});
|
|
2234
2418
|
|
|
2235
2419
|
```
|
|
@@ -2246,7 +2430,7 @@ await client.datasets.uploadCsvToDataset({
|
|
|
2246
2430
|
<dl>
|
|
2247
2431
|
<dd>
|
|
2248
2432
|
|
|
2249
|
-
**request:** `CatchAllApi.
|
|
2433
|
+
**request:** `CatchAllApi.CreateDatasetRequest`
|
|
2250
2434
|
|
|
2251
2435
|
</dd>
|
|
2252
2436
|
</dl>
|
|
@@ -2262,6 +2446,1220 @@ await client.datasets.uploadCsvToDataset({
|
|
|
2262
2446
|
</dl>
|
|
2263
2447
|
|
|
2264
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
|
+
|
|
2265
3663
|
</dd>
|
|
2266
3664
|
</dl>
|
|
2267
3665
|
</details>
|