@chainpatrol/sdk 1.8.0 → 1.10.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/CHANGELOG.md +14 -0
- package/dist/api/index.d.mts +50 -3
- package/dist/api/index.d.ts +50 -3
- package/dist/api/index.js +26 -0
- package/dist/api/index.js.map +1 -1
- package/dist/api/index.mjs +26 -0
- package/dist/api/index.mjs.map +1 -1
- package/dist/{chunk-ZTE6QNOQ.mjs → chunk-ENBUZJ7E.mjs} +17 -11
- package/dist/chunk-ENBUZJ7E.mjs.map +1 -0
- package/dist/index.js +898 -117
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +898 -117
- package/dist/index.mjs.map +1 -1
- package/dist/skill/cli.js +15 -9
- package/dist/skill/cli.js.map +1 -1
- package/dist/skill/cli.mjs +1 -1
- package/dist/skill/index.js +15 -9
- package/dist/skill/index.js.map +1 -1
- package/dist/skill/index.mjs +1 -1
- package/package.json +1 -1
- package/dist/chunk-ZTE6QNOQ.mjs.map +0 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,19 @@
|
|
|
1
1
|
# @chainpatrol/sdk
|
|
2
2
|
|
|
3
|
+
## 1.10.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- 38025fe: Add `getMetricsTakedownTimeByProvider` for median time-to-takedown per takedown provider
|
|
8
|
+
- f65141b: Allow listing inactive organizations: `orgs list --subscription-status INACTIVE` (and the `subscriptionStatus` filter on `/user/orgs` and `/organization/metrics`) now accepts `INACTIVE`. Unfiltered calls are unchanged and still return only the live statuses.
|
|
9
|
+
- d6124a4: Add `getMetricsTakedownSuccessRate` for takedown success rate per asset type
|
|
10
|
+
|
|
11
|
+
## 1.9.0
|
|
12
|
+
|
|
13
|
+
### Minor Changes
|
|
14
|
+
|
|
15
|
+
- 9347b6a: Add `takedownsInProgress` and `takedownsCancelled` to the `/organization/metrics` endpoint, available as `--include` values and as fields on the metrics payload.
|
|
16
|
+
|
|
3
17
|
## 1.8.0
|
|
4
18
|
|
|
5
19
|
### Minor Changes
|
package/dist/api/index.d.mts
CHANGED
|
@@ -66,6 +66,8 @@ interface ApiClient {
|
|
|
66
66
|
getMetricsFound: (input: MetricsFoundInput) => Promise<MetricsFoundResult>;
|
|
67
67
|
getMetricsBreakdown: (input: MetricsBreakdownInput) => Promise<MetricsBreakdownResult>;
|
|
68
68
|
getMetricsTakedownTime: (input: MetricsTakedownTimeInput) => Promise<MetricsTakedownTimeResult>;
|
|
69
|
+
getMetricsTakedownTimeByProvider: (input: MetricsTakedownTimeByProviderInput) => Promise<MetricsTakedownTimeByProviderResult>;
|
|
70
|
+
getMetricsTakedownSuccessRate: (input: MetricsTakedownSuccessRateInput) => Promise<MetricsTakedownSuccessRateResult>;
|
|
69
71
|
getMetricsTakedownTimeTrend: (input: MetricsTakedownTimeTrendInput) => Promise<MetricsTakedownTimeTrendResult>;
|
|
70
72
|
createReport: (input: ReportCreateInput) => Promise<ReportCreateResult>;
|
|
71
73
|
listOrganizationReports: (input: OrganizationReportsListInput) => Promise<OrganizationReportsListResult>;
|
|
@@ -441,6 +443,47 @@ interface MetricsTakedownTimeResult {
|
|
|
441
443
|
count: number;
|
|
442
444
|
}>;
|
|
443
445
|
}
|
|
446
|
+
type TakedownProviderRole = "HOSTING_PROVIDER" | "DOMAIN_REGISTRAR" | "TLD_REGISTRAR";
|
|
447
|
+
interface MetricsTakedownTimeByProviderInput {
|
|
448
|
+
slug: string;
|
|
449
|
+
startDate?: string;
|
|
450
|
+
endDate?: string;
|
|
451
|
+
roles?: TakedownProviderRole[];
|
|
452
|
+
blockLabel?: string;
|
|
453
|
+
brandType?: "INDIVIDUAL" | "ORGANIZATION" | "PRODUCT";
|
|
454
|
+
countryCodes?: string[];
|
|
455
|
+
brandIds?: number[];
|
|
456
|
+
}
|
|
457
|
+
interface MetricsTakedownTimeByProviderResult {
|
|
458
|
+
byProvider: Array<{
|
|
459
|
+
providerId: number;
|
|
460
|
+
providerName: string;
|
|
461
|
+
role: TakedownProviderRole;
|
|
462
|
+
medianTakedownMinutes: number;
|
|
463
|
+
medianTakedownHours: number;
|
|
464
|
+
medianTakedownDays: number;
|
|
465
|
+
count: number;
|
|
466
|
+
}>;
|
|
467
|
+
}
|
|
468
|
+
interface MetricsTakedownSuccessRateInput {
|
|
469
|
+
slug: string;
|
|
470
|
+
startDate?: string;
|
|
471
|
+
endDate?: string;
|
|
472
|
+
blockLabel?: string;
|
|
473
|
+
brandType?: "INDIVIDUAL" | "ORGANIZATION" | "PRODUCT";
|
|
474
|
+
countryCodes?: string[];
|
|
475
|
+
brandIds?: number[];
|
|
476
|
+
}
|
|
477
|
+
interface MetricsTakedownSuccessRateResult {
|
|
478
|
+
byAssetType: Array<{
|
|
479
|
+
assetType: string;
|
|
480
|
+
submitted: number;
|
|
481
|
+
completed: number;
|
|
482
|
+
stillOpen: number;
|
|
483
|
+
successRate: number;
|
|
484
|
+
resolvedSuccessRate: number | null;
|
|
485
|
+
}>;
|
|
486
|
+
}
|
|
444
487
|
interface MetricsTakedownTimeTrendInput {
|
|
445
488
|
slug: string;
|
|
446
489
|
months?: number;
|
|
@@ -1042,7 +1085,7 @@ interface TakedownsListResult {
|
|
|
1042
1085
|
takedowns: TakedownItem[];
|
|
1043
1086
|
next_page: string | null;
|
|
1044
1087
|
}
|
|
1045
|
-
declare const ORGANIZATION_METRICS_INCLUDE_FIELDS: readonly ["reports", "newThreats", "threatsWatchlisted", "takedownsFiled", "takedownsCompleted", "domainThreats", "twitterThreats", "telegramThreats", "otherThreats", "blockedByType", "blockedByDay"];
|
|
1088
|
+
declare const ORGANIZATION_METRICS_INCLUDE_FIELDS: readonly ["reports", "newThreats", "threatsWatchlisted", "takedownsFiled", "takedownsInProgress", "takedownsCompleted", "takedownsCancelled", "domainThreats", "twitterThreats", "telegramThreats", "otherThreats", "blockedByType", "blockedByDay"];
|
|
1046
1089
|
type OrganizationMetricsIncludeField = (typeof ORGANIZATION_METRICS_INCLUDE_FIELDS)[number];
|
|
1047
1090
|
interface OrganizationMetricsServicesFilter {
|
|
1048
1091
|
reporting?: {
|
|
@@ -1081,7 +1124,9 @@ interface OrganizationMetricsResultMetrics {
|
|
|
1081
1124
|
newThreats: number | null;
|
|
1082
1125
|
threatsWatchlisted: number | null;
|
|
1083
1126
|
takedownsFiled: number | null;
|
|
1127
|
+
takedownsInProgress: number | null;
|
|
1084
1128
|
takedownsCompleted: number | null;
|
|
1129
|
+
takedownsCancelled: number | null;
|
|
1085
1130
|
domainThreats: number | null;
|
|
1086
1131
|
twitterThreats: number | null;
|
|
1087
1132
|
telegramThreats: number | null;
|
|
@@ -1156,7 +1201,7 @@ interface HealthcheckRegistryEntry {
|
|
|
1156
1201
|
interface HealthchecksListResult {
|
|
1157
1202
|
checks: HealthcheckRegistryEntry[];
|
|
1158
1203
|
}
|
|
1159
|
-
type UserOrgsSubscriptionStatus = "PROSPECT" | "POC" | "ACTIVE" | "INTEGRATION";
|
|
1204
|
+
type UserOrgsSubscriptionStatus = "PROSPECT" | "POC" | "ACTIVE" | "INTEGRATION" | "INACTIVE";
|
|
1160
1205
|
type PendingApprovalService = "protection" | "takedowns";
|
|
1161
1206
|
interface PendingServiceApproval {
|
|
1162
1207
|
service: PendingApprovalService;
|
|
@@ -1373,6 +1418,8 @@ declare class ChainPatrolApiClient implements ApiClient {
|
|
|
1373
1418
|
getMetricsFound(input: MetricsFoundInput): Promise<MetricsFoundResult>;
|
|
1374
1419
|
getMetricsBreakdown(input: MetricsBreakdownInput): Promise<MetricsBreakdownResult>;
|
|
1375
1420
|
getMetricsTakedownTime(input: MetricsTakedownTimeInput): Promise<MetricsTakedownTimeResult>;
|
|
1421
|
+
getMetricsTakedownTimeByProvider(input: MetricsTakedownTimeByProviderInput): Promise<MetricsTakedownTimeByProviderResult>;
|
|
1422
|
+
getMetricsTakedownSuccessRate(input: MetricsTakedownSuccessRateInput): Promise<MetricsTakedownSuccessRateResult>;
|
|
1376
1423
|
getMetricsTakedownTimeTrend(input: MetricsTakedownTimeTrendInput): Promise<MetricsTakedownTimeTrendResult>;
|
|
1377
1424
|
createReport(input: ReportCreateInput): Promise<ReportCreateResult>;
|
|
1378
1425
|
listOrganizationReports(input: OrganizationReportsListInput): Promise<OrganizationReportsListResult>;
|
|
@@ -1404,4 +1451,4 @@ declare function parseIsoDateString(value: string | undefined): string | undefin
|
|
|
1404
1451
|
*/
|
|
1405
1452
|
declare function parseIsoDateEndOfDay(value: string | undefined): Date | undefined;
|
|
1406
1453
|
|
|
1407
|
-
export { ACTOR_KINDS, type ActorKind, type ApiClient, type ApiCredential, type AssetCheckInput, type AssetCheckResult, type AssetCheckSourceEntry, type AssetCheckStatus, type AssetGroupItem, type AssetListInput, type AssetListItem, type AssetListResult, type AssetSearchInput, type AssetSearchResult, type AssetSearchResultItem, type BrandItem, type BrandLegalDocument, type BrandLegalDocuments, type BrandTrademarkRegistrationItem, type BrandType, ChainPatrolApiClient, type ChainPatrolApiClientOptions, type ConfigEntry, type CredentialProvider, type CustomerReviewDecision, DETECTION_CONFIDENCE_LEVELS, DETECTION_REPORTED_FILTERS, type DetectionBrand, type DetectionConfidence, type DetectionConfigRunInput, type DetectionConfigRunResult, type DetectionConfigUpdateInput, type DetectionConfigUpdateResult, type DetectionConfigValidateInput, type DetectionConfigValidateResult, type DetectionDriftInput, type DetectionDriftResult, type DetectionListInput, type DetectionListItem, type DetectionListResult, type DetectionReportStatus, type DetectionReportedFilter, type DetectionSource, type HealthcheckCategory, type HealthcheckFinding, type HealthcheckRegistryEntry, type HealthcheckResult, type HealthcheckSeverity, type HealthchecksListResult, LIVENESS_FILTER_VALUES, LIVENESS_STATUSES, type LivenessFilterValue, type LivenessStatus, type MetricsBreakdownInput, type MetricsBreakdownResult, type MetricsFoundInput, type MetricsFoundResult, type MetricsSummaryInput, type MetricsSummaryResult, type MetricsTakedownTimeInput, type MetricsTakedownTimeResult, type MetricsTakedownTimeTrendInput, type MetricsTakedownTimeTrendPoint, type MetricsTakedownTimeTrendResult, ORGANIZATION_METRICS_INCLUDE_FIELDS, type OperationsQueuesSnapshotInput, type OperationsQueuesSnapshotResult, type OrganizationAssetGroupsListResult, type OrganizationAssetItem, type OrganizationAssetsListInput, type OrganizationAssetsListResult, type OrganizationBrandsListResult, type OrganizationMetricsIncludeField, type OrganizationMetricsInput, type OrganizationMetricsResult, type OrganizationMetricsResultMetrics, type OrganizationMetricsServicesFilter, type OrganizationMetricsVisibility, type OrganizationPortalVisibility, type OrganizationProposalsReviewInput, type OrganizationProposalsReviewResult, type OrganizationReportAssetScan, type OrganizationReportAssetScanEnrichment, type OrganizationReportAttachment, type OrganizationReportVisibility, type OrganizationReportsListInput, type OrganizationReportsListResult, PROPOSAL_REJECT_REASONS, PROPOSAL_WATCHLIST_REASONS, type PendingApprovalService, type PendingServiceApproval, type ProposalRejectReason, type ProposalWatchlistReason, REPORT_REVIEW_DECISIONS, REPORT_STATUSES, type ReportAssetInput, type ReportCreateInput, type ReportCreateResult, type ReportReviewDecision, type ReportStatus, type ReportsSearchInput, type ReportsSearchResult, type ReportsSearchResultItem, TAKEDOWN_SORT_KEYS, TAKEDOWN_STATUSES, type TakedownItem, type TakedownProviderRef, type TakedownSortKey, type TakedownStatus, type TakedownsListInput, type TakedownsListResult, type ThreatItem, type ThreatsListInput, type ThreatsListResult, type UserMeResult, type UserOrg, type UserOrgBrandMetadata, type UserOrgGetInput, type UserOrgGetResult, type UserOrgIntegrations, type UserOrgLegalDocument, type UserOrgLegalDocuments, type UserOrgPortalCustomization, type UserOrgTrademarkRegistration, type UserOrgsInput, type UserOrgsObligatoryAdminApprovalFilter, type UserOrgsPendingServiceApprovalFilter, type UserOrgsResult, type UserOrgsServiceFilters, type UserOrgsSubscriptionStatus, type ValidateApiKeyResult, WATCHLIST_FILTER_VALUES, type WatchlistFilterValue, parseIsoDate, parseIsoDateEndOfDay, parseIsoDateString, staticApiKey, staticBearerToken };
|
|
1454
|
+
export { ACTOR_KINDS, type ActorKind, type ApiClient, type ApiCredential, type AssetCheckInput, type AssetCheckResult, type AssetCheckSourceEntry, type AssetCheckStatus, type AssetGroupItem, type AssetListInput, type AssetListItem, type AssetListResult, type AssetSearchInput, type AssetSearchResult, type AssetSearchResultItem, type BrandItem, type BrandLegalDocument, type BrandLegalDocuments, type BrandTrademarkRegistrationItem, type BrandType, ChainPatrolApiClient, type ChainPatrolApiClientOptions, type ConfigEntry, type CredentialProvider, type CustomerReviewDecision, DETECTION_CONFIDENCE_LEVELS, DETECTION_REPORTED_FILTERS, type DetectionBrand, type DetectionConfidence, type DetectionConfigRunInput, type DetectionConfigRunResult, type DetectionConfigUpdateInput, type DetectionConfigUpdateResult, type DetectionConfigValidateInput, type DetectionConfigValidateResult, type DetectionDriftInput, type DetectionDriftResult, type DetectionListInput, type DetectionListItem, type DetectionListResult, type DetectionReportStatus, type DetectionReportedFilter, type DetectionSource, type HealthcheckCategory, type HealthcheckFinding, type HealthcheckRegistryEntry, type HealthcheckResult, type HealthcheckSeverity, type HealthchecksListResult, LIVENESS_FILTER_VALUES, LIVENESS_STATUSES, type LivenessFilterValue, type LivenessStatus, type MetricsBreakdownInput, type MetricsBreakdownResult, type MetricsFoundInput, type MetricsFoundResult, type MetricsSummaryInput, type MetricsSummaryResult, type MetricsTakedownSuccessRateInput, type MetricsTakedownSuccessRateResult, type MetricsTakedownTimeByProviderInput, type MetricsTakedownTimeByProviderResult, type MetricsTakedownTimeInput, type MetricsTakedownTimeResult, type MetricsTakedownTimeTrendInput, type MetricsTakedownTimeTrendPoint, type MetricsTakedownTimeTrendResult, ORGANIZATION_METRICS_INCLUDE_FIELDS, type OperationsQueuesSnapshotInput, type OperationsQueuesSnapshotResult, type OrganizationAssetGroupsListResult, type OrganizationAssetItem, type OrganizationAssetsListInput, type OrganizationAssetsListResult, type OrganizationBrandsListResult, type OrganizationMetricsIncludeField, type OrganizationMetricsInput, type OrganizationMetricsResult, type OrganizationMetricsResultMetrics, type OrganizationMetricsServicesFilter, type OrganizationMetricsVisibility, type OrganizationPortalVisibility, type OrganizationProposalsReviewInput, type OrganizationProposalsReviewResult, type OrganizationReportAssetScan, type OrganizationReportAssetScanEnrichment, type OrganizationReportAttachment, type OrganizationReportVisibility, type OrganizationReportsListInput, type OrganizationReportsListResult, PROPOSAL_REJECT_REASONS, PROPOSAL_WATCHLIST_REASONS, type PendingApprovalService, type PendingServiceApproval, type ProposalRejectReason, type ProposalWatchlistReason, REPORT_REVIEW_DECISIONS, REPORT_STATUSES, type ReportAssetInput, type ReportCreateInput, type ReportCreateResult, type ReportReviewDecision, type ReportStatus, type ReportsSearchInput, type ReportsSearchResult, type ReportsSearchResultItem, TAKEDOWN_SORT_KEYS, TAKEDOWN_STATUSES, type TakedownItem, type TakedownProviderRef, type TakedownProviderRole, type TakedownSortKey, type TakedownStatus, type TakedownsListInput, type TakedownsListResult, type ThreatItem, type ThreatsListInput, type ThreatsListResult, type UserMeResult, type UserOrg, type UserOrgBrandMetadata, type UserOrgGetInput, type UserOrgGetResult, type UserOrgIntegrations, type UserOrgLegalDocument, type UserOrgLegalDocuments, type UserOrgPortalCustomization, type UserOrgTrademarkRegistration, type UserOrgsInput, type UserOrgsObligatoryAdminApprovalFilter, type UserOrgsPendingServiceApprovalFilter, type UserOrgsResult, type UserOrgsServiceFilters, type UserOrgsSubscriptionStatus, type ValidateApiKeyResult, WATCHLIST_FILTER_VALUES, type WatchlistFilterValue, parseIsoDate, parseIsoDateEndOfDay, parseIsoDateString, staticApiKey, staticBearerToken };
|
package/dist/api/index.d.ts
CHANGED
|
@@ -66,6 +66,8 @@ interface ApiClient {
|
|
|
66
66
|
getMetricsFound: (input: MetricsFoundInput) => Promise<MetricsFoundResult>;
|
|
67
67
|
getMetricsBreakdown: (input: MetricsBreakdownInput) => Promise<MetricsBreakdownResult>;
|
|
68
68
|
getMetricsTakedownTime: (input: MetricsTakedownTimeInput) => Promise<MetricsTakedownTimeResult>;
|
|
69
|
+
getMetricsTakedownTimeByProvider: (input: MetricsTakedownTimeByProviderInput) => Promise<MetricsTakedownTimeByProviderResult>;
|
|
70
|
+
getMetricsTakedownSuccessRate: (input: MetricsTakedownSuccessRateInput) => Promise<MetricsTakedownSuccessRateResult>;
|
|
69
71
|
getMetricsTakedownTimeTrend: (input: MetricsTakedownTimeTrendInput) => Promise<MetricsTakedownTimeTrendResult>;
|
|
70
72
|
createReport: (input: ReportCreateInput) => Promise<ReportCreateResult>;
|
|
71
73
|
listOrganizationReports: (input: OrganizationReportsListInput) => Promise<OrganizationReportsListResult>;
|
|
@@ -441,6 +443,47 @@ interface MetricsTakedownTimeResult {
|
|
|
441
443
|
count: number;
|
|
442
444
|
}>;
|
|
443
445
|
}
|
|
446
|
+
type TakedownProviderRole = "HOSTING_PROVIDER" | "DOMAIN_REGISTRAR" | "TLD_REGISTRAR";
|
|
447
|
+
interface MetricsTakedownTimeByProviderInput {
|
|
448
|
+
slug: string;
|
|
449
|
+
startDate?: string;
|
|
450
|
+
endDate?: string;
|
|
451
|
+
roles?: TakedownProviderRole[];
|
|
452
|
+
blockLabel?: string;
|
|
453
|
+
brandType?: "INDIVIDUAL" | "ORGANIZATION" | "PRODUCT";
|
|
454
|
+
countryCodes?: string[];
|
|
455
|
+
brandIds?: number[];
|
|
456
|
+
}
|
|
457
|
+
interface MetricsTakedownTimeByProviderResult {
|
|
458
|
+
byProvider: Array<{
|
|
459
|
+
providerId: number;
|
|
460
|
+
providerName: string;
|
|
461
|
+
role: TakedownProviderRole;
|
|
462
|
+
medianTakedownMinutes: number;
|
|
463
|
+
medianTakedownHours: number;
|
|
464
|
+
medianTakedownDays: number;
|
|
465
|
+
count: number;
|
|
466
|
+
}>;
|
|
467
|
+
}
|
|
468
|
+
interface MetricsTakedownSuccessRateInput {
|
|
469
|
+
slug: string;
|
|
470
|
+
startDate?: string;
|
|
471
|
+
endDate?: string;
|
|
472
|
+
blockLabel?: string;
|
|
473
|
+
brandType?: "INDIVIDUAL" | "ORGANIZATION" | "PRODUCT";
|
|
474
|
+
countryCodes?: string[];
|
|
475
|
+
brandIds?: number[];
|
|
476
|
+
}
|
|
477
|
+
interface MetricsTakedownSuccessRateResult {
|
|
478
|
+
byAssetType: Array<{
|
|
479
|
+
assetType: string;
|
|
480
|
+
submitted: number;
|
|
481
|
+
completed: number;
|
|
482
|
+
stillOpen: number;
|
|
483
|
+
successRate: number;
|
|
484
|
+
resolvedSuccessRate: number | null;
|
|
485
|
+
}>;
|
|
486
|
+
}
|
|
444
487
|
interface MetricsTakedownTimeTrendInput {
|
|
445
488
|
slug: string;
|
|
446
489
|
months?: number;
|
|
@@ -1042,7 +1085,7 @@ interface TakedownsListResult {
|
|
|
1042
1085
|
takedowns: TakedownItem[];
|
|
1043
1086
|
next_page: string | null;
|
|
1044
1087
|
}
|
|
1045
|
-
declare const ORGANIZATION_METRICS_INCLUDE_FIELDS: readonly ["reports", "newThreats", "threatsWatchlisted", "takedownsFiled", "takedownsCompleted", "domainThreats", "twitterThreats", "telegramThreats", "otherThreats", "blockedByType", "blockedByDay"];
|
|
1088
|
+
declare const ORGANIZATION_METRICS_INCLUDE_FIELDS: readonly ["reports", "newThreats", "threatsWatchlisted", "takedownsFiled", "takedownsInProgress", "takedownsCompleted", "takedownsCancelled", "domainThreats", "twitterThreats", "telegramThreats", "otherThreats", "blockedByType", "blockedByDay"];
|
|
1046
1089
|
type OrganizationMetricsIncludeField = (typeof ORGANIZATION_METRICS_INCLUDE_FIELDS)[number];
|
|
1047
1090
|
interface OrganizationMetricsServicesFilter {
|
|
1048
1091
|
reporting?: {
|
|
@@ -1081,7 +1124,9 @@ interface OrganizationMetricsResultMetrics {
|
|
|
1081
1124
|
newThreats: number | null;
|
|
1082
1125
|
threatsWatchlisted: number | null;
|
|
1083
1126
|
takedownsFiled: number | null;
|
|
1127
|
+
takedownsInProgress: number | null;
|
|
1084
1128
|
takedownsCompleted: number | null;
|
|
1129
|
+
takedownsCancelled: number | null;
|
|
1085
1130
|
domainThreats: number | null;
|
|
1086
1131
|
twitterThreats: number | null;
|
|
1087
1132
|
telegramThreats: number | null;
|
|
@@ -1156,7 +1201,7 @@ interface HealthcheckRegistryEntry {
|
|
|
1156
1201
|
interface HealthchecksListResult {
|
|
1157
1202
|
checks: HealthcheckRegistryEntry[];
|
|
1158
1203
|
}
|
|
1159
|
-
type UserOrgsSubscriptionStatus = "PROSPECT" | "POC" | "ACTIVE" | "INTEGRATION";
|
|
1204
|
+
type UserOrgsSubscriptionStatus = "PROSPECT" | "POC" | "ACTIVE" | "INTEGRATION" | "INACTIVE";
|
|
1160
1205
|
type PendingApprovalService = "protection" | "takedowns";
|
|
1161
1206
|
interface PendingServiceApproval {
|
|
1162
1207
|
service: PendingApprovalService;
|
|
@@ -1373,6 +1418,8 @@ declare class ChainPatrolApiClient implements ApiClient {
|
|
|
1373
1418
|
getMetricsFound(input: MetricsFoundInput): Promise<MetricsFoundResult>;
|
|
1374
1419
|
getMetricsBreakdown(input: MetricsBreakdownInput): Promise<MetricsBreakdownResult>;
|
|
1375
1420
|
getMetricsTakedownTime(input: MetricsTakedownTimeInput): Promise<MetricsTakedownTimeResult>;
|
|
1421
|
+
getMetricsTakedownTimeByProvider(input: MetricsTakedownTimeByProviderInput): Promise<MetricsTakedownTimeByProviderResult>;
|
|
1422
|
+
getMetricsTakedownSuccessRate(input: MetricsTakedownSuccessRateInput): Promise<MetricsTakedownSuccessRateResult>;
|
|
1376
1423
|
getMetricsTakedownTimeTrend(input: MetricsTakedownTimeTrendInput): Promise<MetricsTakedownTimeTrendResult>;
|
|
1377
1424
|
createReport(input: ReportCreateInput): Promise<ReportCreateResult>;
|
|
1378
1425
|
listOrganizationReports(input: OrganizationReportsListInput): Promise<OrganizationReportsListResult>;
|
|
@@ -1404,4 +1451,4 @@ declare function parseIsoDateString(value: string | undefined): string | undefin
|
|
|
1404
1451
|
*/
|
|
1405
1452
|
declare function parseIsoDateEndOfDay(value: string | undefined): Date | undefined;
|
|
1406
1453
|
|
|
1407
|
-
export { ACTOR_KINDS, type ActorKind, type ApiClient, type ApiCredential, type AssetCheckInput, type AssetCheckResult, type AssetCheckSourceEntry, type AssetCheckStatus, type AssetGroupItem, type AssetListInput, type AssetListItem, type AssetListResult, type AssetSearchInput, type AssetSearchResult, type AssetSearchResultItem, type BrandItem, type BrandLegalDocument, type BrandLegalDocuments, type BrandTrademarkRegistrationItem, type BrandType, ChainPatrolApiClient, type ChainPatrolApiClientOptions, type ConfigEntry, type CredentialProvider, type CustomerReviewDecision, DETECTION_CONFIDENCE_LEVELS, DETECTION_REPORTED_FILTERS, type DetectionBrand, type DetectionConfidence, type DetectionConfigRunInput, type DetectionConfigRunResult, type DetectionConfigUpdateInput, type DetectionConfigUpdateResult, type DetectionConfigValidateInput, type DetectionConfigValidateResult, type DetectionDriftInput, type DetectionDriftResult, type DetectionListInput, type DetectionListItem, type DetectionListResult, type DetectionReportStatus, type DetectionReportedFilter, type DetectionSource, type HealthcheckCategory, type HealthcheckFinding, type HealthcheckRegistryEntry, type HealthcheckResult, type HealthcheckSeverity, type HealthchecksListResult, LIVENESS_FILTER_VALUES, LIVENESS_STATUSES, type LivenessFilterValue, type LivenessStatus, type MetricsBreakdownInput, type MetricsBreakdownResult, type MetricsFoundInput, type MetricsFoundResult, type MetricsSummaryInput, type MetricsSummaryResult, type MetricsTakedownTimeInput, type MetricsTakedownTimeResult, type MetricsTakedownTimeTrendInput, type MetricsTakedownTimeTrendPoint, type MetricsTakedownTimeTrendResult, ORGANIZATION_METRICS_INCLUDE_FIELDS, type OperationsQueuesSnapshotInput, type OperationsQueuesSnapshotResult, type OrganizationAssetGroupsListResult, type OrganizationAssetItem, type OrganizationAssetsListInput, type OrganizationAssetsListResult, type OrganizationBrandsListResult, type OrganizationMetricsIncludeField, type OrganizationMetricsInput, type OrganizationMetricsResult, type OrganizationMetricsResultMetrics, type OrganizationMetricsServicesFilter, type OrganizationMetricsVisibility, type OrganizationPortalVisibility, type OrganizationProposalsReviewInput, type OrganizationProposalsReviewResult, type OrganizationReportAssetScan, type OrganizationReportAssetScanEnrichment, type OrganizationReportAttachment, type OrganizationReportVisibility, type OrganizationReportsListInput, type OrganizationReportsListResult, PROPOSAL_REJECT_REASONS, PROPOSAL_WATCHLIST_REASONS, type PendingApprovalService, type PendingServiceApproval, type ProposalRejectReason, type ProposalWatchlistReason, REPORT_REVIEW_DECISIONS, REPORT_STATUSES, type ReportAssetInput, type ReportCreateInput, type ReportCreateResult, type ReportReviewDecision, type ReportStatus, type ReportsSearchInput, type ReportsSearchResult, type ReportsSearchResultItem, TAKEDOWN_SORT_KEYS, TAKEDOWN_STATUSES, type TakedownItem, type TakedownProviderRef, type TakedownSortKey, type TakedownStatus, type TakedownsListInput, type TakedownsListResult, type ThreatItem, type ThreatsListInput, type ThreatsListResult, type UserMeResult, type UserOrg, type UserOrgBrandMetadata, type UserOrgGetInput, type UserOrgGetResult, type UserOrgIntegrations, type UserOrgLegalDocument, type UserOrgLegalDocuments, type UserOrgPortalCustomization, type UserOrgTrademarkRegistration, type UserOrgsInput, type UserOrgsObligatoryAdminApprovalFilter, type UserOrgsPendingServiceApprovalFilter, type UserOrgsResult, type UserOrgsServiceFilters, type UserOrgsSubscriptionStatus, type ValidateApiKeyResult, WATCHLIST_FILTER_VALUES, type WatchlistFilterValue, parseIsoDate, parseIsoDateEndOfDay, parseIsoDateString, staticApiKey, staticBearerToken };
|
|
1454
|
+
export { ACTOR_KINDS, type ActorKind, type ApiClient, type ApiCredential, type AssetCheckInput, type AssetCheckResult, type AssetCheckSourceEntry, type AssetCheckStatus, type AssetGroupItem, type AssetListInput, type AssetListItem, type AssetListResult, type AssetSearchInput, type AssetSearchResult, type AssetSearchResultItem, type BrandItem, type BrandLegalDocument, type BrandLegalDocuments, type BrandTrademarkRegistrationItem, type BrandType, ChainPatrolApiClient, type ChainPatrolApiClientOptions, type ConfigEntry, type CredentialProvider, type CustomerReviewDecision, DETECTION_CONFIDENCE_LEVELS, DETECTION_REPORTED_FILTERS, type DetectionBrand, type DetectionConfidence, type DetectionConfigRunInput, type DetectionConfigRunResult, type DetectionConfigUpdateInput, type DetectionConfigUpdateResult, type DetectionConfigValidateInput, type DetectionConfigValidateResult, type DetectionDriftInput, type DetectionDriftResult, type DetectionListInput, type DetectionListItem, type DetectionListResult, type DetectionReportStatus, type DetectionReportedFilter, type DetectionSource, type HealthcheckCategory, type HealthcheckFinding, type HealthcheckRegistryEntry, type HealthcheckResult, type HealthcheckSeverity, type HealthchecksListResult, LIVENESS_FILTER_VALUES, LIVENESS_STATUSES, type LivenessFilterValue, type LivenessStatus, type MetricsBreakdownInput, type MetricsBreakdownResult, type MetricsFoundInput, type MetricsFoundResult, type MetricsSummaryInput, type MetricsSummaryResult, type MetricsTakedownSuccessRateInput, type MetricsTakedownSuccessRateResult, type MetricsTakedownTimeByProviderInput, type MetricsTakedownTimeByProviderResult, type MetricsTakedownTimeInput, type MetricsTakedownTimeResult, type MetricsTakedownTimeTrendInput, type MetricsTakedownTimeTrendPoint, type MetricsTakedownTimeTrendResult, ORGANIZATION_METRICS_INCLUDE_FIELDS, type OperationsQueuesSnapshotInput, type OperationsQueuesSnapshotResult, type OrganizationAssetGroupsListResult, type OrganizationAssetItem, type OrganizationAssetsListInput, type OrganizationAssetsListResult, type OrganizationBrandsListResult, type OrganizationMetricsIncludeField, type OrganizationMetricsInput, type OrganizationMetricsResult, type OrganizationMetricsResultMetrics, type OrganizationMetricsServicesFilter, type OrganizationMetricsVisibility, type OrganizationPortalVisibility, type OrganizationProposalsReviewInput, type OrganizationProposalsReviewResult, type OrganizationReportAssetScan, type OrganizationReportAssetScanEnrichment, type OrganizationReportAttachment, type OrganizationReportVisibility, type OrganizationReportsListInput, type OrganizationReportsListResult, PROPOSAL_REJECT_REASONS, PROPOSAL_WATCHLIST_REASONS, type PendingApprovalService, type PendingServiceApproval, type ProposalRejectReason, type ProposalWatchlistReason, REPORT_REVIEW_DECISIONS, REPORT_STATUSES, type ReportAssetInput, type ReportCreateInput, type ReportCreateResult, type ReportReviewDecision, type ReportStatus, type ReportsSearchInput, type ReportsSearchResult, type ReportsSearchResultItem, TAKEDOWN_SORT_KEYS, TAKEDOWN_STATUSES, type TakedownItem, type TakedownProviderRef, type TakedownProviderRole, type TakedownSortKey, type TakedownStatus, type TakedownsListInput, type TakedownsListResult, type ThreatItem, type ThreatsListInput, type ThreatsListResult, type UserMeResult, type UserOrg, type UserOrgBrandMetadata, type UserOrgGetInput, type UserOrgGetResult, type UserOrgIntegrations, type UserOrgLegalDocument, type UserOrgLegalDocuments, type UserOrgPortalCustomization, type UserOrgTrademarkRegistration, type UserOrgsInput, type UserOrgsObligatoryAdminApprovalFilter, type UserOrgsPendingServiceApprovalFilter, type UserOrgsResult, type UserOrgsServiceFilters, type UserOrgsSubscriptionStatus, type ValidateApiKeyResult, WATCHLIST_FILTER_VALUES, type WatchlistFilterValue, parseIsoDate, parseIsoDateEndOfDay, parseIsoDateString, staticApiKey, staticBearerToken };
|
package/dist/api/index.js
CHANGED
|
@@ -97,7 +97,9 @@ var ORGANIZATION_METRICS_INCLUDE_FIELDS = [
|
|
|
97
97
|
"newThreats",
|
|
98
98
|
"threatsWatchlisted",
|
|
99
99
|
"takedownsFiled",
|
|
100
|
+
"takedownsInProgress",
|
|
100
101
|
"takedownsCompleted",
|
|
102
|
+
"takedownsCancelled",
|
|
101
103
|
"domainThreats",
|
|
102
104
|
"twitterThreats",
|
|
103
105
|
"telegramThreats",
|
|
@@ -331,6 +333,30 @@ var ChainPatrolApiClient = class {
|
|
|
331
333
|
endDate: parseIsoDateEndOfDay(input.endDate)
|
|
332
334
|
}));
|
|
333
335
|
}
|
|
336
|
+
getMetricsTakedownTimeByProvider(input) {
|
|
337
|
+
return this.request(
|
|
338
|
+
"/metrics/takedown-time/by-provider",
|
|
339
|
+
__spreadProps(__spreadValues({}, input), {
|
|
340
|
+
startDate: parseIsoDate(input.startDate),
|
|
341
|
+
// Dates serialize as full timestamps, so a date-only `endDate` has to be
|
|
342
|
+
// widened here — the API can no longer tell it apart from an explicit
|
|
343
|
+
// midnight cut-off once it arrives.
|
|
344
|
+
endDate: parseIsoDateEndOfDay(input.endDate)
|
|
345
|
+
})
|
|
346
|
+
);
|
|
347
|
+
}
|
|
348
|
+
getMetricsTakedownSuccessRate(input) {
|
|
349
|
+
return this.request(
|
|
350
|
+
"/metrics/takedown-success-rate",
|
|
351
|
+
__spreadProps(__spreadValues({}, input), {
|
|
352
|
+
startDate: parseIsoDate(input.startDate),
|
|
353
|
+
// Dates serialize as full timestamps, so a date-only `endDate` has to be
|
|
354
|
+
// widened here — the API can no longer tell it apart from an explicit
|
|
355
|
+
// midnight cut-off once it arrives.
|
|
356
|
+
endDate: parseIsoDateEndOfDay(input.endDate)
|
|
357
|
+
})
|
|
358
|
+
);
|
|
359
|
+
}
|
|
334
360
|
getMetricsTakedownTimeTrend(input) {
|
|
335
361
|
return this.request(
|
|
336
362
|
"/metrics/takedown-time/trend",
|