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
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import type * as CatchAllApi from "../index.js";
|
|
2
|
+
export interface DatasetResponse {
|
|
3
|
+
/** Unique identifier of the dataset. */
|
|
4
|
+
id: string;
|
|
5
|
+
/** Organization that owns this dataset. */
|
|
6
|
+
organization_id: string;
|
|
7
|
+
/** Dataset name. */
|
|
8
|
+
name: string;
|
|
9
|
+
/** Optional description. */
|
|
10
|
+
description?: (string | null) | undefined;
|
|
11
|
+
/** Total number of entities in this dataset. */
|
|
12
|
+
entity_count?: number | undefined;
|
|
13
|
+
latest_status?: CatchAllApi.DatasetStatus | undefined;
|
|
14
|
+
/** ID of the user who created this dataset. */
|
|
15
|
+
created_by_user_id?: string | undefined;
|
|
16
|
+
/** ISO 8601 timestamp of when the dataset was created. Returned without timezone offset (server-local time). */
|
|
17
|
+
created_at?: string | undefined;
|
|
18
|
+
/** ISO 8601 timestamp of when the dataset was last updated. Returned without timezone offset (server-local time). */
|
|
19
|
+
updated_at?: string | undefined;
|
|
20
|
+
}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
/** Fields available for sorting dataset list results. */
|
|
2
|
+
export declare const DatasetSortBy: {
|
|
3
|
+
readonly Name: "name";
|
|
4
|
+
readonly CreatedAt: "created_at";
|
|
5
|
+
readonly Status: "status";
|
|
6
|
+
};
|
|
7
|
+
export type DatasetSortBy = (typeof DatasetSortBy)[keyof typeof DatasetSortBy];
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.DatasetSortBy = void 0;
|
|
5
|
+
/** Fields available for sorting dataset list results. */
|
|
6
|
+
exports.DatasetSortBy = {
|
|
7
|
+
Name: "name",
|
|
8
|
+
CreatedAt: "created_at",
|
|
9
|
+
Status: "status",
|
|
10
|
+
};
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Processing status of a dataset.
|
|
3
|
+
*
|
|
4
|
+
* - `pending`: Dataset created, entities queued for enrichment.
|
|
5
|
+
* - `enriching`: Entities are being enriched.
|
|
6
|
+
* - `ready`: All entities enriched and indexed — ready for use in jobs.
|
|
7
|
+
* - `failed`: One or more entity enrichments failed.
|
|
8
|
+
*/
|
|
9
|
+
export declare const DatasetStatus: {
|
|
10
|
+
readonly Pending: "pending";
|
|
11
|
+
readonly Enriching: "enriching";
|
|
12
|
+
readonly Ready: "ready";
|
|
13
|
+
readonly Failed: "failed";
|
|
14
|
+
};
|
|
15
|
+
export type DatasetStatus = (typeof DatasetStatus)[keyof typeof DatasetStatus];
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.DatasetStatus = void 0;
|
|
5
|
+
/**
|
|
6
|
+
* Processing status of a dataset.
|
|
7
|
+
*
|
|
8
|
+
* - `pending`: Dataset created, entities queued for enrichment.
|
|
9
|
+
* - `enriching`: Entities are being enriched.
|
|
10
|
+
* - `ready`: All entities enriched and indexed — ready for use in jobs.
|
|
11
|
+
* - `failed`: One or more entity enrichments failed.
|
|
12
|
+
*/
|
|
13
|
+
exports.DatasetStatus = {
|
|
14
|
+
Pending: "pending",
|
|
15
|
+
Enriching: "enriching",
|
|
16
|
+
Ready: "ready",
|
|
17
|
+
Failed: "failed",
|
|
18
|
+
};
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type * as CatchAllApi from "../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* A single status change event in a dataset's history.
|
|
4
|
+
*/
|
|
5
|
+
export interface DatasetStatusEntry {
|
|
6
|
+
status: CatchAllApi.DatasetStatus;
|
|
7
|
+
/** Additional context about the status change, if available. */
|
|
8
|
+
additional_information?: (Record<string, unknown> | null) | undefined;
|
|
9
|
+
/** ISO 8601 timestamp of when this status was set. Returned without timezone offset (server-local time). */
|
|
10
|
+
created_at?: string | undefined;
|
|
11
|
+
}
|
|
@@ -6,7 +6,9 @@
|
|
|
6
6
|
* - `date`: ISO format dates (YYYY-MM-DD)
|
|
7
7
|
* - `option`: Enum-like fixed values (status, category)
|
|
8
8
|
* - `url`: Web URLs
|
|
9
|
-
* - `company`: Structured company data. Returns `source_text`, `confidence`, and `metadata`.
|
|
9
|
+
* - `company`: Structured company data. Returns `source_text`, `confidence`, and `metadata`.
|
|
10
|
+
*
|
|
11
|
+
* See [Company enrichment](https://www.newscatcherapi.com/docs/web-search-api/api-reference/jobs/company-enrichment-dto) data model.
|
|
10
12
|
*/
|
|
11
13
|
export declare const EnrichmentType: {
|
|
12
14
|
readonly Text: "text";
|
|
@@ -10,7 +10,9 @@ exports.EnrichmentType = void 0;
|
|
|
10
10
|
* - `date`: ISO format dates (YYYY-MM-DD)
|
|
11
11
|
* - `option`: Enum-like fixed values (status, category)
|
|
12
12
|
* - `url`: Web URLs
|
|
13
|
-
* - `company`: Structured company data. Returns `source_text`, `confidence`, and `metadata`.
|
|
13
|
+
* - `company`: Structured company data. Returns `source_text`, `confidence`, and `metadata`.
|
|
14
|
+
*
|
|
15
|
+
* See [Company enrichment](https://www.newscatcherapi.com/docs/web-search-api/api-reference/jobs/company-enrichment-dto) data model.
|
|
14
16
|
*/
|
|
15
17
|
exports.EnrichmentType = {
|
|
16
18
|
Text: "text",
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type * as CatchAllApi from "../index.js";
|
|
2
|
+
export interface EntityListResponse {
|
|
3
|
+
/** Array of entity objects for this page. */
|
|
4
|
+
entities: CatchAllApi.EntityResponse[];
|
|
5
|
+
/** Total number of entities matching the filter criteria. */
|
|
6
|
+
total: number;
|
|
7
|
+
/** Current page number. */
|
|
8
|
+
page: number;
|
|
9
|
+
/** Number of entities per page. */
|
|
10
|
+
page_size: number;
|
|
11
|
+
}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import type * as CatchAllApi from "../index.js";
|
|
2
|
+
export interface EntityResponse {
|
|
3
|
+
/** Unique identifier of the entity. */
|
|
4
|
+
id: string;
|
|
5
|
+
entity_type: CatchAllApi.EntityType;
|
|
6
|
+
/** Organization that owns this entity. */
|
|
7
|
+
organization_id: string;
|
|
8
|
+
/** Entity name. */
|
|
9
|
+
name: string;
|
|
10
|
+
/** Free-text description. */
|
|
11
|
+
description?: (string | null) | undefined;
|
|
12
|
+
additional_attributes?: CatchAllApi.AdditionalAttributes | undefined;
|
|
13
|
+
status: CatchAllApi.EntityStatus;
|
|
14
|
+
/** ID of the user who created this entity. */
|
|
15
|
+
created_by_user_id?: string | undefined;
|
|
16
|
+
/** ISO 8601 timestamp of when the entity was created. Returned without timezone offset (server-local time). */
|
|
17
|
+
created_at?: string | undefined;
|
|
18
|
+
/** ISO 8601 timestamp of when the entity was last updated. Returned without timezone offset (server-local time). */
|
|
19
|
+
updated_at?: string | undefined;
|
|
20
|
+
}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
/** Fields available for sorting entity list results. */
|
|
2
|
+
export declare const EntitySortBy: {
|
|
3
|
+
readonly CreatedAt: "created_at";
|
|
4
|
+
readonly Name: "name";
|
|
5
|
+
readonly Status: "status";
|
|
6
|
+
};
|
|
7
|
+
export type EntitySortBy = (typeof EntitySortBy)[keyof typeof EntitySortBy];
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.EntitySortBy = void 0;
|
|
5
|
+
/** Fields available for sorting entity list results. */
|
|
6
|
+
exports.EntitySortBy = {
|
|
7
|
+
CreatedAt: "created_at",
|
|
8
|
+
Name: "name",
|
|
9
|
+
Status: "status",
|
|
10
|
+
};
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Processing status of an entity.
|
|
3
|
+
*
|
|
4
|
+
* - `pending`: Entity has been created and is queued for enrichment.
|
|
5
|
+
* - `enriching`: Enrichment is in progress.
|
|
6
|
+
* - `ready`: Enrichment complete — entity is indexed and ready for use in jobs.
|
|
7
|
+
* - `failed`: Enrichment failed. The entity may still be used but matching quality may be reduced.
|
|
8
|
+
*/
|
|
9
|
+
export declare const EntityStatus: {
|
|
10
|
+
readonly Pending: "pending";
|
|
11
|
+
readonly Enriching: "enriching";
|
|
12
|
+
readonly Ready: "ready";
|
|
13
|
+
readonly Failed: "failed";
|
|
14
|
+
};
|
|
15
|
+
export type EntityStatus = (typeof EntityStatus)[keyof typeof EntityStatus];
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.EntityStatus = void 0;
|
|
5
|
+
/**
|
|
6
|
+
* Processing status of an entity.
|
|
7
|
+
*
|
|
8
|
+
* - `pending`: Entity has been created and is queued for enrichment.
|
|
9
|
+
* - `enriching`: Enrichment is in progress.
|
|
10
|
+
* - `ready`: Enrichment complete — entity is indexed and ready for use in jobs.
|
|
11
|
+
* - `failed`: Enrichment failed. The entity may still be used but matching quality may be reduced.
|
|
12
|
+
*/
|
|
13
|
+
exports.EntityStatus = {
|
|
14
|
+
Pending: "pending",
|
|
15
|
+
Enriching: "enriching",
|
|
16
|
+
Ready: "ready",
|
|
17
|
+
Failed: "failed",
|
|
18
|
+
};
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import type * as CatchAllApi from "../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* Abbreviated entity object returned when listing entities within a
|
|
4
|
+
* dataset. Uses a flat `attributes` key rather than the nested
|
|
5
|
+
* `additional_attributes.company_attributes` structure used in
|
|
6
|
+
* standalone entity endpoints.
|
|
7
|
+
*/
|
|
8
|
+
export interface EntitySummary {
|
|
9
|
+
/** Unique identifier of the entity. */
|
|
10
|
+
id: string;
|
|
11
|
+
/** Entity name. */
|
|
12
|
+
name: string;
|
|
13
|
+
entity_type: CatchAllApi.EntityType;
|
|
14
|
+
status: CatchAllApi.EntityStatus;
|
|
15
|
+
/** Free-text description. */
|
|
16
|
+
description?: (string | null) | undefined;
|
|
17
|
+
attributes?: CatchAllApi.CompanyAttributes | undefined;
|
|
18
|
+
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The type of entity.
|
|
3
|
+
*
|
|
4
|
+
* - `company`: A company or organization (default).
|
|
5
|
+
* - `person`: An individual person.
|
|
6
|
+
*/
|
|
7
|
+
export declare const EntityType: {
|
|
8
|
+
readonly Company: "company";
|
|
9
|
+
readonly Person: "person";
|
|
10
|
+
};
|
|
11
|
+
export type EntityType = (typeof EntityType)[keyof typeof EntityType];
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.EntityType = void 0;
|
|
5
|
+
/**
|
|
6
|
+
* The type of entity.
|
|
7
|
+
*
|
|
8
|
+
* - `company`: A company or organization (default).
|
|
9
|
+
* - `person`: An individual person.
|
|
10
|
+
*/
|
|
11
|
+
exports.EntityType = {
|
|
12
|
+
Company: "company",
|
|
13
|
+
Person: "person",
|
|
14
|
+
};
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Error body returned by entity endpoints for field-level validation
|
|
3
|
+
* failures. Uses a different structure from the standard `Error` schema
|
|
4
|
+
* (`{"detail": "..."}`) used elsewhere in the API.
|
|
5
|
+
*/
|
|
6
|
+
export interface EntityValidationErrorBody {
|
|
7
|
+
/**
|
|
8
|
+
* Human-readable description of all validation errors, including
|
|
9
|
+
* field path, failure message, and error type.
|
|
10
|
+
*/
|
|
11
|
+
message: string;
|
|
12
|
+
/** HTTP status text. */
|
|
13
|
+
status: string;
|
|
14
|
+
/** HTTP status code. */
|
|
15
|
+
status_code: number;
|
|
16
|
+
}
|
|
@@ -16,6 +16,8 @@ export interface MonitorListItemDto {
|
|
|
16
16
|
timezone?: string | undefined;
|
|
17
17
|
/** The date when the monitor was created. */
|
|
18
18
|
created_at?: string | undefined;
|
|
19
|
-
/** Webhook configuration for this monitor
|
|
20
|
-
webhook?: CatchAllApi.WebhookDto | undefined;
|
|
19
|
+
/** Webhook configuration for this monitor, or null if not set. */
|
|
20
|
+
webhook?: (CatchAllApi.WebhookDto | null) | undefined;
|
|
21
|
+
/** Masked API key associated with this monitor. */
|
|
22
|
+
user_key?: string | undefined;
|
|
21
23
|
}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import type * as CatchAllApi from "../index.js";
|
|
2
2
|
/**
|
|
3
3
|
* Record with monitor-specific metadata. Used in monitor results and webhook payloads.
|
|
4
|
+
*
|
|
4
5
|
* Includes timestamps tracking when records were added and updated, and citations include job tracking.
|
|
5
6
|
*/
|
|
6
7
|
export interface MonitorRecord extends CatchAllApi.BaseRecord {
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
export interface PlanFeature {
|
|
2
|
+
/** Human-readable feature name. */
|
|
3
|
+
name: string;
|
|
4
|
+
/** Machine-readable feature identifier. */
|
|
5
|
+
code: string;
|
|
6
|
+
/** Data type of the feature value. */
|
|
7
|
+
value_type?: string | undefined;
|
|
8
|
+
/** Feature limit. Type depends on `value_type`. */
|
|
9
|
+
value?: unknown | undefined;
|
|
10
|
+
/** Current usage count for this feature. */
|
|
11
|
+
current_usage?: number | undefined;
|
|
12
|
+
}
|
|
@@ -6,14 +6,10 @@ export interface PullJobResponseDto {
|
|
|
6
6
|
query?: string | undefined;
|
|
7
7
|
/** Context provided with the query. */
|
|
8
8
|
context?: string | undefined;
|
|
9
|
-
/**
|
|
10
|
-
validators?: string[] | undefined;
|
|
11
|
-
/**
|
|
12
|
-
|
|
13
|
-
*
|
|
14
|
-
* **Note:** The `enrichment_confidence` field always appears in this list. The system adds it to every record regardless of the enrichments generated or defined.
|
|
15
|
-
*/
|
|
16
|
-
enrichments?: string[] | undefined;
|
|
9
|
+
/** Validators applied to filter results. */
|
|
10
|
+
validators?: Record<string, unknown>[] | undefined;
|
|
11
|
+
/** Enrichment fields used for data extraction. */
|
|
12
|
+
enrichments?: Record<string, unknown>[] | undefined;
|
|
17
13
|
/** Job status. */
|
|
18
14
|
status?: string | undefined;
|
|
19
15
|
/** Error message if the job failed. Null for successful jobs. */
|
|
@@ -39,6 +35,8 @@ export interface PullJobResponseDto {
|
|
|
39
35
|
page_size?: number | undefined;
|
|
40
36
|
/** The total number of pages available. */
|
|
41
37
|
total_pages?: number | undefined;
|
|
38
|
+
/** Processing mode used for this job. */
|
|
39
|
+
mode?: PullJobResponseDto.Mode | undefined;
|
|
42
40
|
/** Array of extracted records with structured data and citations. */
|
|
43
41
|
all_records?: CatchAllApi.Record_[] | undefined;
|
|
44
42
|
}
|
|
@@ -47,4 +45,10 @@ export declare namespace PullJobResponseDto {
|
|
|
47
45
|
start_date?: string | undefined;
|
|
48
46
|
end_date?: string | undefined;
|
|
49
47
|
}
|
|
48
|
+
/** Processing mode used for this job. */
|
|
49
|
+
const Mode: {
|
|
50
|
+
readonly Lite: "lite";
|
|
51
|
+
readonly Base: "base";
|
|
52
|
+
};
|
|
53
|
+
type Mode = (typeof Mode)[keyof typeof Mode];
|
|
50
54
|
}
|
|
@@ -1,3 +1,12 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
// This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.PullJobResponseDto = void 0;
|
|
5
|
+
var PullJobResponseDto;
|
|
6
|
+
(function (PullJobResponseDto) {
|
|
7
|
+
/** Processing mode used for this job. */
|
|
8
|
+
PullJobResponseDto.Mode = {
|
|
9
|
+
Lite: "lite",
|
|
10
|
+
Base: "base",
|
|
11
|
+
};
|
|
12
|
+
})(PullJobResponseDto || (exports.PullJobResponseDto = PullJobResponseDto = {}));
|
|
@@ -2,4 +2,9 @@ import type * as CatchAllApi from "../index.js";
|
|
|
2
2
|
export interface Record_ extends CatchAllApi.BaseRecord {
|
|
3
3
|
/** Source documents that were used to extract this record. */
|
|
4
4
|
citations: CatchAllApi.Citation[];
|
|
5
|
+
/**
|
|
6
|
+
* Entities from the connected dataset that are relevant to this record.
|
|
7
|
+
* Only present when the job was submitted with `connected_dataset_ids`.
|
|
8
|
+
*/
|
|
9
|
+
connected_entities?: CatchAllApi.ConnectedEntity[] | undefined;
|
|
5
10
|
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Details about a CSV row that was skipped during processing.
|
|
3
|
+
*/
|
|
4
|
+
export interface SkippedRow {
|
|
5
|
+
/**
|
|
6
|
+
* 1-based row number in the CSV file (including the header row).
|
|
7
|
+
*
|
|
8
|
+
* A value of `3` means the third line of the file (second data row).
|
|
9
|
+
*/
|
|
10
|
+
row: number;
|
|
11
|
+
/** Human-readable explanation of why the row was skipped. */
|
|
12
|
+
reason: string;
|
|
13
|
+
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Sort direction for list results.
|
|
3
|
+
*
|
|
4
|
+
* - `asc`: ascending (oldest or smallest first)
|
|
5
|
+
* - `desc`: descending (newest or largest first)
|
|
6
|
+
*/
|
|
7
|
+
export declare const SortOrder: {
|
|
8
|
+
readonly Asc: "asc";
|
|
9
|
+
readonly Desc: "desc";
|
|
10
|
+
};
|
|
11
|
+
export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.SortOrder = void 0;
|
|
5
|
+
/**
|
|
6
|
+
* Sort direction for list results.
|
|
7
|
+
*
|
|
8
|
+
* - `asc`: ascending (oldest or smallest first)
|
|
9
|
+
* - `desc`: descending (newest or largest first)
|
|
10
|
+
*/
|
|
11
|
+
exports.SortOrder = {
|
|
12
|
+
Asc: "asc",
|
|
13
|
+
Desc: "desc",
|
|
14
|
+
};
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import type * as CatchAllApi from "../index.js";
|
|
2
|
+
export interface UploadCsvToDatasetResponse {
|
|
3
|
+
/** ID of the dataset that was updated. */
|
|
4
|
+
dataset_id: string;
|
|
5
|
+
/** Number of new entities created from the CSV. */
|
|
6
|
+
entities_created: number;
|
|
7
|
+
validation_report: CatchAllApi.ValidationReport;
|
|
8
|
+
}
|
|
@@ -7,4 +7,16 @@ export interface UserJob {
|
|
|
7
7
|
created_at: string;
|
|
8
8
|
/** Current processing status of the job. */
|
|
9
9
|
status: string;
|
|
10
|
+
/** Processing mode used for this job. */
|
|
11
|
+
mode?: UserJob.Mode | undefined;
|
|
12
|
+
/** Masked API key that created this job. */
|
|
13
|
+
user_key?: string | undefined;
|
|
14
|
+
}
|
|
15
|
+
export declare namespace UserJob {
|
|
16
|
+
/** Processing mode used for this job. */
|
|
17
|
+
const Mode: {
|
|
18
|
+
readonly Lite: "lite";
|
|
19
|
+
readonly Base: "base";
|
|
20
|
+
};
|
|
21
|
+
type Mode = (typeof Mode)[keyof typeof Mode];
|
|
10
22
|
}
|
|
@@ -1,3 +1,12 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
// This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.UserJob = void 0;
|
|
5
|
+
var UserJob;
|
|
6
|
+
(function (UserJob) {
|
|
7
|
+
/** Processing mode used for this job. */
|
|
8
|
+
UserJob.Mode = {
|
|
9
|
+
Lite: "lite",
|
|
10
|
+
Base: "base",
|
|
11
|
+
};
|
|
12
|
+
})(UserJob || (exports.UserJob = UserJob = {}));
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import type * as CatchAllApi from "../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* Summary of CSV processing results.
|
|
4
|
+
*/
|
|
5
|
+
export interface ValidationReport {
|
|
6
|
+
/**
|
|
7
|
+
* Total number of data rows in the uploaded CSV (excluding the
|
|
8
|
+
* header row).
|
|
9
|
+
*/
|
|
10
|
+
total_rows: number;
|
|
11
|
+
/** Number of rows successfully processed into entities. */
|
|
12
|
+
valid_rows: number;
|
|
13
|
+
/** Number of rows skipped due to validation errors. */
|
|
14
|
+
skipped_count: number;
|
|
15
|
+
/** Details for each skipped row. */
|
|
16
|
+
skipped_rows: CatchAllApi.SkippedRow[];
|
|
17
|
+
}
|
|
@@ -1,35 +1,64 @@
|
|
|
1
|
+
export * from "./AdditionalAttributes.js";
|
|
1
2
|
export * from "./BaseRecord.js";
|
|
2
3
|
export * from "./Citation.js";
|
|
4
|
+
export * from "./CompanyAttributes.js";
|
|
3
5
|
export * from "./CompanyEnrichmentOutput.js";
|
|
6
|
+
export * from "./ConnectedEntity.js";
|
|
4
7
|
export * from "./Context.js";
|
|
5
8
|
export * from "./ContinueResponseDto.js";
|
|
9
|
+
export * from "./CreateDatasetCsvResponse.js";
|
|
10
|
+
export * from "./CreateEntitiesBatchResponse.js";
|
|
11
|
+
export * from "./CreateEntityRequest.js";
|
|
12
|
+
export * from "./CreateEntityResponse.js";
|
|
6
13
|
export * from "./CreateMonitorResponseDto.js";
|
|
14
|
+
export * from "./DatasetEntityIdsRequest.js";
|
|
15
|
+
export * from "./DatasetEntityListResponse.js";
|
|
16
|
+
export * from "./DatasetListResponse.js";
|
|
17
|
+
export * from "./DatasetResponse.js";
|
|
18
|
+
export * from "./DatasetSortBy.js";
|
|
19
|
+
export * from "./DatasetStatus.js";
|
|
20
|
+
export * from "./DatasetStatusEntry.js";
|
|
21
|
+
export * from "./DatasetStatusHistoryResponse.js";
|
|
7
22
|
export * from "./EndDate.js";
|
|
8
23
|
export * from "./EnrichmentSchema.js";
|
|
9
24
|
export * from "./EnrichmentType.js";
|
|
25
|
+
export * from "./EntityListResponse.js";
|
|
26
|
+
export * from "./EntityResponse.js";
|
|
27
|
+
export * from "./EntitySortBy.js";
|
|
28
|
+
export * from "./EntityStatus.js";
|
|
29
|
+
export * from "./EntitySummary.js";
|
|
30
|
+
export * from "./EntityType.js";
|
|
31
|
+
export * from "./EntityValidationErrorBody.js";
|
|
10
32
|
export * from "./Error_.js";
|
|
33
|
+
export * from "./GetPlanLimitsResponseDto.js";
|
|
11
34
|
export * from "./InitializeResponseDto.js";
|
|
12
35
|
export * from "./JobStep.js";
|
|
13
36
|
export * from "./Limit.js";
|
|
14
37
|
export * from "./ListMonitorsResponseDto.js";
|
|
15
38
|
export * from "./ListUserJobsResponseDto.js";
|
|
39
|
+
export * from "./ManageEntitiesResponse.js";
|
|
16
40
|
export * from "./MonitorCitation.js";
|
|
17
41
|
export * from "./MonitorJobItem.js";
|
|
18
42
|
export * from "./MonitorListItemDto.js";
|
|
19
43
|
export * from "./MonitorRecord.js";
|
|
44
|
+
export * from "./PlanFeature.js";
|
|
20
45
|
export * from "./PublicJobStatus.js";
|
|
21
46
|
export * from "./PullJobResponseDto.js";
|
|
22
47
|
export * from "./PullMonitorResponseDto.js";
|
|
23
48
|
export * from "./Query.js";
|
|
24
49
|
export * from "./Record_.js";
|
|
25
50
|
export * from "./ReferenceJob.js";
|
|
51
|
+
export * from "./SkippedRow.js";
|
|
52
|
+
export * from "./SortOrder.js";
|
|
26
53
|
export * from "./StartDate.js";
|
|
27
54
|
export * from "./StatusResponseDto.js";
|
|
28
55
|
export * from "./SubmitResponseDto.js";
|
|
29
56
|
export * from "./UpdateMonitorResponseDto.js";
|
|
57
|
+
export * from "./UploadCsvToDatasetResponse.js";
|
|
30
58
|
export * from "./UserJob.js";
|
|
31
59
|
export * from "./ValidationErrorDetail.js";
|
|
32
60
|
export * from "./ValidationErrorResponse.js";
|
|
61
|
+
export * from "./ValidationReport.js";
|
|
33
62
|
export * from "./ValidatorSchema.js";
|
|
34
63
|
export * from "./WebhookDto.js";
|
|
35
64
|
export * from "./WebhookPayload.js";
|