newscatcher-catchall-sdk 1.1.2 → 1.4.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 +365 -284
- package/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/Client.d.ts +18 -0
- package/dist/cjs/Client.js +83 -6
- package/dist/cjs/api/errors/BadRequestError.d.ts +1 -2
- package/dist/cjs/api/resources/datasets/client/Client.d.ts +245 -0
- package/dist/cjs/api/resources/datasets/client/Client.js +779 -0
- package/dist/cjs/api/resources/datasets/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/datasets/client/index.js +17 -0
- package/dist/cjs/api/resources/datasets/client/requests/AddEntitiesToDatasetRequest.d.ts +15 -0
- package/dist/cjs/api/resources/datasets/client/requests/AddEntitiesToDatasetRequest.js +3 -0
- package/dist/cjs/api/resources/datasets/client/requests/CreateDatasetFromCsvRequest.d.ts +16 -0
- package/dist/cjs/api/resources/datasets/client/requests/CreateDatasetFromCsvRequest.js +3 -0
- package/dist/cjs/api/resources/datasets/client/requests/CreateDatasetRequest.d.ts +16 -0
- package/dist/cjs/api/resources/datasets/client/requests/CreateDatasetRequest.js +3 -0
- package/dist/cjs/api/resources/datasets/client/requests/DeleteDatasetRequest.d.ts +10 -0
- package/dist/cjs/api/resources/datasets/client/requests/DeleteDatasetRequest.js +3 -0
- package/dist/cjs/api/resources/datasets/client/requests/GetDatasetRequest.d.ts +10 -0
- package/dist/cjs/api/resources/datasets/client/requests/GetDatasetRequest.js +3 -0
- package/dist/cjs/api/resources/datasets/client/requests/GetDatasetStatusHistoryRequest.d.ts +10 -0
- package/dist/cjs/api/resources/datasets/client/requests/GetDatasetStatusHistoryRequest.js +3 -0
- package/dist/cjs/api/resources/datasets/client/requests/ListDatasetsRequest.d.ts +19 -0
- package/dist/cjs/api/resources/datasets/client/requests/ListDatasetsRequest.js +3 -0
- package/dist/cjs/api/resources/datasets/client/requests/ListEntitiesInDatasetRequest.d.ts +21 -0
- package/dist/cjs/api/resources/datasets/client/requests/ListEntitiesInDatasetRequest.js +3 -0
- package/dist/cjs/api/resources/datasets/client/requests/RemoveEntitiesFromDatasetRequest.d.ts +15 -0
- package/dist/cjs/api/resources/datasets/client/requests/RemoveEntitiesFromDatasetRequest.js +3 -0
- package/dist/cjs/api/resources/datasets/client/requests/UpdateDatasetRequest.d.ts +16 -0
- package/dist/cjs/api/resources/datasets/client/requests/UpdateDatasetRequest.js +3 -0
- package/dist/cjs/api/resources/datasets/client/requests/UploadCsvToDatasetRequest.d.ts +14 -0
- package/dist/cjs/api/resources/datasets/client/requests/UploadCsvToDatasetRequest.js +3 -0
- package/dist/cjs/api/resources/datasets/client/requests/index.d.ts +11 -0
- package/dist/cjs/api/resources/datasets/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/datasets/exports.d.ts +2 -0
- package/dist/cjs/api/resources/datasets/exports.js +21 -0
- package/dist/cjs/api/resources/datasets/index.d.ts +1 -0
- package/dist/cjs/api/resources/datasets/index.js +17 -0
- package/dist/cjs/api/resources/entities/client/Client.d.ts +164 -0
- package/dist/cjs/api/resources/entities/client/Client.js +468 -0
- package/dist/cjs/api/resources/entities/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/entities/client/index.js +17 -0
- package/dist/cjs/api/resources/entities/client/requests/CreateEntitiesBatchRequest.d.ts +35 -0
- package/dist/cjs/api/resources/entities/client/requests/CreateEntitiesBatchRequest.js +3 -0
- package/dist/cjs/api/resources/entities/client/requests/DeleteEntityRequest.d.ts +10 -0
- package/dist/cjs/api/resources/entities/client/requests/DeleteEntityRequest.js +3 -0
- package/dist/cjs/api/resources/entities/client/requests/GetEntityRequest.d.ts +10 -0
- package/dist/cjs/api/resources/entities/client/requests/GetEntityRequest.js +3 -0
- package/dist/cjs/api/resources/entities/client/requests/ListEntitiesRequest.d.ts +19 -0
- package/dist/cjs/api/resources/entities/client/requests/ListEntitiesRequest.js +3 -0
- package/dist/cjs/api/resources/entities/client/requests/UpdateEntityRequest.d.ts +22 -0
- package/dist/cjs/api/resources/entities/client/requests/UpdateEntityRequest.js +3 -0
- package/dist/cjs/api/resources/entities/client/requests/index.d.ts +5 -0
- package/dist/cjs/api/resources/entities/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/entities/exports.d.ts +2 -0
- package/dist/cjs/api/resources/entities/exports.js +21 -0
- package/dist/cjs/api/resources/entities/index.d.ts +1 -0
- package/dist/cjs/api/resources/entities/index.js +17 -0
- package/dist/cjs/api/resources/index.d.ts +4 -0
- package/dist/cjs/api/resources/index.js +5 -1
- package/dist/cjs/api/resources/jobs/client/Client.d.ts +32 -31
- package/dist/cjs/api/resources/jobs/client/Client.js +75 -74
- package/dist/cjs/api/resources/jobs/client/requests/SubmitRequestDto.d.ts +28 -1
- package/dist/cjs/api/resources/jobs/client/requests/SubmitRequestDto.js +14 -0
- package/dist/cjs/api/resources/jobs/client/requests/index.d.ts +1 -1
- package/dist/cjs/api/resources/jobs/client/requests/index.js +3 -0
- package/dist/cjs/api/resources/meta/client/Client.d.ts +15 -3
- package/dist/cjs/api/resources/meta/client/Client.js +49 -1
- package/dist/cjs/api/resources/monitors/client/Client.d.ts +40 -40
- package/dist/cjs/api/resources/monitors/client/Client.js +101 -101
- package/dist/cjs/api/types/AdditionalAttributes.d.ts +7 -0
- package/dist/cjs/api/types/AdditionalAttributes.js +3 -0
- package/dist/cjs/api/types/CompanyAttributes.d.ts +17 -0
- package/dist/cjs/api/types/CompanyAttributes.js +3 -0
- package/dist/cjs/api/types/ConnectedEntity.d.ts +30 -0
- package/dist/cjs/api/types/ConnectedEntity.js +3 -0
- package/dist/cjs/api/types/CreateDatasetCsvResponse.d.ts +10 -0
- package/dist/cjs/api/types/CreateDatasetCsvResponse.js +3 -0
- package/dist/cjs/api/types/CreateEntitiesBatchResponse.d.ts +7 -0
- package/dist/cjs/api/types/CreateEntitiesBatchResponse.js +3 -0
- package/dist/cjs/api/types/CreateEntityRequest.d.ts +13 -0
- package/dist/cjs/api/types/CreateEntityRequest.js +3 -0
- package/dist/cjs/api/types/CreateEntityResponse.d.ts +6 -0
- package/dist/cjs/api/types/CreateEntityResponse.js +3 -0
- package/dist/cjs/api/types/DatasetEntityIdsRequest.d.ts +4 -0
- package/dist/cjs/api/types/DatasetEntityIdsRequest.js +3 -0
- package/dist/cjs/api/types/DatasetEntityListResponse.d.ts +11 -0
- package/dist/cjs/api/types/DatasetEntityListResponse.js +3 -0
- package/dist/cjs/api/types/DatasetListResponse.d.ts +11 -0
- package/dist/cjs/api/types/DatasetListResponse.js +3 -0
- package/dist/cjs/api/types/DatasetResponse.d.ts +20 -0
- package/dist/cjs/api/types/DatasetResponse.js +3 -0
- package/dist/cjs/api/types/DatasetSortBy.d.ts +7 -0
- package/dist/cjs/api/types/DatasetSortBy.js +10 -0
- package/dist/cjs/api/types/DatasetStatus.d.ts +15 -0
- package/dist/cjs/api/types/DatasetStatus.js +18 -0
- package/dist/cjs/api/types/DatasetStatusEntry.d.ts +11 -0
- package/dist/cjs/api/types/DatasetStatusEntry.js +3 -0
- package/dist/cjs/api/types/DatasetStatusHistoryResponse.d.ts +7 -0
- package/dist/cjs/api/types/DatasetStatusHistoryResponse.js +3 -0
- package/dist/cjs/api/types/EnrichmentType.d.ts +3 -1
- package/dist/cjs/api/types/EnrichmentType.js +3 -1
- package/dist/cjs/api/types/EntityListResponse.d.ts +11 -0
- package/dist/cjs/api/types/EntityListResponse.js +3 -0
- package/dist/cjs/api/types/EntityResponse.d.ts +20 -0
- package/dist/cjs/api/types/EntityResponse.js +3 -0
- package/dist/cjs/api/types/EntitySortBy.d.ts +7 -0
- package/dist/cjs/api/types/EntitySortBy.js +10 -0
- package/dist/cjs/api/types/EntityStatus.d.ts +15 -0
- package/dist/cjs/api/types/EntityStatus.js +18 -0
- package/dist/cjs/api/types/EntitySummary.d.ts +18 -0
- package/dist/cjs/api/types/EntitySummary.js +3 -0
- package/dist/cjs/api/types/EntityType.d.ts +11 -0
- package/dist/cjs/api/types/EntityType.js +14 -0
- package/dist/cjs/api/types/EntityValidationErrorBody.d.ts +16 -0
- package/dist/cjs/api/types/EntityValidationErrorBody.js +3 -0
- package/dist/cjs/api/types/GetPlanLimitsResponseDto.d.ts +5 -0
- package/dist/cjs/api/types/GetPlanLimitsResponseDto.js +3 -0
- package/dist/cjs/api/types/ManageEntitiesResponse.d.ts +6 -0
- package/dist/cjs/api/types/ManageEntitiesResponse.js +3 -0
- package/dist/cjs/api/types/MonitorListItemDto.d.ts +4 -2
- package/dist/cjs/api/types/MonitorRecord.d.ts +1 -0
- package/dist/cjs/api/types/PlanFeature.d.ts +12 -0
- package/dist/cjs/api/types/PlanFeature.js +3 -0
- package/dist/cjs/api/types/PullJobResponseDto.d.ts +12 -8
- package/dist/cjs/api/types/PullJobResponseDto.js +9 -0
- package/dist/cjs/api/types/Record_.d.ts +5 -0
- package/dist/cjs/api/types/SkippedRow.d.ts +13 -0
- package/dist/cjs/api/types/SkippedRow.js +3 -0
- package/dist/cjs/api/types/SortOrder.d.ts +11 -0
- package/dist/cjs/api/types/SortOrder.js +14 -0
- package/dist/cjs/api/types/UploadCsvToDatasetResponse.d.ts +8 -0
- package/dist/cjs/api/types/UploadCsvToDatasetResponse.js +3 -0
- package/dist/cjs/api/types/UserJob.d.ts +12 -0
- package/dist/cjs/api/types/UserJob.js +9 -0
- package/dist/cjs/api/types/ValidationReport.d.ts +17 -0
- package/dist/cjs/api/types/ValidationReport.js +3 -0
- package/dist/cjs/api/types/index.d.ts +29 -0
- package/dist/cjs/api/types/index.js +29 -0
- package/dist/cjs/core/auth/BasicAuth.d.ts +2 -2
- package/dist/cjs/core/auth/BasicAuth.js +7 -1
- package/dist/cjs/core/exports.d.ts +1 -0
- package/dist/cjs/core/exports.js +1 -0
- package/dist/cjs/core/fetcher/BinaryResponse.d.ts +1 -1
- package/dist/cjs/core/fetcher/Fetcher.d.ts +2 -0
- package/dist/cjs/core/fetcher/Fetcher.js +4 -0
- package/dist/cjs/core/fetcher/index.d.ts +2 -0
- package/dist/cjs/core/fetcher/index.js +3 -1
- package/dist/cjs/core/fetcher/makePassthroughRequest.d.ts +49 -0
- package/dist/cjs/core/fetcher/makePassthroughRequest.js +135 -0
- package/dist/cjs/core/file/exports.d.ts +1 -0
- package/dist/cjs/core/file/exports.js +2 -0
- package/dist/cjs/core/file/file.d.ts +10 -0
- package/dist/cjs/core/file/file.js +222 -0
- package/dist/cjs/core/file/index.d.ts +2 -0
- package/dist/cjs/core/file/index.js +18 -0
- package/dist/cjs/core/file/types.d.ts +66 -0
- package/dist/cjs/core/file/types.js +2 -0
- package/dist/cjs/core/form-data-utils/FormDataWrapper.d.ts +15 -0
- package/dist/cjs/core/form-data-utils/FormDataWrapper.js +185 -0
- package/dist/cjs/core/form-data-utils/encodeAsFormParameter.d.ts +1 -0
- package/dist/cjs/core/form-data-utils/encodeAsFormParameter.js +12 -0
- package/dist/cjs/core/form-data-utils/index.d.ts +2 -0
- package/dist/cjs/core/form-data-utils/index.js +20 -0
- package/dist/cjs/core/index.d.ts +2 -0
- package/dist/cjs/core/index.js +3 -1
- package/dist/cjs/errors/CatchAllApiError.d.ts +3 -1
- package/dist/cjs/errors/CatchAllApiError.js +4 -1
- package/dist/cjs/errors/CatchAllApiTimeoutError.d.ts +4 -1
- package/dist/cjs/errors/CatchAllApiTimeoutError.js +4 -1
- package/dist/cjs/errors/handleNonStatusCodeError.js +4 -1
- 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 +18 -0
- package/dist/esm/Client.mjs +44 -0
- package/dist/esm/api/errors/BadRequestError.d.mts +1 -2
- package/dist/esm/api/resources/datasets/client/Client.d.mts +245 -0
- package/dist/esm/api/resources/datasets/client/Client.mjs +742 -0
- package/dist/esm/api/resources/datasets/client/index.d.mts +1 -0
- package/dist/esm/api/resources/datasets/client/index.mjs +1 -0
- package/dist/esm/api/resources/datasets/client/requests/AddEntitiesToDatasetRequest.d.mts +15 -0
- package/dist/esm/api/resources/datasets/client/requests/AddEntitiesToDatasetRequest.mjs +2 -0
- package/dist/esm/api/resources/datasets/client/requests/CreateDatasetFromCsvRequest.d.mts +16 -0
- package/dist/esm/api/resources/datasets/client/requests/CreateDatasetFromCsvRequest.mjs +2 -0
- package/dist/esm/api/resources/datasets/client/requests/CreateDatasetRequest.d.mts +16 -0
- package/dist/esm/api/resources/datasets/client/requests/CreateDatasetRequest.mjs +2 -0
- package/dist/esm/api/resources/datasets/client/requests/DeleteDatasetRequest.d.mts +10 -0
- package/dist/esm/api/resources/datasets/client/requests/DeleteDatasetRequest.mjs +2 -0
- package/dist/esm/api/resources/datasets/client/requests/GetDatasetRequest.d.mts +10 -0
- package/dist/esm/api/resources/datasets/client/requests/GetDatasetRequest.mjs +2 -0
- package/dist/esm/api/resources/datasets/client/requests/GetDatasetStatusHistoryRequest.d.mts +10 -0
- package/dist/esm/api/resources/datasets/client/requests/GetDatasetStatusHistoryRequest.mjs +2 -0
- package/dist/esm/api/resources/datasets/client/requests/ListDatasetsRequest.d.mts +19 -0
- package/dist/esm/api/resources/datasets/client/requests/ListDatasetsRequest.mjs +2 -0
- package/dist/esm/api/resources/datasets/client/requests/ListEntitiesInDatasetRequest.d.mts +21 -0
- package/dist/esm/api/resources/datasets/client/requests/ListEntitiesInDatasetRequest.mjs +2 -0
- package/dist/esm/api/resources/datasets/client/requests/RemoveEntitiesFromDatasetRequest.d.mts +15 -0
- package/dist/esm/api/resources/datasets/client/requests/RemoveEntitiesFromDatasetRequest.mjs +2 -0
- package/dist/esm/api/resources/datasets/client/requests/UpdateDatasetRequest.d.mts +16 -0
- package/dist/esm/api/resources/datasets/client/requests/UpdateDatasetRequest.mjs +2 -0
- package/dist/esm/api/resources/datasets/client/requests/UploadCsvToDatasetRequest.d.mts +14 -0
- package/dist/esm/api/resources/datasets/client/requests/UploadCsvToDatasetRequest.mjs +2 -0
- package/dist/esm/api/resources/datasets/client/requests/index.d.mts +11 -0
- package/dist/esm/api/resources/datasets/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/datasets/exports.d.mts +2 -0
- package/dist/esm/api/resources/datasets/exports.mjs +3 -0
- package/dist/esm/api/resources/datasets/index.d.mts +1 -0
- package/dist/esm/api/resources/datasets/index.mjs +1 -0
- package/dist/esm/api/resources/entities/client/Client.d.mts +164 -0
- package/dist/esm/api/resources/entities/client/Client.mjs +431 -0
- package/dist/esm/api/resources/entities/client/index.d.mts +1 -0
- package/dist/esm/api/resources/entities/client/index.mjs +1 -0
- package/dist/esm/api/resources/entities/client/requests/CreateEntitiesBatchRequest.d.mts +35 -0
- package/dist/esm/api/resources/entities/client/requests/CreateEntitiesBatchRequest.mjs +2 -0
- package/dist/esm/api/resources/entities/client/requests/DeleteEntityRequest.d.mts +10 -0
- package/dist/esm/api/resources/entities/client/requests/DeleteEntityRequest.mjs +2 -0
- package/dist/esm/api/resources/entities/client/requests/GetEntityRequest.d.mts +10 -0
- package/dist/esm/api/resources/entities/client/requests/GetEntityRequest.mjs +2 -0
- package/dist/esm/api/resources/entities/client/requests/ListEntitiesRequest.d.mts +19 -0
- package/dist/esm/api/resources/entities/client/requests/ListEntitiesRequest.mjs +2 -0
- package/dist/esm/api/resources/entities/client/requests/UpdateEntityRequest.d.mts +22 -0
- package/dist/esm/api/resources/entities/client/requests/UpdateEntityRequest.mjs +2 -0
- package/dist/esm/api/resources/entities/client/requests/index.d.mts +5 -0
- package/dist/esm/api/resources/entities/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/entities/exports.d.mts +2 -0
- package/dist/esm/api/resources/entities/exports.mjs +3 -0
- package/dist/esm/api/resources/entities/index.d.mts +1 -0
- package/dist/esm/api/resources/entities/index.mjs +1 -0
- package/dist/esm/api/resources/index.d.mts +4 -0
- package/dist/esm/api/resources/index.mjs +4 -0
- package/dist/esm/api/resources/jobs/client/Client.d.mts +32 -31
- package/dist/esm/api/resources/jobs/client/Client.mjs +75 -74
- package/dist/esm/api/resources/jobs/client/requests/SubmitRequestDto.d.mts +28 -1
- package/dist/esm/api/resources/jobs/client/requests/SubmitRequestDto.mjs +13 -1
- package/dist/esm/api/resources/jobs/client/requests/index.d.mts +1 -1
- package/dist/esm/api/resources/jobs/client/requests/index.mjs +1 -1
- package/dist/esm/api/resources/meta/client/Client.d.mts +15 -3
- package/dist/esm/api/resources/meta/client/Client.mjs +50 -2
- package/dist/esm/api/resources/monitors/client/Client.d.mts +40 -40
- package/dist/esm/api/resources/monitors/client/Client.mjs +101 -101
- package/dist/esm/api/types/AdditionalAttributes.d.mts +7 -0
- package/dist/esm/api/types/AdditionalAttributes.mjs +2 -0
- package/dist/esm/api/types/CompanyAttributes.d.mts +17 -0
- package/dist/esm/api/types/CompanyAttributes.mjs +2 -0
- package/dist/esm/api/types/ConnectedEntity.d.mts +30 -0
- package/dist/esm/api/types/ConnectedEntity.mjs +2 -0
- package/dist/esm/api/types/CreateDatasetCsvResponse.d.mts +10 -0
- package/dist/esm/api/types/CreateDatasetCsvResponse.mjs +2 -0
- package/dist/esm/api/types/CreateEntitiesBatchResponse.d.mts +7 -0
- package/dist/esm/api/types/CreateEntitiesBatchResponse.mjs +2 -0
- package/dist/esm/api/types/CreateEntityRequest.d.mts +13 -0
- package/dist/esm/api/types/CreateEntityRequest.mjs +2 -0
- package/dist/esm/api/types/CreateEntityResponse.d.mts +6 -0
- package/dist/esm/api/types/CreateEntityResponse.mjs +2 -0
- package/dist/esm/api/types/DatasetEntityIdsRequest.d.mts +4 -0
- package/dist/esm/api/types/DatasetEntityIdsRequest.mjs +2 -0
- package/dist/esm/api/types/DatasetEntityListResponse.d.mts +11 -0
- package/dist/esm/api/types/DatasetEntityListResponse.mjs +2 -0
- package/dist/esm/api/types/DatasetListResponse.d.mts +11 -0
- package/dist/esm/api/types/DatasetListResponse.mjs +2 -0
- package/dist/esm/api/types/DatasetResponse.d.mts +20 -0
- package/dist/esm/api/types/DatasetResponse.mjs +2 -0
- package/dist/esm/api/types/DatasetSortBy.d.mts +7 -0
- package/dist/esm/api/types/DatasetSortBy.mjs +7 -0
- package/dist/esm/api/types/DatasetStatus.d.mts +15 -0
- package/dist/esm/api/types/DatasetStatus.mjs +15 -0
- package/dist/esm/api/types/DatasetStatusEntry.d.mts +11 -0
- package/dist/esm/api/types/DatasetStatusEntry.mjs +2 -0
- package/dist/esm/api/types/DatasetStatusHistoryResponse.d.mts +7 -0
- package/dist/esm/api/types/DatasetStatusHistoryResponse.mjs +2 -0
- package/dist/esm/api/types/EnrichmentType.d.mts +3 -1
- package/dist/esm/api/types/EnrichmentType.mjs +3 -1
- package/dist/esm/api/types/EntityListResponse.d.mts +11 -0
- package/dist/esm/api/types/EntityListResponse.mjs +2 -0
- package/dist/esm/api/types/EntityResponse.d.mts +20 -0
- package/dist/esm/api/types/EntityResponse.mjs +2 -0
- package/dist/esm/api/types/EntitySortBy.d.mts +7 -0
- package/dist/esm/api/types/EntitySortBy.mjs +7 -0
- package/dist/esm/api/types/EntityStatus.d.mts +15 -0
- package/dist/esm/api/types/EntityStatus.mjs +15 -0
- package/dist/esm/api/types/EntitySummary.d.mts +18 -0
- package/dist/esm/api/types/EntitySummary.mjs +2 -0
- package/dist/esm/api/types/EntityType.d.mts +11 -0
- package/dist/esm/api/types/EntityType.mjs +11 -0
- package/dist/esm/api/types/EntityValidationErrorBody.d.mts +16 -0
- package/dist/esm/api/types/EntityValidationErrorBody.mjs +2 -0
- package/dist/esm/api/types/GetPlanLimitsResponseDto.d.mts +5 -0
- package/dist/esm/api/types/GetPlanLimitsResponseDto.mjs +2 -0
- package/dist/esm/api/types/ManageEntitiesResponse.d.mts +6 -0
- package/dist/esm/api/types/ManageEntitiesResponse.mjs +2 -0
- package/dist/esm/api/types/MonitorListItemDto.d.mts +4 -2
- package/dist/esm/api/types/MonitorRecord.d.mts +1 -0
- package/dist/esm/api/types/PlanFeature.d.mts +12 -0
- package/dist/esm/api/types/PlanFeature.mjs +2 -0
- package/dist/esm/api/types/PullJobResponseDto.d.mts +12 -8
- package/dist/esm/api/types/PullJobResponseDto.mjs +8 -1
- package/dist/esm/api/types/Record_.d.mts +5 -0
- package/dist/esm/api/types/SkippedRow.d.mts +13 -0
- package/dist/esm/api/types/SkippedRow.mjs +2 -0
- package/dist/esm/api/types/SortOrder.d.mts +11 -0
- package/dist/esm/api/types/SortOrder.mjs +11 -0
- package/dist/esm/api/types/UploadCsvToDatasetResponse.d.mts +8 -0
- package/dist/esm/api/types/UploadCsvToDatasetResponse.mjs +2 -0
- package/dist/esm/api/types/UserJob.d.mts +12 -0
- package/dist/esm/api/types/UserJob.mjs +8 -1
- package/dist/esm/api/types/ValidationReport.d.mts +17 -0
- package/dist/esm/api/types/ValidationReport.mjs +2 -0
- package/dist/esm/api/types/index.d.mts +29 -0
- package/dist/esm/api/types/index.mjs +29 -0
- package/dist/esm/core/auth/BasicAuth.d.mts +2 -2
- package/dist/esm/core/auth/BasicAuth.mjs +7 -1
- package/dist/esm/core/exports.d.mts +1 -0
- package/dist/esm/core/exports.mjs +1 -0
- package/dist/esm/core/fetcher/BinaryResponse.d.mts +1 -1
- package/dist/esm/core/fetcher/Fetcher.d.mts +2 -0
- package/dist/esm/core/fetcher/Fetcher.mjs +4 -0
- package/dist/esm/core/fetcher/index.d.mts +2 -0
- package/dist/esm/core/fetcher/index.mjs +1 -0
- package/dist/esm/core/fetcher/makePassthroughRequest.d.mts +49 -0
- package/dist/esm/core/fetcher/makePassthroughRequest.mjs +132 -0
- package/dist/esm/core/file/exports.d.mts +1 -0
- package/dist/esm/core/file/exports.mjs +1 -0
- package/dist/esm/core/file/file.d.mts +10 -0
- package/dist/esm/core/file/file.mjs +185 -0
- package/dist/esm/core/file/index.d.mts +2 -0
- package/dist/esm/core/file/index.mjs +2 -0
- package/dist/esm/core/file/types.d.mts +66 -0
- package/dist/esm/core/file/types.mjs +1 -0
- package/dist/esm/core/form-data-utils/FormDataWrapper.d.mts +15 -0
- package/dist/esm/core/form-data-utils/FormDataWrapper.mjs +147 -0
- package/dist/esm/core/form-data-utils/encodeAsFormParameter.d.mts +1 -0
- package/dist/esm/core/form-data-utils/encodeAsFormParameter.mjs +9 -0
- package/dist/esm/core/form-data-utils/index.d.mts +2 -0
- package/dist/esm/core/form-data-utils/index.mjs +2 -0
- package/dist/esm/core/index.d.mts +2 -0
- package/dist/esm/core/index.mjs +2 -0
- package/dist/esm/errors/CatchAllApiError.d.mts +3 -1
- package/dist/esm/errors/CatchAllApiError.mjs +4 -1
- package/dist/esm/errors/CatchAllApiTimeoutError.d.mts +4 -1
- package/dist/esm/errors/CatchAllApiTimeoutError.mjs +4 -1
- package/dist/esm/errors/handleNonStatusCodeError.mjs +4 -1
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +29 -7
- package/reference.md +1312 -58
|
@@ -13,6 +13,20 @@ export declare namespace MonitorsClient {
|
|
|
13
13
|
export declare class MonitorsClient {
|
|
14
14
|
protected readonly _options: NormalizedClientOptionsWithAuth<MonitorsClient.Options>;
|
|
15
15
|
constructor(options?: MonitorsClient.Options);
|
|
16
|
+
/**
|
|
17
|
+
* Returns all monitors created by the authenticated user.
|
|
18
|
+
*
|
|
19
|
+
* @param {CatchAllApi.ListMonitorsRequest} request
|
|
20
|
+
* @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
21
|
+
*
|
|
22
|
+
* @throws {@link CatchAllApi.ForbiddenError}
|
|
23
|
+
* @throws {@link CatchAllApi.UnprocessableEntityError}
|
|
24
|
+
*
|
|
25
|
+
* @example
|
|
26
|
+
* await client.monitors.listMonitors()
|
|
27
|
+
*/
|
|
28
|
+
listMonitors(request?: CatchAllApi.ListMonitorsRequest, requestOptions?: MonitorsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.ListMonitorsResponseDto>;
|
|
29
|
+
private __listMonitors;
|
|
16
30
|
/**
|
|
17
31
|
* Create a scheduled monitor based on a reference job.
|
|
18
32
|
*
|
|
@@ -39,29 +53,21 @@ export declare class MonitorsClient {
|
|
|
39
53
|
createMonitor(request: CatchAllApi.CreateMonitorRequestDto, requestOptions?: MonitorsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.CreateMonitorResponseDto>;
|
|
40
54
|
private __createMonitor;
|
|
41
55
|
/**
|
|
42
|
-
*
|
|
56
|
+
* Retrieve aggregated results from all jobs executed by a monitor.
|
|
43
57
|
*
|
|
44
|
-
* @param {CatchAllApi.
|
|
58
|
+
* @param {CatchAllApi.PullMonitorResultsRequest} request
|
|
45
59
|
* @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
46
60
|
*
|
|
47
|
-
* @throws {@link CatchAllApi.ForbiddenError}
|
|
48
61
|
* @throws {@link CatchAllApi.NotFoundError}
|
|
49
62
|
* @throws {@link CatchAllApi.UnprocessableEntityError}
|
|
50
63
|
*
|
|
51
64
|
* @example
|
|
52
|
-
* await client.monitors.
|
|
53
|
-
* monitor_id: "monitor_id"
|
|
54
|
-
* webhook: {
|
|
55
|
-
* url: "https://new-endpoint.com/webhook",
|
|
56
|
-
* method: "POST",
|
|
57
|
-
* headers: {
|
|
58
|
-
* "Authorization": "Bearer new_token_xyz"
|
|
59
|
-
* }
|
|
60
|
-
* }
|
|
65
|
+
* await client.monitors.pullMonitorResults({
|
|
66
|
+
* monitor_id: "monitor_id"
|
|
61
67
|
* })
|
|
62
68
|
*/
|
|
63
|
-
|
|
64
|
-
private
|
|
69
|
+
pullMonitorResults(request: CatchAllApi.PullMonitorResultsRequest, requestOptions?: MonitorsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.PullMonitorResponseDto>;
|
|
70
|
+
private __pullMonitorResults;
|
|
65
71
|
/**
|
|
66
72
|
* Return all jobs executed by a monitor.
|
|
67
73
|
*
|
|
@@ -79,21 +85,23 @@ export declare class MonitorsClient {
|
|
|
79
85
|
listMonitorJobs(request: CatchAllApi.ListMonitorJobsRequest, requestOptions?: MonitorsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.ListMonitorJobsResponse>;
|
|
80
86
|
private __listMonitorJobs;
|
|
81
87
|
/**
|
|
82
|
-
*
|
|
88
|
+
* Resume scheduled job execution for a monitor.
|
|
83
89
|
*
|
|
84
|
-
* @param {CatchAllApi.
|
|
90
|
+
* @param {CatchAllApi.EnableMonitorRequestDto} request
|
|
85
91
|
* @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
86
92
|
*
|
|
93
|
+
* @throws {@link CatchAllApi.ForbiddenError}
|
|
87
94
|
* @throws {@link CatchAllApi.NotFoundError}
|
|
88
95
|
* @throws {@link CatchAllApi.UnprocessableEntityError}
|
|
89
96
|
*
|
|
90
97
|
* @example
|
|
91
|
-
* await client.monitors.
|
|
92
|
-
* monitor_id: "monitor_id"
|
|
98
|
+
* await client.monitors.enableMonitor({
|
|
99
|
+
* monitor_id: "monitor_id",
|
|
100
|
+
* backfill: true
|
|
93
101
|
* })
|
|
94
102
|
*/
|
|
95
|
-
|
|
96
|
-
private
|
|
103
|
+
enableMonitor(request: CatchAllApi.EnableMonitorRequestDto, requestOptions?: MonitorsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.EnableMonitorResponse>;
|
|
104
|
+
private __enableMonitor;
|
|
97
105
|
/**
|
|
98
106
|
* Stop scheduled job execution for a monitor.
|
|
99
107
|
*
|
|
@@ -112,9 +120,9 @@ export declare class MonitorsClient {
|
|
|
112
120
|
disableMonitor(request: CatchAllApi.DisableMonitorRequest, requestOptions?: MonitorsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.DisableMonitorResponse>;
|
|
113
121
|
private __disableMonitor;
|
|
114
122
|
/**
|
|
115
|
-
*
|
|
123
|
+
* Update the webhook configuration for an existing monitor.
|
|
116
124
|
*
|
|
117
|
-
* @param {CatchAllApi.
|
|
125
|
+
* @param {CatchAllApi.UpdateMonitorRequestDto} request
|
|
118
126
|
* @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
119
127
|
*
|
|
120
128
|
* @throws {@link CatchAllApi.ForbiddenError}
|
|
@@ -122,25 +130,17 @@ export declare class MonitorsClient {
|
|
|
122
130
|
* @throws {@link CatchAllApi.UnprocessableEntityError}
|
|
123
131
|
*
|
|
124
132
|
* @example
|
|
125
|
-
* await client.monitors.
|
|
133
|
+
* await client.monitors.updateMonitor({
|
|
126
134
|
* monitor_id: "monitor_id",
|
|
127
|
-
*
|
|
135
|
+
* webhook: {
|
|
136
|
+
* url: "https://new-endpoint.com/webhook",
|
|
137
|
+
* method: "POST",
|
|
138
|
+
* headers: {
|
|
139
|
+
* "Authorization": "Bearer new_token_xyz"
|
|
140
|
+
* }
|
|
141
|
+
* }
|
|
128
142
|
* })
|
|
129
143
|
*/
|
|
130
|
-
|
|
131
|
-
private
|
|
132
|
-
/**
|
|
133
|
-
* Returns all monitors created by the authenticated user.
|
|
134
|
-
*
|
|
135
|
-
* @param {CatchAllApi.ListMonitorsRequest} request
|
|
136
|
-
* @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
137
|
-
*
|
|
138
|
-
* @throws {@link CatchAllApi.ForbiddenError}
|
|
139
|
-
* @throws {@link CatchAllApi.UnprocessableEntityError}
|
|
140
|
-
*
|
|
141
|
-
* @example
|
|
142
|
-
* await client.monitors.listMonitors()
|
|
143
|
-
*/
|
|
144
|
-
listMonitors(request?: CatchAllApi.ListMonitorsRequest, requestOptions?: MonitorsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.ListMonitorsResponseDto>;
|
|
145
|
-
private __listMonitors;
|
|
144
|
+
updateMonitor(request: CatchAllApi.UpdateMonitorRequestDto, requestOptions?: MonitorsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.UpdateMonitorResponseDto>;
|
|
145
|
+
private __updateMonitor;
|
|
146
146
|
}
|
|
@@ -33,6 +33,62 @@ export class MonitorsClient {
|
|
|
33
33
|
constructor(options = {}) {
|
|
34
34
|
this._options = normalizeClientOptionsWithAuth(options);
|
|
35
35
|
}
|
|
36
|
+
/**
|
|
37
|
+
* Returns all monitors created by the authenticated user.
|
|
38
|
+
*
|
|
39
|
+
* @param {CatchAllApi.ListMonitorsRequest} request
|
|
40
|
+
* @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
41
|
+
*
|
|
42
|
+
* @throws {@link CatchAllApi.ForbiddenError}
|
|
43
|
+
* @throws {@link CatchAllApi.UnprocessableEntityError}
|
|
44
|
+
*
|
|
45
|
+
* @example
|
|
46
|
+
* await client.monitors.listMonitors()
|
|
47
|
+
*/
|
|
48
|
+
listMonitors(request = {}, requestOptions) {
|
|
49
|
+
return core.HttpResponsePromise.fromPromise(this.__listMonitors(request, requestOptions));
|
|
50
|
+
}
|
|
51
|
+
__listMonitors() {
|
|
52
|
+
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
53
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
54
|
+
const { page, page_size: pageSize } = request;
|
|
55
|
+
const _queryParams = {
|
|
56
|
+
page,
|
|
57
|
+
page_size: pageSize,
|
|
58
|
+
};
|
|
59
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
60
|
+
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
61
|
+
const _response = yield core.fetcher({
|
|
62
|
+
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/monitors"),
|
|
63
|
+
method: "GET",
|
|
64
|
+
headers: _headers,
|
|
65
|
+
queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
|
|
66
|
+
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,
|
|
67
|
+
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,
|
|
68
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
69
|
+
fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
|
|
70
|
+
logging: this._options.logging,
|
|
71
|
+
});
|
|
72
|
+
if (_response.ok) {
|
|
73
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
74
|
+
}
|
|
75
|
+
if (_response.error.reason === "status-code") {
|
|
76
|
+
switch (_response.error.statusCode) {
|
|
77
|
+
case 403:
|
|
78
|
+
throw new CatchAllApi.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
79
|
+
case 422:
|
|
80
|
+
throw new CatchAllApi.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
81
|
+
default:
|
|
82
|
+
throw new errors.CatchAllApiError({
|
|
83
|
+
statusCode: _response.error.statusCode,
|
|
84
|
+
body: _response.error.body,
|
|
85
|
+
rawResponse: _response.rawResponse,
|
|
86
|
+
});
|
|
87
|
+
}
|
|
88
|
+
}
|
|
89
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/catchAll/monitors");
|
|
90
|
+
});
|
|
91
|
+
}
|
|
36
92
|
/**
|
|
37
93
|
* Create a scheduled monitor based on a reference job.
|
|
38
94
|
*
|
|
@@ -97,44 +153,33 @@ export class MonitorsClient {
|
|
|
97
153
|
});
|
|
98
154
|
}
|
|
99
155
|
/**
|
|
100
|
-
*
|
|
156
|
+
* Retrieve aggregated results from all jobs executed by a monitor.
|
|
101
157
|
*
|
|
102
|
-
* @param {CatchAllApi.
|
|
158
|
+
* @param {CatchAllApi.PullMonitorResultsRequest} request
|
|
103
159
|
* @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
104
160
|
*
|
|
105
|
-
* @throws {@link CatchAllApi.ForbiddenError}
|
|
106
161
|
* @throws {@link CatchAllApi.NotFoundError}
|
|
107
162
|
* @throws {@link CatchAllApi.UnprocessableEntityError}
|
|
108
163
|
*
|
|
109
164
|
* @example
|
|
110
|
-
* await client.monitors.
|
|
111
|
-
* monitor_id: "monitor_id"
|
|
112
|
-
* webhook: {
|
|
113
|
-
* url: "https://new-endpoint.com/webhook",
|
|
114
|
-
* method: "POST",
|
|
115
|
-
* headers: {
|
|
116
|
-
* "Authorization": "Bearer new_token_xyz"
|
|
117
|
-
* }
|
|
118
|
-
* }
|
|
165
|
+
* await client.monitors.pullMonitorResults({
|
|
166
|
+
* monitor_id: "monitor_id"
|
|
119
167
|
* })
|
|
120
168
|
*/
|
|
121
|
-
|
|
122
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
169
|
+
pullMonitorResults(request, requestOptions) {
|
|
170
|
+
return core.HttpResponsePromise.fromPromise(this.__pullMonitorResults(request, requestOptions));
|
|
123
171
|
}
|
|
124
|
-
|
|
172
|
+
__pullMonitorResults(request, requestOptions) {
|
|
125
173
|
return __awaiter(this, void 0, void 0, function* () {
|
|
126
174
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
127
|
-
const { monitor_id: monitorId } = request
|
|
175
|
+
const { monitor_id: monitorId } = request;
|
|
128
176
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
129
177
|
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
130
178
|
const _response = yield core.fetcher({
|
|
131
|
-
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/monitors/${core.url.encodePathParam(monitorId)}`),
|
|
132
|
-
method: "
|
|
179
|
+
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/monitors/pull/${core.url.encodePathParam(monitorId)}`),
|
|
180
|
+
method: "GET",
|
|
133
181
|
headers: _headers,
|
|
134
|
-
contentType: "application/json",
|
|
135
182
|
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
136
|
-
requestType: "json",
|
|
137
|
-
body: _body,
|
|
138
183
|
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,
|
|
139
184
|
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,
|
|
140
185
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -146,8 +191,6 @@ export class MonitorsClient {
|
|
|
146
191
|
}
|
|
147
192
|
if (_response.error.reason === "status-code") {
|
|
148
193
|
switch (_response.error.statusCode) {
|
|
149
|
-
case 403:
|
|
150
|
-
throw new CatchAllApi.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
151
194
|
case 404:
|
|
152
195
|
throw new CatchAllApi.NotFoundError(_response.error.body, _response.rawResponse);
|
|
153
196
|
case 422:
|
|
@@ -160,7 +203,7 @@ export class MonitorsClient {
|
|
|
160
203
|
});
|
|
161
204
|
}
|
|
162
205
|
}
|
|
163
|
-
return handleNonStatusCodeError(_response.error, _response.rawResponse, "
|
|
206
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/catchAll/monitors/pull/{monitor_id}");
|
|
164
207
|
});
|
|
165
208
|
}
|
|
166
209
|
/**
|
|
@@ -221,33 +264,38 @@ export class MonitorsClient {
|
|
|
221
264
|
});
|
|
222
265
|
}
|
|
223
266
|
/**
|
|
224
|
-
*
|
|
267
|
+
* Resume scheduled job execution for a monitor.
|
|
225
268
|
*
|
|
226
|
-
* @param {CatchAllApi.
|
|
269
|
+
* @param {CatchAllApi.EnableMonitorRequestDto} request
|
|
227
270
|
* @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
228
271
|
*
|
|
272
|
+
* @throws {@link CatchAllApi.ForbiddenError}
|
|
229
273
|
* @throws {@link CatchAllApi.NotFoundError}
|
|
230
274
|
* @throws {@link CatchAllApi.UnprocessableEntityError}
|
|
231
275
|
*
|
|
232
276
|
* @example
|
|
233
|
-
* await client.monitors.
|
|
234
|
-
* monitor_id: "monitor_id"
|
|
277
|
+
* await client.monitors.enableMonitor({
|
|
278
|
+
* monitor_id: "monitor_id",
|
|
279
|
+
* backfill: true
|
|
235
280
|
* })
|
|
236
281
|
*/
|
|
237
|
-
|
|
238
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
282
|
+
enableMonitor(request, requestOptions) {
|
|
283
|
+
return core.HttpResponsePromise.fromPromise(this.__enableMonitor(request, requestOptions));
|
|
239
284
|
}
|
|
240
|
-
|
|
285
|
+
__enableMonitor(request, requestOptions) {
|
|
241
286
|
return __awaiter(this, void 0, void 0, function* () {
|
|
242
287
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
243
|
-
const { monitor_id: monitorId } = request;
|
|
288
|
+
const { monitor_id: monitorId } = request, _body = __rest(request, ["monitor_id"]);
|
|
244
289
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
245
290
|
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
246
291
|
const _response = yield core.fetcher({
|
|
247
|
-
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/monitors
|
|
248
|
-
method: "
|
|
292
|
+
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/monitors/${core.url.encodePathParam(monitorId)}/enable`),
|
|
293
|
+
method: "POST",
|
|
249
294
|
headers: _headers,
|
|
295
|
+
contentType: "application/json",
|
|
250
296
|
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
297
|
+
requestType: "json",
|
|
298
|
+
body: _body,
|
|
251
299
|
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,
|
|
252
300
|
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,
|
|
253
301
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -259,6 +307,8 @@ export class MonitorsClient {
|
|
|
259
307
|
}
|
|
260
308
|
if (_response.error.reason === "status-code") {
|
|
261
309
|
switch (_response.error.statusCode) {
|
|
310
|
+
case 403:
|
|
311
|
+
throw new CatchAllApi.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
262
312
|
case 404:
|
|
263
313
|
throw new CatchAllApi.NotFoundError(_response.error.body, _response.rawResponse);
|
|
264
314
|
case 422:
|
|
@@ -271,7 +321,7 @@ export class MonitorsClient {
|
|
|
271
321
|
});
|
|
272
322
|
}
|
|
273
323
|
}
|
|
274
|
-
return handleNonStatusCodeError(_response.error, _response.rawResponse, "
|
|
324
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/catchAll/monitors/{monitor_id}/enable");
|
|
275
325
|
});
|
|
276
326
|
}
|
|
277
327
|
/**
|
|
@@ -332,9 +382,9 @@ export class MonitorsClient {
|
|
|
332
382
|
});
|
|
333
383
|
}
|
|
334
384
|
/**
|
|
335
|
-
*
|
|
385
|
+
* Update the webhook configuration for an existing monitor.
|
|
336
386
|
*
|
|
337
|
-
* @param {CatchAllApi.
|
|
387
|
+
* @param {CatchAllApi.UpdateMonitorRequestDto} request
|
|
338
388
|
* @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
339
389
|
*
|
|
340
390
|
* @throws {@link CatchAllApi.ForbiddenError}
|
|
@@ -342,23 +392,29 @@ export class MonitorsClient {
|
|
|
342
392
|
* @throws {@link CatchAllApi.UnprocessableEntityError}
|
|
343
393
|
*
|
|
344
394
|
* @example
|
|
345
|
-
* await client.monitors.
|
|
395
|
+
* await client.monitors.updateMonitor({
|
|
346
396
|
* monitor_id: "monitor_id",
|
|
347
|
-
*
|
|
397
|
+
* webhook: {
|
|
398
|
+
* url: "https://new-endpoint.com/webhook",
|
|
399
|
+
* method: "POST",
|
|
400
|
+
* headers: {
|
|
401
|
+
* "Authorization": "Bearer new_token_xyz"
|
|
402
|
+
* }
|
|
403
|
+
* }
|
|
348
404
|
* })
|
|
349
405
|
*/
|
|
350
|
-
|
|
351
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
406
|
+
updateMonitor(request, requestOptions) {
|
|
407
|
+
return core.HttpResponsePromise.fromPromise(this.__updateMonitor(request, requestOptions));
|
|
352
408
|
}
|
|
353
|
-
|
|
409
|
+
__updateMonitor(request, requestOptions) {
|
|
354
410
|
return __awaiter(this, void 0, void 0, function* () {
|
|
355
411
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
356
412
|
const { monitor_id: monitorId } = request, _body = __rest(request, ["monitor_id"]);
|
|
357
413
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
358
414
|
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
359
415
|
const _response = yield core.fetcher({
|
|
360
|
-
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/monitors/${core.url.encodePathParam(monitorId)}
|
|
361
|
-
method: "
|
|
416
|
+
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/monitors/${core.url.encodePathParam(monitorId)}`),
|
|
417
|
+
method: "PATCH",
|
|
362
418
|
headers: _headers,
|
|
363
419
|
contentType: "application/json",
|
|
364
420
|
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
@@ -389,63 +445,7 @@ export class MonitorsClient {
|
|
|
389
445
|
});
|
|
390
446
|
}
|
|
391
447
|
}
|
|
392
|
-
return handleNonStatusCodeError(_response.error, _response.rawResponse, "
|
|
393
|
-
});
|
|
394
|
-
}
|
|
395
|
-
/**
|
|
396
|
-
* Returns all monitors created by the authenticated user.
|
|
397
|
-
*
|
|
398
|
-
* @param {CatchAllApi.ListMonitorsRequest} request
|
|
399
|
-
* @param {MonitorsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
400
|
-
*
|
|
401
|
-
* @throws {@link CatchAllApi.ForbiddenError}
|
|
402
|
-
* @throws {@link CatchAllApi.UnprocessableEntityError}
|
|
403
|
-
*
|
|
404
|
-
* @example
|
|
405
|
-
* await client.monitors.listMonitors()
|
|
406
|
-
*/
|
|
407
|
-
listMonitors(request = {}, requestOptions) {
|
|
408
|
-
return core.HttpResponsePromise.fromPromise(this.__listMonitors(request, requestOptions));
|
|
409
|
-
}
|
|
410
|
-
__listMonitors() {
|
|
411
|
-
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
412
|
-
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
413
|
-
const { page, page_size: pageSize } = request;
|
|
414
|
-
const _queryParams = {
|
|
415
|
-
page,
|
|
416
|
-
page_size: pageSize,
|
|
417
|
-
};
|
|
418
|
-
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
419
|
-
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
420
|
-
const _response = yield core.fetcher({
|
|
421
|
-
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/monitors"),
|
|
422
|
-
method: "GET",
|
|
423
|
-
headers: _headers,
|
|
424
|
-
queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
|
|
425
|
-
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,
|
|
426
|
-
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,
|
|
427
|
-
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
428
|
-
fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
|
|
429
|
-
logging: this._options.logging,
|
|
430
|
-
});
|
|
431
|
-
if (_response.ok) {
|
|
432
|
-
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
433
|
-
}
|
|
434
|
-
if (_response.error.reason === "status-code") {
|
|
435
|
-
switch (_response.error.statusCode) {
|
|
436
|
-
case 403:
|
|
437
|
-
throw new CatchAllApi.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
438
|
-
case 422:
|
|
439
|
-
throw new CatchAllApi.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
440
|
-
default:
|
|
441
|
-
throw new errors.CatchAllApiError({
|
|
442
|
-
statusCode: _response.error.statusCode,
|
|
443
|
-
body: _response.error.body,
|
|
444
|
-
rawResponse: _response.rawResponse,
|
|
445
|
-
});
|
|
446
|
-
}
|
|
447
|
-
}
|
|
448
|
-
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/catchAll/monitors");
|
|
448
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "PATCH", "/catchAll/monitors/{monitor_id}");
|
|
449
449
|
});
|
|
450
450
|
}
|
|
451
451
|
}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Identifying attributes for a company entity. All fields are optional but improve matching quality.
|
|
3
|
+
*/
|
|
4
|
+
export interface CompanyAttributes {
|
|
5
|
+
/**
|
|
6
|
+
* Company website domain without protocol or trailing slash.
|
|
7
|
+
*
|
|
8
|
+
* The most reliable identifier — strongly recommended when available.
|
|
9
|
+
*/
|
|
10
|
+
domain?: (string | null) | undefined;
|
|
11
|
+
/** Detailed description of the company used for matching. */
|
|
12
|
+
description?: (string | null) | undefined;
|
|
13
|
+
/** Names of key people associated with the company (founders, executives, etc.). Improves matching for articles that mention people rather than the company name. */
|
|
14
|
+
key_persons?: (string[] | null) | undefined;
|
|
15
|
+
/** Alternative names, abbreviations, or aliases. Helps resolve common variations of the company name. */
|
|
16
|
+
alternative_names?: (string[] | null) | undefined;
|
|
17
|
+
}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* A company entity matched to a record in a Company Search job, with
|
|
3
|
+
* a relevance score and explanation.
|
|
4
|
+
*
|
|
5
|
+
* Only entities with `ed_score` ≥ 1 appear in results. Entities scored
|
|
6
|
+
* 0 are filtered out before the response is returned.
|
|
7
|
+
*/
|
|
8
|
+
export interface ConnectedEntity {
|
|
9
|
+
/** Unique identifier of the matched entity. */
|
|
10
|
+
entity_id: string;
|
|
11
|
+
/** Name of the matched entity. */
|
|
12
|
+
name: string;
|
|
13
|
+
/**
|
|
14
|
+
* Relevance score indicating how directly the entity is associated
|
|
15
|
+
* with this event.
|
|
16
|
+
*
|
|
17
|
+
* | Score | Meaning |
|
|
18
|
+
* |-------|---------|
|
|
19
|
+
* | 10 | Direct mention, critical event (merger, CEO change, major lawsuit) |
|
|
20
|
+
* | 7–9 | Major impact (earnings, product launch, senior hire) |
|
|
21
|
+
* | 4–6 | Routine update (minor product news, mid-level changes) |
|
|
22
|
+
* | 1–3 | Indirect mention (listed with others, stock noise) |
|
|
23
|
+
*/
|
|
24
|
+
ed_score: number;
|
|
25
|
+
/**
|
|
26
|
+
* Short explanation (up to 100 characters) of why this entity is
|
|
27
|
+
* associated with the event.
|
|
28
|
+
*/
|
|
29
|
+
relation: string;
|
|
30
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type * as CatchAllApi from "../index.mjs";
|
|
2
|
+
export interface CreateDatasetCsvResponse {
|
|
3
|
+
/** Unique identifier of the created dataset. */
|
|
4
|
+
dataset_id: string;
|
|
5
|
+
/** Name of the created dataset. */
|
|
6
|
+
dataset_name: string;
|
|
7
|
+
/** Number of entities successfully created from the CSV. */
|
|
8
|
+
entities_created: number;
|
|
9
|
+
validation_report: CatchAllApi.ValidationReport;
|
|
10
|
+
}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import type * as CatchAllApi from "../index.mjs";
|
|
2
|
+
export interface CreateEntitiesBatchResponse {
|
|
3
|
+
/** Array of created entity stubs in the same order as the input. */
|
|
4
|
+
entities: CatchAllApi.CreateEntityResponse[];
|
|
5
|
+
/** Total number of entities created. */
|
|
6
|
+
count: number;
|
|
7
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import type * as CatchAllApi from "../index.mjs";
|
|
2
|
+
/**
|
|
3
|
+
* Request body for creating a single entity. Only `name` is required.
|
|
4
|
+
* The more fields you provide, the better the matching quality.
|
|
5
|
+
*/
|
|
6
|
+
export interface CreateEntityRequest {
|
|
7
|
+
/** The company or person name. Required and must be non-empty. */
|
|
8
|
+
name: string;
|
|
9
|
+
entity_type?: CatchAllApi.EntityType | undefined;
|
|
10
|
+
/** Free-text description of the entity used for disambiguation when similar names exist. */
|
|
11
|
+
description?: string | undefined;
|
|
12
|
+
additional_attributes?: CatchAllApi.AdditionalAttributes | undefined;
|
|
13
|
+
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type * as CatchAllApi from "../index.mjs";
|
|
2
|
+
export interface DatasetEntityListResponse {
|
|
3
|
+
/** Array of entity summary objects for this page. */
|
|
4
|
+
entities: CatchAllApi.EntitySummary[];
|
|
5
|
+
/** Total number of entities in the dataset. */
|
|
6
|
+
total: number;
|
|
7
|
+
/** Current page number. */
|
|
8
|
+
page: number;
|
|
9
|
+
/** Number of entities per page. */
|
|
10
|
+
page_size: number;
|
|
11
|
+
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type * as CatchAllApi from "../index.mjs";
|
|
2
|
+
export interface DatasetListResponse {
|
|
3
|
+
/** Array of dataset objects for this page. */
|
|
4
|
+
datasets: CatchAllApi.DatasetResponse[];
|
|
5
|
+
/** Total number of datasets matching the filter criteria. */
|
|
6
|
+
total: number;
|
|
7
|
+
/** Current page number. */
|
|
8
|
+
page: number;
|
|
9
|
+
/** Number of datasets per page. */
|
|
10
|
+
page_size: number;
|
|
11
|
+
}
|