@cdot65/prisma-airs-sdk 0.2.0 → 0.2.1

package/dist/index.d.cts

@@ -1,9 +1,14 @@
 import { z } from 'zod';
 
+/** Options for initializing the global scan API configuration. */
 interface InitOptions {
+    /** AIRS API key. Falls back to `PANW_AI_SEC_API_KEY` env var. */
     apiKey?: string;
+    /** Pre-obtained bearer token. Falls back to `PANW_AI_SEC_API_TOKEN` env var. */
     apiToken?: string;
+    /** AIRS API endpoint URL. Falls back to `PANW_AI_SEC_API_ENDPOINT` env var. */
     apiEndpoint?: string;
+    /** Max retry attempts (0–5). Defaults to 5. */
     numRetries?: number;
 }
 declare class Configuration {
@@ -20,9 +25,16 @@ declare class Configuration {
     init(opts?: InitOptions): void;
     reset(): void;
 }
+/** Global singleton holding scan API configuration. */
 declare const globalConfiguration: Configuration;
+/**
+ * Initialize the global scan API configuration. Must be called before using {@link Scanner}.
+ * @param opts - Configuration options. Reads env vars as fallbacks.
+ * @throws {AISecSDKException} If neither apiKey nor apiToken is provided.
+ */
 declare function init(opts?: InitOptions): void;
 
+/** Zod schema for AI security profile identifier. Requires profile_id or profile_name. */
 declare const AiProfileSchema: z.ZodEffects<z.ZodObject<{
     profile_id: z.ZodOptional<z.ZodString>;
     profile_name: z.ZodOptional<z.ZodString>;
@@ -39,8 +51,10 @@ declare const AiProfileSchema: z.ZodEffects<z.ZodObject<{
     profile_id?: string | undefined;
     profile_name?: string | undefined;
 }>;
+/** AI security profile identifier. At least one of profile_id or profile_name required. */
 type AiProfile = z.infer<typeof AiProfileSchema>;
 
+/** Zod schema for AI agent metadata. */
 declare const AgentMetaSchema: z.ZodObject<{
     agent_id: z.ZodOptional<z.ZodString>;
     agent_version: z.ZodOptional<z.ZodString>;
@@ -54,7 +68,9 @@ declare const AgentMetaSchema: z.ZodObject<{
     agent_version?: string | undefined;
     agent_arn?: string | undefined;
 }>;
+/** AI agent metadata (agent ID, version, ARN). */
 type AgentMeta = z.infer<typeof AgentMetaSchema>;
+/** Zod schema for scan request metadata. */
 declare const MetadataSchema: z.ZodObject<{
     app_name: z.ZodOptional<z.ZodString>;
     app_user: z.ZodOptional<z.ZodString>;
@@ -94,8 +110,10 @@ declare const MetadataSchema: z.ZodObject<{
         agent_arn?: string | undefined;
     } | undefined;
 }>;
+/** Application metadata attached to scan requests. */
 type Metadata = z.infer<typeof MetadataSchema>;
 
+/** Zod schema for masked data in scan results. */
 declare const MaskedDataSchema: z.ZodObject<{
     data: z.ZodOptional<z.ZodString>;
     pattern_detections: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>, "many">>;
@@ -106,7 +124,9 @@ declare const MaskedDataSchema: z.ZodObject<{
     data?: string | undefined;
     pattern_detections?: Record<string, unknown>[] | undefined;
 }>;
+/** Masked data containing redacted content and pattern detections. */
 type MaskedData = z.infer<typeof MaskedDataSchema>;
+/** Zod schema for I/O detection flags. */
 declare const IODetectedSchema: z.ZodObject<{
     url_cats: z.ZodOptional<z.ZodBoolean>;
     dlp: z.ZodOptional<z.ZodBoolean>;
@@ -126,7 +146,9 @@ declare const IODetectedSchema: z.ZodObject<{
     toxic_content: z.ZodOptional<z.ZodBoolean>;
     malicious_code: z.ZodOptional<z.ZodBoolean>;
 }, z.ZodTypeAny, "passthrough">>;
+/** Flags indicating which detection types triggered on input or output. */
 type IODetected = z.infer<typeof IODetectedSchema>;
+/** Zod schema for the scan summary (verdict + action). */
 declare const ScanSummarySchema: z.ZodObject<{
     verdict: z.ZodOptional<z.ZodString>;
     action: z.ZodOptional<z.ZodString>;
@@ -137,7 +159,9 @@ declare const ScanSummarySchema: z.ZodObject<{
     verdict: z.ZodOptional<z.ZodString>;
     action: z.ZodOptional<z.ZodString>;
 }, z.ZodTypeAny, "passthrough">>;
+/** Scan summary containing overall verdict and action. */
 type ScanSummary = z.infer<typeof ScanSummarySchema>;
+/** Zod schema for tool/agent detection results. */
 declare const ToolDetectedSchema: z.ZodObject<{
     verdict: z.ZodOptional<z.ZodString>;
     metadata: z.ZodOptional<z.ZodObject<{
@@ -257,7 +281,9 @@ declare const ToolDetectedSchema: z.ZodObject<{
         malicious_code: z.ZodOptional<z.ZodBoolean>;
     }, z.ZodTypeAny, "passthrough"> | undefined;
 }>;
+/** Detection results for tool/agent interactions. */
 type ToolDetected = z.infer<typeof ToolDetectedSchema>;
+/** Zod schema for a complete scan response from the AIRS API. */
 declare const ScanResponseSchema: z.ZodObject<{
     source: z.ZodOptional<z.ZodString>;
     report_id: z.ZodString;
@@ -621,8 +647,10 @@ declare const ScanResponseSchema: z.ZodObject<{
     created_at?: string | undefined;
     completed_at?: string | undefined;
 }>;
+/** Complete scan response with verdict, action, and detection details. */
 type ScanResponse = z.infer<typeof ScanResponseSchema>;
 
+/** Zod schema for an async scan batch item. */
 declare const AsyncScanObjectSchema: z.ZodObject<{
     req_id: z.ZodNumber;
     scan_req: z.ZodObject<{
@@ -908,7 +936,9 @@ declare const AsyncScanObjectSchema: z.ZodObject<{
         session_id?: string | undefined;
     };
 }>;
+/** Async scan batch item containing a request ID and scan request. */
 type AsyncScanObject = z.infer<typeof AsyncScanObjectSchema>;
+/** Zod schema for the async scan API response. */
 declare const AsyncScanResponseSchema: z.ZodObject<{
     received: z.ZodString;
     scan_id: z.ZodString;
@@ -925,8 +955,10 @@ declare const AsyncScanResponseSchema: z.ZodObject<{
     source?: string | undefined;
     report_id?: string | undefined;
 }>;
+/** Async scan API response with scan ID for later querying. */
 type AsyncScanResponse = z.infer<typeof AsyncScanResponseSchema>;
 
+/** Zod schema for a scan ID query result. */
 declare const ScanIdResultSchema: z.ZodObject<{
     source: z.ZodOptional<z.ZodString>;
     req_id: z.ZodOptional<z.ZodNumber>;
@@ -1452,8 +1484,10 @@ declare const ScanIdResultSchema: z.ZodObject<{
         completed_at?: string | undefined;
     } | undefined;
 }>;
+/** Result of querying a scan by its scan ID, including status and full scan response. */
 type ScanIdResult = z.infer<typeof ScanIdResultSchema>;
 
+/** Zod schema for a detailed threat scan report. */
 declare const ThreatScanReportSchema: z.ZodObject<{
     source: z.ZodOptional<z.ZodString>;
     report_id: z.ZodOptional<z.ZodString>;
@@ -1655,8 +1689,10 @@ declare const ThreatScanReportSchema: z.ZodObject<{
         } | undefined;
     }[] | undefined;
 }>;
+/** Detailed threat scan report with per-service detection results. */
 type ThreatScanReport = z.infer<typeof ThreatScanReportSchema>;
 
+/** Zod schema for tool/function call event metadata. */
 declare const ToolEventMetadataSchema: z.ZodObject<{
     ecosystem: z.ZodString;
     method: z.ZodString;
@@ -1673,7 +1709,9 @@ declare const ToolEventMetadataSchema: z.ZodObject<{
     server_name: string;
     tool_invoked?: string | undefined;
 }>;
+/** Tool/function call event metadata (ecosystem, method, server, tool). */
 type ToolEventMetadata = z.infer<typeof ToolEventMetadataSchema>;
+/** Zod schema for a tool/function call event with input and output. */
 declare const ToolEventSchema: z.ZodObject<{
     metadata: z.ZodOptional<z.ZodObject<{
         ecosystem: z.ZodString;
@@ -1712,8 +1750,10 @@ declare const ToolEventSchema: z.ZodObject<{
     input?: string | undefined;
     output?: string | undefined;
 }>;
+/** Tool/function call event with optional input and output strings. */
 type ToolEvent = z.infer<typeof ToolEventSchema>;
 
+/** Zod schema for a single content item within a scan request. */
 declare const ScanRequestContentsInnerSchema: z.ZodObject<{
     prompt: z.ZodOptional<z.ZodString>;
     response: z.ZodOptional<z.ZodString>;
@@ -1791,7 +1831,9 @@ declare const ScanRequestContentsInnerSchema: z.ZodObject<{
         output?: string | undefined;
     } | undefined;
 }>;
+/** Single content item within a scan request. */
 type ScanRequestContentsInner = z.infer<typeof ScanRequestContentsInnerSchema>;
+/** Zod schema for a complete scan request payload. */
 declare const ScanRequestSchema: z.ZodObject<{
     tr_id: z.ZodOptional<z.ZodString>;
     session_id: z.ZodOptional<z.ZodString>;
@@ -1998,16 +2040,28 @@ declare const ScanRequestSchema: z.ZodObject<{
     tr_id?: string | undefined;
     session_id?: string | undefined;
 }>;
+/** Complete scan request payload sent to the AIRS API. */
 type ScanRequest = z.infer<typeof ScanRequestSchema>;
 
+/** Options for constructing a {@link Content} instance. At least one field is required. */
 interface ContentOptions {
+    /** User prompt text. Max 2 MB. */
     prompt?: string;
+    /** AI model response text. Max 2 MB. */
     response?: string;
+    /** Conversation context. Max 100 MB. */
     context?: string;
+    /** Code prompt text. Max 2 MB. */
     codePrompt?: string;
+    /** Code response text. Max 2 MB. */
     codeResponse?: string;
+    /** Tool/function call event data. */
     toolEvent?: ToolEvent;
 }
+/**
+ * Represents content to be scanned by AIRS.
+ * Validates byte-length limits on construction and property assignment.
+ */
 declare class Content {
     private _prompt?;
     private _response?;
@@ -2028,37 +2082,115 @@ declare class Content {
     set codeResponse(value: string | undefined);
     get toolEvent(): ToolEvent | undefined;
     set toolEvent(value: ToolEvent | undefined);
+    /** Total byte length of all text content fields. */
     get length(): number;
+    /** Serialize to the API request format. */
     toJSON(): ScanRequestContentsInner;
+    /**
+     * Create a Content instance from an API response object.
+     * @param json - Scan request contents inner object.
+     */
     static fromJSON(json: ScanRequestContentsInner): Content;
+    /**
+     * Load content from a JSON file.
+     * @param filePath - Path to JSON file containing scan request contents.
+     */
     static fromJSONFile(filePath: string): Content;
 }
 
+/** Optional parameters for {@link Scanner.syncScan}. */
 interface SyncScanOptions {
+    /** Transaction ID for tracing. Max 100 characters. */
     trId?: string;
+    /** Session ID for grouping related scans. Max 100 characters. */
     sessionId?: string;
+    /** Application metadata attached to the scan request. */
     metadata?: Metadata;
 }
+/** Client for AIRS scan operations (sync, async, and query). */
 declare class Scanner {
+    /**
+     * Perform a synchronous content scan.
+     * @param aiProfile - AI security profile to scan against.
+     * @param content - Content to scan.
+     * @param opts - Optional transaction/session IDs and metadata.
+     * @returns Scan response with verdict, action, and detection details.
+     */
     syncScan(aiProfile: AiProfile, content: Content, opts?: SyncScanOptions): Promise<ScanResponse>;
+    /**
+     * Submit content for asynchronous scanning.
+     * @param scanObjects - Array of scan objects (1–5 items).
+     * @returns Response containing scan IDs for later querying.
+     */
     asyncScan(scanObjects: AsyncScanObject[]): Promise<AsyncScanResponse>;
+    /**
+     * Query scan results by scan IDs.
+     * @param scanIds - Array of scan UUIDs (1–5 items).
+     * @returns Array of scan results with status and response data.
+     */
     queryByScanIds(scanIds: string[]): Promise<ScanIdResult[]>;
+    /**
+     * Query detailed threat reports by report IDs.
+     * @param reportIds - Array of report IDs (1–5 items).
+     * @returns Array of threat scan reports with detection details.
+     */
     queryByReportIds(reportIds: string[]): Promise<ThreatScanReport[]>;
 }
 
+/** Classification of SDK errors by origin. */
 declare enum ErrorType {
+    /** 5xx response from the AIRS API. */
     SERVER_SIDE_ERROR = "AISEC_SERVER_SIDE_ERROR",
+    /** 4xx response or network failure. */
     CLIENT_SIDE_ERROR = "AISEC_CLIENT_SIDE_ERROR",
+    /** Invalid user-supplied input (bad UUID, oversized content, etc.). */
     USER_REQUEST_PAYLOAD_ERROR = "AISEC_USER_REQUEST_PAYLOAD_ERROR",
+    /** Required configuration value is missing. */
     MISSING_VARIABLE = "AISEC_MISSING_VARIABLE",
+    /** Internal SDK error. */
     AISEC_SDK_ERROR = "AISEC_SDK_ERROR",
+    /** OAuth2 token fetch failure. */
     OAUTH_ERROR = "AISEC_OAUTH_ERROR"
 }
+/**
+ * Base exception for all AIRS SDK errors.
+ * The `errorType` field classifies the error origin.
+ */
 declare class AISecSDKException extends Error {
     readonly errorType?: ErrorType;
+    /**
+     * @param message - Human-readable error description.
+     * @param errorType - Classification of the error.
+     */
     constructor(message: string, errorType?: ErrorType);
 }
 
+/** Scan result verdict classification. */
+declare const Verdict: {
+    readonly BENIGN: "benign";
+    readonly MALICIOUS: "malicious";
+    readonly UNKNOWN: "unknown";
+};
+/** Union type of all possible verdict values. */
+type Verdict = (typeof Verdict)[keyof typeof Verdict];
+/** Enforcement action taken by AIRS. */
+declare const Action: {
+    readonly ALLOW: "allow";
+    readonly BLOCK: "block";
+    readonly ALERT: "alert";
+};
+/** Union type of all possible action values. */
+type Action = (typeof Action)[keyof typeof Action];
+/** Top-level scan result category. */
+declare const Category: {
+    readonly BENIGN: "benign";
+    readonly MALICIOUS: "malicious";
+    readonly UNKNOWN: "unknown";
+};
+/** Union type of all possible category values. */
+type Category = (typeof Category)[keyof typeof Category];
+
+/** Zod schema for prompt detection detail data. */
 declare const PromptDetectionDetailsSchema: z.ZodObject<{
     topic_guardrails_details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
 }, "strip", z.ZodTypeAny, {
@@ -2066,7 +2198,9 @@ declare const PromptDetectionDetailsSchema: z.ZodObject<{
 }, {
     topic_guardrails_details?: Record<string, unknown> | undefined;
 }>;
+/** Prompt detection detail data including topic guardrails. */
 type PromptDetectionDetails = z.infer<typeof PromptDetectionDetailsSchema>;
+/** Zod schema for prompt-side detection flags. */
 declare const PromptDetectedSchema: z.ZodObject<{
     url_cats: z.ZodOptional<z.ZodBoolean>;
     dlp: z.ZodOptional<z.ZodBoolean>;
@@ -2092,8 +2226,10 @@ declare const PromptDetectedSchema: z.ZodObject<{
     agent?: boolean | undefined;
     topic_violation?: boolean | undefined;
 }>;
+/** Flags indicating which detection types triggered on the prompt. */
 type PromptDetected = z.infer<typeof PromptDetectedSchema>;
 
+/** Zod schema for response detection detail data. */
 declare const ResponseDetectionDetailsSchema: z.ZodObject<{
     topic_guardrails_details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
 }, "strip", z.ZodTypeAny, {
@@ -2101,7 +2237,9 @@ declare const ResponseDetectionDetailsSchema: z.ZodObject<{
 }, {
     topic_guardrails_details?: Record<string, unknown> | undefined;
 }>;
+/** Response detection detail data including topic guardrails. */
 type ResponseDetectionDetails = z.infer<typeof ResponseDetectionDetailsSchema>;
+/** Zod schema for response-side detection flags. */
 declare const ResponseDetectedSchema: z.ZodObject<{
     url_cats: z.ZodOptional<z.ZodBoolean>;
     dlp: z.ZodOptional<z.ZodBoolean>;
@@ -2130,8 +2268,10 @@ declare const ResponseDetectedSchema: z.ZodObject<{
     db_security?: boolean | undefined;
     ungrounded?: boolean | undefined;
 }>;
+/** Flags indicating which detection types triggered on the response. */
 type ResponseDetected = z.infer<typeof ResponseDetectedSchema>;
 
+/** Zod schema for detection service detail results (URLF and DLP reports). */
 declare const DSDetailResultSchema: z.ZodObject<{
     urlf_report: z.ZodOptional<z.ZodArray<z.ZodObject<{
         url: z.ZodOptional<z.ZodString>;
@@ -2197,7 +2337,9 @@ declare const DSDetailResultSchema: z.ZodObject<{
         data_pattern_rule2_verdict?: string | undefined;
     } | undefined;
 }>;
+/** Detection service detail results containing URLF and DLP reports. */
 type DSDetailResult = z.infer<typeof DSDetailResultSchema>;
+/** Zod schema for detection service result metadata (score and confidence). */
 declare const DSResultMetadataSchema: z.ZodObject<{
     score: z.ZodOptional<z.ZodNumber>;
     confidence: z.ZodOptional<z.ZodString>;
@@ -2208,7 +2350,9 @@ declare const DSResultMetadataSchema: z.ZodObject<{
     score: z.ZodOptional<z.ZodNumber>;
     confidence: z.ZodOptional<z.ZodString>;
 }, z.ZodTypeAny, "passthrough">>;
+/** Detection service result metadata with score and confidence. */
 type DSResultMetadata = z.infer<typeof DSResultMetadataSchema>;
+/** Zod schema for an individual detection service result. */
 declare const DetectionServiceResultSchema: z.ZodObject<{
     data_type: z.ZodOptional<z.ZodString>;
     detection_service: z.ZodOptional<z.ZodString>;
@@ -2338,8 +2482,10 @@ declare const DetectionServiceResultSchema: z.ZodObject<{
         } | undefined;
     } | undefined;
 }>;
+/** Individual detection service result with verdict, action, and details. */
 type DetectionServiceResult = z.infer<typeof DetectionServiceResultSchema>;
 
+/** Zod schema for a DLP (Data Loss Prevention) report. */
 declare const DlpReportSchema: z.ZodObject<{
     dlp_report_id: z.ZodOptional<z.ZodString>;
     dlp_profile_name: z.ZodOptional<z.ZodString>;
@@ -2362,8 +2508,10 @@ declare const DlpReportSchema: z.ZodObject<{
     data_pattern_rule1_verdict?: string | undefined;
     data_pattern_rule2_verdict?: string | undefined;
 }>;
+/** DLP report with profile info and data pattern rule verdicts. */
 type DlpReport = z.infer<typeof DlpReportSchema>;
 
+/** Zod schema for a URL filtering report entry. */
 declare const UrlfEntrySchema: z.ZodObject<{
     url: z.ZodOptional<z.ZodString>;
     risk_level: z.ZodOptional<z.ZodString>;
@@ -2377,8 +2525,10 @@ declare const UrlfEntrySchema: z.ZodObject<{
     risk_level?: string | undefined;
     categories?: string[] | undefined;
 }>;
+/** URL filtering report entry with URL, risk level, and categories. */
 type UrlfEntry = z.infer<typeof UrlfEntrySchema>;
 
+/** Zod schema for an AIRS API error response. */
 declare const ErrorResponseSchema: z.ZodObject<{
     status_code: z.ZodOptional<z.ZodNumber>;
     message: z.ZodOptional<z.ZodString>;
@@ -2420,8 +2570,10 @@ declare const ErrorResponseSchema: z.ZodObject<{
         unit?: string | undefined;
     } | undefined;
 }>;
+/** AIRS API error response with optional retry-after guidance. */
 type ErrorResponse = z.infer<typeof ErrorResponseSchema>;
 
+/** Zod schema for the security profile policy. */
 declare const PolicySchema: z.ZodObject<{
     'data-leak-detection': z.ZodOptional<z.ZodObject<{
         'data-leak-detection-status': z.ZodOptional<z.ZodString>;
@@ -2954,7 +3106,9 @@ declare const PolicySchema: z.ZodObject<{
         }, z.ZodTypeAny, "passthrough">>>;
     }, z.ZodTypeAny, "passthrough">>>;
 }, z.ZodTypeAny, "passthrough">>;
+/** Security profile policy containing all protection and configuration settings. */
 type Policy = z.infer<typeof PolicySchema>;
+/** Zod schema for an AIRS security profile. */
 declare const SecurityProfileSchema: z.ZodObject<{
     profile_id: z.ZodOptional<z.ZodString>;
     profile_name: z.ZodString;
@@ -4576,7 +4730,9 @@ declare const SecurityProfileSchema: z.ZodObject<{
     updated_by: z.ZodOptional<z.ZodString>;
     last_modified_ts: z.ZodOptional<z.ZodString>;
 }, z.ZodTypeAny, "passthrough">>;
+/** AIRS security profile with name, policy, and audit metadata. */
 type SecurityProfile = z.infer<typeof SecurityProfileSchema>;
+/** Zod schema for a security profile create/update request. */
 declare const CreateSecurityProfileRequestSchema: z.ZodObject<{
     profile_id: z.ZodOptional<z.ZodString>;
     profile_name: z.ZodString;
@@ -6198,7 +6354,9 @@ declare const CreateSecurityProfileRequestSchema: z.ZodObject<{
     updated_by: z.ZodOptional<z.ZodString>;
     last_modified_ts: z.ZodOptional<z.ZodString>;
 }, z.ZodTypeAny, "passthrough">>;
+/** Request body for creating or updating a security profile. */
 type CreateSecurityProfileRequest = z.infer<typeof CreateSecurityProfileRequestSchema>;
+/** Zod schema for a paginated security profile list response. */
 declare const SecurityProfileListResponseSchema: z.ZodObject<{
     ai_profiles: z.ZodArray<z.ZodObject<{
         profile_id: z.ZodOptional<z.ZodString>;
@@ -11069,7 +11227,9 @@ declare const SecurityProfileListResponseSchema: z.ZodObject<{
     }, z.ZodTypeAny, "passthrough">>, "many">;
     next_offset: z.ZodOptional<z.ZodNumber>;
 }, z.ZodTypeAny, "passthrough">>;
+/** Paginated list of security profiles. */
 type SecurityProfileListResponse = z.infer<typeof SecurityProfileListResponseSchema>;
+/** Zod schema for a profile deletion response. */
 declare const DeleteProfileResponseSchema: z.ZodObject<{
     message: z.ZodString;
 }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
@@ -11077,7 +11237,9 @@ declare const DeleteProfileResponseSchema: z.ZodObject<{
 }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
     message: z.ZodString;
 }, z.ZodTypeAny, "passthrough">>;
+/** Response from deleting a security profile. */
 type DeleteProfileResponse = z.infer<typeof DeleteProfileResponseSchema>;
+/** Zod schema for a profile deletion conflict (409). */
 declare const DeleteProfileConflictSchema: z.ZodObject<{
     message: z.ZodString;
     payload: z.ZodArray<z.ZodObject<{
@@ -11124,8 +11286,10 @@ declare const DeleteProfileConflictSchema: z.ZodObject<{
         priority: z.ZodNumber;
     }, z.ZodTypeAny, "passthrough">>, "many">;
 }, z.ZodTypeAny, "passthrough">>;
+/** Conflict response when deleting a profile referenced by policies. */
 type DeleteProfileConflict = z.infer<typeof DeleteProfileConflictSchema>;
 
+/** Zod schema for an AIRS custom topic. */
 declare const CustomTopicSchema: z.ZodObject<{
     topic_id: z.ZodOptional<z.ZodString>;
     topic_name: z.ZodString;
@@ -11160,7 +11324,9 @@ declare const CustomTopicSchema: z.ZodObject<{
     last_modified_ts: z.ZodOptional<z.ZodString>;
     created_ts: z.ZodOptional<z.ZodString>;
 }, z.ZodTypeAny, "passthrough">>;
+/** AIRS custom topic with name, description, examples, and audit metadata. */
 type CustomTopic = z.infer<typeof CustomTopicSchema>;
+/** Zod schema for a custom topic create/update request. */
 declare const CreateCustomTopicRequestSchema: z.ZodObject<{
     topic_id: z.ZodOptional<z.ZodString>;
     topic_name: z.ZodString;
@@ -11195,7 +11361,9 @@ declare const CreateCustomTopicRequestSchema: z.ZodObject<{
     last_modified_ts: z.ZodOptional<z.ZodString>;
     created_ts: z.ZodOptional<z.ZodString>;
 }, z.ZodTypeAny, "passthrough">>;
+/** Request body for creating or updating a custom topic. */
 type CreateCustomTopicRequest = z.infer<typeof CreateCustomTopicRequestSchema>;
+/** Zod schema for a paginated custom topic list response. */
 declare const CustomTopicListResponseSchema: z.ZodObject<{
     custom_topics: z.ZodArray<z.ZodObject<{
         topic_id: z.ZodOptional<z.ZodString>;
@@ -11305,7 +11473,9 @@ declare const CustomTopicListResponseSchema: z.ZodObject<{
     }, z.ZodTypeAny, "passthrough">>, "many">;
     next_offset: z.ZodOptional<z.ZodNumber>;
 }, z.ZodTypeAny, "passthrough">>;
+/** Paginated list of custom topics. */
 type CustomTopicListResponse = z.infer<typeof CustomTopicListResponseSchema>;
+/** Zod schema for a topic deletion response. */
 declare const DeleteTopicResponseSchema: z.ZodObject<{
     message: z.ZodString;
 }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
@@ -11313,7 +11483,9 @@ declare const DeleteTopicResponseSchema: z.ZodObject<{
 }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
     message: z.ZodString;
 }, z.ZodTypeAny, "passthrough">>;
+/** Response from deleting a custom topic. */
 type DeleteTopicResponse = z.infer<typeof DeleteTopicResponseSchema>;
+/** Zod schema for a topic deletion conflict (409). */
 declare const DeleteTopicConflictSchema: z.ZodObject<{
     message: z.ZodString;
     payload: z.ZodArray<z.ZodObject<{
@@ -11360,6 +11532,7 @@ declare const DeleteTopicConflictSchema: z.ZodObject<{
         revision: z.ZodNumber;
     }, z.ZodTypeAny, "passthrough">>, "many">;
 }, z.ZodTypeAny, "passthrough">>;
+/** Conflict response when deleting a topic referenced by profiles. */
 type DeleteTopicConflict = z.infer<typeof DeleteTopicConflictSchema>;
 
 declare const HEADER_API_KEY = "x-pan-token";
@@ -11386,8 +11559,8 @@ declare const MAX_NUMBER_OF_BATCH_SCAN_OBJECTS = 5;
 declare const MAX_CONNECTION_POOL_SIZE = 100;
 declare const MAX_NUMBER_OF_RETRIES = 5;
 declare const HTTP_FORCE_RETRY_STATUS_CODES: number[];
-declare const SDK_VERSION = "0.1.2";
-declare const USER_AGENT = "PAN-AIRS/0.1.2-typescript-sdk";
+declare const SDK_VERSION = "0.2.1";
+declare const USER_AGENT = "PAN-AIRS/0.2.1-typescript-sdk";
 declare const DEFAULT_MGMT_ENDPOINT = "https://api.sase.paloaltonetworks.com/aisec";
 declare const DEFAULT_TOKEN_ENDPOINT = "https://auth.apps.paloaltonetworks.com/oauth2/access_token";
 declare const MGMT_CLIENT_ID = "PANW_MGMT_CLIENT_ID";
@@ -11405,12 +11578,21 @@ declare const MGMT_TOPIC_PATH = "/v1/mgmt/topic";
 declare const MGMT_TOPICS_TSG_PATH = "/v1/mgmt/topics/tsg";
 declare const MGMT_TOPIC_FORCE_PATH = "/v1/mgmt/topic/force";
 
+/** Options for constructing an {@link OAuthClient}. */
 interface OAuthClientOptions {
+    /** OAuth2 client ID. */
     clientId: string;
+    /** OAuth2 client secret. */
     clientSecret: string;
+    /** Tenant Service Group ID. */
     tsgId: string;
+    /** OAuth2 token endpoint URL. Defaults to Palo Alto Networks auth endpoint. */
     tokenEndpoint?: string;
 }
+/**
+ * OAuth2 client_credentials token manager.
+ * Caches tokens, refreshes before expiry, and deduplicates concurrent requests.
+ */
 declare class OAuthClient {
     readonly tokenEndpoint: string;
     private readonly clientId;
@@ -11420,64 +11602,134 @@ declare class OAuthClient {
     private expiresAt;
     private pendingFetch;
     constructor(opts: OAuthClientOptions);
+    /**
+     * Get a valid access token, refreshing if needed.
+     * @returns Bearer access token string.
+     */
     getToken(): Promise<string>;
+    /** Clear the cached token, forcing a fresh fetch on next call. */
     clearToken(): void;
     private fetchToken;
 }
 
+/** Pagination parameters for list operations. */
 interface PaginationOptions {
+    /** Starting offset. Defaults to 0. */
     offset?: number;
+    /** Max items to return. Defaults to 100. */
     limit?: number;
 }
+/** @internal */
 interface ProfilesClientOptions {
     baseUrl: string;
     oauthClient: OAuthClient;
     tsgId: string;
     numRetries: number;
 }
+/** Client for AIRS security profile CRUD operations. */
 declare class ProfilesClient {
     private readonly baseUrl;
     private readonly oauthClient;
     private readonly tsgId;
     private readonly numRetries;
     constructor(opts: ProfilesClientOptions);
+    /**
+     * Create a new security profile.
+     * @param request - Profile configuration.
+     * @returns The created security profile.
+     */
     create(request: CreateSecurityProfileRequest): Promise<SecurityProfile>;
+    /**
+     * List security profiles for the TSG.
+     * @param opts - Pagination options.
+     * @returns Paginated list of security profiles.
+     */
     list(opts?: PaginationOptions): Promise<SecurityProfileListResponse>;
+    /**
+     * Update an existing security profile.
+     * @param profileId - UUID of the profile to update.
+     * @param request - Updated profile configuration.
+     * @returns The updated security profile.
+     */
     update(profileId: string, request: CreateSecurityProfileRequest): Promise<SecurityProfile>;
+    /**
+     * Delete a security profile.
+     * @param profileId - UUID of the profile to delete.
+     * @returns Deletion confirmation message.
+     */
     delete(profileId: string): Promise<DeleteProfileResponse>;
 }
 
+/** @internal */
 interface TopicsClientOptions {
     baseUrl: string;
     oauthClient: OAuthClient;
     tsgId: string;
     numRetries: number;
 }
+/** Client for AIRS custom topic CRUD operations. */
 declare class TopicsClient {
     private readonly baseUrl;
     private readonly oauthClient;
     private readonly tsgId;
     private readonly numRetries;
     constructor(opts: TopicsClientOptions);
+    /**
+     * Create a new custom topic.
+     * @param request - Topic definition with name, description, and examples.
+     * @returns The created custom topic.
+     */
     create(request: CreateCustomTopicRequest): Promise<CustomTopic>;
+    /**
+     * List custom topics for the TSG.
+     * @param opts - Pagination options.
+     * @returns Paginated list of custom topics.
+     */
     list(opts?: PaginationOptions): Promise<CustomTopicListResponse>;
+    /**
+     * Update an existing custom topic.
+     * @param topicId - UUID of the topic to update.
+     * @param request - Updated topic definition.
+     * @returns The updated custom topic.
+     */
     update(topicId: string, request: CreateCustomTopicRequest): Promise<CustomTopic>;
+    /**
+     * Delete a custom topic. Fails if topic is referenced by a profile.
+     * @param topicId - UUID of the topic to delete.
+     * @returns Deletion confirmation message.
+     */
     delete(topicId: string): Promise<DeleteTopicResponse>;
+    /**
+     * Force-delete a custom topic, removing it from any referencing profiles.
+     * @param topicId - UUID of the topic to force-delete.
+     * @returns Deletion confirmation message.
+     */
     forceDelete(topicId: string): Promise<DeleteTopicResponse>;
 }
 
+/** Options for constructing a {@link ManagementClient}. */
 interface ManagementClientOptions {
+    /** OAuth2 client ID. Falls back to `PANW_MGMT_CLIENT_ID` env var. */
     clientId?: string;
+    /** OAuth2 client secret. Falls back to `PANW_MGMT_CLIENT_SECRET` env var. */
     clientSecret?: string;
+    /** Tenant Service Group ID. Falls back to `PANW_MGMT_TSG_ID` env var. */
     tsgId?: string;
+    /** Management API endpoint URL. Falls back to `PANW_MGMT_ENDPOINT` env var. */
     apiEndpoint?: string;
+    /** OAuth2 token endpoint URL. Falls back to `PANW_MGMT_TOKEN_ENDPOINT` env var. */
     tokenEndpoint?: string;
+    /** Max retry attempts (0–5). Defaults to 5. */
     numRetries?: number;
 }
+/**
+ * Client for AIRS management API operations (profiles and topics CRUD).
+ * Authenticates via OAuth2 client_credentials flow.
+ */
 declare class ManagementClient {
     readonly profiles: ProfilesClient;
     readonly topics: TopicsClient;
     constructor(opts?: ManagementClientOptions);
 }
 
-export { AISecSDKException, AI_SEC_API_ENDPOINT, AI_SEC_API_KEY, AI_SEC_API_TOKEN, ASYNC_SCAN_PATH, type AgentMeta, AgentMetaSchema, type AiProfile, AiProfileSchema, type AsyncScanObject, AsyncScanObjectSchema, type AsyncScanResponse, AsyncScanResponseSchema, BEARER, Content, type ContentOptions, type CreateCustomTopicRequest, CreateCustomTopicRequestSchema, type CreateSecurityProfileRequest, CreateSecurityProfileRequestSchema, type CustomTopic, type CustomTopicListResponse, CustomTopicListResponseSchema, CustomTopicSchema, DEFAULT_ENDPOINT, DEFAULT_MGMT_ENDPOINT, DEFAULT_TOKEN_ENDPOINT, type DSDetailResult, DSDetailResultSchema, type DSResultMetadata, DSResultMetadataSchema, type DeleteProfileConflict, DeleteProfileConflictSchema, type DeleteProfileResponse, DeleteProfileResponseSchema, type DeleteTopicConflict, DeleteTopicConflictSchema, type DeleteTopicResponse, DeleteTopicResponseSchema, type DetectionServiceResult, DetectionServiceResultSchema, type DlpReport, DlpReportSchema, type ErrorResponse, ErrorResponseSchema, ErrorType, HEADER_API_KEY, HEADER_AUTH_TOKEN, HTTP_FORCE_RETRY_STATUS_CODES, type IODetected, IODetectedSchema, type InitOptions, MAX_AI_PROFILE_NAME_LENGTH, MAX_API_KEY_LENGTH, MAX_CONNECTION_POOL_SIZE, MAX_CONTENT_CONTEXT_LENGTH, MAX_CONTENT_PROMPT_LENGTH, MAX_CONTENT_RESPONSE_LENGTH, MAX_NUMBER_OF_BATCH_SCAN_OBJECTS, MAX_NUMBER_OF_REPORT_IDS, MAX_NUMBER_OF_RETRIES, MAX_NUMBER_OF_SCAN_IDS, MAX_REPORT_ID_STR_LENGTH, MAX_SCAN_ID_STR_LENGTH, MAX_SESSION_ID_STR_LENGTH, MAX_TOKEN_LENGTH, MAX_TRANSACTION_ID_STR_LENGTH, MGMT_CLIENT_ID, MGMT_CLIENT_SECRET, MGMT_ENDPOINT, MGMT_PROFILES_TSG_PATH, MGMT_PROFILE_PATH, MGMT_TOKEN_ENDPOINT, MGMT_TOPICS_TSG_PATH, MGMT_TOPIC_FORCE_PATH, MGMT_TOPIC_PATH, MGMT_TSG_ID, ManagementClient, type ManagementClientOptions, type MaskedData, MaskedDataSchema, type Metadata, MetadataSchema, PAYLOAD_HASH, type PaginationOptions, type Policy, PolicySchema, ProfilesClient, type PromptDetected, PromptDetectedSchema, type PromptDetectionDetails, PromptDetectionDetailsSchema, type ResponseDetected, ResponseDetectedSchema, type ResponseDetectionDetails, ResponseDetectionDetailsSchema, SCAN_REPORTS_PATH, SCAN_RESULTS_PATH, SDK_VERSION, SYNC_SCAN_PATH, type ScanIdResult, ScanIdResultSchema, type ScanRequest, type ScanRequestContentsInner, ScanRequestContentsInnerSchema, ScanRequestSchema, type ScanResponse, ScanResponseSchema, type ScanSummary, ScanSummarySchema, Scanner, type SecurityProfile, type SecurityProfileListResponse, SecurityProfileListResponseSchema, SecurityProfileSchema, type SyncScanOptions, type ThreatScanReport, ThreatScanReportSchema, type ToolDetected, ToolDetectedSchema, type ToolEvent, type ToolEventMetadata, ToolEventMetadataSchema, ToolEventSchema, TopicsClient, USER_AGENT, type UrlfEntry, UrlfEntrySchema, globalConfiguration, init };
+export { AISecSDKException, AI_SEC_API_ENDPOINT, AI_SEC_API_KEY, AI_SEC_API_TOKEN, ASYNC_SCAN_PATH, Action, Action as ActionType, type AgentMeta, AgentMetaSchema, type AiProfile, AiProfileSchema, type AsyncScanObject, AsyncScanObjectSchema, type AsyncScanResponse, AsyncScanResponseSchema, BEARER, Category, Category as CategoryType, Content, type ContentOptions, type CreateCustomTopicRequest, CreateCustomTopicRequestSchema, type CreateSecurityProfileRequest, CreateSecurityProfileRequestSchema, type CustomTopic, type CustomTopicListResponse, CustomTopicListResponseSchema, CustomTopicSchema, DEFAULT_ENDPOINT, DEFAULT_MGMT_ENDPOINT, DEFAULT_TOKEN_ENDPOINT, type DSDetailResult, DSDetailResultSchema, type DSResultMetadata, DSResultMetadataSchema, type DeleteProfileConflict, DeleteProfileConflictSchema, type DeleteProfileResponse, DeleteProfileResponseSchema, type DeleteTopicConflict, DeleteTopicConflictSchema, type DeleteTopicResponse, DeleteTopicResponseSchema, type DetectionServiceResult, DetectionServiceResultSchema, type DlpReport, DlpReportSchema, type ErrorResponse, ErrorResponseSchema, ErrorType, HEADER_API_KEY, HEADER_AUTH_TOKEN, HTTP_FORCE_RETRY_STATUS_CODES, type IODetected, IODetectedSchema, type InitOptions, MAX_AI_PROFILE_NAME_LENGTH, MAX_API_KEY_LENGTH, MAX_CONNECTION_POOL_SIZE, MAX_CONTENT_CONTEXT_LENGTH, MAX_CONTENT_PROMPT_LENGTH, MAX_CONTENT_RESPONSE_LENGTH, MAX_NUMBER_OF_BATCH_SCAN_OBJECTS, MAX_NUMBER_OF_REPORT_IDS, MAX_NUMBER_OF_RETRIES, MAX_NUMBER_OF_SCAN_IDS, MAX_REPORT_ID_STR_LENGTH, MAX_SCAN_ID_STR_LENGTH, MAX_SESSION_ID_STR_LENGTH, MAX_TOKEN_LENGTH, MAX_TRANSACTION_ID_STR_LENGTH, MGMT_CLIENT_ID, MGMT_CLIENT_SECRET, MGMT_ENDPOINT, MGMT_PROFILES_TSG_PATH, MGMT_PROFILE_PATH, MGMT_TOKEN_ENDPOINT, MGMT_TOPICS_TSG_PATH, MGMT_TOPIC_FORCE_PATH, MGMT_TOPIC_PATH, MGMT_TSG_ID, ManagementClient, type ManagementClientOptions, type MaskedData, MaskedDataSchema, type Metadata, MetadataSchema, PAYLOAD_HASH, type PaginationOptions, type Policy, PolicySchema, ProfilesClient, type PromptDetected, PromptDetectedSchema, type PromptDetectionDetails, PromptDetectionDetailsSchema, type ResponseDetected, ResponseDetectedSchema, type ResponseDetectionDetails, ResponseDetectionDetailsSchema, SCAN_REPORTS_PATH, SCAN_RESULTS_PATH, SDK_VERSION, SYNC_SCAN_PATH, type ScanIdResult, ScanIdResultSchema, type ScanRequest, type ScanRequestContentsInner, ScanRequestContentsInnerSchema, ScanRequestSchema, type ScanResponse, ScanResponseSchema, type ScanSummary, ScanSummarySchema, Scanner, type SecurityProfile, type SecurityProfileListResponse, SecurityProfileListResponseSchema, SecurityProfileSchema, type SyncScanOptions, type ThreatScanReport, ThreatScanReportSchema, type ToolDetected, ToolDetectedSchema, type ToolEvent, type ToolEventMetadata, ToolEventMetadataSchema, ToolEventSchema, TopicsClient, USER_AGENT, type UrlfEntry, UrlfEntrySchema, Verdict, Verdict as VerdictType, globalConfiguration, init };