newscatcher-catchall-sdk 1.5.1 → 3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -2
- package/dist/cjs/BaseClient.d.ts +3 -0
- package/dist/cjs/BaseClient.js +17 -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 +32 -32
- package/dist/cjs/api/resources/datasets/client/Client.js +59 -66
- package/dist/cjs/api/resources/datasets/client/requests/ListDatasetEntitiesRequest.d.ts +28 -0
- package/dist/cjs/api/resources/datasets/client/requests/ListDatasetsRequest.d.ts +4 -2
- package/dist/cjs/api/resources/datasets/client/requests/index.d.ts +1 -1
- package/dist/cjs/api/resources/entities/client/Client.d.ts +3 -7
- package/dist/cjs/api/resources/entities/client/Client.js +3 -7
- 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 +23 -5
- package/dist/cjs/api/resources/jobs/client/Client.js +65 -6
- package/dist/cjs/api/resources/jobs/client/requests/GetUserJobsRequest.d.ts +5 -2
- package/dist/cjs/api/resources/jobs/client/requests/SubmitRequestDto.d.ts +11 -1
- 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 +7 -16
- package/dist/cjs/api/resources/monitors/client/Client.js +9 -17
- package/dist/cjs/api/resources/monitors/client/requests/CreateMonitorRequestDto.d.ts +17 -14
- package/dist/cjs/api/resources/monitors/client/requests/ListMonitorsRequest.d.ts +5 -2
- 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 +12 -9
- 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/core/auth/AuthProvider.d.ts +1 -0
- package/dist/cjs/core/auth/AuthProvider.js +7 -0
- package/dist/cjs/core/auth/index.d.ts +1 -1
- package/dist/cjs/core/auth/index.js +3 -1
- package/dist/cjs/core/fetcher/requestWithRetries.js +4 -1
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.d.mts +3 -0
- package/dist/esm/BaseClient.mjs +17 -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 +32 -32
- package/dist/esm/api/resources/datasets/client/Client.mjs +59 -66
- package/dist/esm/api/resources/datasets/client/requests/ListDatasetEntitiesRequest.d.mts +28 -0
- package/dist/esm/api/resources/datasets/client/requests/ListDatasetsRequest.d.mts +4 -2
- package/dist/esm/api/resources/datasets/client/requests/index.d.mts +1 -1
- package/dist/esm/api/resources/entities/client/Client.d.mts +3 -7
- package/dist/esm/api/resources/entities/client/Client.mjs +3 -7
- 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 +23 -5
- package/dist/esm/api/resources/jobs/client/Client.mjs +65 -6
- package/dist/esm/api/resources/jobs/client/requests/GetUserJobsRequest.d.mts +5 -2
- package/dist/esm/api/resources/jobs/client/requests/SubmitRequestDto.d.mts +11 -1
- 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 +7 -16
- package/dist/esm/api/resources/monitors/client/Client.mjs +9 -17
- package/dist/esm/api/resources/monitors/client/requests/CreateMonitorRequestDto.d.mts +17 -14
- package/dist/esm/api/resources/monitors/client/requests/ListMonitorsRequest.d.mts +5 -2
- 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 +12 -9
- 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/core/auth/AuthProvider.d.mts +1 -0
- package/dist/esm/core/auth/AuthProvider.mjs +6 -1
- package/dist/esm/core/auth/index.d.mts +1 -1
- package/dist/esm/core/auth/index.mjs +1 -0
- package/dist/esm/core/fetcher/requestWithRetries.mjs +4 -1
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +24 -2
- package/reference.md +1614 -223
- package/dist/cjs/api/resources/datasets/client/requests/ListEntitiesInDatasetRequest.d.ts +0 -21
- package/dist/esm/api/resources/datasets/client/requests/ListEntitiesInDatasetRequest.d.mts +0 -21
- /package/dist/cjs/api/resources/datasets/client/requests/{ListEntitiesInDatasetRequest.js → ListDatasetEntitiesRequest.js} +0 -0
- /package/dist/esm/api/resources/datasets/client/requests/{ListEntitiesInDatasetRequest.mjs → ListDatasetEntitiesRequest.mjs} +0 -0
|
@@ -9,3 +9,8 @@ export * from "./meta/types/index.js";
|
|
|
9
9
|
export * from "./monitors/client/requests/index.js";
|
|
10
10
|
export * as monitors from "./monitors/index.js";
|
|
11
11
|
export * from "./monitors/types/index.js";
|
|
12
|
+
export * from "./projects/client/requests/index.js";
|
|
13
|
+
export * as projects from "./projects/index.js";
|
|
14
|
+
export * from "./webhooks/client/requests/index.js";
|
|
15
|
+
export * as webhooks from "./webhooks/index.js";
|
|
16
|
+
export * from "./webhooks/types/index.js";
|
|
@@ -36,7 +36,7 @@ var __importStar = (this && this.__importStar) || (function () {
|
|
|
36
36
|
};
|
|
37
37
|
})();
|
|
38
38
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
39
|
-
exports.monitors = exports.meta = exports.jobs = exports.entities = exports.datasets = void 0;
|
|
39
|
+
exports.webhooks = exports.projects = exports.monitors = exports.meta = exports.jobs = exports.entities = exports.datasets = void 0;
|
|
40
40
|
__exportStar(require("./datasets/client/requests/index.js"), exports);
|
|
41
41
|
exports.datasets = __importStar(require("./datasets/index.js"));
|
|
42
42
|
__exportStar(require("./entities/client/requests/index.js"), exports);
|
|
@@ -48,3 +48,8 @@ __exportStar(require("./meta/types/index.js"), exports);
|
|
|
48
48
|
__exportStar(require("./monitors/client/requests/index.js"), exports);
|
|
49
49
|
exports.monitors = __importStar(require("./monitors/index.js"));
|
|
50
50
|
__exportStar(require("./monitors/types/index.js"), exports);
|
|
51
|
+
__exportStar(require("./projects/client/requests/index.js"), exports);
|
|
52
|
+
exports.projects = __importStar(require("./projects/index.js"));
|
|
53
|
+
__exportStar(require("./webhooks/client/requests/index.js"), exports);
|
|
54
|
+
exports.webhooks = __importStar(require("./webhooks/index.js"));
|
|
55
|
+
__exportStar(require("./webhooks/types/index.js"), exports);
|
|
@@ -22,10 +22,30 @@ export declare class JobsClient {
|
|
|
22
22
|
* @throws {@link CatchAllApi.ForbiddenError}
|
|
23
23
|
*
|
|
24
24
|
* @example
|
|
25
|
-
* await client.jobs.getUserJobs(
|
|
25
|
+
* await client.jobs.getUserJobs({
|
|
26
|
+
* project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04"
|
|
27
|
+
* })
|
|
26
28
|
*/
|
|
27
29
|
getUserJobs(request?: CatchAllApi.GetUserJobsRequest, requestOptions?: JobsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.ListUserJobsResponseDto>;
|
|
28
30
|
private __getUserJobs;
|
|
31
|
+
/**
|
|
32
|
+
* Checks whether a query is well-formed and likely to produce good results before submitting a job.
|
|
33
|
+
*
|
|
34
|
+
* Returns a quality assessment with a status level, identified issues, and actionable suggestions.
|
|
35
|
+
*
|
|
36
|
+
* @param {CatchAllApi.ValidateQueryRequestDto} request
|
|
37
|
+
* @param {JobsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
38
|
+
*
|
|
39
|
+
* @throws {@link CatchAllApi.ForbiddenError}
|
|
40
|
+
* @throws {@link CatchAllApi.UnprocessableEntityError}
|
|
41
|
+
*
|
|
42
|
+
* @example
|
|
43
|
+
* await client.jobs.validateQuery({
|
|
44
|
+
* query: "Series B funding rounds for SaaS startups"
|
|
45
|
+
* })
|
|
46
|
+
*/
|
|
47
|
+
validateQuery(request: CatchAllApi.ValidateQueryRequestDto, requestOptions?: JobsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.ValidateQueryResponseDto>;
|
|
48
|
+
private __validateQuery;
|
|
29
49
|
/**
|
|
30
50
|
* Get suggested validators, enrichments, and date ranges for a query.
|
|
31
51
|
*
|
|
@@ -116,11 +136,9 @@ export declare class JobsClient {
|
|
|
116
136
|
continueJob(request: CatchAllApi.ContinueRequestDto, requestOptions?: JobsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.ContinueResponseDto>;
|
|
117
137
|
private __continueJob;
|
|
118
138
|
/**
|
|
119
|
-
* Soft-deletes a job. The job is flagged as deleted and no longer
|
|
120
|
-
* appears in list results. The underlying data is retained.
|
|
139
|
+
* Soft-deletes a job. The job is flagged as deleted and no longer appears in list results. The underlying data is retained.
|
|
121
140
|
*
|
|
122
|
-
* Only the job owner can delete a job. Returns `404` if the job is not
|
|
123
|
-
* found or does not belong to the authenticated user.
|
|
141
|
+
* Only the job owner can delete a job. Returns `404` if the job is not found or does not belong to the authenticated user.
|
|
124
142
|
*
|
|
125
143
|
* Deleting an already-deleted job returns `200`.
|
|
126
144
|
*
|
|
@@ -67,7 +67,9 @@ class JobsClient {
|
|
|
67
67
|
* @throws {@link CatchAllApi.ForbiddenError}
|
|
68
68
|
*
|
|
69
69
|
* @example
|
|
70
|
-
* await client.jobs.getUserJobs(
|
|
70
|
+
* await client.jobs.getUserJobs({
|
|
71
|
+
* project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04"
|
|
72
|
+
* })
|
|
71
73
|
*/
|
|
72
74
|
getUserJobs(request = {}, requestOptions) {
|
|
73
75
|
return core.HttpResponsePromise.fromPromise(this.__getUserJobs(request, requestOptions));
|
|
@@ -75,12 +77,13 @@ class JobsClient {
|
|
|
75
77
|
__getUserJobs() {
|
|
76
78
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
77
79
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
78
|
-
const { page, page_size: pageSize, search, ownership } = request;
|
|
80
|
+
const { page, page_size: pageSize, search, ownership, project_id: projectId } = request;
|
|
79
81
|
const _queryParams = {
|
|
80
82
|
page,
|
|
81
83
|
page_size: pageSize,
|
|
82
84
|
search,
|
|
83
85
|
ownership: ownership != null ? ownership : undefined,
|
|
86
|
+
project_id: projectId,
|
|
84
87
|
};
|
|
85
88
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
86
89
|
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
@@ -117,6 +120,64 @@ class JobsClient {
|
|
|
117
120
|
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/catchAll/jobs/user");
|
|
118
121
|
});
|
|
119
122
|
}
|
|
123
|
+
/**
|
|
124
|
+
* Checks whether a query is well-formed and likely to produce good results before submitting a job.
|
|
125
|
+
*
|
|
126
|
+
* Returns a quality assessment with a status level, identified issues, and actionable suggestions.
|
|
127
|
+
*
|
|
128
|
+
* @param {CatchAllApi.ValidateQueryRequestDto} request
|
|
129
|
+
* @param {JobsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
130
|
+
*
|
|
131
|
+
* @throws {@link CatchAllApi.ForbiddenError}
|
|
132
|
+
* @throws {@link CatchAllApi.UnprocessableEntityError}
|
|
133
|
+
*
|
|
134
|
+
* @example
|
|
135
|
+
* await client.jobs.validateQuery({
|
|
136
|
+
* query: "Series B funding rounds for SaaS startups"
|
|
137
|
+
* })
|
|
138
|
+
*/
|
|
139
|
+
validateQuery(request, requestOptions) {
|
|
140
|
+
return core.HttpResponsePromise.fromPromise(this.__validateQuery(request, requestOptions));
|
|
141
|
+
}
|
|
142
|
+
__validateQuery(request, requestOptions) {
|
|
143
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
144
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
145
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
146
|
+
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
147
|
+
const _response = yield core.fetcher({
|
|
148
|
+
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CatchAllApiEnvironment.Default, "catchAll/validate"),
|
|
149
|
+
method: "POST",
|
|
150
|
+
headers: _headers,
|
|
151
|
+
contentType: "application/json",
|
|
152
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
153
|
+
requestType: "json",
|
|
154
|
+
body: request,
|
|
155
|
+
timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
|
|
156
|
+
maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
|
|
157
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
158
|
+
fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
|
|
159
|
+
logging: this._options.logging,
|
|
160
|
+
});
|
|
161
|
+
if (_response.ok) {
|
|
162
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
163
|
+
}
|
|
164
|
+
if (_response.error.reason === "status-code") {
|
|
165
|
+
switch (_response.error.statusCode) {
|
|
166
|
+
case 403:
|
|
167
|
+
throw new CatchAllApi.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
168
|
+
case 422:
|
|
169
|
+
throw new CatchAllApi.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
170
|
+
default:
|
|
171
|
+
throw new errors.CatchAllApiError({
|
|
172
|
+
statusCode: _response.error.statusCode,
|
|
173
|
+
body: _response.error.body,
|
|
174
|
+
rawResponse: _response.rawResponse,
|
|
175
|
+
});
|
|
176
|
+
}
|
|
177
|
+
}
|
|
178
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/catchAll/validate");
|
|
179
|
+
});
|
|
180
|
+
}
|
|
120
181
|
/**
|
|
121
182
|
* Get suggested validators, enrichments, and date ranges for a query.
|
|
122
183
|
*
|
|
@@ -415,11 +476,9 @@ class JobsClient {
|
|
|
415
476
|
});
|
|
416
477
|
}
|
|
417
478
|
/**
|
|
418
|
-
* Soft-deletes a job. The job is flagged as deleted and no longer
|
|
419
|
-
* appears in list results. The underlying data is retained.
|
|
479
|
+
* Soft-deletes a job. The job is flagged as deleted and no longer appears in list results. The underlying data is retained.
|
|
420
480
|
*
|
|
421
|
-
* Only the job owner can delete a job. Returns `404` if the job is not
|
|
422
|
-
* found or does not belong to the authenticated user.
|
|
481
|
+
* Only the job owner can delete a job. Returns `404` if the job is not found or does not belong to the authenticated user.
|
|
423
482
|
*
|
|
424
483
|
* Deleting an already-deleted job returns `200`.
|
|
425
484
|
*
|
|
@@ -1,7 +1,9 @@
|
|
|
1
1
|
import type * as CatchAllApi from "../../../../index.js";
|
|
2
2
|
/**
|
|
3
3
|
* @example
|
|
4
|
-
* {
|
|
4
|
+
* {
|
|
5
|
+
* project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04"
|
|
6
|
+
* }
|
|
5
7
|
*/
|
|
6
8
|
export interface GetUserJobsRequest {
|
|
7
9
|
/** Page number to retrieve. */
|
|
@@ -10,6 +12,7 @@ export interface GetUserJobsRequest {
|
|
|
10
12
|
page_size?: number;
|
|
11
13
|
/** Filter results by text (case-insensitive substring match). */
|
|
12
14
|
search?: string;
|
|
13
|
-
/** Filter results by ownership. Defaults to `all`. */
|
|
14
15
|
ownership?: CatchAllApi.OwnershipFilter;
|
|
16
|
+
/** Filter results to resources belonging to this project. */
|
|
17
|
+
project_id?: string;
|
|
15
18
|
}
|
|
@@ -36,11 +36,21 @@ export interface SubmitRequestDto {
|
|
|
36
36
|
*/
|
|
37
37
|
mode?: SubmitRequestDto.Mode;
|
|
38
38
|
/**
|
|
39
|
-
* Dataset IDs to connect to
|
|
39
|
+
* Dataset IDs to connect to the job. When provided, this enables Company Watchlist mode — the job returns only events relevant to companies in the connected datasets. To set the minimum relevance threshold, use `ed_score_min`.
|
|
40
40
|
*
|
|
41
41
|
* The dataset must have `latest_status: ready` before the job is submitted. Submitting with a non-existent or inaccessible dataset ID returns `400`.
|
|
42
42
|
*/
|
|
43
43
|
connected_dataset_ids?: string[];
|
|
44
|
+
/**
|
|
45
|
+
* The minimum relevance score a connected entity must reach for its record to be included in results.
|
|
46
|
+
*
|
|
47
|
+
* Only valid when `connected_dataset_ids` is set; otherwise ignored. Records where no connected entity meets the threshold are excluded entirely.
|
|
48
|
+
*/
|
|
49
|
+
ed_score_min?: number;
|
|
50
|
+
/** Project to assign this job to. The job appears in the project's resource list immediately after submission. */
|
|
51
|
+
project_id?: string;
|
|
52
|
+
/** IDs of webhooks to notify when the job completes. Maximum 5 per job. */
|
|
53
|
+
webhook_ids?: string[];
|
|
44
54
|
}
|
|
45
55
|
export declare namespace SubmitRequestDto {
|
|
46
56
|
/**
|
|
@@ -5,3 +5,4 @@ export type { GetJobStatusRequest } from "./GetJobStatusRequest.js";
|
|
|
5
5
|
export type { GetUserJobsRequest } from "./GetUserJobsRequest.js";
|
|
6
6
|
export type { InitializeRequestDto } from "./InitializeRequestDto.js";
|
|
7
7
|
export { SubmitRequestDto } from "./SubmitRequestDto.js";
|
|
8
|
+
export type { ValidateQueryRequestDto } from "./ValidateQueryRequestDto.js";
|
|
@@ -23,7 +23,9 @@ export declare class MonitorsClient {
|
|
|
23
23
|
* @throws {@link CatchAllApi.UnprocessableEntityError}
|
|
24
24
|
*
|
|
25
25
|
* @example
|
|
26
|
-
* await client.monitors.listMonitors(
|
|
26
|
+
* await client.monitors.listMonitors({
|
|
27
|
+
* project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04"
|
|
28
|
+
* })
|
|
27
29
|
*/
|
|
28
30
|
listMonitors(request?: CatchAllApi.ListMonitorsRequest, requestOptions?: MonitorsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.ListMonitorsResponseDto>;
|
|
29
31
|
private __listMonitors;
|
|
@@ -38,14 +40,9 @@ export declare class MonitorsClient {
|
|
|
38
40
|
* @example
|
|
39
41
|
* await client.monitors.createMonitor({
|
|
40
42
|
* reference_job_id: "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c",
|
|
41
|
-
* schedule: "every day at 12 PM
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
* method: "POST",
|
|
45
|
-
* headers: {
|
|
46
|
-
* "Authorization": "Bearer your_token_here"
|
|
47
|
-
* }
|
|
48
|
-
* },
|
|
43
|
+
* schedule: "every day at 12 PM",
|
|
44
|
+
* timezone: "UTC",
|
|
45
|
+
* webhook_ids: ["a1b2c3d4-e5f6-7890-abcd-ef1234567890"],
|
|
49
46
|
* limit: 10,
|
|
50
47
|
* backfill: true
|
|
51
48
|
* })
|
|
@@ -171,13 +168,7 @@ export declare class MonitorsClient {
|
|
|
171
168
|
* @example
|
|
172
169
|
* await client.monitors.updateMonitor({
|
|
173
170
|
* monitor_id: "monitor_id",
|
|
174
|
-
*
|
|
175
|
-
* url: "https://new-endpoint.com/webhook",
|
|
176
|
-
* method: "POST",
|
|
177
|
-
* headers: {
|
|
178
|
-
* "Authorization": "Bearer new_token_xyz"
|
|
179
|
-
* }
|
|
180
|
-
* }
|
|
171
|
+
* webhook_ids: ["a1b2c3d4-e5f6-7890-abcd-ef1234567890"]
|
|
181
172
|
* })
|
|
182
173
|
*/
|
|
183
174
|
updateMonitor(request: CatchAllApi.UpdateMonitorRequestDto, requestOptions?: MonitorsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.UpdateMonitorResponseDto>;
|
|
@@ -79,7 +79,9 @@ class MonitorsClient {
|
|
|
79
79
|
* @throws {@link CatchAllApi.UnprocessableEntityError}
|
|
80
80
|
*
|
|
81
81
|
* @example
|
|
82
|
-
* await client.monitors.listMonitors(
|
|
82
|
+
* await client.monitors.listMonitors({
|
|
83
|
+
* project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04"
|
|
84
|
+
* })
|
|
83
85
|
*/
|
|
84
86
|
listMonitors(request = {}, requestOptions) {
|
|
85
87
|
return core.HttpResponsePromise.fromPromise(this.__listMonitors(request, requestOptions));
|
|
@@ -87,12 +89,13 @@ class MonitorsClient {
|
|
|
87
89
|
__listMonitors() {
|
|
88
90
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
89
91
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
90
|
-
const { page, page_size: pageSize, search, ownership } = request;
|
|
92
|
+
const { page, page_size: pageSize, search, ownership, project_id: projectId } = request;
|
|
91
93
|
const _queryParams = {
|
|
92
94
|
page,
|
|
93
95
|
page_size: pageSize,
|
|
94
96
|
search,
|
|
95
97
|
ownership: ownership != null ? ownership : undefined,
|
|
98
|
+
project_id: projectId,
|
|
96
99
|
};
|
|
97
100
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
98
101
|
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
@@ -142,14 +145,9 @@ class MonitorsClient {
|
|
|
142
145
|
* @example
|
|
143
146
|
* await client.monitors.createMonitor({
|
|
144
147
|
* reference_job_id: "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c",
|
|
145
|
-
* schedule: "every day at 12 PM
|
|
146
|
-
*
|
|
147
|
-
*
|
|
148
|
-
* method: "POST",
|
|
149
|
-
* headers: {
|
|
150
|
-
* "Authorization": "Bearer your_token_here"
|
|
151
|
-
* }
|
|
152
|
-
* },
|
|
148
|
+
* schedule: "every day at 12 PM",
|
|
149
|
+
* timezone: "UTC",
|
|
150
|
+
* webhook_ids: ["a1b2c3d4-e5f6-7890-abcd-ef1234567890"],
|
|
153
151
|
* limit: 10,
|
|
154
152
|
* backfill: true
|
|
155
153
|
* })
|
|
@@ -558,13 +556,7 @@ class MonitorsClient {
|
|
|
558
556
|
* @example
|
|
559
557
|
* await client.monitors.updateMonitor({
|
|
560
558
|
* monitor_id: "monitor_id",
|
|
561
|
-
*
|
|
562
|
-
* url: "https://new-endpoint.com/webhook",
|
|
563
|
-
* method: "POST",
|
|
564
|
-
* headers: {
|
|
565
|
-
* "Authorization": "Bearer new_token_xyz"
|
|
566
|
-
* }
|
|
567
|
-
* }
|
|
559
|
+
* webhook_ids: ["a1b2c3d4-e5f6-7890-abcd-ef1234567890"]
|
|
568
560
|
* })
|
|
569
561
|
*/
|
|
570
562
|
updateMonitor(request, requestOptions) {
|
|
@@ -1,16 +1,10 @@
|
|
|
1
|
-
import type * as CatchAllApi from "../../../../index.js";
|
|
2
1
|
/**
|
|
3
2
|
* @example
|
|
4
3
|
* {
|
|
5
4
|
* reference_job_id: "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c",
|
|
6
|
-
* schedule: "every day at 12 PM
|
|
7
|
-
*
|
|
8
|
-
*
|
|
9
|
-
* method: "POST",
|
|
10
|
-
* headers: {
|
|
11
|
-
* "Authorization": "Bearer your_token_here"
|
|
12
|
-
* }
|
|
13
|
-
* },
|
|
5
|
+
* schedule: "every day at 12 PM",
|
|
6
|
+
* timezone: "UTC",
|
|
7
|
+
* webhook_ids: ["a1b2c3d4-e5f6-7890-abcd-ef1234567890"],
|
|
14
8
|
* limit: 10,
|
|
15
9
|
* backfill: true
|
|
16
10
|
* }
|
|
@@ -22,14 +16,21 @@ export interface CreateMonitorRequestDto {
|
|
|
22
16
|
* If [`backfill`](https://www.newscatcherapi.com/docs/web-search-api/api-reference/monitors/create-monitor#body-backfill) is true, the job's `end_date` must be within the last 7 days.
|
|
23
17
|
*/
|
|
24
18
|
reference_job_id: string;
|
|
19
|
+
/** Monitor schedule in plain text format. Minimum frequency depends on your plan. */
|
|
20
|
+
schedule: string;
|
|
25
21
|
/**
|
|
26
|
-
*
|
|
22
|
+
* The IANA timezone identifier used as the fallback when the `schedule` string does not include an explicit timezone.
|
|
27
23
|
*
|
|
28
|
-
*
|
|
24
|
+
* If the schedule includes a timezone abbreviation (for example, `"every day at 9am EST"`), the parsed timezone takes priority and this value is ignored.
|
|
29
25
|
*/
|
|
30
|
-
|
|
31
|
-
/**
|
|
32
|
-
|
|
26
|
+
timezone?: string;
|
|
27
|
+
/**
|
|
28
|
+
* IDs of centralized webhooks to notify on each run completion.
|
|
29
|
+
* Passing IDs here is equivalent to calling
|
|
30
|
+
* `POST /catchAll/webhooks/{webhook_id}/resources` for each ID after creation.
|
|
31
|
+
* Maximum 5 per monitor.
|
|
32
|
+
*/
|
|
33
|
+
webhook_ids?: string[];
|
|
33
34
|
/** Maximum number of records per monitor run. If not provided, defaults to the plan limit. */
|
|
34
35
|
limit?: number;
|
|
35
36
|
/**
|
|
@@ -38,4 +39,6 @@ export interface CreateMonitorRequestDto {
|
|
|
38
39
|
* If false, no gap filling occurs and the first run uses the current cron window only — the reference job's age does not matter.
|
|
39
40
|
*/
|
|
40
41
|
backfill?: boolean;
|
|
42
|
+
/** Project to assign this monitor to. The monitor appears in the project's resource list after creation. */
|
|
43
|
+
project_id?: string;
|
|
41
44
|
}
|
|
@@ -1,7 +1,9 @@
|
|
|
1
1
|
import type * as CatchAllApi from "../../../../index.js";
|
|
2
2
|
/**
|
|
3
3
|
* @example
|
|
4
|
-
* {
|
|
4
|
+
* {
|
|
5
|
+
* project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04"
|
|
6
|
+
* }
|
|
5
7
|
*/
|
|
6
8
|
export interface ListMonitorsRequest {
|
|
7
9
|
/** Page number to retrieve. */
|
|
@@ -10,6 +12,7 @@ export interface ListMonitorsRequest {
|
|
|
10
12
|
page_size?: number;
|
|
11
13
|
/** Filter results by text (case-insensitive substring match). */
|
|
12
14
|
search?: string;
|
|
13
|
-
/** Filter results by ownership. Defaults to `all`. */
|
|
14
15
|
ownership?: CatchAllApi.OwnershipFilter;
|
|
16
|
+
/** Filter results to resources belonging to this project. */
|
|
17
|
+
project_id?: string;
|
|
15
18
|
}
|
|
@@ -1,22 +1,19 @@
|
|
|
1
|
-
import type * as CatchAllApi from "../../../../index.js";
|
|
2
1
|
/**
|
|
3
2
|
* @example
|
|
4
3
|
* {
|
|
5
4
|
* monitor_id: "monitor_id",
|
|
6
|
-
*
|
|
7
|
-
* url: "https://new-endpoint.com/webhook",
|
|
8
|
-
* method: "POST",
|
|
9
|
-
* headers: {
|
|
10
|
-
* "Authorization": "Bearer new_token_xyz"
|
|
11
|
-
* }
|
|
12
|
-
* }
|
|
5
|
+
* webhook_ids: ["a1b2c3d4-e5f6-7890-abcd-ef1234567890"]
|
|
13
6
|
* }
|
|
14
7
|
*/
|
|
15
8
|
export interface UpdateMonitorRequestDto {
|
|
16
9
|
/** Monitor identifier. */
|
|
17
10
|
monitor_id: string;
|
|
18
|
-
/**
|
|
19
|
-
|
|
11
|
+
/**
|
|
12
|
+
* Updated list of centralized webhook IDs for this monitor.
|
|
13
|
+
*
|
|
14
|
+
* Replaces all existing webhook assignments. Pass an empty array `[]` to clear all assignments. Omit to leave existing assignments unchanged.
|
|
15
|
+
*/
|
|
16
|
+
webhook_ids?: string[];
|
|
20
17
|
/** Updated maximum number of records per monitor run. */
|
|
21
18
|
limit?: number;
|
|
22
19
|
}
|
|
@@ -0,0 +1,178 @@
|
|
|
1
|
+
import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
|
|
2
|
+
import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
|
|
3
|
+
import * as core from "../../../../core/index.js";
|
|
4
|
+
import * as CatchAllApi from "../../../index.js";
|
|
5
|
+
export declare namespace ProjectsClient {
|
|
6
|
+
type Options = BaseClientOptions;
|
|
7
|
+
interface RequestOptions extends BaseRequestOptions {
|
|
8
|
+
}
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* Operations to create, organize, and manage projects.
|
|
12
|
+
*
|
|
13
|
+
* A project is a named container for jobs, monitors, and datasets. Group
|
|
14
|
+
* related resources by use case, team, or client, and share them with
|
|
15
|
+
* teammates. Resources can be assigned at creation time or post-hoc.
|
|
16
|
+
*/
|
|
17
|
+
export declare class ProjectsClient {
|
|
18
|
+
protected readonly _options: NormalizedClientOptionsWithAuth<ProjectsClient.Options>;
|
|
19
|
+
constructor(options?: ProjectsClient.Options);
|
|
20
|
+
/**
|
|
21
|
+
* Returns all projects visible to the authenticated user.
|
|
22
|
+
*
|
|
23
|
+
* @param {CatchAllApi.ListProjectsRequest} request
|
|
24
|
+
* @param {ProjectsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
25
|
+
*
|
|
26
|
+
* @throws {@link CatchAllApi.ForbiddenError}
|
|
27
|
+
* @throws {@link CatchAllApi.UnprocessableEntityError}
|
|
28
|
+
*
|
|
29
|
+
* @example
|
|
30
|
+
* await client.projects.listProjects({
|
|
31
|
+
* search: "M&A"
|
|
32
|
+
* })
|
|
33
|
+
*/
|
|
34
|
+
listProjects(request?: CatchAllApi.ListProjectsRequest, requestOptions?: ProjectsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.ProjectListResponseDto>;
|
|
35
|
+
private __listProjects;
|
|
36
|
+
/**
|
|
37
|
+
* Creates a new project.
|
|
38
|
+
*
|
|
39
|
+
* @param {CatchAllApi.CreateProjectRequestDto} request
|
|
40
|
+
* @param {ProjectsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
41
|
+
*
|
|
42
|
+
* @throws {@link CatchAllApi.ForbiddenError}
|
|
43
|
+
* @throws {@link CatchAllApi.UnprocessableEntityError}
|
|
44
|
+
*
|
|
45
|
+
* @example
|
|
46
|
+
* await client.projects.createProject({
|
|
47
|
+
* name: "AI M&A Tracking",
|
|
48
|
+
* description: "Tracks AI-related M&A activity for our investment team."
|
|
49
|
+
* })
|
|
50
|
+
*/
|
|
51
|
+
createProject(request: CatchAllApi.CreateProjectRequestDto, requestOptions?: ProjectsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.CreateProjectResponseDto>;
|
|
52
|
+
private __createProject;
|
|
53
|
+
/**
|
|
54
|
+
* Returns a single project by ID.
|
|
55
|
+
*
|
|
56
|
+
* @param {CatchAllApi.GetProjectRequest} request
|
|
57
|
+
* @param {ProjectsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link CatchAllApi.ForbiddenError}
|
|
60
|
+
* @throws {@link CatchAllApi.NotFoundError}
|
|
61
|
+
*
|
|
62
|
+
* @example
|
|
63
|
+
* await client.projects.getProject({
|
|
64
|
+
* project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04"
|
|
65
|
+
* })
|
|
66
|
+
*/
|
|
67
|
+
getProject(request: CatchAllApi.GetProjectRequest, requestOptions?: ProjectsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.ProjectResponseDto>;
|
|
68
|
+
private __getProject;
|
|
69
|
+
/**
|
|
70
|
+
* Deletes a project. By default, assigned resources are unassigned but not deleted.
|
|
71
|
+
*
|
|
72
|
+
* @param {CatchAllApi.DeleteProjectRequest} request
|
|
73
|
+
* @param {ProjectsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link CatchAllApi.ForbiddenError}
|
|
76
|
+
* @throws {@link CatchAllApi.NotFoundError}
|
|
77
|
+
*
|
|
78
|
+
* @example
|
|
79
|
+
* await client.projects.deleteProject({
|
|
80
|
+
* project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04"
|
|
81
|
+
* })
|
|
82
|
+
*/
|
|
83
|
+
deleteProject(request: CatchAllApi.DeleteProjectRequest, requestOptions?: ProjectsClient.RequestOptions): core.HttpResponsePromise<void>;
|
|
84
|
+
private __deleteProject;
|
|
85
|
+
/**
|
|
86
|
+
* Updates the name or description of an existing project.
|
|
87
|
+
*
|
|
88
|
+
* @param {CatchAllApi.UpdateProjectRequestDto} request
|
|
89
|
+
* @param {ProjectsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link CatchAllApi.ForbiddenError}
|
|
92
|
+
* @throws {@link CatchAllApi.NotFoundError}
|
|
93
|
+
* @throws {@link CatchAllApi.UnprocessableEntityError}
|
|
94
|
+
*
|
|
95
|
+
* @example
|
|
96
|
+
* await client.projects.updateProject({
|
|
97
|
+
* project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04",
|
|
98
|
+
* name: "AI M&A Tracking (Q2 2026)"
|
|
99
|
+
* })
|
|
100
|
+
*/
|
|
101
|
+
updateProject(request: CatchAllApi.UpdateProjectRequestDto, requestOptions?: ProjectsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.UpdateProjectResponseDto>;
|
|
102
|
+
private __updateProject;
|
|
103
|
+
/**
|
|
104
|
+
* Returns resource counts for a project, grouped by type and status.
|
|
105
|
+
*
|
|
106
|
+
* 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.
|
|
107
|
+
*
|
|
108
|
+
* @param {CatchAllApi.GetProjectOverviewRequest} request
|
|
109
|
+
* @param {ProjectsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
110
|
+
*
|
|
111
|
+
* @throws {@link CatchAllApi.ForbiddenError}
|
|
112
|
+
* @throws {@link CatchAllApi.NotFoundError}
|
|
113
|
+
*
|
|
114
|
+
* @example
|
|
115
|
+
* await client.projects.getProjectOverview({
|
|
116
|
+
* project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04"
|
|
117
|
+
* })
|
|
118
|
+
*/
|
|
119
|
+
getProjectOverview(request: CatchAllApi.GetProjectOverviewRequest, requestOptions?: ProjectsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.ProjectOverviewResponseDto>;
|
|
120
|
+
private __getProjectOverview;
|
|
121
|
+
/**
|
|
122
|
+
* Returns all resources assigned to a project, with optional filtering by type.
|
|
123
|
+
*
|
|
124
|
+
* @param {CatchAllApi.ListProjectResourcesRequest} request
|
|
125
|
+
* @param {ProjectsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
126
|
+
*
|
|
127
|
+
* @throws {@link CatchAllApi.ForbiddenError}
|
|
128
|
+
* @throws {@link CatchAllApi.NotFoundError}
|
|
129
|
+
* @throws {@link CatchAllApi.UnprocessableEntityError}
|
|
130
|
+
*
|
|
131
|
+
* @example
|
|
132
|
+
* await client.projects.listProjectResources({
|
|
133
|
+
* project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04"
|
|
134
|
+
* })
|
|
135
|
+
*/
|
|
136
|
+
listProjectResources(request: CatchAllApi.ListProjectResourcesRequest, requestOptions?: ProjectsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.ProjectResourceListResponseDto>;
|
|
137
|
+
private __listProjectResources;
|
|
138
|
+
/**
|
|
139
|
+
* Assigns one or more existing resources to a project in a single request.
|
|
140
|
+
*
|
|
141
|
+
* @param {CatchAllApi.AddResourceRequestDto} request
|
|
142
|
+
* @param {ProjectsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
143
|
+
*
|
|
144
|
+
* @throws {@link CatchAllApi.BadRequestError}
|
|
145
|
+
* @throws {@link CatchAllApi.ForbiddenError}
|
|
146
|
+
* @throws {@link CatchAllApi.NotFoundError}
|
|
147
|
+
*
|
|
148
|
+
* @example
|
|
149
|
+
* await client.projects.addResourceToProject({
|
|
150
|
+
* project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04",
|
|
151
|
+
* resources: [{
|
|
152
|
+
* resource_type: "job",
|
|
153
|
+
* resource_id: "48421e16-1f50-4048-b62c-d3bc0789d30d"
|
|
154
|
+
* }]
|
|
155
|
+
* })
|
|
156
|
+
*/
|
|
157
|
+
addResourceToProject(request: CatchAllApi.AddResourceRequestDto, requestOptions?: ProjectsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.AddResourceResponseDto>;
|
|
158
|
+
private __addResourceToProject;
|
|
159
|
+
/**
|
|
160
|
+
* Removes a resource from a project. The resource itself is not
|
|
161
|
+
* deleted — it becomes unassigned and continues to exist.
|
|
162
|
+
*
|
|
163
|
+
* @param {CatchAllApi.RemoveResourceFromProjectRequest} request
|
|
164
|
+
* @param {ProjectsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
165
|
+
*
|
|
166
|
+
* @throws {@link CatchAllApi.ForbiddenError}
|
|
167
|
+
* @throws {@link CatchAllApi.NotFoundError}
|
|
168
|
+
*
|
|
169
|
+
* @example
|
|
170
|
+
* await client.projects.removeResourceFromProject({
|
|
171
|
+
* project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04",
|
|
172
|
+
* resource_type: "job",
|
|
173
|
+
* resource_id: "48421e16-1f50-4048-b62c-d3bc0789d30d"
|
|
174
|
+
* })
|
|
175
|
+
*/
|
|
176
|
+
removeResourceFromProject(request: CatchAllApi.RemoveResourceFromProjectRequest, requestOptions?: ProjectsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.RemoveResourceResponseDto>;
|
|
177
|
+
private __removeResourceFromProject;
|
|
178
|
+
}
|