import {z} from 'zod' export type InboxRuleAction = {description?: string | undefined}; export type SecurityFindingType = 'api_security' | 'attack_path' | 'host_and_container_vulnerability' | 'iac_misconfiguration' | 'identity_risk' | 'library_vulnerability' | 'misconfiguration' | 'runtime_code_vulnerability' | 'secret' | 'static_code_vulnerability' | 'workload_activity'; export type SecurityFindingTypes = Array; export type AutomationRuleScope = {finding_types: SecurityFindingTypes, query?: string | undefined}; export type InboxRuleAttributesCreate = {action: InboxRuleAction, enabled?: boolean | undefined, name: string, rule: AutomationRuleScope}; export type InboxRuleType = 'inbox_rules'; export type InboxRuleDataUpdate = {attributes: InboxRuleAttributesCreate, id: string, type: InboxRuleType}; export type InboxRuleUpdateRequest = {data: InboxRuleDataUpdate}; export type UpdateApiApiV2SecurityFindingsAutomationInboxRulesRuleIdArgs = {rule_id: string, body: InboxRuleUpdateRequest}; export type UpdateApiApiV2SecurityFindingsAutomationInboxRulesRuleIdOptions = {baseUrl?: string | undefined, apiKeyAuth?: string | undefined, appKeyAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const inboxRuleAction = z.object({description: z.string().max(20000).optional()}); export const automationRuleActorType = z.enum(["user", "system"]); export const automationRuleCreatedBy = z.object({id: z.string(), name: z.string(), type: automationRuleActorType}); export const automationRuleModifiedBy = z.object({id: z.string(), name: z.string(), type: automationRuleActorType}); export const securityFindingType = z.enum(["api_security", "attack_path", "host_and_container_vulnerability", "iac_misconfiguration", "identity_risk", "library_vulnerability", "misconfiguration", "runtime_code_vulnerability", "secret", "static_code_vulnerability", "workload_activity"]); export const securityFindingTypes = z.array(securityFindingType); export const automationRuleScope = z.object({finding_types: securityFindingTypes, query: z.string().max(30000).optional()}); export const inboxRuleAttributesResponse = z.object({action: inboxRuleAction, created_at: z.number().int(), created_by: automationRuleCreatedBy, enabled: z.boolean(), modified_at: z.number().int(), modified_by: automationRuleModifiedBy, name: z.string().min(1).max(255), rule: automationRuleScope}); export const inboxRuleType = z.literal("inbox_rules"); export const inboxRuleDataResponse = z.object({attributes: inboxRuleAttributesResponse, id: z.string(), type: inboxRuleType}); export const inboxRuleResponse = z.object({data: inboxRuleDataResponse}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * Update an inbox rule * * PUT /api/v2/security/findings/automation/inbox_rules/{rule_id} * * Also accepts auth: AuthZ */ export const updateApiApiV2SecurityFindingsAutomationInboxRulesRuleId = async (args: UpdateApiApiV2SecurityFindingsAutomationInboxRulesRuleIdArgs, options?: UpdateApiApiV2SecurityFindingsAutomationInboxRulesRuleIdOptions) => { const {baseUrl = "https://api.datadoghq.com", fetch: fetchFn = fetch, apiKeyAuth, appKeyAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('content-type', "application/json") headers.set('accept', "application/json") if (apiKeyAuth !== undefined) headers.set("DD-API-KEY", apiKeyAuth) if (appKeyAuth !== undefined) headers.set("DD-APPLICATION-KEY", appKeyAuth) const url = `${baseUrl.replace(/\/+$/, '')}/api/v2/security/findings/automation/inbox_rules/${encodeURIComponent(String(args.rule_id))}${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "PUT", headers, body: JSON.stringify(args.body)}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(inboxRuleResponse, await res.json()) };