import { APIResource } from "../../../core/resource.mjs"; import { APIPromise } from "../../../core/api-promise.mjs"; import { RequestOptions } from "../../../internal/request-options.mjs"; export declare class BaseRelationships extends APIResource { static readonly _key: readonly ['cloudforceOne', 'threatEvents', 'relationships']; /** * The `event_id` must be defined (to list existing events (and their IDs), use the * [`Filter and List Events`](https://developers.cloudflare.com/api/resources/cloudforce_one/subresources/threat_events/methods/list/) * endpoint). Also, must provide query parameters. * * @example * ```ts * const relationships = * await client.cloudforceOne.threatEvents.relationships.list( * 'event_id', * { account_id: 'account_id', datasetId: 'datasetId' }, * ); * ``` */ list(eventID: string, params: RelationshipListParams, options?: RequestOptions): APIPromise; } export declare class Relationships extends BaseRelationships { } export type RelationshipListResponse = Array; export declare namespace RelationshipListResponse { interface RelationshipListResponseItem { attacker: string; attackerCountry: string; attackerCountryAlpha3: string; category: string; datasetId: string; date: string; event: string; hasChildren: boolean; indicator: string; indicatorType: string; indicatorTypeId: number; killChain: number; mitreAttack: Array; mitreCapec: Array; numReferenced: number; numReferences: number; rawId: string; referenced: Array; referencedIds: Array; references: Array; referencesIds: Array; tags: Array; targetCountry: string; targetCountryAlpha3: string; targetIndustry: string; tlp: string; uuid: string; insight?: string; releasabilityId?: string; } } export interface RelationshipListParams { /** * Path param: Account ID. */ account_id: string; /** * Query param: The dataset ID to search within. */ datasetId: string; /** * Query param: The direction to traverse the graph. Defaults to 'both' to search * all. */ direction?: 'ancestors' | 'descendants' | 'both'; /** * Query param: Whether to include the starting event in the results. Defaults to * true. */ includeParent?: boolean; /** * Query param: An optional array of indicator type IDs to filter the results by. */ indicatorTypeIds?: Array; /** * Query param: The maximum depth to traverse. Defaults to 5. */ maxDepth?: number; /** * Query param */ page?: number; /** * Query param */ pageSize?: number; /** * Query param: An optional array of relationship types to filter by. */ relationshipTypes?: string | Array; } export declare namespace Relationships { export { type RelationshipListResponse as RelationshipListResponse, type RelationshipListParams as RelationshipListParams, }; } //# sourceMappingURL=relationships.d.mts.map