newscatcher-catchall-sdk 0.1.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/LICENSE +21 -0
- package/README.md +332 -0
- package/dist/cjs/BaseClient.d.ts +31 -0
- package/dist/cjs/BaseClient.js +50 -0
- package/dist/cjs/Client.d.ts +20 -0
- package/dist/cjs/Client.js +26 -0
- package/dist/cjs/api/errors/ForbiddenError.d.ts +6 -0
- package/dist/cjs/api/errors/ForbiddenError.js +50 -0
- package/dist/cjs/api/errors/NotFoundError.d.ts +6 -0
- package/dist/cjs/api/errors/NotFoundError.js +50 -0
- package/dist/cjs/api/errors/UnprocessableEntityError.d.ts +6 -0
- package/dist/cjs/api/errors/UnprocessableEntityError.js +50 -0
- package/dist/cjs/api/errors/index.d.ts +3 -0
- package/dist/cjs/api/errors/index.js +19 -0
- package/dist/cjs/api/index.d.ts +3 -0
- package/dist/cjs/api/index.js +19 -0
- package/dist/cjs/api/resources/index.d.ts +7 -0
- package/dist/cjs/api/resources/index.js +46 -0
- package/dist/cjs/api/resources/jobs/client/Client.d.ts +77 -0
- package/dist/cjs/api/resources/jobs/client/Client.js +335 -0
- package/dist/cjs/api/resources/jobs/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/jobs/client/index.js +17 -0
- package/dist/cjs/api/resources/jobs/client/requests/GetJobResultsRequest.d.ts +14 -0
- package/dist/cjs/api/resources/jobs/client/requests/GetJobResultsRequest.js +3 -0
- package/dist/cjs/api/resources/jobs/client/requests/GetJobStatusRequest.d.ts +10 -0
- package/dist/cjs/api/resources/jobs/client/requests/GetJobStatusRequest.js +3 -0
- package/dist/cjs/api/resources/jobs/client/requests/SubmitRequestDto.d.ts +14 -0
- package/dist/cjs/api/resources/jobs/client/requests/SubmitRequestDto.js +3 -0
- package/dist/cjs/api/resources/jobs/client/requests/index.d.ts +3 -0
- package/dist/cjs/api/resources/jobs/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/jobs/index.d.ts +1 -0
- package/dist/cjs/api/resources/jobs/index.js +17 -0
- package/dist/cjs/api/resources/meta/client/Client.d.ts +37 -0
- package/dist/cjs/api/resources/meta/client/Client.js +172 -0
- package/dist/cjs/api/resources/meta/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/meta/client/index.js +2 -0
- package/dist/cjs/api/resources/meta/index.d.ts +2 -0
- package/dist/cjs/api/resources/meta/index.js +18 -0
- package/dist/cjs/api/resources/meta/types/GetVersionResponse.d.ts +3 -0
- package/dist/cjs/api/resources/meta/types/GetVersionResponse.js +3 -0
- package/dist/cjs/api/resources/meta/types/HealthCheckResponse.d.ts +3 -0
- package/dist/cjs/api/resources/meta/types/HealthCheckResponse.js +3 -0
- package/dist/cjs/api/resources/meta/types/index.d.ts +2 -0
- package/dist/cjs/api/resources/meta/types/index.js +18 -0
- package/dist/cjs/api/resources/monitors/client/Client.d.ts +119 -0
- package/dist/cjs/api/resources/monitors/client/Client.js +482 -0
- package/dist/cjs/api/resources/monitors/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/monitors/client/index.js +17 -0
- package/dist/cjs/api/resources/monitors/client/requests/CreateMonitorRequestDto.d.ts +23 -0
- package/dist/cjs/api/resources/monitors/client/requests/CreateMonitorRequestDto.js +3 -0
- package/dist/cjs/api/resources/monitors/client/requests/DisableMonitorRequest.d.ts +10 -0
- package/dist/cjs/api/resources/monitors/client/requests/DisableMonitorRequest.js +3 -0
- package/dist/cjs/api/resources/monitors/client/requests/EnableMonitorRequest.d.ts +10 -0
- package/dist/cjs/api/resources/monitors/client/requests/EnableMonitorRequest.js +3 -0
- package/dist/cjs/api/resources/monitors/client/requests/ListMonitorJobsRequest.d.ts +13 -0
- package/dist/cjs/api/resources/monitors/client/requests/ListMonitorJobsRequest.js +3 -0
- package/dist/cjs/api/resources/monitors/client/requests/PullMonitorResultsRequest.d.ts +10 -0
- package/dist/cjs/api/resources/monitors/client/requests/PullMonitorResultsRequest.js +3 -0
- package/dist/cjs/api/resources/monitors/client/requests/index.d.ts +5 -0
- package/dist/cjs/api/resources/monitors/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/monitors/index.d.ts +2 -0
- package/dist/cjs/api/resources/monitors/index.js +18 -0
- package/dist/cjs/api/resources/monitors/types/DisableMonitorResponse.d.ts +8 -0
- package/dist/cjs/api/resources/monitors/types/DisableMonitorResponse.js +3 -0
- package/dist/cjs/api/resources/monitors/types/EnableMonitorResponse.d.ts +8 -0
- package/dist/cjs/api/resources/monitors/types/EnableMonitorResponse.js +3 -0
- package/dist/cjs/api/resources/monitors/types/ListMonitorJobsRequestSort.d.ts +5 -0
- package/dist/cjs/api/resources/monitors/types/ListMonitorJobsRequestSort.js +8 -0
- package/dist/cjs/api/resources/monitors/types/ListMonitorJobsResponse.d.ts +19 -0
- package/dist/cjs/api/resources/monitors/types/ListMonitorJobsResponse.js +12 -0
- package/dist/cjs/api/resources/monitors/types/index.d.ts +4 -0
- package/dist/cjs/api/resources/monitors/types/index.js +20 -0
- package/dist/cjs/api/types/Citation.d.ts +8 -0
- package/dist/cjs/api/types/Citation.js +3 -0
- package/dist/cjs/api/types/Context.d.ts +4 -0
- package/dist/cjs/api/types/Context.js +3 -0
- package/dist/cjs/api/types/CreateMonitorResponseDto.d.ts +6 -0
- package/dist/cjs/api/types/CreateMonitorResponseDto.js +3 -0
- package/dist/cjs/api/types/Error_.d.ts +4 -0
- package/dist/cjs/api/types/Error_.js +3 -0
- package/dist/cjs/api/types/JobStatus.d.ts +23 -0
- package/dist/cjs/api/types/JobStatus.js +26 -0
- package/dist/cjs/api/types/JobStep.d.ts +8 -0
- package/dist/cjs/api/types/JobStep.js +3 -0
- package/dist/cjs/api/types/ListMonitorsResponseDto.d.ts +7 -0
- package/dist/cjs/api/types/ListMonitorsResponseDto.js +3 -0
- package/dist/cjs/api/types/ListUserJobsResponseDto.d.ts +6 -0
- package/dist/cjs/api/types/ListUserJobsResponseDto.js +3 -0
- package/dist/cjs/api/types/MonitorCitation.d.ts +16 -0
- package/dist/cjs/api/types/MonitorCitation.js +3 -0
- package/dist/cjs/api/types/MonitorJobItem.d.ts +8 -0
- package/dist/cjs/api/types/MonitorJobItem.js +3 -0
- package/dist/cjs/api/types/MonitorListItemDto.d.ts +16 -0
- package/dist/cjs/api/types/MonitorListItemDto.js +3 -0
- package/dist/cjs/api/types/MonitorRecord.d.ts +23 -0
- package/dist/cjs/api/types/MonitorRecord.js +3 -0
- package/dist/cjs/api/types/PullJobResponseDto.d.ts +34 -0
- package/dist/cjs/api/types/PullJobResponseDto.js +3 -0
- package/dist/cjs/api/types/PullMonitorResponseDto.d.ts +35 -0
- package/dist/cjs/api/types/PullMonitorResponseDto.js +3 -0
- package/dist/cjs/api/types/Query.d.ts +6 -0
- package/dist/cjs/api/types/Query.js +3 -0
- package/dist/cjs/api/types/Record_.d.ts +15 -0
- package/dist/cjs/api/types/Record_.js +3 -0
- package/dist/cjs/api/types/ReferenceJob.d.ts +6 -0
- package/dist/cjs/api/types/ReferenceJob.js +3 -0
- package/dist/cjs/api/types/Schema.d.ts +6 -0
- package/dist/cjs/api/types/Schema.js +3 -0
- package/dist/cjs/api/types/StatusResponseDto.d.ts +9 -0
- package/dist/cjs/api/types/StatusResponseDto.js +3 -0
- package/dist/cjs/api/types/SubmitResponseBody.d.ts +4 -0
- package/dist/cjs/api/types/SubmitResponseBody.js +3 -0
- package/dist/cjs/api/types/ValidationErrorDetail.d.ts +14 -0
- package/dist/cjs/api/types/ValidationErrorDetail.js +3 -0
- package/dist/cjs/api/types/ValidationErrorResponse.d.ts +4 -0
- package/dist/cjs/api/types/ValidationErrorResponse.js +3 -0
- package/dist/cjs/api/types/WebhookDto.d.ts +20 -0
- package/dist/cjs/api/types/WebhookDto.js +12 -0
- package/dist/cjs/api/types/WebhookPayload.d.ts +28 -0
- package/dist/cjs/api/types/WebhookPayload.js +3 -0
- package/dist/cjs/api/types/index.d.ts +24 -0
- package/dist/cjs/api/types/index.js +40 -0
- package/dist/cjs/core/exports.d.ts +1 -0
- package/dist/cjs/core/exports.js +17 -0
- package/dist/cjs/core/fetcher/APIResponse.d.ts +20 -0
- package/dist/cjs/core/fetcher/APIResponse.js +2 -0
- package/dist/cjs/core/fetcher/BinaryResponse.d.ts +20 -0
- package/dist/cjs/core/fetcher/BinaryResponse.js +17 -0
- package/dist/cjs/core/fetcher/EndpointMetadata.d.ts +13 -0
- package/dist/cjs/core/fetcher/EndpointMetadata.js +2 -0
- package/dist/cjs/core/fetcher/EndpointSupplier.d.ts +12 -0
- package/dist/cjs/core/fetcher/EndpointSupplier.js +22 -0
- package/dist/cjs/core/fetcher/Fetcher.d.ts +45 -0
- package/dist/cjs/core/fetcher/Fetcher.js +315 -0
- package/dist/cjs/core/fetcher/Headers.d.ts +2 -0
- package/dist/cjs/core/fetcher/Headers.js +84 -0
- package/dist/cjs/core/fetcher/HttpResponsePromise.d.ts +58 -0
- package/dist/cjs/core/fetcher/HttpResponsePromise.js +103 -0
- package/dist/cjs/core/fetcher/RawResponse.d.ts +29 -0
- package/dist/cjs/core/fetcher/RawResponse.js +44 -0
- package/dist/cjs/core/fetcher/ResponseWithBody.d.ts +4 -0
- package/dist/cjs/core/fetcher/ResponseWithBody.js +6 -0
- package/dist/cjs/core/fetcher/Supplier.d.ts +4 -0
- package/dist/cjs/core/fetcher/Supplier.js +22 -0
- package/dist/cjs/core/fetcher/createRequestUrl.d.ts +1 -0
- package/dist/cjs/core/fetcher/createRequestUrl.js +8 -0
- package/dist/cjs/core/fetcher/getErrorResponseBody.d.ts +1 -0
- package/dist/cjs/core/fetcher/getErrorResponseBody.js +45 -0
- package/dist/cjs/core/fetcher/getFetchFn.d.ts +1 -0
- package/dist/cjs/core/fetcher/getFetchFn.js +17 -0
- package/dist/cjs/core/fetcher/getHeader.d.ts +1 -0
- package/dist/cjs/core/fetcher/getHeader.js +11 -0
- package/dist/cjs/core/fetcher/getRequestBody.d.ts +7 -0
- package/dist/cjs/core/fetcher/getRequestBody.js +27 -0
- package/dist/cjs/core/fetcher/getResponseBody.d.ts +1 -0
- package/dist/cjs/core/fetcher/getResponseBody.js +55 -0
- package/dist/cjs/core/fetcher/index.d.ts +11 -0
- package/dist/cjs/core/fetcher/index.js +17 -0
- package/dist/cjs/core/fetcher/makeRequest.d.ts +1 -0
- package/dist/cjs/core/fetcher/makeRequest.js +40 -0
- package/dist/cjs/core/fetcher/requestWithRetries.d.ts +1 -0
- package/dist/cjs/core/fetcher/requestWithRetries.js +67 -0
- package/dist/cjs/core/fetcher/signals.d.ts +5 -0
- package/dist/cjs/core/fetcher/signals.js +24 -0
- package/dist/cjs/core/headers.d.ts +2 -0
- package/dist/cjs/core/headers.js +31 -0
- package/dist/cjs/core/index.d.ts +4 -0
- package/dist/cjs/core/index.js +43 -0
- package/dist/cjs/core/json.d.ts +15 -0
- package/dist/cjs/core/json.js +24 -0
- package/dist/cjs/core/logging/exports.d.ts +18 -0
- package/dist/cjs/core/logging/exports.js +45 -0
- package/dist/cjs/core/logging/index.d.ts +1 -0
- package/dist/cjs/core/logging/index.js +17 -0
- package/dist/cjs/core/logging/logger.d.ts +126 -0
- package/dist/cjs/core/logging/logger.js +144 -0
- package/dist/cjs/core/runtime/index.d.ts +1 -0
- package/dist/cjs/core/runtime/index.js +5 -0
- package/dist/cjs/core/runtime/runtime.d.ts +9 -0
- package/dist/cjs/core/runtime/runtime.js +102 -0
- package/dist/cjs/core/url/encodePathParam.d.ts +1 -0
- package/dist/cjs/core/url/encodePathParam.js +21 -0
- package/dist/cjs/core/url/index.d.ts +3 -0
- package/dist/cjs/core/url/index.js +9 -0
- package/dist/cjs/core/url/join.d.ts +1 -0
- package/dist/cjs/core/url/join.js +68 -0
- package/dist/cjs/core/url/qs.d.ts +6 -0
- package/dist/cjs/core/url/qs.js +64 -0
- package/dist/cjs/environments.d.ts +4 -0
- package/dist/cjs/environments.js +7 -0
- package/dist/cjs/errors/CatchAllApiError.d.ts +12 -0
- package/dist/cjs/errors/CatchAllApiError.js +28 -0
- package/dist/cjs/errors/CatchAllApiTimeoutError.d.ts +3 -0
- package/dist/cjs/errors/CatchAllApiTimeoutError.js +11 -0
- package/dist/cjs/errors/index.d.ts +2 -0
- package/dist/cjs/errors/index.js +7 -0
- package/dist/cjs/exports.d.ts +1 -0
- package/dist/cjs/exports.js +17 -0
- package/dist/cjs/index.d.ts +6 -0
- package/dist/cjs/index.js +48 -0
- package/dist/cjs/version.d.ts +1 -0
- package/dist/cjs/version.js +4 -0
- package/dist/esm/BaseClient.d.mts +31 -0
- package/dist/esm/BaseClient.mjs +14 -0
- package/dist/esm/Client.d.mts +20 -0
- package/dist/esm/Client.mjs +22 -0
- package/dist/esm/api/errors/ForbiddenError.d.mts +6 -0
- package/dist/esm/api/errors/ForbiddenError.mjs +13 -0
- package/dist/esm/api/errors/NotFoundError.d.mts +6 -0
- package/dist/esm/api/errors/NotFoundError.mjs +13 -0
- package/dist/esm/api/errors/UnprocessableEntityError.d.mts +6 -0
- package/dist/esm/api/errors/UnprocessableEntityError.mjs +13 -0
- package/dist/esm/api/errors/index.d.mts +3 -0
- package/dist/esm/api/errors/index.mjs +3 -0
- package/dist/esm/api/index.d.mts +3 -0
- package/dist/esm/api/index.mjs +3 -0
- package/dist/esm/api/resources/index.d.mts +7 -0
- package/dist/esm/api/resources/index.mjs +7 -0
- package/dist/esm/api/resources/jobs/client/Client.d.mts +77 -0
- package/dist/esm/api/resources/jobs/client/Client.mjs +298 -0
- package/dist/esm/api/resources/jobs/client/index.d.mts +1 -0
- package/dist/esm/api/resources/jobs/client/index.mjs +1 -0
- package/dist/esm/api/resources/jobs/client/requests/GetJobResultsRequest.d.mts +14 -0
- package/dist/esm/api/resources/jobs/client/requests/GetJobResultsRequest.mjs +2 -0
- package/dist/esm/api/resources/jobs/client/requests/GetJobStatusRequest.d.mts +10 -0
- package/dist/esm/api/resources/jobs/client/requests/GetJobStatusRequest.mjs +2 -0
- package/dist/esm/api/resources/jobs/client/requests/SubmitRequestDto.d.mts +14 -0
- package/dist/esm/api/resources/jobs/client/requests/SubmitRequestDto.mjs +2 -0
- package/dist/esm/api/resources/jobs/client/requests/index.d.mts +3 -0
- package/dist/esm/api/resources/jobs/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/jobs/index.d.mts +1 -0
- package/dist/esm/api/resources/jobs/index.mjs +1 -0
- package/dist/esm/api/resources/meta/client/Client.d.mts +37 -0
- package/dist/esm/api/resources/meta/client/Client.mjs +135 -0
- package/dist/esm/api/resources/meta/client/index.d.mts +1 -0
- package/dist/esm/api/resources/meta/client/index.mjs +1 -0
- package/dist/esm/api/resources/meta/index.d.mts +2 -0
- package/dist/esm/api/resources/meta/index.mjs +2 -0
- package/dist/esm/api/resources/meta/types/GetVersionResponse.d.mts +3 -0
- package/dist/esm/api/resources/meta/types/GetVersionResponse.mjs +2 -0
- package/dist/esm/api/resources/meta/types/HealthCheckResponse.d.mts +3 -0
- package/dist/esm/api/resources/meta/types/HealthCheckResponse.mjs +2 -0
- package/dist/esm/api/resources/meta/types/index.d.mts +2 -0
- package/dist/esm/api/resources/meta/types/index.mjs +2 -0
- package/dist/esm/api/resources/monitors/client/Client.d.mts +119 -0
- package/dist/esm/api/resources/monitors/client/Client.mjs +445 -0
- package/dist/esm/api/resources/monitors/client/index.d.mts +1 -0
- package/dist/esm/api/resources/monitors/client/index.mjs +1 -0
- package/dist/esm/api/resources/monitors/client/requests/CreateMonitorRequestDto.d.mts +23 -0
- package/dist/esm/api/resources/monitors/client/requests/CreateMonitorRequestDto.mjs +2 -0
- package/dist/esm/api/resources/monitors/client/requests/DisableMonitorRequest.d.mts +10 -0
- package/dist/esm/api/resources/monitors/client/requests/DisableMonitorRequest.mjs +2 -0
- package/dist/esm/api/resources/monitors/client/requests/EnableMonitorRequest.d.mts +10 -0
- package/dist/esm/api/resources/monitors/client/requests/EnableMonitorRequest.mjs +2 -0
- package/dist/esm/api/resources/monitors/client/requests/ListMonitorJobsRequest.d.mts +13 -0
- package/dist/esm/api/resources/monitors/client/requests/ListMonitorJobsRequest.mjs +2 -0
- package/dist/esm/api/resources/monitors/client/requests/PullMonitorResultsRequest.d.mts +10 -0
- package/dist/esm/api/resources/monitors/client/requests/PullMonitorResultsRequest.mjs +2 -0
- package/dist/esm/api/resources/monitors/client/requests/index.d.mts +5 -0
- package/dist/esm/api/resources/monitors/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/monitors/index.d.mts +2 -0
- package/dist/esm/api/resources/monitors/index.mjs +2 -0
- package/dist/esm/api/resources/monitors/types/DisableMonitorResponse.d.mts +8 -0
- package/dist/esm/api/resources/monitors/types/DisableMonitorResponse.mjs +2 -0
- package/dist/esm/api/resources/monitors/types/EnableMonitorResponse.d.mts +8 -0
- package/dist/esm/api/resources/monitors/types/EnableMonitorResponse.mjs +2 -0
- package/dist/esm/api/resources/monitors/types/ListMonitorJobsRequestSort.d.mts +5 -0
- package/dist/esm/api/resources/monitors/types/ListMonitorJobsRequestSort.mjs +5 -0
- package/dist/esm/api/resources/monitors/types/ListMonitorJobsResponse.d.mts +19 -0
- package/dist/esm/api/resources/monitors/types/ListMonitorJobsResponse.mjs +9 -0
- package/dist/esm/api/resources/monitors/types/index.d.mts +4 -0
- package/dist/esm/api/resources/monitors/types/index.mjs +4 -0
- package/dist/esm/api/types/Citation.d.mts +8 -0
- package/dist/esm/api/types/Citation.mjs +2 -0
- package/dist/esm/api/types/Context.d.mts +4 -0
- package/dist/esm/api/types/Context.mjs +2 -0
- package/dist/esm/api/types/CreateMonitorResponseDto.d.mts +6 -0
- package/dist/esm/api/types/CreateMonitorResponseDto.mjs +2 -0
- package/dist/esm/api/types/Error_.d.mts +4 -0
- package/dist/esm/api/types/Error_.mjs +2 -0
- package/dist/esm/api/types/JobStatus.d.mts +23 -0
- package/dist/esm/api/types/JobStatus.mjs +23 -0
- package/dist/esm/api/types/JobStep.d.mts +8 -0
- package/dist/esm/api/types/JobStep.mjs +2 -0
- package/dist/esm/api/types/ListMonitorsResponseDto.d.mts +7 -0
- package/dist/esm/api/types/ListMonitorsResponseDto.mjs +2 -0
- package/dist/esm/api/types/ListUserJobsResponseDto.d.mts +6 -0
- package/dist/esm/api/types/ListUserJobsResponseDto.mjs +2 -0
- package/dist/esm/api/types/MonitorCitation.d.mts +16 -0
- package/dist/esm/api/types/MonitorCitation.mjs +2 -0
- package/dist/esm/api/types/MonitorJobItem.d.mts +8 -0
- package/dist/esm/api/types/MonitorJobItem.mjs +2 -0
- package/dist/esm/api/types/MonitorListItemDto.d.mts +16 -0
- package/dist/esm/api/types/MonitorListItemDto.mjs +2 -0
- package/dist/esm/api/types/MonitorRecord.d.mts +23 -0
- package/dist/esm/api/types/MonitorRecord.mjs +2 -0
- package/dist/esm/api/types/PullJobResponseDto.d.mts +34 -0
- package/dist/esm/api/types/PullJobResponseDto.mjs +2 -0
- package/dist/esm/api/types/PullMonitorResponseDto.d.mts +35 -0
- package/dist/esm/api/types/PullMonitorResponseDto.mjs +2 -0
- package/dist/esm/api/types/Query.d.mts +6 -0
- package/dist/esm/api/types/Query.mjs +2 -0
- package/dist/esm/api/types/Record_.d.mts +15 -0
- package/dist/esm/api/types/Record_.mjs +2 -0
- package/dist/esm/api/types/ReferenceJob.d.mts +6 -0
- package/dist/esm/api/types/ReferenceJob.mjs +2 -0
- package/dist/esm/api/types/Schema.d.mts +6 -0
- package/dist/esm/api/types/Schema.mjs +2 -0
- package/dist/esm/api/types/StatusResponseDto.d.mts +9 -0
- package/dist/esm/api/types/StatusResponseDto.mjs +2 -0
- package/dist/esm/api/types/SubmitResponseBody.d.mts +4 -0
- package/dist/esm/api/types/SubmitResponseBody.mjs +2 -0
- package/dist/esm/api/types/ValidationErrorDetail.d.mts +14 -0
- package/dist/esm/api/types/ValidationErrorDetail.mjs +2 -0
- package/dist/esm/api/types/ValidationErrorResponse.d.mts +4 -0
- package/dist/esm/api/types/ValidationErrorResponse.mjs +2 -0
- package/dist/esm/api/types/WebhookDto.d.mts +20 -0
- package/dist/esm/api/types/WebhookDto.mjs +9 -0
- package/dist/esm/api/types/WebhookPayload.d.mts +28 -0
- package/dist/esm/api/types/WebhookPayload.mjs +2 -0
- package/dist/esm/api/types/index.d.mts +24 -0
- package/dist/esm/api/types/index.mjs +24 -0
- package/dist/esm/core/exports.d.mts +1 -0
- package/dist/esm/core/exports.mjs +1 -0
- package/dist/esm/core/fetcher/APIResponse.d.mts +20 -0
- package/dist/esm/core/fetcher/APIResponse.mjs +1 -0
- package/dist/esm/core/fetcher/BinaryResponse.d.mts +20 -0
- package/dist/esm/core/fetcher/BinaryResponse.mjs +14 -0
- package/dist/esm/core/fetcher/EndpointMetadata.d.mts +13 -0
- package/dist/esm/core/fetcher/EndpointMetadata.mjs +1 -0
- package/dist/esm/core/fetcher/EndpointSupplier.d.mts +12 -0
- package/dist/esm/core/fetcher/EndpointSupplier.mjs +19 -0
- package/dist/esm/core/fetcher/Fetcher.d.mts +45 -0
- package/dist/esm/core/fetcher/Fetcher.mjs +311 -0
- package/dist/esm/core/fetcher/Headers.d.mts +2 -0
- package/dist/esm/core/fetcher/Headers.mjs +82 -0
- package/dist/esm/core/fetcher/HttpResponsePromise.d.mts +58 -0
- package/dist/esm/core/fetcher/HttpResponsePromise.mjs +99 -0
- package/dist/esm/core/fetcher/RawResponse.d.mts +29 -0
- package/dist/esm/core/fetcher/RawResponse.mjs +40 -0
- package/dist/esm/core/fetcher/ResponseWithBody.d.mts +4 -0
- package/dist/esm/core/fetcher/ResponseWithBody.mjs +3 -0
- package/dist/esm/core/fetcher/Supplier.d.mts +4 -0
- package/dist/esm/core/fetcher/Supplier.mjs +19 -0
- package/dist/esm/core/fetcher/createRequestUrl.d.mts +1 -0
- package/dist/esm/core/fetcher/createRequestUrl.mjs +5 -0
- package/dist/esm/core/fetcher/getErrorResponseBody.d.mts +1 -0
- package/dist/esm/core/fetcher/getErrorResponseBody.mjs +42 -0
- package/dist/esm/core/fetcher/getFetchFn.d.mts +1 -0
- package/dist/esm/core/fetcher/getFetchFn.mjs +14 -0
- package/dist/esm/core/fetcher/getHeader.d.mts +1 -0
- package/dist/esm/core/fetcher/getHeader.mjs +8 -0
- package/dist/esm/core/fetcher/getRequestBody.d.mts +7 -0
- package/dist/esm/core/fetcher/getRequestBody.mjs +24 -0
- package/dist/esm/core/fetcher/getResponseBody.d.mts +1 -0
- package/dist/esm/core/fetcher/getResponseBody.mjs +52 -0
- package/dist/esm/core/fetcher/index.d.mts +11 -0
- package/dist/esm/core/fetcher/index.mjs +6 -0
- package/dist/esm/core/fetcher/makeRequest.d.mts +1 -0
- package/dist/esm/core/fetcher/makeRequest.mjs +36 -0
- package/dist/esm/core/fetcher/requestWithRetries.d.mts +1 -0
- package/dist/esm/core/fetcher/requestWithRetries.mjs +64 -0
- package/dist/esm/core/fetcher/signals.d.mts +5 -0
- package/dist/esm/core/fetcher/signals.mjs +20 -0
- package/dist/esm/core/headers.d.mts +2 -0
- package/dist/esm/core/headers.mjs +27 -0
- package/dist/esm/core/index.d.mts +4 -0
- package/dist/esm/core/index.mjs +4 -0
- package/dist/esm/core/json.d.mts +15 -0
- package/dist/esm/core/json.mjs +19 -0
- package/dist/esm/core/logging/exports.d.mts +18 -0
- package/dist/esm/core/logging/exports.mjs +9 -0
- package/dist/esm/core/logging/index.d.mts +1 -0
- package/dist/esm/core/logging/index.mjs +1 -0
- package/dist/esm/core/logging/logger.d.mts +126 -0
- package/dist/esm/core/logging/logger.mjs +138 -0
- package/dist/esm/core/runtime/index.d.mts +1 -0
- package/dist/esm/core/runtime/index.mjs +1 -0
- package/dist/esm/core/runtime/runtime.d.mts +9 -0
- package/dist/esm/core/runtime/runtime.mjs +99 -0
- package/dist/esm/core/url/encodePathParam.d.mts +1 -0
- package/dist/esm/core/url/encodePathParam.mjs +18 -0
- package/dist/esm/core/url/index.d.mts +3 -0
- package/dist/esm/core/url/index.mjs +3 -0
- package/dist/esm/core/url/join.d.mts +1 -0
- package/dist/esm/core/url/join.mjs +65 -0
- package/dist/esm/core/url/qs.d.mts +6 -0
- package/dist/esm/core/url/qs.mjs +61 -0
- package/dist/esm/environments.d.mts +4 -0
- package/dist/esm/environments.mjs +4 -0
- package/dist/esm/errors/CatchAllApiError.d.mts +12 -0
- package/dist/esm/errors/CatchAllApiError.mjs +24 -0
- package/dist/esm/errors/CatchAllApiTimeoutError.d.mts +3 -0
- package/dist/esm/errors/CatchAllApiTimeoutError.mjs +7 -0
- package/dist/esm/errors/index.d.mts +2 -0
- package/dist/esm/errors/index.mjs +2 -0
- package/dist/esm/exports.d.mts +1 -0
- package/dist/esm/exports.mjs +1 -0
- package/dist/esm/index.d.mts +6 -0
- package/dist/esm/index.mjs +5 -0
- package/dist/esm/version.d.mts +1 -0
- package/dist/esm/version.mjs +1 -0
- package/package.json +67 -0
- package/reference.md +753 -0
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.ListMonitorJobsRequestSort = void 0;
|
|
5
|
+
exports.ListMonitorJobsRequestSort = {
|
|
6
|
+
Asc: "asc",
|
|
7
|
+
Desc: "desc",
|
|
8
|
+
};
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import type * as CatchAllApi from "../../../index.js";
|
|
2
|
+
export interface ListMonitorJobsResponse {
|
|
3
|
+
/** Monitor identifier. */
|
|
4
|
+
monitor_id: string;
|
|
5
|
+
/** Sort order applied to results. */
|
|
6
|
+
sort_order: ListMonitorJobsResponse.SortOrder;
|
|
7
|
+
/** Total number of jobs for this monitor. */
|
|
8
|
+
total_jobs: number;
|
|
9
|
+
/** Array of job executions for this monitor. */
|
|
10
|
+
jobs: CatchAllApi.MonitorJobItem[];
|
|
11
|
+
}
|
|
12
|
+
export declare namespace ListMonitorJobsResponse {
|
|
13
|
+
/** Sort order applied to results. */
|
|
14
|
+
const SortOrder: {
|
|
15
|
+
readonly Asc: "asc";
|
|
16
|
+
readonly Desc: "desc";
|
|
17
|
+
};
|
|
18
|
+
type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
|
|
19
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.ListMonitorJobsResponse = void 0;
|
|
5
|
+
var ListMonitorJobsResponse;
|
|
6
|
+
(function (ListMonitorJobsResponse) {
|
|
7
|
+
/** Sort order applied to results. */
|
|
8
|
+
ListMonitorJobsResponse.SortOrder = {
|
|
9
|
+
Asc: "asc",
|
|
10
|
+
Desc: "desc",
|
|
11
|
+
};
|
|
12
|
+
})(ListMonitorJobsResponse || (exports.ListMonitorJobsResponse = ListMonitorJobsResponse = {}));
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./DisableMonitorResponse.js"), exports);
|
|
18
|
+
__exportStar(require("./EnableMonitorResponse.js"), exports);
|
|
19
|
+
__exportStar(require("./ListMonitorJobsRequestSort.js"), exports);
|
|
20
|
+
__exportStar(require("./ListMonitorJobsResponse.js"), exports);
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Current job processing status. Jobs progress through these stages:
|
|
3
|
+
*
|
|
4
|
+
* - `submitted`: Job queued, waiting to start processing.
|
|
5
|
+
* - `analyzing`: Extracting keywords, generating search queries, and creating validators/extractors.
|
|
6
|
+
* - `fetching`: Retrieving articles from web sources.
|
|
7
|
+
* - `clustering`: Grouping similar articles into distinct events.
|
|
8
|
+
* - `enriching`: Validating clusters and extracting structured data.
|
|
9
|
+
* - `completed`: Job finished successfully, results ready.
|
|
10
|
+
* - `failed`: Job processing failed.
|
|
11
|
+
*
|
|
12
|
+
* Poll `/catchAll/status/{job_id}` every 30-60 seconds until status is `completed` (typically 10-15 minutes).
|
|
13
|
+
*/
|
|
14
|
+
export declare const JobStatus: {
|
|
15
|
+
readonly Submitted: "submitted";
|
|
16
|
+
readonly Analyzing: "analyzing";
|
|
17
|
+
readonly Fetching: "fetching";
|
|
18
|
+
readonly Clustering: "clustering";
|
|
19
|
+
readonly Enriching: "enriching";
|
|
20
|
+
readonly Completed: "completed";
|
|
21
|
+
readonly Failed: "failed";
|
|
22
|
+
};
|
|
23
|
+
export type JobStatus = (typeof JobStatus)[keyof typeof JobStatus];
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.JobStatus = void 0;
|
|
5
|
+
/**
|
|
6
|
+
* Current job processing status. Jobs progress through these stages:
|
|
7
|
+
*
|
|
8
|
+
* - `submitted`: Job queued, waiting to start processing.
|
|
9
|
+
* - `analyzing`: Extracting keywords, generating search queries, and creating validators/extractors.
|
|
10
|
+
* - `fetching`: Retrieving articles from web sources.
|
|
11
|
+
* - `clustering`: Grouping similar articles into distinct events.
|
|
12
|
+
* - `enriching`: Validating clusters and extracting structured data.
|
|
13
|
+
* - `completed`: Job finished successfully, results ready.
|
|
14
|
+
* - `failed`: Job processing failed.
|
|
15
|
+
*
|
|
16
|
+
* Poll `/catchAll/status/{job_id}` every 30-60 seconds until status is `completed` (typically 10-15 minutes).
|
|
17
|
+
*/
|
|
18
|
+
exports.JobStatus = {
|
|
19
|
+
Submitted: "submitted",
|
|
20
|
+
Analyzing: "analyzing",
|
|
21
|
+
Fetching: "fetching",
|
|
22
|
+
Clustering: "clustering",
|
|
23
|
+
Enriching: "enriching",
|
|
24
|
+
Completed: "completed",
|
|
25
|
+
Failed: "failed",
|
|
26
|
+
};
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import type * as CatchAllApi from "../index.js";
|
|
2
|
+
export interface JobStep {
|
|
3
|
+
status: CatchAllApi.JobStatus;
|
|
4
|
+
/** Sequential position of this step in the pipeline (1-7). */
|
|
5
|
+
order: number;
|
|
6
|
+
/** Whether this step has finished processing. */
|
|
7
|
+
completed?: boolean;
|
|
8
|
+
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Citation with monitor-specific metadata. Used in monitor results and webhook payloads.
|
|
3
|
+
* Extends base citation with tracking information for job_id and timestamps.
|
|
4
|
+
*/
|
|
5
|
+
export interface MonitorCitation {
|
|
6
|
+
/** Article title */
|
|
7
|
+
title: string;
|
|
8
|
+
/** URL to the source article */
|
|
9
|
+
link: string;
|
|
10
|
+
/** Article publication date in ISO 8601 format with UTC timezone. */
|
|
11
|
+
published_date: string;
|
|
12
|
+
/** Job ID that found this citation. */
|
|
13
|
+
job_id: string;
|
|
14
|
+
/** The date when the citation was added to the record in ISO 8601 format with UTC timezone. */
|
|
15
|
+
added_on: string;
|
|
16
|
+
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
export interface MonitorJobItem {
|
|
2
|
+
/** Unique identifier for this job execution. */
|
|
3
|
+
job_id: string;
|
|
4
|
+
/** Start of the data collection time window for this job execution (based on monitor schedule) in ISO 8601 format with UTC timezone. */
|
|
5
|
+
start_date: string;
|
|
6
|
+
/** End of the data collection time window for this job execution (based on monitor schedule) in ISO 8601 format with UTC timezone. */
|
|
7
|
+
end_date: string;
|
|
8
|
+
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
export interface MonitorListItemDto {
|
|
2
|
+
/** Monitor identifier. */
|
|
3
|
+
monitor_id: string;
|
|
4
|
+
/** Job identifier used as a reference for this monitor. */
|
|
5
|
+
reference_job_id: string;
|
|
6
|
+
/** Natural language query from the reference job. */
|
|
7
|
+
reference_job_query: string;
|
|
8
|
+
/** Whether the monitor is currently active. */
|
|
9
|
+
enabled: boolean;
|
|
10
|
+
/** Cron expression for monitor schedule. */
|
|
11
|
+
schedule?: string;
|
|
12
|
+
/** Timezone for schedule execution. */
|
|
13
|
+
timezone?: string;
|
|
14
|
+
/** The date when the monitor was created. */
|
|
15
|
+
created_at?: string;
|
|
16
|
+
}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import type * as CatchAllApi from "../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* Record with monitor-specific metadata. Used in monitor results and webhook payloads.
|
|
4
|
+
* Includes timestamps tracking when records were added and updated, and citations include job tracking.
|
|
5
|
+
*/
|
|
6
|
+
export interface MonitorRecord {
|
|
7
|
+
/** Unique identifier for the record. */
|
|
8
|
+
record_id: string;
|
|
9
|
+
/** Short title summarizing the record. */
|
|
10
|
+
record_title: string;
|
|
11
|
+
/**
|
|
12
|
+
* Structured data extracted from articles. Schema is dynamically generated per job. Field names are chosen semantically to match the content.
|
|
13
|
+
*
|
|
14
|
+
* See [Understanding dynamic schemas](https://www.newscatcherapi.com/docs/v3/catch-all/overview/dynamic-schemas) for integration guidance.
|
|
15
|
+
*/
|
|
16
|
+
enrichment: Record<string, unknown>;
|
|
17
|
+
/** Source articles with monitor-specific metadata (job_id, added_on timestamps). */
|
|
18
|
+
citations: CatchAllApi.MonitorCitation[];
|
|
19
|
+
/** The date when this record was first added to monitor results in ISO 8601 format with UTC timezone. */
|
|
20
|
+
added_on?: string;
|
|
21
|
+
/** The date when this record was last updated in monitor results in ISO 8601 format with UTC timezone. */
|
|
22
|
+
updated_on?: string;
|
|
23
|
+
}
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
import type * as CatchAllApi from "../index.js";
|
|
2
|
+
export interface PullJobResponseDto {
|
|
3
|
+
/** Job identifier. */
|
|
4
|
+
job_id: string;
|
|
5
|
+
/** Original natural language query. */
|
|
6
|
+
query?: string;
|
|
7
|
+
/** Context provided with the query. */
|
|
8
|
+
context?: string;
|
|
9
|
+
/** List of validation criteria applied to filter results. */
|
|
10
|
+
validators?: string[];
|
|
11
|
+
/** Job status. */
|
|
12
|
+
status: string;
|
|
13
|
+
/** Total time taken to process the job. */
|
|
14
|
+
duration?: string;
|
|
15
|
+
/** Number of candidate records before validation. */
|
|
16
|
+
candidate_records?: number;
|
|
17
|
+
/** Number of validated records extracted. */
|
|
18
|
+
valid_records?: number;
|
|
19
|
+
date_range?: PullJobResponseDto.DateRange;
|
|
20
|
+
/** The current page number. */
|
|
21
|
+
page?: number;
|
|
22
|
+
/** The total number of pages available. */
|
|
23
|
+
total_pages?: number;
|
|
24
|
+
/** The number of records per page. */
|
|
25
|
+
page_size?: number;
|
|
26
|
+
/** Array of extracted records with structured data and citations. */
|
|
27
|
+
all_records?: CatchAllApi.Record_[];
|
|
28
|
+
}
|
|
29
|
+
export declare namespace PullJobResponseDto {
|
|
30
|
+
interface DateRange {
|
|
31
|
+
start_date?: string;
|
|
32
|
+
end_date?: string;
|
|
33
|
+
}
|
|
34
|
+
}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import type * as CatchAllApi from "../index.js";
|
|
2
|
+
export interface PullMonitorResponseDto {
|
|
3
|
+
/** Unique identifier for the monitor. */
|
|
4
|
+
monitor_id: string;
|
|
5
|
+
/**
|
|
6
|
+
* Parsed cron expression from the natural language schedule.
|
|
7
|
+
* Standard cron format (minute hour day month day-of-week).
|
|
8
|
+
*/
|
|
9
|
+
cron_expression?: string;
|
|
10
|
+
/** Timezone used for schedule execution. */
|
|
11
|
+
timezone?: string;
|
|
12
|
+
reference_job: CatchAllApi.ReferenceJob;
|
|
13
|
+
/** Execution time range for this monitor. */
|
|
14
|
+
run_info?: PullMonitorResponseDto.RunInfo;
|
|
15
|
+
/** Total number of records collected across all monitor jobs. */
|
|
16
|
+
records?: number;
|
|
17
|
+
/** Current monitor status or error message if monitor creation failed. */
|
|
18
|
+
status: string;
|
|
19
|
+
/**
|
|
20
|
+
* Aggregated records from all jobs executed by this monitor.
|
|
21
|
+
* Each record includes structured data extracted from web sources with citations.
|
|
22
|
+
*/
|
|
23
|
+
all_records?: CatchAllApi.MonitorRecord[];
|
|
24
|
+
}
|
|
25
|
+
export declare namespace PullMonitorResponseDto {
|
|
26
|
+
/**
|
|
27
|
+
* Execution time range for this monitor.
|
|
28
|
+
*/
|
|
29
|
+
interface RunInfo {
|
|
30
|
+
/** Timestamp of the first job execution. */
|
|
31
|
+
first_run?: string;
|
|
32
|
+
/** Timestamp of the most recent job execution. */
|
|
33
|
+
last_run?: string;
|
|
34
|
+
}
|
|
35
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import type * as CatchAllApi from "../index.js";
|
|
2
|
+
export interface Record_ {
|
|
3
|
+
/** Unique identifier for the record. */
|
|
4
|
+
record_id: string;
|
|
5
|
+
/** Short title summarizing the record. */
|
|
6
|
+
record_title: string;
|
|
7
|
+
/**
|
|
8
|
+
* Structured data extracted from articles. Schema is dynamically generated per job. Field names are chosen semantically to match the content.
|
|
9
|
+
*
|
|
10
|
+
* See [Understanding dynamic schemas](https://www.newscatcherapi.com/docs/v3/catch-all/overview/dynamic-schemas) for integration guidance.
|
|
11
|
+
*/
|
|
12
|
+
enrichment: Record<string, unknown>;
|
|
13
|
+
/** Source articles that were used to extract this record. */
|
|
14
|
+
citations: CatchAllApi.Citation[];
|
|
15
|
+
}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Template string to guide record summary formatting. Use placeholder syntax with brackets to indicate desired fields: [COMPANY], [REVENUE], [DATE], etc.
|
|
3
|
+
*
|
|
4
|
+
* When provided, the system generates a `schema_based_summary` field for each record following this template.
|
|
5
|
+
*/
|
|
6
|
+
export type Schema = string;
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type * as CatchAllApi from "../index.js";
|
|
2
|
+
export interface StatusResponseDto {
|
|
3
|
+
/** Job identifier. */
|
|
4
|
+
job_id: string;
|
|
5
|
+
/** Internal job processing status. Use the `steps` array for reliable status tracking. */
|
|
6
|
+
status?: string;
|
|
7
|
+
/** Detailed progress tracking for each processing stage. Steps progress sequentially from order 1 (submitted) through 5 (enriching), ending at order 6 (completed) or 7 (failed). */
|
|
8
|
+
steps: CatchAllApi.JobStep[];
|
|
9
|
+
}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
export interface ValidationErrorDetail {
|
|
2
|
+
/** Location of the validation error */
|
|
3
|
+
loc?: ValidationErrorDetail.Loc.Item[];
|
|
4
|
+
/** Error message */
|
|
5
|
+
msg?: string;
|
|
6
|
+
/** Error type */
|
|
7
|
+
type?: string;
|
|
8
|
+
}
|
|
9
|
+
export declare namespace ValidationErrorDetail {
|
|
10
|
+
type Loc = Loc.Item[];
|
|
11
|
+
namespace Loc {
|
|
12
|
+
type Item = string | number;
|
|
13
|
+
}
|
|
14
|
+
}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
export interface WebhookDto {
|
|
2
|
+
/** Webhook endpoint URL. */
|
|
3
|
+
url: string;
|
|
4
|
+
/** HTTP method to use. */
|
|
5
|
+
method?: WebhookDto.Method;
|
|
6
|
+
/** HTTP headers to include in request. */
|
|
7
|
+
headers?: Record<string, string>;
|
|
8
|
+
/** Query string parameters. */
|
|
9
|
+
params?: Record<string, unknown>;
|
|
10
|
+
/** Basic auth credentials [username, password]. */
|
|
11
|
+
auth?: string[];
|
|
12
|
+
}
|
|
13
|
+
export declare namespace WebhookDto {
|
|
14
|
+
/** HTTP method to use. */
|
|
15
|
+
const Method: {
|
|
16
|
+
readonly Post: "POST";
|
|
17
|
+
readonly Put: "PUT";
|
|
18
|
+
};
|
|
19
|
+
type Method = (typeof Method)[keyof typeof Method];
|
|
20
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.WebhookDto = void 0;
|
|
5
|
+
var WebhookDto;
|
|
6
|
+
(function (WebhookDto) {
|
|
7
|
+
/** HTTP method to use. */
|
|
8
|
+
WebhookDto.Method = {
|
|
9
|
+
Post: "POST",
|
|
10
|
+
Put: "PUT",
|
|
11
|
+
};
|
|
12
|
+
})(WebhookDto || (exports.WebhookDto = WebhookDto = {}));
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import type * as CatchAllApi from "../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* Payload sent to webhook URL when a monitor job completes.
|
|
4
|
+
* Content-Type: application/json
|
|
5
|
+
*
|
|
6
|
+
* Note: Citations in webhook payloads include an additional 'id' field
|
|
7
|
+
* (string, internal identifier) not present in API GET responses.
|
|
8
|
+
*/
|
|
9
|
+
export interface WebhookPayload {
|
|
10
|
+
/** Monitor identifier. */
|
|
11
|
+
monitor_id?: string;
|
|
12
|
+
/** Reference job used as template for this monitor. */
|
|
13
|
+
reference_job_id?: string;
|
|
14
|
+
/** Job ID of the most recent execution. */
|
|
15
|
+
latest_job_id?: string;
|
|
16
|
+
/** Number of new records from latest job (after deduplication). */
|
|
17
|
+
records_count?: number;
|
|
18
|
+
/** Total number of jobs executed by this monitor. */
|
|
19
|
+
jobs_processed?: number;
|
|
20
|
+
/** The date when the webhook was triggered in ISO 8601 format with UTC timezone. */
|
|
21
|
+
updated_at?: string;
|
|
22
|
+
/** Cron expression defining the monitor schedule. */
|
|
23
|
+
cron_expression?: string;
|
|
24
|
+
/** Timezone for schedule execution. */
|
|
25
|
+
timezone?: string;
|
|
26
|
+
/** Array of new records from the latest job execution (includes monitor-specific fields like added_on, updated_on). */
|
|
27
|
+
records?: CatchAllApi.MonitorRecord[];
|
|
28
|
+
}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
export * from "./Citation.js";
|
|
2
|
+
export * from "./Context.js";
|
|
3
|
+
export * from "./CreateMonitorResponseDto.js";
|
|
4
|
+
export * from "./Error_.js";
|
|
5
|
+
export * from "./JobStatus.js";
|
|
6
|
+
export * from "./JobStep.js";
|
|
7
|
+
export * from "./ListMonitorsResponseDto.js";
|
|
8
|
+
export * from "./ListUserJobsResponseDto.js";
|
|
9
|
+
export * from "./MonitorCitation.js";
|
|
10
|
+
export * from "./MonitorJobItem.js";
|
|
11
|
+
export * from "./MonitorListItemDto.js";
|
|
12
|
+
export * from "./MonitorRecord.js";
|
|
13
|
+
export * from "./PullJobResponseDto.js";
|
|
14
|
+
export * from "./PullMonitorResponseDto.js";
|
|
15
|
+
export * from "./Query.js";
|
|
16
|
+
export * from "./Record_.js";
|
|
17
|
+
export * from "./ReferenceJob.js";
|
|
18
|
+
export * from "./Schema.js";
|
|
19
|
+
export * from "./StatusResponseDto.js";
|
|
20
|
+
export * from "./SubmitResponseBody.js";
|
|
21
|
+
export * from "./ValidationErrorDetail.js";
|
|
22
|
+
export * from "./ValidationErrorResponse.js";
|
|
23
|
+
export * from "./WebhookDto.js";
|
|
24
|
+
export * from "./WebhookPayload.js";
|