newscatcher-catchall-sdk 1.5.1 → 3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -2
- package/dist/cjs/BaseClient.d.ts +3 -0
- package/dist/cjs/BaseClient.js +17 -2
- package/dist/cjs/Client.d.ts +6 -0
- package/dist/cjs/Client.js +10 -0
- package/dist/cjs/api/resources/datasets/client/Client.d.ts +32 -32
- package/dist/cjs/api/resources/datasets/client/Client.js +59 -66
- package/dist/cjs/api/resources/datasets/client/requests/ListDatasetEntitiesRequest.d.ts +28 -0
- package/dist/cjs/api/resources/datasets/client/requests/ListDatasetsRequest.d.ts +4 -2
- package/dist/cjs/api/resources/datasets/client/requests/index.d.ts +1 -1
- package/dist/cjs/api/resources/entities/client/Client.d.ts +3 -7
- package/dist/cjs/api/resources/entities/client/Client.js +3 -7
- package/dist/cjs/api/resources/index.d.ts +5 -0
- package/dist/cjs/api/resources/index.js +6 -1
- package/dist/cjs/api/resources/jobs/client/Client.d.ts +23 -5
- package/dist/cjs/api/resources/jobs/client/Client.js +65 -6
- package/dist/cjs/api/resources/jobs/client/requests/GetUserJobsRequest.d.ts +5 -2
- package/dist/cjs/api/resources/jobs/client/requests/SubmitRequestDto.d.ts +11 -1
- package/dist/cjs/api/resources/jobs/client/requests/ValidateQueryRequestDto.d.ts +10 -0
- package/dist/cjs/api/resources/jobs/client/requests/ValidateQueryRequestDto.js +3 -0
- package/dist/cjs/api/resources/jobs/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/monitors/client/Client.d.ts +7 -16
- package/dist/cjs/api/resources/monitors/client/Client.js +9 -17
- package/dist/cjs/api/resources/monitors/client/requests/CreateMonitorRequestDto.d.ts +17 -14
- package/dist/cjs/api/resources/monitors/client/requests/ListMonitorsRequest.d.ts +5 -2
- package/dist/cjs/api/resources/monitors/client/requests/UpdateMonitorRequestDto.d.ts +7 -10
- package/dist/cjs/api/resources/monitors/types/DisableMonitorResponse.d.ts +1 -1
- package/dist/cjs/api/resources/monitors/types/EnableMonitorResponse.d.ts +1 -1
- package/dist/cjs/api/resources/projects/client/Client.d.ts +178 -0
- package/dist/cjs/api/resources/projects/client/Client.js +626 -0
- package/dist/cjs/api/resources/projects/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/projects/client/index.js +17 -0
- package/dist/cjs/api/resources/projects/client/requests/AddResourceRequestDto.d.ts +17 -0
- package/dist/cjs/api/resources/projects/client/requests/AddResourceRequestDto.js +3 -0
- package/dist/cjs/api/resources/projects/client/requests/CreateProjectRequestDto.d.ts +13 -0
- package/dist/cjs/api/resources/projects/client/requests/CreateProjectRequestDto.js +3 -0
- package/dist/cjs/api/resources/projects/client/requests/DeleteProjectRequest.d.ts +12 -0
- package/dist/cjs/api/resources/projects/client/requests/DeleteProjectRequest.js +3 -0
- package/dist/cjs/api/resources/projects/client/requests/GetProjectOverviewRequest.d.ts +10 -0
- package/dist/cjs/api/resources/projects/client/requests/GetProjectOverviewRequest.js +3 -0
- package/dist/cjs/api/resources/projects/client/requests/GetProjectRequest.d.ts +10 -0
- package/dist/cjs/api/resources/projects/client/requests/GetProjectRequest.js +3 -0
- package/dist/cjs/api/resources/projects/client/requests/ListProjectResourcesRequest.d.ts +16 -0
- package/dist/cjs/api/resources/projects/client/requests/ListProjectResourcesRequest.js +3 -0
- package/dist/cjs/api/resources/projects/client/requests/ListProjectsRequest.d.ts +16 -0
- package/dist/cjs/api/resources/projects/client/requests/ListProjectsRequest.js +3 -0
- package/dist/cjs/api/resources/projects/client/requests/RemoveResourceFromProjectRequest.d.ts +16 -0
- package/dist/cjs/api/resources/projects/client/requests/RemoveResourceFromProjectRequest.js +3 -0
- package/dist/cjs/api/resources/projects/client/requests/UpdateProjectRequestDto.d.ts +15 -0
- package/dist/cjs/api/resources/projects/client/requests/UpdateProjectRequestDto.js +3 -0
- package/dist/cjs/api/resources/projects/client/requests/index.d.ts +9 -0
- package/dist/cjs/api/resources/projects/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/projects/exports.d.ts +2 -0
- package/dist/cjs/api/resources/projects/exports.js +21 -0
- package/dist/cjs/api/resources/projects/index.d.ts +1 -0
- package/dist/cjs/api/resources/projects/index.js +17 -0
- package/dist/cjs/api/resources/webhooks/client/Client.d.ts +231 -0
- package/dist/cjs/api/resources/webhooks/client/Client.js +779 -0
- package/dist/cjs/api/resources/webhooks/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/webhooks/client/index.js +17 -0
- package/dist/cjs/api/resources/webhooks/client/requests/AssignWebhookResourceRequestDto.d.ts +17 -0
- package/dist/cjs/api/resources/webhooks/client/requests/AssignWebhookResourceRequestDto.js +3 -0
- package/dist/cjs/api/resources/webhooks/client/requests/CreateWebhookRequestDto.d.ts +42 -0
- package/dist/cjs/api/resources/webhooks/client/requests/CreateWebhookRequestDto.js +3 -0
- package/dist/cjs/api/resources/webhooks/client/requests/DeleteWebhookRequest.d.ts +10 -0
- package/dist/cjs/api/resources/webhooks/client/requests/DeleteWebhookRequest.js +3 -0
- package/dist/cjs/api/resources/webhooks/client/requests/GetWebhookDeliveryHistoryRequest.d.ts +18 -0
- package/dist/cjs/api/resources/webhooks/client/requests/GetWebhookDeliveryHistoryRequest.js +3 -0
- package/dist/cjs/api/resources/webhooks/client/requests/GetWebhookRequest.d.ts +10 -0
- package/dist/cjs/api/resources/webhooks/client/requests/GetWebhookRequest.js +3 -0
- package/dist/cjs/api/resources/webhooks/client/requests/ListWebhookResourcesRequest.d.ts +16 -0
- package/dist/cjs/api/resources/webhooks/client/requests/ListWebhookResourcesRequest.js +3 -0
- package/dist/cjs/api/resources/webhooks/client/requests/ListWebhooksForResourceRequest.d.ts +19 -0
- package/dist/cjs/api/resources/webhooks/client/requests/ListWebhooksForResourceRequest.js +3 -0
- package/dist/cjs/api/resources/webhooks/client/requests/ListWebhooksRequest.d.ts +12 -0
- package/dist/cjs/api/resources/webhooks/client/requests/ListWebhooksRequest.js +3 -0
- package/dist/cjs/api/resources/webhooks/client/requests/RemoveWebhookResourceRequest.d.ts +16 -0
- package/dist/cjs/api/resources/webhooks/client/requests/RemoveWebhookResourceRequest.js +3 -0
- package/dist/cjs/api/resources/webhooks/client/requests/TestWebhookRequestDto.d.ts +19 -0
- package/dist/cjs/api/resources/webhooks/client/requests/TestWebhookRequestDto.js +3 -0
- package/dist/cjs/api/resources/webhooks/client/requests/UpdateWebhookRequestDto.d.ts +30 -0
- package/dist/cjs/api/resources/webhooks/client/requests/UpdateWebhookRequestDto.js +3 -0
- package/dist/cjs/api/resources/webhooks/client/requests/index.d.ts +11 -0
- package/dist/cjs/api/resources/webhooks/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/webhooks/exports.d.ts +2 -0
- package/dist/cjs/api/resources/webhooks/exports.js +21 -0
- package/dist/cjs/api/resources/webhooks/index.d.ts +2 -0
- package/dist/cjs/api/resources/webhooks/index.js +18 -0
- package/dist/cjs/api/resources/webhooks/types/CreateWebhookRequestDtoAuth.d.ts +19 -0
- package/dist/cjs/api/resources/webhooks/types/CreateWebhookRequestDtoAuth.js +3 -0
- package/dist/cjs/api/resources/webhooks/types/UpdateWebhookRequestDtoAuth.d.ts +16 -0
- package/dist/cjs/api/resources/webhooks/types/UpdateWebhookRequestDtoAuth.js +3 -0
- package/dist/cjs/api/resources/webhooks/types/index.d.ts +2 -0
- package/dist/cjs/api/resources/webhooks/types/index.js +18 -0
- package/dist/cjs/api/types/AddResourceResponseDto.d.ts +9 -0
- package/dist/cjs/api/types/AddResourceResponseDto.js +3 -0
- package/dist/cjs/api/types/ApiKeyAuthDto.d.ts +6 -0
- package/dist/cjs/api/types/ApiKeyAuthDto.js +3 -0
- package/dist/cjs/api/types/AssignWebhookResourceResponseDto.d.ts +11 -0
- package/dist/cjs/api/types/AssignWebhookResourceResponseDto.js +3 -0
- package/dist/cjs/api/types/BasicAuthDto.d.ts +6 -0
- package/dist/cjs/api/types/BasicAuthDto.js +3 -0
- package/dist/cjs/api/types/BearerAuthDto.d.ts +4 -0
- package/dist/cjs/api/types/BearerAuthDto.js +3 -0
- package/dist/cjs/api/types/ConnectedEntity.d.ts +12 -9
- package/dist/cjs/api/types/CreateProjectResponseDto.d.ts +10 -0
- package/dist/cjs/api/types/CreateProjectResponseDto.js +3 -0
- package/dist/cjs/api/types/CreateWebhookResponseDto.d.ts +9 -0
- package/dist/cjs/api/types/CreateWebhookResponseDto.js +3 -0
- package/dist/cjs/api/types/DeleteJobResponseDto.d.ts +1 -1
- package/dist/cjs/api/types/DeleteMonitorResponseDto.d.ts +1 -1
- package/dist/cjs/api/types/DeliveryHistoryItemDto.d.ts +25 -0
- package/dist/cjs/api/types/DeliveryHistoryItemDto.js +3 -0
- package/dist/cjs/api/types/DeliveryHistoryResponseDto.d.ts +17 -0
- package/dist/cjs/api/types/DeliveryHistoryResponseDto.js +3 -0
- package/dist/cjs/api/types/DeliveryMode.d.ts +11 -0
- package/dist/cjs/api/types/DeliveryMode.js +14 -0
- package/dist/cjs/api/types/DeliveryStatus.d.ts +6 -0
- package/dist/cjs/api/types/DeliveryStatus.js +9 -0
- package/dist/cjs/api/types/GetWebhookResponseDto.d.ts +9 -0
- package/dist/cjs/api/types/GetWebhookResponseDto.js +3 -0
- package/dist/cjs/api/types/HttpMethod.d.ts +9 -0
- package/dist/cjs/api/types/HttpMethod.js +12 -0
- package/dist/cjs/api/types/IssueType.d.ts +25 -0
- package/dist/cjs/api/types/IssueType.js +28 -0
- package/dist/cjs/api/types/JobStep.d.ts +1 -1
- package/dist/cjs/api/types/ListWebhookResourcesResponseDto.d.ts +13 -0
- package/dist/cjs/api/types/ListWebhookResourcesResponseDto.js +3 -0
- package/dist/cjs/api/types/ListWebhooksResponseDto.d.ts +13 -0
- package/dist/cjs/api/types/ListWebhooksResponseDto.js +3 -0
- package/dist/cjs/api/types/MappableResourceType.d.ts +7 -0
- package/dist/cjs/api/types/MappableResourceType.js +10 -0
- package/dist/cjs/api/types/MonitorListItemDto.d.ts +1 -1
- package/dist/cjs/api/types/MonitorStatusHistoryResponseDto.d.ts +1 -1
- package/dist/cjs/api/types/ProjectListResponseDto.d.ts +13 -0
- package/dist/cjs/api/types/ProjectListResponseDto.js +3 -0
- package/dist/cjs/api/types/ProjectOverviewCountsDto.d.ts +4 -0
- package/dist/cjs/api/types/ProjectOverviewCountsDto.js +3 -0
- package/dist/cjs/api/types/ProjectOverviewResponseDto.d.ts +18 -0
- package/dist/cjs/api/types/ProjectOverviewResponseDto.js +3 -0
- package/dist/cjs/api/types/ProjectResourceDto.d.ts +18 -0
- package/dist/cjs/api/types/ProjectResourceDto.js +3 -0
- package/dist/cjs/api/types/ProjectResourceListResponseDto.d.ts +13 -0
- package/dist/cjs/api/types/ProjectResourceListResponseDto.js +3 -0
- package/dist/cjs/api/types/ProjectResourceType.d.ts +8 -0
- package/dist/cjs/api/types/ProjectResourceType.js +11 -0
- package/dist/cjs/api/types/ProjectResponseDto.d.ts +18 -0
- package/dist/cjs/api/types/ProjectResponseDto.js +3 -0
- package/dist/cjs/api/types/ProjectSummaryDto.d.ts +17 -0
- package/dist/cjs/api/types/ProjectSummaryDto.js +3 -0
- package/dist/cjs/api/types/QueryStatus.d.ts +13 -0
- package/dist/cjs/api/types/QueryStatus.js +16 -0
- package/dist/cjs/api/types/RemoveResourceResponseDto.d.ts +6 -0
- package/dist/cjs/api/types/RemoveResourceResponseDto.js +3 -0
- package/dist/cjs/api/types/ResourceItemDto.d.ts +6 -0
- package/dist/cjs/api/types/ResourceItemDto.js +3 -0
- package/dist/cjs/api/types/ResourceResultDto.d.ts +12 -0
- package/dist/cjs/api/types/ResourceResultDto.js +3 -0
- package/dist/cjs/api/types/Suggestion.d.ts +12 -0
- package/dist/cjs/api/types/Suggestion.js +3 -0
- package/dist/cjs/api/types/TestWebhookResponseDto.d.ts +10 -0
- package/dist/cjs/api/types/TestWebhookResponseDto.js +3 -0
- package/dist/cjs/api/types/UpdateProjectResponseDto.d.ts +8 -0
- package/dist/cjs/api/types/UpdateProjectResponseDto.js +3 -0
- package/dist/cjs/api/types/UpdateWebhookResponseDto.d.ts +9 -0
- package/dist/cjs/api/types/UpdateWebhookResponseDto.js +3 -0
- package/dist/cjs/api/types/ValidateQueryResponseDto.d.ts +18 -0
- package/dist/cjs/api/types/ValidateQueryResponseDto.js +3 -0
- package/dist/cjs/api/types/WebhookResourceMappingResponseDto.d.ts +12 -0
- package/dist/cjs/api/types/WebhookResourceMappingResponseDto.js +3 -0
- package/dist/cjs/api/types/WebhookResponseDto.d.ts +28 -0
- package/dist/cjs/api/types/WebhookResponseDto.js +3 -0
- package/dist/cjs/api/types/WebhookType.d.ts +17 -0
- package/dist/cjs/api/types/WebhookType.js +20 -0
- package/dist/cjs/api/types/index.d.ts +37 -0
- package/dist/cjs/api/types/index.js +37 -0
- package/dist/cjs/core/auth/AuthProvider.d.ts +1 -0
- package/dist/cjs/core/auth/AuthProvider.js +7 -0
- package/dist/cjs/core/auth/index.d.ts +1 -1
- package/dist/cjs/core/auth/index.js +3 -1
- package/dist/cjs/core/fetcher/requestWithRetries.js +4 -1
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.d.mts +3 -0
- package/dist/esm/BaseClient.mjs +17 -2
- package/dist/esm/Client.d.mts +6 -0
- package/dist/esm/Client.mjs +10 -0
- package/dist/esm/api/resources/datasets/client/Client.d.mts +32 -32
- package/dist/esm/api/resources/datasets/client/Client.mjs +59 -66
- package/dist/esm/api/resources/datasets/client/requests/ListDatasetEntitiesRequest.d.mts +28 -0
- package/dist/esm/api/resources/datasets/client/requests/ListDatasetsRequest.d.mts +4 -2
- package/dist/esm/api/resources/datasets/client/requests/index.d.mts +1 -1
- package/dist/esm/api/resources/entities/client/Client.d.mts +3 -7
- package/dist/esm/api/resources/entities/client/Client.mjs +3 -7
- package/dist/esm/api/resources/index.d.mts +5 -0
- package/dist/esm/api/resources/index.mjs +5 -0
- package/dist/esm/api/resources/jobs/client/Client.d.mts +23 -5
- package/dist/esm/api/resources/jobs/client/Client.mjs +65 -6
- package/dist/esm/api/resources/jobs/client/requests/GetUserJobsRequest.d.mts +5 -2
- package/dist/esm/api/resources/jobs/client/requests/SubmitRequestDto.d.mts +11 -1
- package/dist/esm/api/resources/jobs/client/requests/ValidateQueryRequestDto.d.mts +10 -0
- package/dist/esm/api/resources/jobs/client/requests/ValidateQueryRequestDto.mjs +2 -0
- package/dist/esm/api/resources/jobs/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/monitors/client/Client.d.mts +7 -16
- package/dist/esm/api/resources/monitors/client/Client.mjs +9 -17
- package/dist/esm/api/resources/monitors/client/requests/CreateMonitorRequestDto.d.mts +17 -14
- package/dist/esm/api/resources/monitors/client/requests/ListMonitorsRequest.d.mts +5 -2
- package/dist/esm/api/resources/monitors/client/requests/UpdateMonitorRequestDto.d.mts +7 -10
- package/dist/esm/api/resources/monitors/types/DisableMonitorResponse.d.mts +1 -1
- package/dist/esm/api/resources/monitors/types/EnableMonitorResponse.d.mts +1 -1
- package/dist/esm/api/resources/projects/client/Client.d.mts +178 -0
- package/dist/esm/api/resources/projects/client/Client.mjs +589 -0
- package/dist/esm/api/resources/projects/client/index.d.mts +1 -0
- package/dist/esm/api/resources/projects/client/index.mjs +1 -0
- package/dist/esm/api/resources/projects/client/requests/AddResourceRequestDto.d.mts +17 -0
- package/dist/esm/api/resources/projects/client/requests/AddResourceRequestDto.mjs +2 -0
- package/dist/esm/api/resources/projects/client/requests/CreateProjectRequestDto.d.mts +13 -0
- package/dist/esm/api/resources/projects/client/requests/CreateProjectRequestDto.mjs +2 -0
- package/dist/esm/api/resources/projects/client/requests/DeleteProjectRequest.d.mts +12 -0
- package/dist/esm/api/resources/projects/client/requests/DeleteProjectRequest.mjs +2 -0
- package/dist/esm/api/resources/projects/client/requests/GetProjectOverviewRequest.d.mts +10 -0
- package/dist/esm/api/resources/projects/client/requests/GetProjectOverviewRequest.mjs +2 -0
- package/dist/esm/api/resources/projects/client/requests/GetProjectRequest.d.mts +10 -0
- package/dist/esm/api/resources/projects/client/requests/GetProjectRequest.mjs +2 -0
- package/dist/esm/api/resources/projects/client/requests/ListProjectResourcesRequest.d.mts +16 -0
- package/dist/esm/api/resources/projects/client/requests/ListProjectResourcesRequest.mjs +2 -0
- package/dist/esm/api/resources/projects/client/requests/ListProjectsRequest.d.mts +16 -0
- package/dist/esm/api/resources/projects/client/requests/ListProjectsRequest.mjs +2 -0
- package/dist/esm/api/resources/projects/client/requests/RemoveResourceFromProjectRequest.d.mts +16 -0
- package/dist/esm/api/resources/projects/client/requests/RemoveResourceFromProjectRequest.mjs +2 -0
- package/dist/esm/api/resources/projects/client/requests/UpdateProjectRequestDto.d.mts +15 -0
- package/dist/esm/api/resources/projects/client/requests/UpdateProjectRequestDto.mjs +2 -0
- package/dist/esm/api/resources/projects/client/requests/index.d.mts +9 -0
- package/dist/esm/api/resources/projects/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/projects/exports.d.mts +2 -0
- package/dist/esm/api/resources/projects/exports.mjs +3 -0
- package/dist/esm/api/resources/projects/index.d.mts +1 -0
- package/dist/esm/api/resources/projects/index.mjs +1 -0
- package/dist/esm/api/resources/webhooks/client/Client.d.mts +231 -0
- package/dist/esm/api/resources/webhooks/client/Client.mjs +742 -0
- package/dist/esm/api/resources/webhooks/client/index.d.mts +1 -0
- package/dist/esm/api/resources/webhooks/client/index.mjs +1 -0
- package/dist/esm/api/resources/webhooks/client/requests/AssignWebhookResourceRequestDto.d.mts +17 -0
- package/dist/esm/api/resources/webhooks/client/requests/AssignWebhookResourceRequestDto.mjs +2 -0
- package/dist/esm/api/resources/webhooks/client/requests/CreateWebhookRequestDto.d.mts +42 -0
- package/dist/esm/api/resources/webhooks/client/requests/CreateWebhookRequestDto.mjs +2 -0
- package/dist/esm/api/resources/webhooks/client/requests/DeleteWebhookRequest.d.mts +10 -0
- package/dist/esm/api/resources/webhooks/client/requests/DeleteWebhookRequest.mjs +2 -0
- package/dist/esm/api/resources/webhooks/client/requests/GetWebhookDeliveryHistoryRequest.d.mts +18 -0
- package/dist/esm/api/resources/webhooks/client/requests/GetWebhookDeliveryHistoryRequest.mjs +2 -0
- package/dist/esm/api/resources/webhooks/client/requests/GetWebhookRequest.d.mts +10 -0
- package/dist/esm/api/resources/webhooks/client/requests/GetWebhookRequest.mjs +2 -0
- package/dist/esm/api/resources/webhooks/client/requests/ListWebhookResourcesRequest.d.mts +16 -0
- package/dist/esm/api/resources/webhooks/client/requests/ListWebhookResourcesRequest.mjs +2 -0
- package/dist/esm/api/resources/webhooks/client/requests/ListWebhooksForResourceRequest.d.mts +19 -0
- package/dist/esm/api/resources/webhooks/client/requests/ListWebhooksForResourceRequest.mjs +2 -0
- package/dist/esm/api/resources/webhooks/client/requests/ListWebhooksRequest.d.mts +12 -0
- package/dist/esm/api/resources/webhooks/client/requests/ListWebhooksRequest.mjs +2 -0
- package/dist/esm/api/resources/webhooks/client/requests/RemoveWebhookResourceRequest.d.mts +16 -0
- package/dist/esm/api/resources/webhooks/client/requests/RemoveWebhookResourceRequest.mjs +2 -0
- package/dist/esm/api/resources/webhooks/client/requests/TestWebhookRequestDto.d.mts +19 -0
- package/dist/esm/api/resources/webhooks/client/requests/TestWebhookRequestDto.mjs +2 -0
- package/dist/esm/api/resources/webhooks/client/requests/UpdateWebhookRequestDto.d.mts +30 -0
- package/dist/esm/api/resources/webhooks/client/requests/UpdateWebhookRequestDto.mjs +2 -0
- package/dist/esm/api/resources/webhooks/client/requests/index.d.mts +11 -0
- package/dist/esm/api/resources/webhooks/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/webhooks/exports.d.mts +2 -0
- package/dist/esm/api/resources/webhooks/exports.mjs +3 -0
- package/dist/esm/api/resources/webhooks/index.d.mts +2 -0
- package/dist/esm/api/resources/webhooks/index.mjs +2 -0
- package/dist/esm/api/resources/webhooks/types/CreateWebhookRequestDtoAuth.d.mts +19 -0
- package/dist/esm/api/resources/webhooks/types/CreateWebhookRequestDtoAuth.mjs +2 -0
- package/dist/esm/api/resources/webhooks/types/UpdateWebhookRequestDtoAuth.d.mts +16 -0
- package/dist/esm/api/resources/webhooks/types/UpdateWebhookRequestDtoAuth.mjs +2 -0
- package/dist/esm/api/resources/webhooks/types/index.d.mts +2 -0
- package/dist/esm/api/resources/webhooks/types/index.mjs +2 -0
- package/dist/esm/api/types/AddResourceResponseDto.d.mts +9 -0
- package/dist/esm/api/types/AddResourceResponseDto.mjs +2 -0
- package/dist/esm/api/types/ApiKeyAuthDto.d.mts +6 -0
- package/dist/esm/api/types/ApiKeyAuthDto.mjs +2 -0
- package/dist/esm/api/types/AssignWebhookResourceResponseDto.d.mts +11 -0
- package/dist/esm/api/types/AssignWebhookResourceResponseDto.mjs +2 -0
- package/dist/esm/api/types/BasicAuthDto.d.mts +6 -0
- package/dist/esm/api/types/BasicAuthDto.mjs +2 -0
- package/dist/esm/api/types/BearerAuthDto.d.mts +4 -0
- package/dist/esm/api/types/BearerAuthDto.mjs +2 -0
- package/dist/esm/api/types/ConnectedEntity.d.mts +12 -9
- package/dist/esm/api/types/CreateProjectResponseDto.d.mts +10 -0
- package/dist/esm/api/types/CreateProjectResponseDto.mjs +2 -0
- package/dist/esm/api/types/CreateWebhookResponseDto.d.mts +9 -0
- package/dist/esm/api/types/CreateWebhookResponseDto.mjs +2 -0
- package/dist/esm/api/types/DeleteJobResponseDto.d.mts +1 -1
- package/dist/esm/api/types/DeleteMonitorResponseDto.d.mts +1 -1
- package/dist/esm/api/types/DeliveryHistoryItemDto.d.mts +25 -0
- package/dist/esm/api/types/DeliveryHistoryItemDto.mjs +2 -0
- package/dist/esm/api/types/DeliveryHistoryResponseDto.d.mts +17 -0
- package/dist/esm/api/types/DeliveryHistoryResponseDto.mjs +2 -0
- package/dist/esm/api/types/DeliveryMode.d.mts +11 -0
- package/dist/esm/api/types/DeliveryMode.mjs +11 -0
- package/dist/esm/api/types/DeliveryStatus.d.mts +6 -0
- package/dist/esm/api/types/DeliveryStatus.mjs +6 -0
- package/dist/esm/api/types/GetWebhookResponseDto.d.mts +9 -0
- package/dist/esm/api/types/GetWebhookResponseDto.mjs +2 -0
- package/dist/esm/api/types/HttpMethod.d.mts +9 -0
- package/dist/esm/api/types/HttpMethod.mjs +9 -0
- package/dist/esm/api/types/IssueType.d.mts +25 -0
- package/dist/esm/api/types/IssueType.mjs +25 -0
- package/dist/esm/api/types/JobStep.d.mts +1 -1
- package/dist/esm/api/types/ListWebhookResourcesResponseDto.d.mts +13 -0
- package/dist/esm/api/types/ListWebhookResourcesResponseDto.mjs +2 -0
- package/dist/esm/api/types/ListWebhooksResponseDto.d.mts +13 -0
- package/dist/esm/api/types/ListWebhooksResponseDto.mjs +2 -0
- package/dist/esm/api/types/MappableResourceType.d.mts +7 -0
- package/dist/esm/api/types/MappableResourceType.mjs +7 -0
- package/dist/esm/api/types/MonitorListItemDto.d.mts +1 -1
- package/dist/esm/api/types/MonitorStatusHistoryResponseDto.d.mts +1 -1
- package/dist/esm/api/types/ProjectListResponseDto.d.mts +13 -0
- package/dist/esm/api/types/ProjectListResponseDto.mjs +2 -0
- package/dist/esm/api/types/ProjectOverviewCountsDto.d.mts +4 -0
- package/dist/esm/api/types/ProjectOverviewCountsDto.mjs +2 -0
- package/dist/esm/api/types/ProjectOverviewResponseDto.d.mts +18 -0
- package/dist/esm/api/types/ProjectOverviewResponseDto.mjs +2 -0
- package/dist/esm/api/types/ProjectResourceDto.d.mts +18 -0
- package/dist/esm/api/types/ProjectResourceDto.mjs +2 -0
- package/dist/esm/api/types/ProjectResourceListResponseDto.d.mts +13 -0
- package/dist/esm/api/types/ProjectResourceListResponseDto.mjs +2 -0
- package/dist/esm/api/types/ProjectResourceType.d.mts +8 -0
- package/dist/esm/api/types/ProjectResourceType.mjs +8 -0
- package/dist/esm/api/types/ProjectResponseDto.d.mts +18 -0
- package/dist/esm/api/types/ProjectResponseDto.mjs +2 -0
- package/dist/esm/api/types/ProjectSummaryDto.d.mts +17 -0
- package/dist/esm/api/types/ProjectSummaryDto.mjs +2 -0
- package/dist/esm/api/types/QueryStatus.d.mts +13 -0
- package/dist/esm/api/types/QueryStatus.mjs +13 -0
- package/dist/esm/api/types/RemoveResourceResponseDto.d.mts +6 -0
- package/dist/esm/api/types/RemoveResourceResponseDto.mjs +2 -0
- package/dist/esm/api/types/ResourceItemDto.d.mts +6 -0
- package/dist/esm/api/types/ResourceItemDto.mjs +2 -0
- package/dist/esm/api/types/ResourceResultDto.d.mts +12 -0
- package/dist/esm/api/types/ResourceResultDto.mjs +2 -0
- package/dist/esm/api/types/Suggestion.d.mts +12 -0
- package/dist/esm/api/types/Suggestion.mjs +2 -0
- package/dist/esm/api/types/TestWebhookResponseDto.d.mts +10 -0
- package/dist/esm/api/types/TestWebhookResponseDto.mjs +2 -0
- package/dist/esm/api/types/UpdateProjectResponseDto.d.mts +8 -0
- package/dist/esm/api/types/UpdateProjectResponseDto.mjs +2 -0
- package/dist/esm/api/types/UpdateWebhookResponseDto.d.mts +9 -0
- package/dist/esm/api/types/UpdateWebhookResponseDto.mjs +2 -0
- package/dist/esm/api/types/ValidateQueryResponseDto.d.mts +18 -0
- package/dist/esm/api/types/ValidateQueryResponseDto.mjs +2 -0
- package/dist/esm/api/types/WebhookResourceMappingResponseDto.d.mts +12 -0
- package/dist/esm/api/types/WebhookResourceMappingResponseDto.mjs +2 -0
- package/dist/esm/api/types/WebhookResponseDto.d.mts +28 -0
- package/dist/esm/api/types/WebhookResponseDto.mjs +2 -0
- package/dist/esm/api/types/WebhookType.d.mts +17 -0
- package/dist/esm/api/types/WebhookType.mjs +17 -0
- package/dist/esm/api/types/index.d.mts +37 -0
- package/dist/esm/api/types/index.mjs +37 -0
- package/dist/esm/core/auth/AuthProvider.d.mts +1 -0
- package/dist/esm/core/auth/AuthProvider.mjs +6 -1
- package/dist/esm/core/auth/index.d.mts +1 -1
- package/dist/esm/core/auth/index.mjs +1 -0
- package/dist/esm/core/fetcher/requestWithRetries.mjs +4 -1
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +24 -2
- package/reference.md +1614 -223
- package/dist/cjs/api/resources/datasets/client/requests/ListEntitiesInDatasetRequest.d.ts +0 -21
- package/dist/esm/api/resources/datasets/client/requests/ListEntitiesInDatasetRequest.d.mts +0 -21
- /package/dist/cjs/api/resources/datasets/client/requests/{ListEntitiesInDatasetRequest.js → ListDatasetEntitiesRequest.js} +0 -0
- /package/dist/esm/api/resources/datasets/client/requests/{ListEntitiesInDatasetRequest.mjs → ListDatasetEntitiesRequest.mjs} +0 -0
package/README.md
CHANGED
|
@@ -202,11 +202,19 @@ The SDK is instrumented with automatic retries with exponential backoff. A reque
|
|
|
202
202
|
as the request is deemed retryable and the number of retry attempts has not grown larger than the configured
|
|
203
203
|
retry limit (default: 2).
|
|
204
204
|
|
|
205
|
-
|
|
205
|
+
Which status codes are retried depends on the `retryStatusCodes` generator configuration:
|
|
206
206
|
|
|
207
|
+
**`legacy`** (current default): retries on
|
|
207
208
|
- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
|
|
208
209
|
- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
|
|
209
|
-
- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status
|
|
210
|
+
- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status#server_error_responses) (All server errors, including 500)
|
|
211
|
+
|
|
212
|
+
**`recommended`**: retries on
|
|
213
|
+
- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
|
|
214
|
+
- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
|
|
215
|
+
- [502](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/502) (Bad Gateway)
|
|
216
|
+
- [503](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/503) (Service Unavailable)
|
|
217
|
+
- [504](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/504) (Gateway Timeout)
|
|
210
218
|
|
|
211
219
|
Use the `maxRetries` request option to configure this behavior.
|
|
212
220
|
|
|
@@ -365,3 +373,5 @@ On the other hand, contributions to the README are always very welcome!
|
|
|
365
373
|
|
|
366
374
|
|
|
367
375
|
|
|
376
|
+
|
|
377
|
+
|
package/dist/cjs/BaseClient.d.ts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { HeaderAuthProvider } from "./auth/HeaderAuthProvider.js";
|
|
2
2
|
import * as core from "./core/index.js";
|
|
3
3
|
import type * as environments from "./environments.js";
|
|
4
|
+
export type AuthOption = false | core.AuthProvider["getAuthRequest"] | core.AuthProvider | HeaderAuthProvider.AuthOptions;
|
|
4
5
|
export type BaseClientOptions = {
|
|
5
6
|
environment?: core.Supplier<environments.CatchAllApiEnvironment | string>;
|
|
6
7
|
/** Specify a custom URL to connect the client to. */
|
|
@@ -15,6 +16,8 @@ export type BaseClientOptions = {
|
|
|
15
16
|
fetch?: typeof fetch;
|
|
16
17
|
/** Configure logging for the client. */
|
|
17
18
|
logging?: core.logging.LogConfig | core.logging.Logger;
|
|
19
|
+
/** Override auth. Pass false to disable, a function returning auth headers, an AuthProvider, or auth options. */
|
|
20
|
+
auth?: AuthOption;
|
|
18
21
|
} & HeaderAuthProvider.AuthOptions;
|
|
19
22
|
export interface BaseRequestOptions {
|
|
20
23
|
/** The maximum time to wait for a response in seconds. */
|
package/dist/cjs/BaseClient.js
CHANGED
|
@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
|
|
|
43
43
|
const headers = (0, headers_js_1.mergeHeaders)({
|
|
44
44
|
"X-Fern-Language": "JavaScript",
|
|
45
45
|
"X-Fern-SDK-Name": "newscatcher-catchall-sdk",
|
|
46
|
-
"X-Fern-SDK-Version": "
|
|
47
|
-
"User-Agent": "newscatcher-catchall-sdk/
|
|
46
|
+
"X-Fern-SDK-Version": "3.0.0",
|
|
47
|
+
"User-Agent": "newscatcher-catchall-sdk/3.0.0",
|
|
48
48
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
49
49
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
50
50
|
}, options === null || options === void 0 ? void 0 : options.headers);
|
|
@@ -53,6 +53,21 @@ function normalizeClientOptions(options) {
|
|
|
53
53
|
function normalizeClientOptionsWithAuth(options) {
|
|
54
54
|
var _a;
|
|
55
55
|
const normalized = normalizeClientOptions(options);
|
|
56
|
+
if (options.auth === false) {
|
|
57
|
+
normalized.authProvider = new core.NoOpAuthProvider();
|
|
58
|
+
return normalized;
|
|
59
|
+
}
|
|
60
|
+
if (options.auth != null) {
|
|
61
|
+
if (typeof options.auth === "function") {
|
|
62
|
+
normalized.authProvider = { getAuthRequest: options.auth };
|
|
63
|
+
return normalized;
|
|
64
|
+
}
|
|
65
|
+
if (core.isAuthProvider(options.auth)) {
|
|
66
|
+
normalized.authProvider = options.auth;
|
|
67
|
+
return normalized;
|
|
68
|
+
}
|
|
69
|
+
Object.assign(normalized, options.auth);
|
|
70
|
+
}
|
|
56
71
|
const normalizedWithNoOpAuthProvider = withNoOpAuthProvider(normalized);
|
|
57
72
|
(_a = normalized.authProvider) !== null && _a !== void 0 ? _a : (normalized.authProvider = new HeaderAuthProvider_js_1.HeaderAuthProvider(normalizedWithNoOpAuthProvider));
|
|
58
73
|
return normalized;
|
package/dist/cjs/Client.d.ts
CHANGED
|
@@ -3,6 +3,8 @@ import { EntitiesClient } from "./api/resources/entities/client/Client.js";
|
|
|
3
3
|
import { JobsClient } from "./api/resources/jobs/client/Client.js";
|
|
4
4
|
import { MetaClient } from "./api/resources/meta/client/Client.js";
|
|
5
5
|
import { MonitorsClient } from "./api/resources/monitors/client/Client.js";
|
|
6
|
+
import { ProjectsClient } from "./api/resources/projects/client/Client.js";
|
|
7
|
+
import { WebhooksClient } from "./api/resources/webhooks/client/Client.js";
|
|
6
8
|
import type { BaseClientOptions, BaseRequestOptions } from "./BaseClient.js";
|
|
7
9
|
import { type NormalizedClientOptionsWithAuth } from "./BaseClient.js";
|
|
8
10
|
import * as core from "./core/index.js";
|
|
@@ -15,14 +17,18 @@ export declare class CatchAllApiClient {
|
|
|
15
17
|
protected readonly _options: NormalizedClientOptionsWithAuth<CatchAllApiClient.Options>;
|
|
16
18
|
protected _jobs: JobsClient | undefined;
|
|
17
19
|
protected _monitors: MonitorsClient | undefined;
|
|
20
|
+
protected _webhooks: WebhooksClient | undefined;
|
|
18
21
|
protected _entities: EntitiesClient | undefined;
|
|
19
22
|
protected _datasets: DatasetsClient | undefined;
|
|
23
|
+
protected _projects: ProjectsClient | undefined;
|
|
20
24
|
protected _meta: MetaClient | undefined;
|
|
21
25
|
constructor(options?: CatchAllApiClient.Options);
|
|
22
26
|
get jobs(): JobsClient;
|
|
23
27
|
get monitors(): MonitorsClient;
|
|
28
|
+
get webhooks(): WebhooksClient;
|
|
24
29
|
get entities(): EntitiesClient;
|
|
25
30
|
get datasets(): DatasetsClient;
|
|
31
|
+
get projects(): ProjectsClient;
|
|
26
32
|
get meta(): MetaClient;
|
|
27
33
|
/**
|
|
28
34
|
* Make a passthrough request using the SDK's configured auth, retry, logging, etc.
|
package/dist/cjs/Client.js
CHANGED
|
@@ -49,6 +49,8 @@ const Client_js_2 = require("./api/resources/entities/client/Client.js");
|
|
|
49
49
|
const Client_js_3 = require("./api/resources/jobs/client/Client.js");
|
|
50
50
|
const Client_js_4 = require("./api/resources/meta/client/Client.js");
|
|
51
51
|
const Client_js_5 = require("./api/resources/monitors/client/Client.js");
|
|
52
|
+
const Client_js_6 = require("./api/resources/projects/client/Client.js");
|
|
53
|
+
const Client_js_7 = require("./api/resources/webhooks/client/Client.js");
|
|
52
54
|
const BaseClient_js_1 = require("./BaseClient.js");
|
|
53
55
|
const core = __importStar(require("./core/index.js"));
|
|
54
56
|
class CatchAllApiClient {
|
|
@@ -63,6 +65,10 @@ class CatchAllApiClient {
|
|
|
63
65
|
var _a;
|
|
64
66
|
return ((_a = this._monitors) !== null && _a !== void 0 ? _a : (this._monitors = new Client_js_5.MonitorsClient(this._options)));
|
|
65
67
|
}
|
|
68
|
+
get webhooks() {
|
|
69
|
+
var _a;
|
|
70
|
+
return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new Client_js_7.WebhooksClient(this._options)));
|
|
71
|
+
}
|
|
66
72
|
get entities() {
|
|
67
73
|
var _a;
|
|
68
74
|
return ((_a = this._entities) !== null && _a !== void 0 ? _a : (this._entities = new Client_js_2.EntitiesClient(this._options)));
|
|
@@ -71,6 +77,10 @@ class CatchAllApiClient {
|
|
|
71
77
|
var _a;
|
|
72
78
|
return ((_a = this._datasets) !== null && _a !== void 0 ? _a : (this._datasets = new Client_js_1.DatasetsClient(this._options)));
|
|
73
79
|
}
|
|
80
|
+
get projects() {
|
|
81
|
+
var _a;
|
|
82
|
+
return ((_a = this._projects) !== null && _a !== void 0 ? _a : (this._projects = new Client_js_6.ProjectsClient(this._options)));
|
|
83
|
+
}
|
|
74
84
|
get meta() {
|
|
75
85
|
var _a;
|
|
76
86
|
return ((_a = this._meta) !== null && _a !== void 0 ? _a : (this._meta = new Client_js_4.MetaClient(this._options)));
|
|
@@ -18,9 +18,7 @@ export declare class DatasetsClient {
|
|
|
18
18
|
protected readonly _options: NormalizedClientOptionsWithAuth<DatasetsClient.Options>;
|
|
19
19
|
constructor(options?: DatasetsClient.Options);
|
|
20
20
|
/**
|
|
21
|
-
* Returns a paginated list of datasets belonging to the authenticated
|
|
22
|
-
* organization. Supports filtering by status and sorting by name,
|
|
23
|
-
* status, or creation date.
|
|
21
|
+
* Returns a paginated list of datasets belonging to the authenticated organization. Supports filtering by status and sorting by name, status, or creation date.
|
|
24
22
|
*
|
|
25
23
|
* @param {CatchAllApi.ListDatasetsRequest} request
|
|
26
24
|
* @param {DatasetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -29,7 +27,8 @@ export declare class DatasetsClient {
|
|
|
29
27
|
*
|
|
30
28
|
* @example
|
|
31
29
|
* await client.datasets.listDatasets({
|
|
32
|
-
* search: "Portfolio"
|
|
30
|
+
* search: "Portfolio",
|
|
31
|
+
* project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04"
|
|
33
32
|
* })
|
|
34
33
|
*/
|
|
35
34
|
listDatasets(request?: CatchAllApi.ListDatasetsRequest, requestOptions?: DatasetsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.DatasetListResponse>;
|
|
@@ -61,9 +60,7 @@ export declare class DatasetsClient {
|
|
|
61
60
|
createDataset(request: CatchAllApi.CreateDatasetRequest, requestOptions?: DatasetsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.DatasetResponse>;
|
|
62
61
|
private __createDataset;
|
|
63
62
|
/**
|
|
64
|
-
* Creates a new dataset by uploading a CSV file. Each row in the CSV
|
|
65
|
-
* becomes an entity. The `name` column is required; all other columns
|
|
66
|
-
* are optional.
|
|
63
|
+
* Creates a new dataset by uploading a CSV file. Each row in the CSV becomes an entity. The `name` and `domain`columns are required; all other columns are optional.
|
|
67
64
|
*
|
|
68
65
|
* **CSV format:**
|
|
69
66
|
* ```csv
|
|
@@ -144,22 +141,6 @@ export declare class DatasetsClient {
|
|
|
144
141
|
*/
|
|
145
142
|
updateDataset(request: CatchAllApi.UpdateDatasetRequest, requestOptions?: DatasetsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.DatasetResponse>;
|
|
146
143
|
private __updateDataset;
|
|
147
|
-
/**
|
|
148
|
-
* Returns a paginated list of entities in a dataset. Supports filtering by status and entity type.
|
|
149
|
-
*
|
|
150
|
-
* @param {CatchAllApi.ListEntitiesInDatasetRequest} request
|
|
151
|
-
* @param {DatasetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
152
|
-
*
|
|
153
|
-
* @throws {@link CatchAllApi.ForbiddenError}
|
|
154
|
-
* @throws {@link CatchAllApi.NotFoundError}
|
|
155
|
-
*
|
|
156
|
-
* @example
|
|
157
|
-
* await client.datasets.listEntitiesInDataset({
|
|
158
|
-
* dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2"
|
|
159
|
-
* })
|
|
160
|
-
*/
|
|
161
|
-
listEntitiesInDataset(request: CatchAllApi.ListEntitiesInDatasetRequest, requestOptions?: DatasetsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.DatasetEntityListResponse>;
|
|
162
|
-
private __listEntitiesInDataset;
|
|
163
144
|
/**
|
|
164
145
|
* Adds one or more existing entities to a dataset. Returns the number of entities added.
|
|
165
146
|
*
|
|
@@ -181,9 +162,7 @@ export declare class DatasetsClient {
|
|
|
181
162
|
addEntitiesToDataset(request: CatchAllApi.AddEntitiesToDatasetRequest, requestOptions?: DatasetsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.ManageEntitiesResponse>;
|
|
182
163
|
private __addEntitiesToDataset;
|
|
183
164
|
/**
|
|
184
|
-
* Removes one or more entities from a dataset. The entities themselves
|
|
185
|
-
* are not deleted — they are only removed from this dataset. Returns
|
|
186
|
-
* the number of entities removed.
|
|
165
|
+
* Removes one or more entities from a dataset. The entities themselves are not deleted — they are only removed from this dataset. Returns the number of entities removed.
|
|
187
166
|
*
|
|
188
167
|
* @param {CatchAllApi.RemoveEntitiesFromDatasetRequest} request
|
|
189
168
|
* @param {DatasetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -203,8 +182,31 @@ export declare class DatasetsClient {
|
|
|
203
182
|
removeEntitiesFromDataset(request: CatchAllApi.RemoveEntitiesFromDatasetRequest, requestOptions?: DatasetsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.ManageEntitiesResponse>;
|
|
204
183
|
private __removeEntitiesFromDataset;
|
|
205
184
|
/**
|
|
206
|
-
* Returns
|
|
207
|
-
*
|
|
185
|
+
* Returns a paginated list of entities in a dataset. Supports filtering by status, entity type, and name search.
|
|
186
|
+
*
|
|
187
|
+
* @param {CatchAllApi.ListDatasetEntitiesRequest} request
|
|
188
|
+
* @param {DatasetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
189
|
+
*
|
|
190
|
+
* @throws {@link CatchAllApi.ForbiddenError}
|
|
191
|
+
* @throws {@link CatchAllApi.NotFoundError}
|
|
192
|
+
* @throws {@link CatchAllApi.UnprocessableEntityError}
|
|
193
|
+
*
|
|
194
|
+
* @example
|
|
195
|
+
* await client.datasets.listEntitiesInDataset({
|
|
196
|
+
* dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2",
|
|
197
|
+
* page: 1,
|
|
198
|
+
* page_size: 100,
|
|
199
|
+
* search: "OpenAI",
|
|
200
|
+
* status: "ready",
|
|
201
|
+
* entity_type: "company",
|
|
202
|
+
* sort_by: "created_at",
|
|
203
|
+
* sort_order: "desc"
|
|
204
|
+
* })
|
|
205
|
+
*/
|
|
206
|
+
listEntitiesInDataset(request: CatchAllApi.ListDatasetEntitiesRequest, requestOptions?: DatasetsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.DatasetEntityListResponse>;
|
|
207
|
+
private __listEntitiesInDataset;
|
|
208
|
+
/**
|
|
209
|
+
* Returns the full status change history for a dataset, ordered chronologically from oldest to newest.
|
|
208
210
|
*
|
|
209
211
|
* @param {CatchAllApi.GetDatasetStatusHistoryRequest} request
|
|
210
212
|
* @param {DatasetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -220,11 +222,9 @@ export declare class DatasetsClient {
|
|
|
220
222
|
getDatasetStatusHistory(request: CatchAllApi.GetDatasetStatusHistoryRequest, requestOptions?: DatasetsClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.DatasetStatusHistoryResponse>;
|
|
221
223
|
private __getDatasetStatusHistory;
|
|
222
224
|
/**
|
|
223
|
-
* Appends new companies to an existing dataset by uploading a CSV file.
|
|
224
|
-
* Uses the same CSV format as the dataset creation endpoint.
|
|
225
|
+
* Appends new companies to an existing dataset by uploading a CSV file. Uses the same CSV format as the dataset creation endpoint.
|
|
225
226
|
*
|
|
226
|
-
* The response omits `dataset_name` compared to the create-from-CSV
|
|
227
|
-
* endpoint since the dataset already exists.
|
|
227
|
+
* The response omits `dataset_name` compared to the create-from-CSV endpoint since the dataset already exists.
|
|
228
228
|
*
|
|
229
229
|
* @param {CatchAllApi.UploadCsvToDatasetRequest} request
|
|
230
230
|
* @param {DatasetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -74,9 +74,7 @@ class DatasetsClient {
|
|
|
74
74
|
this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
|
|
75
75
|
}
|
|
76
76
|
/**
|
|
77
|
-
* Returns a paginated list of datasets belonging to the authenticated
|
|
78
|
-
* organization. Supports filtering by status and sorting by name,
|
|
79
|
-
* status, or creation date.
|
|
77
|
+
* Returns a paginated list of datasets belonging to the authenticated organization. Supports filtering by status and sorting by name, status, or creation date.
|
|
80
78
|
*
|
|
81
79
|
* @param {CatchAllApi.ListDatasetsRequest} request
|
|
82
80
|
* @param {DatasetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -85,7 +83,8 @@ class DatasetsClient {
|
|
|
85
83
|
*
|
|
86
84
|
* @example
|
|
87
85
|
* await client.datasets.listDatasets({
|
|
88
|
-
* search: "Portfolio"
|
|
86
|
+
* search: "Portfolio",
|
|
87
|
+
* project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04"
|
|
89
88
|
* })
|
|
90
89
|
*/
|
|
91
90
|
listDatasets(request = {}, requestOptions) {
|
|
@@ -94,7 +93,7 @@ class DatasetsClient {
|
|
|
94
93
|
__listDatasets() {
|
|
95
94
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
96
95
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
97
|
-
const { page, page_size: pageSize, search, latest_status: latestStatus, sort_by: sortBy, sort_order: sortOrder, ownership, } = request;
|
|
96
|
+
const { page, page_size: pageSize, search, latest_status: latestStatus, sort_by: sortBy, sort_order: sortOrder, ownership, project_id: projectId, } = request;
|
|
98
97
|
const _queryParams = {
|
|
99
98
|
page,
|
|
100
99
|
page_size: pageSize,
|
|
@@ -103,6 +102,7 @@ class DatasetsClient {
|
|
|
103
102
|
sort_by: sortBy != null ? sortBy : undefined,
|
|
104
103
|
sort_order: sortOrder != null ? sortOrder : undefined,
|
|
105
104
|
ownership: ownership != null ? ownership : undefined,
|
|
105
|
+
project_id: projectId,
|
|
106
106
|
};
|
|
107
107
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
108
108
|
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
@@ -208,9 +208,7 @@ class DatasetsClient {
|
|
|
208
208
|
});
|
|
209
209
|
}
|
|
210
210
|
/**
|
|
211
|
-
* Creates a new dataset by uploading a CSV file. Each row in the CSV
|
|
212
|
-
* becomes an entity. The `name` column is required; all other columns
|
|
213
|
-
* are optional.
|
|
211
|
+
* Creates a new dataset by uploading a CSV file. Each row in the CSV becomes an entity. The `name` and `domain`columns are required; all other columns are optional.
|
|
214
212
|
*
|
|
215
213
|
* **CSV format:**
|
|
216
214
|
* ```csv
|
|
@@ -458,46 +456,40 @@ class DatasetsClient {
|
|
|
458
456
|
});
|
|
459
457
|
}
|
|
460
458
|
/**
|
|
461
|
-
*
|
|
459
|
+
* Adds one or more existing entities to a dataset. Returns the number of entities added.
|
|
462
460
|
*
|
|
463
|
-
* @param {CatchAllApi.
|
|
461
|
+
* @param {CatchAllApi.AddEntitiesToDatasetRequest} request
|
|
464
462
|
* @param {DatasetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
465
463
|
*
|
|
466
464
|
* @throws {@link CatchAllApi.ForbiddenError}
|
|
467
465
|
* @throws {@link CatchAllApi.NotFoundError}
|
|
466
|
+
* @throws {@link CatchAllApi.UnprocessableEntityError}
|
|
468
467
|
*
|
|
469
468
|
* @example
|
|
470
|
-
* await client.datasets.
|
|
471
|
-
* dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2"
|
|
469
|
+
* await client.datasets.addEntitiesToDataset({
|
|
470
|
+
* dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2",
|
|
471
|
+
* body: {
|
|
472
|
+
* entity_ids: ["854198fa-f702-49db-a381-0427fa87f173"]
|
|
473
|
+
* }
|
|
472
474
|
* })
|
|
473
475
|
*/
|
|
474
|
-
|
|
475
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
476
|
+
addEntitiesToDataset(request, requestOptions) {
|
|
477
|
+
return core.HttpResponsePromise.fromPromise(this.__addEntitiesToDataset(request, requestOptions));
|
|
476
478
|
}
|
|
477
|
-
|
|
479
|
+
__addEntitiesToDataset(request, requestOptions) {
|
|
478
480
|
return __awaiter(this, void 0, void 0, function* () {
|
|
479
481
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
480
|
-
const { dataset_id: datasetId,
|
|
481
|
-
const _queryParams = {
|
|
482
|
-
page,
|
|
483
|
-
page_size: pageSize,
|
|
484
|
-
search,
|
|
485
|
-
status: status != null ? status : undefined,
|
|
486
|
-
entity_type: entityType != null ? entityType : undefined,
|
|
487
|
-
sort_by: sortBy != null ? sortBy : undefined,
|
|
488
|
-
sort_order: sortOrder != null ? sortOrder : undefined,
|
|
489
|
-
};
|
|
482
|
+
const { dataset_id: datasetId, body: _body } = request;
|
|
490
483
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
491
484
|
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
492
485
|
const _response = yield core.fetcher({
|
|
493
486
|
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/datasets/${core.url.encodePathParam(datasetId)}/entities`),
|
|
494
|
-
method: "
|
|
487
|
+
method: "POST",
|
|
495
488
|
headers: _headers,
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
.build(),
|
|
489
|
+
contentType: "application/json",
|
|
490
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
491
|
+
requestType: "json",
|
|
492
|
+
body: _body,
|
|
501
493
|
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,
|
|
502
494
|
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,
|
|
503
495
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -505,10 +497,7 @@ class DatasetsClient {
|
|
|
505
497
|
logging: this._options.logging,
|
|
506
498
|
});
|
|
507
499
|
if (_response.ok) {
|
|
508
|
-
return {
|
|
509
|
-
data: _response.body,
|
|
510
|
-
rawResponse: _response.rawResponse,
|
|
511
|
-
};
|
|
500
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
512
501
|
}
|
|
513
502
|
if (_response.error.reason === "status-code") {
|
|
514
503
|
switch (_response.error.statusCode) {
|
|
@@ -516,6 +505,8 @@ class DatasetsClient {
|
|
|
516
505
|
throw new CatchAllApi.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
517
506
|
case 404:
|
|
518
507
|
throw new CatchAllApi.NotFoundError(_response.error.body, _response.rawResponse);
|
|
508
|
+
case 422:
|
|
509
|
+
throw new CatchAllApi.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
519
510
|
default:
|
|
520
511
|
throw new errors.CatchAllApiError({
|
|
521
512
|
statusCode: _response.error.statusCode,
|
|
@@ -524,13 +515,13 @@ class DatasetsClient {
|
|
|
524
515
|
});
|
|
525
516
|
}
|
|
526
517
|
}
|
|
527
|
-
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "
|
|
518
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/catchAll/datasets/{dataset_id}/entities");
|
|
528
519
|
});
|
|
529
520
|
}
|
|
530
521
|
/**
|
|
531
|
-
*
|
|
522
|
+
* Removes one or more entities from a dataset. The entities themselves are not deleted — they are only removed from this dataset. Returns the number of entities removed.
|
|
532
523
|
*
|
|
533
|
-
* @param {CatchAllApi.
|
|
524
|
+
* @param {CatchAllApi.RemoveEntitiesFromDatasetRequest} request
|
|
534
525
|
* @param {DatasetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
535
526
|
*
|
|
536
527
|
* @throws {@link CatchAllApi.ForbiddenError}
|
|
@@ -538,17 +529,17 @@ class DatasetsClient {
|
|
|
538
529
|
* @throws {@link CatchAllApi.UnprocessableEntityError}
|
|
539
530
|
*
|
|
540
531
|
* @example
|
|
541
|
-
* await client.datasets.
|
|
532
|
+
* await client.datasets.removeEntitiesFromDataset({
|
|
542
533
|
* dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2",
|
|
543
534
|
* body: {
|
|
544
535
|
* entity_ids: ["854198fa-f702-49db-a381-0427fa87f173"]
|
|
545
536
|
* }
|
|
546
537
|
* })
|
|
547
538
|
*/
|
|
548
|
-
|
|
549
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
539
|
+
removeEntitiesFromDataset(request, requestOptions) {
|
|
540
|
+
return core.HttpResponsePromise.fromPromise(this.__removeEntitiesFromDataset(request, requestOptions));
|
|
550
541
|
}
|
|
551
|
-
|
|
542
|
+
__removeEntitiesFromDataset(request, requestOptions) {
|
|
552
543
|
return __awaiter(this, void 0, void 0, function* () {
|
|
553
544
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
554
545
|
const { dataset_id: datasetId, body: _body } = request;
|
|
@@ -556,7 +547,7 @@ class DatasetsClient {
|
|
|
556
547
|
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
557
548
|
const _response = yield core.fetcher({
|
|
558
549
|
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/datasets/${core.url.encodePathParam(datasetId)}/entities`),
|
|
559
|
-
method: "
|
|
550
|
+
method: "DELETE",
|
|
560
551
|
headers: _headers,
|
|
561
552
|
contentType: "application/json",
|
|
562
553
|
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
@@ -587,15 +578,13 @@ class DatasetsClient {
|
|
|
587
578
|
});
|
|
588
579
|
}
|
|
589
580
|
}
|
|
590
|
-
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "
|
|
581
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "DELETE", "/catchAll/datasets/{dataset_id}/entities");
|
|
591
582
|
});
|
|
592
583
|
}
|
|
593
584
|
/**
|
|
594
|
-
*
|
|
595
|
-
* are not deleted — they are only removed from this dataset. Returns
|
|
596
|
-
* the number of entities removed.
|
|
585
|
+
* Returns a paginated list of entities in a dataset. Supports filtering by status, entity type, and name search.
|
|
597
586
|
*
|
|
598
|
-
* @param {CatchAllApi.
|
|
587
|
+
* @param {CatchAllApi.ListDatasetEntitiesRequest} request
|
|
599
588
|
* @param {DatasetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
600
589
|
*
|
|
601
590
|
* @throws {@link CatchAllApi.ForbiddenError}
|
|
@@ -603,25 +592,29 @@ class DatasetsClient {
|
|
|
603
592
|
* @throws {@link CatchAllApi.UnprocessableEntityError}
|
|
604
593
|
*
|
|
605
594
|
* @example
|
|
606
|
-
* await client.datasets.
|
|
595
|
+
* await client.datasets.listEntitiesInDataset({
|
|
607
596
|
* dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2",
|
|
608
|
-
*
|
|
609
|
-
*
|
|
610
|
-
*
|
|
597
|
+
* page: 1,
|
|
598
|
+
* page_size: 100,
|
|
599
|
+
* search: "OpenAI",
|
|
600
|
+
* status: "ready",
|
|
601
|
+
* entity_type: "company",
|
|
602
|
+
* sort_by: "created_at",
|
|
603
|
+
* sort_order: "desc"
|
|
611
604
|
* })
|
|
612
605
|
*/
|
|
613
|
-
|
|
614
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
606
|
+
listEntitiesInDataset(request, requestOptions) {
|
|
607
|
+
return core.HttpResponsePromise.fromPromise(this.__listEntitiesInDataset(request, requestOptions));
|
|
615
608
|
}
|
|
616
|
-
|
|
609
|
+
__listEntitiesInDataset(request, requestOptions) {
|
|
617
610
|
return __awaiter(this, void 0, void 0, function* () {
|
|
618
611
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
619
|
-
const { dataset_id: datasetId,
|
|
612
|
+
const { dataset_id: datasetId } = request, _body = __rest(request, ["dataset_id"]);
|
|
620
613
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
621
614
|
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
622
615
|
const _response = yield core.fetcher({
|
|
623
|
-
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/datasets/${core.url.encodePathParam(datasetId)}/entities`),
|
|
624
|
-
method: "
|
|
616
|
+
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/datasets/${core.url.encodePathParam(datasetId)}/entities/list`),
|
|
617
|
+
method: "POST",
|
|
625
618
|
headers: _headers,
|
|
626
619
|
contentType: "application/json",
|
|
627
620
|
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
@@ -634,7 +627,10 @@ class DatasetsClient {
|
|
|
634
627
|
logging: this._options.logging,
|
|
635
628
|
});
|
|
636
629
|
if (_response.ok) {
|
|
637
|
-
return {
|
|
630
|
+
return {
|
|
631
|
+
data: _response.body,
|
|
632
|
+
rawResponse: _response.rawResponse,
|
|
633
|
+
};
|
|
638
634
|
}
|
|
639
635
|
if (_response.error.reason === "status-code") {
|
|
640
636
|
switch (_response.error.statusCode) {
|
|
@@ -652,12 +648,11 @@ class DatasetsClient {
|
|
|
652
648
|
});
|
|
653
649
|
}
|
|
654
650
|
}
|
|
655
|
-
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "
|
|
651
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/catchAll/datasets/{dataset_id}/entities/list");
|
|
656
652
|
});
|
|
657
653
|
}
|
|
658
654
|
/**
|
|
659
|
-
* Returns the full status change history for a dataset, ordered
|
|
660
|
-
* chronologically from oldest to newest.
|
|
655
|
+
* Returns the full status change history for a dataset, ordered chronologically from oldest to newest.
|
|
661
656
|
*
|
|
662
657
|
* @param {CatchAllApi.GetDatasetStatusHistoryRequest} request
|
|
663
658
|
* @param {DatasetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -714,11 +709,9 @@ class DatasetsClient {
|
|
|
714
709
|
});
|
|
715
710
|
}
|
|
716
711
|
/**
|
|
717
|
-
* Appends new companies to an existing dataset by uploading a CSV file.
|
|
718
|
-
* Uses the same CSV format as the dataset creation endpoint.
|
|
712
|
+
* Appends new companies to an existing dataset by uploading a CSV file. Uses the same CSV format as the dataset creation endpoint.
|
|
719
713
|
*
|
|
720
|
-
* The response omits `dataset_name` compared to the create-from-CSV
|
|
721
|
-
* endpoint since the dataset already exists.
|
|
714
|
+
* The response omits `dataset_name` compared to the create-from-CSV endpoint since the dataset already exists.
|
|
722
715
|
*
|
|
723
716
|
* @param {CatchAllApi.UploadCsvToDatasetRequest} request
|
|
724
717
|
* @param {DatasetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import type * as CatchAllApi from "../../../../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* @example
|
|
4
|
+
* {
|
|
5
|
+
* dataset_id: "ccabb755-afc2-4047-b84c-78d1f23d49b2",
|
|
6
|
+
* page: 1,
|
|
7
|
+
* page_size: 100,
|
|
8
|
+
* search: "OpenAI",
|
|
9
|
+
* status: "ready",
|
|
10
|
+
* entity_type: "company",
|
|
11
|
+
* sort_by: "created_at",
|
|
12
|
+
* sort_order: "desc"
|
|
13
|
+
* }
|
|
14
|
+
*/
|
|
15
|
+
export interface ListDatasetEntitiesRequest {
|
|
16
|
+
/** Unique dataset identifier. */
|
|
17
|
+
dataset_id: string;
|
|
18
|
+
/** The page number to retrieve. */
|
|
19
|
+
page?: number;
|
|
20
|
+
/** The number of entities per page. */
|
|
21
|
+
page_size?: number;
|
|
22
|
+
/** Filters entities by name using a case-insensitive substring match. */
|
|
23
|
+
search?: string;
|
|
24
|
+
status?: CatchAllApi.EntityStatus;
|
|
25
|
+
entity_type?: CatchAllApi.EntityType;
|
|
26
|
+
sort_by?: CatchAllApi.EntitySortBy;
|
|
27
|
+
sort_order?: CatchAllApi.SortOrder;
|
|
28
|
+
}
|
|
@@ -2,7 +2,8 @@ import type * as CatchAllApi from "../../../../index.js";
|
|
|
2
2
|
/**
|
|
3
3
|
* @example
|
|
4
4
|
* {
|
|
5
|
-
* search: "Portfolio"
|
|
5
|
+
* search: "Portfolio",
|
|
6
|
+
* project_id: "60a85db4-78ec-4b78-876a-bc7d9cdadd04"
|
|
6
7
|
* }
|
|
7
8
|
*/
|
|
8
9
|
export interface ListDatasetsRequest {
|
|
@@ -16,6 +17,7 @@ export interface ListDatasetsRequest {
|
|
|
16
17
|
latest_status?: CatchAllApi.DatasetStatus;
|
|
17
18
|
sort_by?: CatchAllApi.DatasetSortBy;
|
|
18
19
|
sort_order?: CatchAllApi.SortOrder;
|
|
19
|
-
/** Filter results by ownership. Defaults to `all`. */
|
|
20
20
|
ownership?: CatchAllApi.OwnershipFilter;
|
|
21
|
+
/** Filter results to resources belonging to this project. */
|
|
22
|
+
project_id?: string;
|
|
21
23
|
}
|
|
@@ -4,8 +4,8 @@ export type { CreateDatasetRequest } from "./CreateDatasetRequest.js";
|
|
|
4
4
|
export type { DeleteDatasetRequest } from "./DeleteDatasetRequest.js";
|
|
5
5
|
export type { GetDatasetRequest } from "./GetDatasetRequest.js";
|
|
6
6
|
export type { GetDatasetStatusHistoryRequest } from "./GetDatasetStatusHistoryRequest.js";
|
|
7
|
+
export type { ListDatasetEntitiesRequest } from "./ListDatasetEntitiesRequest.js";
|
|
7
8
|
export type { ListDatasetsRequest } from "./ListDatasetsRequest.js";
|
|
8
|
-
export type { ListEntitiesInDatasetRequest } from "./ListEntitiesInDatasetRequest.js";
|
|
9
9
|
export type { RemoveEntitiesFromDatasetRequest } from "./RemoveEntitiesFromDatasetRequest.js";
|
|
10
10
|
export type { UpdateDatasetRequest } from "./UpdateDatasetRequest.js";
|
|
11
11
|
export type { UploadCsvToDatasetRequest } from "./UploadCsvToDatasetRequest.js";
|
|
@@ -18,9 +18,7 @@ export declare class EntitiesClient {
|
|
|
18
18
|
protected readonly _options: NormalizedClientOptionsWithAuth<EntitiesClient.Options>;
|
|
19
19
|
constructor(options?: EntitiesClient.Options);
|
|
20
20
|
/**
|
|
21
|
-
* Returns a paginated list of entities belonging to the authenticated
|
|
22
|
-
* organization. Supports filtering by status and entity type, and
|
|
23
|
-
* sorting by name, status, or creation date.
|
|
21
|
+
* Returns a paginated list of entities belonging to the authenticated organization. Supports filtering by status and entity type, and sorting by name, status, or creation date.
|
|
24
22
|
*
|
|
25
23
|
* @param {CatchAllApi.ListEntitiesRequest} request
|
|
26
24
|
* @param {EntitiesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -65,11 +63,9 @@ export declare class EntitiesClient {
|
|
|
65
63
|
createEntity(request: CatchAllApi.CreateEntityRequest, requestOptions?: EntitiesClient.RequestOptions): core.HttpResponsePromise<CatchAllApi.CreateEntityResponse>;
|
|
66
64
|
private __createEntity;
|
|
67
65
|
/**
|
|
68
|
-
* Creates multiple entities in a single request. Each entity is
|
|
69
|
-
* processed independently — a failure in one does not affect others.
|
|
66
|
+
* Creates multiple entities in a single request. Each entity is processed independently — a failure in one does not affect others.
|
|
70
67
|
*
|
|
71
|
-
* Returns an array of `{id, status}` objects in the same order as
|
|
72
|
-
* the input array.
|
|
68
|
+
* Returns an array of `{id, status}` objects in the same order as the input array.
|
|
73
69
|
*
|
|
74
70
|
* @param {CatchAllApi.CreateEntitiesBatchRequest} request
|
|
75
71
|
* @param {EntitiesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -74,9 +74,7 @@ class EntitiesClient {
|
|
|
74
74
|
this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
|
|
75
75
|
}
|
|
76
76
|
/**
|
|
77
|
-
* Returns a paginated list of entities belonging to the authenticated
|
|
78
|
-
* organization. Supports filtering by status and entity type, and
|
|
79
|
-
* sorting by name, status, or creation date.
|
|
77
|
+
* Returns a paginated list of entities belonging to the authenticated organization. Supports filtering by status and entity type, and sorting by name, status, or creation date.
|
|
80
78
|
*
|
|
81
79
|
* @param {CatchAllApi.ListEntitiesRequest} request
|
|
82
80
|
* @param {EntitiesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -210,11 +208,9 @@ class EntitiesClient {
|
|
|
210
208
|
});
|
|
211
209
|
}
|
|
212
210
|
/**
|
|
213
|
-
* Creates multiple entities in a single request. Each entity is
|
|
214
|
-
* processed independently — a failure in one does not affect others.
|
|
211
|
+
* Creates multiple entities in a single request. Each entity is processed independently — a failure in one does not affect others.
|
|
215
212
|
*
|
|
216
|
-
* Returns an array of `{id, status}` objects in the same order as
|
|
217
|
-
* the input array.
|
|
213
|
+
* Returns an array of `{id, status}` objects in the same order as the input array.
|
|
218
214
|
*
|
|
219
215
|
* @param {CatchAllApi.CreateEntitiesBatchRequest} request
|
|
220
216
|
* @param {EntitiesClient.RequestOptions} requestOptions - Request-specific configuration.
|