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
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./requests/index.mjs";
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./requests/index.mjs";
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import type * as CatchAllApi from "../../../../index.mjs";
|
|
2
|
+
/**
|
|
3
|
+
* @example
|
|
4
|
+
* {
|
|
5
|
+
* webhook_id: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
|
6
|
+
* resource_type: "monitor",
|
|
7
|
+
* resource_id: "3fec5b07-8786-46d7-9486-d43ff67eccd4"
|
|
8
|
+
* }
|
|
9
|
+
*/
|
|
10
|
+
export interface AssignWebhookResourceRequestDto {
|
|
11
|
+
/** Unique webhook identifier. */
|
|
12
|
+
webhook_id: string;
|
|
13
|
+
/** Type of resource to assign. */
|
|
14
|
+
resource_type: CatchAllApi.MappableResourceType;
|
|
15
|
+
/** ID of the resource to assign. */
|
|
16
|
+
resource_id: string;
|
|
17
|
+
}
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
import type * as CatchAllApi from "../../../../index.mjs";
|
|
2
|
+
/**
|
|
3
|
+
* @example
|
|
4
|
+
* {
|
|
5
|
+
* name: "Layoffs Alert",
|
|
6
|
+
* url: "https://hooks.slack.com/services/T000/B000/xxx",
|
|
7
|
+
* type: "slack",
|
|
8
|
+
* delivery_mode: "full"
|
|
9
|
+
* }
|
|
10
|
+
*/
|
|
11
|
+
export interface CreateWebhookRequestDto {
|
|
12
|
+
/** Human-readable label for this webhook. */
|
|
13
|
+
name: string;
|
|
14
|
+
/**
|
|
15
|
+
* Destination URL that receives the payload. Must use HTTPS. IP addresses are not accepted.
|
|
16
|
+
*
|
|
17
|
+
* Type-specific URL requirements:
|
|
18
|
+
* - `slack`: Must start with `https://hooks.slack.com/`.
|
|
19
|
+
* - `teams`: Hostname must match `*.webhook.office.com` or `*.webhook.office365.com`.
|
|
20
|
+
* - `generic`: Any valid HTTPS domain.
|
|
21
|
+
* - `custom`: Any valid HTTPS domain.
|
|
22
|
+
*
|
|
23
|
+
* When `type` is omitted, it is auto-detected from the URL.
|
|
24
|
+
*/
|
|
25
|
+
url: string;
|
|
26
|
+
type?: CatchAllApi.WebhookType;
|
|
27
|
+
delivery_mode?: CatchAllApi.DeliveryMode;
|
|
28
|
+
method?: CatchAllApi.HttpMethod;
|
|
29
|
+
/** Custom HTTP headers forwarded with each delivery. */
|
|
30
|
+
headers?: Record<string, string>;
|
|
31
|
+
/** Query parameters appended to the webhook URL. */
|
|
32
|
+
params?: Record<string, string>;
|
|
33
|
+
/**
|
|
34
|
+
* Authentication forwarded with each delivery. Supported types:
|
|
35
|
+
* - `bearer`: Adds an `Authorization: Bearer <token>` header.
|
|
36
|
+
* - `api_key`: Adds a custom header with the specified name and value.
|
|
37
|
+
* - `basic`: Adds an `Authorization: Basic <credentials>` header.
|
|
38
|
+
*/
|
|
39
|
+
auth?: CatchAllApi.CreateWebhookRequestDtoAuth;
|
|
40
|
+
/** Custom payload transformation configuration. Required only when `type` is `custom`. */
|
|
41
|
+
formatter_config?: Record<string, unknown> | null;
|
|
42
|
+
}
|
package/dist/esm/api/resources/webhooks/client/requests/GetWebhookDeliveryHistoryRequest.d.mts
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import type * as CatchAllApi from "../../../../index.mjs";
|
|
2
|
+
/**
|
|
3
|
+
* @example
|
|
4
|
+
* {
|
|
5
|
+
* resource_type: "job",
|
|
6
|
+
* resource_id: "3fec5b07-8786-46d7-9486-d43ff67eccd4"
|
|
7
|
+
* }
|
|
8
|
+
*/
|
|
9
|
+
export interface GetWebhookDeliveryHistoryRequest {
|
|
10
|
+
/** Type of the resource to retrieve delivery history for. */
|
|
11
|
+
resource_type: CatchAllApi.MappableResourceType;
|
|
12
|
+
/** Identifier of the resource to retrieve delivery history for. */
|
|
13
|
+
resource_id: string;
|
|
14
|
+
/** Page number to retrieve. */
|
|
15
|
+
page?: number;
|
|
16
|
+
/** Number of records per page. */
|
|
17
|
+
page_size?: number;
|
|
18
|
+
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import type * as CatchAllApi from "../../../../index.mjs";
|
|
2
|
+
/**
|
|
3
|
+
* @example
|
|
4
|
+
* {
|
|
5
|
+
* webhook_id: "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
|
|
6
|
+
* }
|
|
7
|
+
*/
|
|
8
|
+
export interface ListWebhookResourcesRequest {
|
|
9
|
+
/** Unique webhook identifier. */
|
|
10
|
+
webhook_id: string;
|
|
11
|
+
resource_type?: CatchAllApi.MappableResourceType;
|
|
12
|
+
/** Page number to retrieve. */
|
|
13
|
+
page?: number;
|
|
14
|
+
/** Number of assignments per page. */
|
|
15
|
+
page_size?: number;
|
|
16
|
+
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import type * as CatchAllApi from "../../../../index.mjs";
|
|
2
|
+
/**
|
|
3
|
+
* @example
|
|
4
|
+
* {
|
|
5
|
+
* resource_type: "job",
|
|
6
|
+
* resource_id: "3fec5b07-8786-46d7-9486-d43ff67eccd4"
|
|
7
|
+
* }
|
|
8
|
+
*/
|
|
9
|
+
export interface ListWebhooksForResourceRequest {
|
|
10
|
+
resource_type: CatchAllApi.MappableResourceType;
|
|
11
|
+
/** Unique resource identifier. */
|
|
12
|
+
resource_id: string;
|
|
13
|
+
/** Filter by active status. Omit to return webhooks regardless of status. */
|
|
14
|
+
is_active?: boolean;
|
|
15
|
+
/** Page number to retrieve. */
|
|
16
|
+
page?: number;
|
|
17
|
+
/** Number of webhooks per page. */
|
|
18
|
+
page_size?: number;
|
|
19
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {}
|
|
4
|
+
*/
|
|
5
|
+
export interface ListWebhooksRequest {
|
|
6
|
+
/** Page number to retrieve. */
|
|
7
|
+
page?: number;
|
|
8
|
+
/** Number of webhooks per page. */
|
|
9
|
+
page_size?: number;
|
|
10
|
+
/** Filter results by text (case-insensitive substring match). */
|
|
11
|
+
search?: string;
|
|
12
|
+
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import type * as CatchAllApi from "../../../../index.mjs";
|
|
2
|
+
/**
|
|
3
|
+
* @example
|
|
4
|
+
* {
|
|
5
|
+
* webhook_id: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
|
6
|
+
* resource_type: "job",
|
|
7
|
+
* resource_id: "3fec5b07-8786-46d7-9486-d43ff67eccd4"
|
|
8
|
+
* }
|
|
9
|
+
*/
|
|
10
|
+
export interface RemoveWebhookResourceRequest {
|
|
11
|
+
/** Unique webhook identifier. */
|
|
12
|
+
webhook_id: string;
|
|
13
|
+
resource_type: CatchAllApi.MappableResourceType;
|
|
14
|
+
/** Unique resource identifier. */
|
|
15
|
+
resource_id: string;
|
|
16
|
+
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {
|
|
4
|
+
* webhook_id: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
|
5
|
+
* payload: {
|
|
6
|
+
* "test": true,
|
|
7
|
+
* "message": "CatchAll webhook test"
|
|
8
|
+
* }
|
|
9
|
+
* }
|
|
10
|
+
*/
|
|
11
|
+
export interface TestWebhookRequestDto {
|
|
12
|
+
/** Unique webhook identifier. */
|
|
13
|
+
webhook_id: string;
|
|
14
|
+
/**
|
|
15
|
+
* Custom payload to send in the test request. If omitted, a synthetic
|
|
16
|
+
* test payload is sent.
|
|
17
|
+
*/
|
|
18
|
+
payload?: Record<string, unknown>;
|
|
19
|
+
}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import type * as CatchAllApi from "../../../../index.mjs";
|
|
2
|
+
/**
|
|
3
|
+
* @example
|
|
4
|
+
* {
|
|
5
|
+
* webhook_id: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
|
6
|
+
* name: "Layoffs Alert (EU)",
|
|
7
|
+
* is_active: false
|
|
8
|
+
* }
|
|
9
|
+
*/
|
|
10
|
+
export interface UpdateWebhookRequestDto {
|
|
11
|
+
/** Unique webhook identifier. */
|
|
12
|
+
webhook_id: string;
|
|
13
|
+
/** Updated webhook name. */
|
|
14
|
+
name?: string;
|
|
15
|
+
/** Updated destination URL. Must use HTTPS. Type-specific URL rules apply. */
|
|
16
|
+
url?: string;
|
|
17
|
+
type?: CatchAllApi.WebhookType;
|
|
18
|
+
delivery_mode?: CatchAllApi.DeliveryMode;
|
|
19
|
+
method?: CatchAllApi.HttpMethod;
|
|
20
|
+
/** Updated HTTP headers. Replaces existing headers entirely. */
|
|
21
|
+
headers?: Record<string, string>;
|
|
22
|
+
/** Updated query parameters. Replaces existing params entirely. */
|
|
23
|
+
params?: Record<string, string>;
|
|
24
|
+
/** Updated authentication configuration. Replaces existing auth entirely. */
|
|
25
|
+
auth?: CatchAllApi.UpdateWebhookRequestDtoAuth;
|
|
26
|
+
/** Updated formatter configuration. */
|
|
27
|
+
formatter_config?: Record<string, unknown> | null;
|
|
28
|
+
/** Set to `false` to disable delivery without deleting the webhook. */
|
|
29
|
+
is_active?: boolean;
|
|
30
|
+
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
export type { AssignWebhookResourceRequestDto } from "./AssignWebhookResourceRequestDto.mjs";
|
|
2
|
+
export type { CreateWebhookRequestDto } from "./CreateWebhookRequestDto.mjs";
|
|
3
|
+
export type { DeleteWebhookRequest } from "./DeleteWebhookRequest.mjs";
|
|
4
|
+
export type { GetWebhookDeliveryHistoryRequest } from "./GetWebhookDeliveryHistoryRequest.mjs";
|
|
5
|
+
export type { GetWebhookRequest } from "./GetWebhookRequest.mjs";
|
|
6
|
+
export type { ListWebhookResourcesRequest } from "./ListWebhookResourcesRequest.mjs";
|
|
7
|
+
export type { ListWebhooksForResourceRequest } from "./ListWebhooksForResourceRequest.mjs";
|
|
8
|
+
export type { ListWebhooksRequest } from "./ListWebhooksRequest.mjs";
|
|
9
|
+
export type { RemoveWebhookResourceRequest } from "./RemoveWebhookResourceRequest.mjs";
|
|
10
|
+
export type { TestWebhookRequestDto } from "./TestWebhookRequestDto.mjs";
|
|
11
|
+
export type { UpdateWebhookRequestDto } from "./UpdateWebhookRequestDto.mjs";
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import type * as CatchAllApi from "../../../index.mjs";
|
|
2
|
+
/**
|
|
3
|
+
* Authentication forwarded with each delivery. Supported types:
|
|
4
|
+
* - `bearer`: Adds an `Authorization: Bearer <token>` header.
|
|
5
|
+
* - `api_key`: Adds a custom header with the specified name and value.
|
|
6
|
+
* - `basic`: Adds an `Authorization: Basic <credentials>` header.
|
|
7
|
+
*/
|
|
8
|
+
export type CreateWebhookRequestDtoAuth = CatchAllApi.CreateWebhookRequestDtoAuth.Bearer | CatchAllApi.CreateWebhookRequestDtoAuth.ApiKey | CatchAllApi.CreateWebhookRequestDtoAuth.Basic;
|
|
9
|
+
export declare namespace CreateWebhookRequestDtoAuth {
|
|
10
|
+
interface Bearer extends CatchAllApi.BearerAuthDto {
|
|
11
|
+
type: "bearer";
|
|
12
|
+
}
|
|
13
|
+
interface ApiKey extends CatchAllApi.ApiKeyAuthDto {
|
|
14
|
+
type: "api_key";
|
|
15
|
+
}
|
|
16
|
+
interface Basic extends CatchAllApi.BasicAuthDto {
|
|
17
|
+
type: "basic";
|
|
18
|
+
}
|
|
19
|
+
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import type * as CatchAllApi from "../../../index.mjs";
|
|
2
|
+
/**
|
|
3
|
+
* Updated authentication configuration. Replaces existing auth entirely.
|
|
4
|
+
*/
|
|
5
|
+
export type UpdateWebhookRequestDtoAuth = CatchAllApi.UpdateWebhookRequestDtoAuth.Bearer | CatchAllApi.UpdateWebhookRequestDtoAuth.ApiKey | CatchAllApi.UpdateWebhookRequestDtoAuth.Basic;
|
|
6
|
+
export declare namespace UpdateWebhookRequestDtoAuth {
|
|
7
|
+
interface Bearer extends CatchAllApi.BearerAuthDto {
|
|
8
|
+
type: "bearer";
|
|
9
|
+
}
|
|
10
|
+
interface ApiKey extends CatchAllApi.ApiKeyAuthDto {
|
|
11
|
+
type: "api_key";
|
|
12
|
+
}
|
|
13
|
+
interface Basic extends CatchAllApi.BasicAuthDto {
|
|
14
|
+
type: "basic";
|
|
15
|
+
}
|
|
16
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type * as CatchAllApi from "../index.mjs";
|
|
2
|
+
export interface AddResourceResponseDto {
|
|
3
|
+
/** True if the overall operation succeeded. */
|
|
4
|
+
success: boolean;
|
|
5
|
+
/** Top-level result message. */
|
|
6
|
+
message: string;
|
|
7
|
+
/** Per-resource outcome, one entry per submitted resource. */
|
|
8
|
+
results: CatchAllApi.ResourceResultDto[];
|
|
9
|
+
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type * as CatchAllApi from "../index.mjs";
|
|
2
|
+
export interface AssignWebhookResourceResponseDto {
|
|
3
|
+
/** True if the operation succeeded; false otherwise. */
|
|
4
|
+
success: boolean;
|
|
5
|
+
/** Human-readable result message. */
|
|
6
|
+
message?: string | undefined;
|
|
7
|
+
/** True if the assignment already existed before this request. */
|
|
8
|
+
already_existed?: boolean | undefined;
|
|
9
|
+
/** The created or existing resource mapping. */
|
|
10
|
+
mapping?: CatchAllApi.WebhookResourceMappingResponseDto | undefined;
|
|
11
|
+
}
|
|
@@ -27,7 +27,7 @@ export interface ConnectedEntity {
|
|
|
27
27
|
/**
|
|
28
28
|
* The stored attributes for this entity. Present only when attributes exist in the database.
|
|
29
29
|
*
|
|
30
|
-
* The field name matches the value of `type` — for example, `"company"` type entities have a `company`
|
|
30
|
+
* The field name matches the value of `type` — for example, `"company"` type entities have a `company` field.
|
|
31
31
|
*/
|
|
32
32
|
company?: CatchAllApi.CompanyAttributes | undefined;
|
|
33
33
|
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
export interface CreateProjectResponseDto {
|
|
2
|
+
/** True if the operation succeeded; false otherwise. */
|
|
3
|
+
success: boolean;
|
|
4
|
+
/** Human-readable result message. */
|
|
5
|
+
message: string;
|
|
6
|
+
/** Project identifier. */
|
|
7
|
+
project_id: string;
|
|
8
|
+
/** Name of the created project. */
|
|
9
|
+
name: string;
|
|
10
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type * as CatchAllApi from "../index.mjs";
|
|
2
|
+
export interface CreateWebhookResponseDto {
|
|
3
|
+
/** True if the webhook was created; false otherwise. */
|
|
4
|
+
success: boolean;
|
|
5
|
+
/** Human-readable result message. */
|
|
6
|
+
message: string;
|
|
7
|
+
/** The created webhook object. */
|
|
8
|
+
webhook?: CatchAllApi.WebhookResponseDto | undefined;
|
|
9
|
+
}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import type * as CatchAllApi from "../index.mjs";
|
|
2
|
+
export interface DeliveryHistoryItemDto {
|
|
3
|
+
/** Delivery record identifier. */
|
|
4
|
+
id: number;
|
|
5
|
+
/** Identifier of the webhook that was dispatched. */
|
|
6
|
+
webhook_id: string;
|
|
7
|
+
/** Type of the resource that triggered the delivery. */
|
|
8
|
+
resource_type: CatchAllApi.MappableResourceType;
|
|
9
|
+
/** Identifier of the resource that triggered the delivery. */
|
|
10
|
+
resource_id: string;
|
|
11
|
+
/** Extra context about the triggering event, such as job query or monitor schedule. */
|
|
12
|
+
additional_info?: Record<string, unknown> | undefined;
|
|
13
|
+
/** HTTP response code returned by the webhook endpoint. */
|
|
14
|
+
status_code: number;
|
|
15
|
+
/** Delivery attempt number. 1 indicates the first attempt. */
|
|
16
|
+
attempt_number: number;
|
|
17
|
+
/** Time of the delivery attempt in ISO 8601 format with UTC timezone. */
|
|
18
|
+
timestamp: string;
|
|
19
|
+
/** Outcome of this delivery attempt. */
|
|
20
|
+
delivery_status: CatchAllApi.DeliveryStatus;
|
|
21
|
+
/** Error detail when `delivery_status` is `FAILED`. Null on success. */
|
|
22
|
+
error_message?: (string | null) | undefined;
|
|
23
|
+
/** Non-fatal warning, such as payload truncation notices. Null when no warnings occurred. */
|
|
24
|
+
warning_message?: (string | null) | undefined;
|
|
25
|
+
}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import type * as CatchAllApi from "../index.mjs";
|
|
2
|
+
export interface DeliveryHistoryResponseDto {
|
|
3
|
+
/** Type of the queried resource. */
|
|
4
|
+
resource_type: CatchAllApi.MappableResourceType;
|
|
5
|
+
/** Identifier of the queried resource. */
|
|
6
|
+
resource_id: string;
|
|
7
|
+
/** Total number of delivery records for this resource. */
|
|
8
|
+
total: number;
|
|
9
|
+
/** Current page number. */
|
|
10
|
+
page: number;
|
|
11
|
+
/** Number of records per page. */
|
|
12
|
+
page_size: number;
|
|
13
|
+
/** Total number of pages available. */
|
|
14
|
+
total_pages: number;
|
|
15
|
+
/** Delivery records on this page, ordered by timestamp descending. */
|
|
16
|
+
items: CatchAllApi.DeliveryHistoryItemDto[];
|
|
17
|
+
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Delivery mode for webhook payloads.
|
|
3
|
+
*
|
|
4
|
+
* - `full`: Sends all records in a single request on each trigger.
|
|
5
|
+
* - `per_record`: Sends one request per record. For large result sets, this may generate many requests.
|
|
6
|
+
*/
|
|
7
|
+
export declare const DeliveryMode: {
|
|
8
|
+
readonly Full: "full";
|
|
9
|
+
readonly PerRecord: "per_record";
|
|
10
|
+
};
|
|
11
|
+
export type DeliveryMode = (typeof DeliveryMode)[keyof typeof DeliveryMode];
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
+
/**
|
|
3
|
+
* Delivery mode for webhook payloads.
|
|
4
|
+
*
|
|
5
|
+
* - `full`: Sends all records in a single request on each trigger.
|
|
6
|
+
* - `per_record`: Sends one request per record. For large result sets, this may generate many requests.
|
|
7
|
+
*/
|
|
8
|
+
export const DeliveryMode = {
|
|
9
|
+
Full: "full",
|
|
10
|
+
PerRecord: "per_record",
|
|
11
|
+
};
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type * as CatchAllApi from "../index.mjs";
|
|
2
|
+
export interface GetWebhookResponseDto {
|
|
3
|
+
/** True if the operation succeeded; false otherwise. */
|
|
4
|
+
success: boolean;
|
|
5
|
+
/** Human-readable result message. */
|
|
6
|
+
message: string;
|
|
7
|
+
/** The retrieved webhook object. */
|
|
8
|
+
webhook?: CatchAllApi.WebhookResponseDto | undefined;
|
|
9
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/** HTTP method used for webhook delivery. */
|
|
2
|
+
export declare const HttpMethod: {
|
|
3
|
+
readonly Get: "GET";
|
|
4
|
+
readonly Post: "POST";
|
|
5
|
+
readonly Put: "PUT";
|
|
6
|
+
readonly Patch: "PATCH";
|
|
7
|
+
readonly Delete: "DELETE";
|
|
8
|
+
};
|
|
9
|
+
export type HttpMethod = (typeof HttpMethod)[keyof typeof HttpMethod];
|