@cdot65/prisma-airs-sdk 0.6.4 → 0.6.6

package/dist/index.d.cts

@@ -16485,9 +16485,15 @@ 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. */
+    /**
+     * Total byte length of all text content fields.
+     * @returns Combined byte length of all text content fields.
+     */
     get length(): number;
-    /** Serialize to the API request format. */
+    /**
+     * Serialize to the API request format.
+     * @returns The content as a scan request contents inner object.
+     */
     toJSON(): ScanRequestContentsInner;
     /**
      * Create a Content instance from an API response object.
@@ -16497,6 +16503,7 @@ declare class Content {
     /**
      * Load content from a JSON file.
      * @param filePath - Path to JSON file containing scan request contents.
+     * @returns A new Content instance populated from the JSON file.
      */
     static fromJSONFile(filePath: string): Content;
 }
@@ -20752,13 +20759,13 @@ declare const ErrorResponseSchema: z.ZodObject<{
     retry_after: z.ZodOptional<z.ZodObject<{
         interval: z.ZodOptional<z.ZodNumber>;
         unit: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        interval?: number | undefined;
-        unit?: string | undefined;
-    }, {
-        interval?: number | undefined;
-        unit?: string | undefined;
-    }>>;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        interval: z.ZodOptional<z.ZodNumber>;
+        unit: z.ZodOptional<z.ZodString>;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        interval: z.ZodOptional<z.ZodNumber>;
+        unit: z.ZodOptional<z.ZodString>;
+    }, z.ZodTypeAny, "passthrough">>>;
 }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
     status_code: z.ZodOptional<z.ZodNumber>;
     message: z.ZodOptional<z.ZodString>;
@@ -20772,13 +20779,13 @@ declare const ErrorResponseSchema: z.ZodObject<{
     retry_after: z.ZodOptional<z.ZodObject<{
         interval: z.ZodOptional<z.ZodNumber>;
         unit: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        interval?: number | undefined;
-        unit?: string | undefined;
-    }, {
-        interval?: number | undefined;
-        unit?: string | undefined;
-    }>>;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        interval: z.ZodOptional<z.ZodNumber>;
+        unit: z.ZodOptional<z.ZodString>;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        interval: z.ZodOptional<z.ZodNumber>;
+        unit: z.ZodOptional<z.ZodString>;
+    }, z.ZodTypeAny, "passthrough">>>;
 }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
     status_code: z.ZodOptional<z.ZodNumber>;
     message: z.ZodOptional<z.ZodString>;
@@ -20792,13 +20799,13 @@ declare const ErrorResponseSchema: z.ZodObject<{
     retry_after: z.ZodOptional<z.ZodObject<{
         interval: z.ZodOptional<z.ZodNumber>;
         unit: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        interval?: number | undefined;
-        unit?: string | undefined;
-    }, {
-        interval?: number | undefined;
-        unit?: string | undefined;
-    }>>;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        interval: z.ZodOptional<z.ZodNumber>;
+        unit: z.ZodOptional<z.ZodString>;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        interval: z.ZodOptional<z.ZodNumber>;
+        unit: z.ZodOptional<z.ZodString>;
+    }, z.ZodTypeAny, "passthrough">>>;
 }, z.ZodTypeAny, "passthrough">>;
 /** AIRS API error response with optional retry-after guidance. */
 type ErrorResponse = z.infer<typeof ErrorResponseSchema>;
@@ -29860,31 +29867,31 @@ declare const ApiKeyCreateRequestSchema: z.ZodObject<{
     api_key_name: z.ZodString;
     rotation_time_interval: z.ZodNumber;
     rotation_time_unit: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    created_by: string;
-    api_key_name: string;
-    auth_code: string;
-    revoked: boolean;
-    cust_app: string;
-    rotation_time_interval: number;
-    rotation_time_unit: string;
-    cust_env?: string | undefined;
-    cust_ai_agent_framework?: string | undefined;
-    cust_cloud_provider?: string | undefined;
-    dp_name?: string | undefined;
-}, {
-    created_by: string;
-    api_key_name: string;
-    auth_code: string;
-    revoked: boolean;
-    cust_app: string;
-    rotation_time_interval: number;
-    rotation_time_unit: string;
-    cust_env?: string | undefined;
-    cust_ai_agent_framework?: string | undefined;
-    cust_cloud_provider?: string | undefined;
-    dp_name?: string | undefined;
-}>;
+}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+    dp_name: z.ZodOptional<z.ZodString>;
+    auth_code: z.ZodString;
+    cust_app: z.ZodString;
+    cust_env: z.ZodOptional<z.ZodString>;
+    cust_cloud_provider: z.ZodOptional<z.ZodString>;
+    cust_ai_agent_framework: z.ZodOptional<z.ZodString>;
+    revoked: z.ZodBoolean;
+    created_by: z.ZodString;
+    api_key_name: z.ZodString;
+    rotation_time_interval: z.ZodNumber;
+    rotation_time_unit: z.ZodString;
+}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+    dp_name: z.ZodOptional<z.ZodString>;
+    auth_code: z.ZodString;
+    cust_app: z.ZodString;
+    cust_env: z.ZodOptional<z.ZodString>;
+    cust_cloud_provider: z.ZodOptional<z.ZodString>;
+    cust_ai_agent_framework: z.ZodOptional<z.ZodString>;
+    revoked: z.ZodBoolean;
+    created_by: z.ZodString;
+    api_key_name: z.ZodString;
+    rotation_time_interval: z.ZodNumber;
+    rotation_time_unit: z.ZodString;
+}, z.ZodTypeAny, "passthrough">>;
 /** API key creation request. */
 type ApiKeyCreateRequest = z.infer<typeof ApiKeyCreateRequestSchema>;
 /** Zod schema for API key regeneration request. */
@@ -29892,15 +29899,15 @@ declare const ApiKeyRegenerateRequestSchema: z.ZodObject<{
     rotation_time_interval: z.ZodNumber;
     rotation_time_unit: z.ZodString;
     updated_by: z.ZodOptional<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
-    rotation_time_interval: number;
-    rotation_time_unit: string;
-    updated_by?: string | undefined;
-}, {
-    rotation_time_interval: number;
-    rotation_time_unit: string;
-    updated_by?: string | undefined;
-}>;
+}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+    rotation_time_interval: z.ZodNumber;
+    rotation_time_unit: z.ZodString;
+    updated_by: z.ZodOptional<z.ZodString>;
+}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+    rotation_time_interval: z.ZodNumber;
+    rotation_time_unit: z.ZodString;
+    updated_by: z.ZodOptional<z.ZodString>;
+}, z.ZodTypeAny, "passthrough">>;
 /** API key regeneration request. */
 type ApiKeyRegenerateRequest = z.infer<typeof ApiKeyRegenerateRequestSchema>;
 /** Zod schema for paginated API key list response. */
@@ -33678,13 +33685,13 @@ type PaginatedScanResults = z.infer<typeof PaginatedScanResultsSchema>;
 declare const ClientIdAndCustomerAppSchema: z.ZodObject<{
     client_id: z.ZodString;
     customer_app: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    client_id: string;
-    customer_app: string;
-}, {
-    client_id: string;
-    customer_app: string;
-}>;
+}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+    client_id: z.ZodString;
+    customer_app: z.ZodString;
+}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+    client_id: z.ZodString;
+    customer_app: z.ZodString;
+}, z.ZodTypeAny, "passthrough">>;
 /** OAuth client_id and customer_app request body. */
 type ClientIdAndCustomerApp = z.infer<typeof ClientIdAndCustomerAppSchema>;
 /** Zod schema for OAuth2 token response. */
@@ -56690,8 +56697,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.6.4";
-declare const USER_AGENT = "PAN-AIRS/0.6.4-typescript-sdk";
+declare const SDK_VERSION = "0.6.6";
+declare const USER_AGENT = "PAN-AIRS/0.6.6-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";
@@ -56803,14 +56810,20 @@ declare class OAuthClient {
      * @returns Bearer access token string.
      */
     getToken(): Promise<string>;
-    /** Clear the cached token, forcing a fresh fetch on next call. */
+    /**
+     * Clear the cached token, forcing a fresh fetch on next call.
+     */
     clearToken(): void;
-    /** Check if the current token has passed its expiry time. Returns true if no token exists. */
+    /**
+     * Check if the current token has passed its expiry time. Returns true if no token exists.
+     * @returns Whether the token is expired.
+     */
     isTokenExpired(): boolean;
     /**
      * Check if the token is within the pre-expiry buffer window.
      * Returns true if no token exists.
      * @param bufferMs - Custom buffer in ms. Defaults to the configured `tokenBufferMs`.
+     * @returns Whether the token is expiring soon.
      */
     isTokenExpiringSoon(bufferMs?: number): boolean;
     /**
@@ -56918,7 +56931,7 @@ declare class TopicsClient {
     /**
      * Force-delete a custom topic, removing it from any referencing profiles.
      * @param topicId - UUID of the topic to force-delete.
-     * @param updatedBy - Email of the user performing the deletion.
+     * @param updatedBy - Optional. Email of the user performing the deletion.
      * @returns Deletion confirmation message.
      */
     forceDelete(topicId: string, updatedBy?: string): Promise<DeleteTopicResponse>;
@@ -57394,6 +57407,7 @@ declare class ModelSecurityGroupsClient {
     /**
      * Delete a security group.
      * @param uuid - Security group UUID.
+     * @returns Resolves when the security group is deleted.
      */
     delete(uuid: string): Promise<void>;
     /**
@@ -57527,13 +57541,28 @@ declare class RedTeamScansClient {
      * @returns The created job response.
      */
     create(request: JobCreateRequest): Promise<JobResponse>;
-    /** List red team scan jobs with optional filters. */
+    /**
+     * List red team scan jobs with optional filters.
+     * @param opts - Optional pagination, search, and filter options.
+     * @returns The paginated list of scan jobs.
+     */
     list(opts?: RedTeamScanListOptions): Promise<JobListResponse>;
-    /** Get a single scan job by ID. */
+    /**
+     * Get a single scan job by ID.
+     * @param jobId - The job UUID.
+     * @returns The job response.
+     */
     get(jobId: string): Promise<JobResponse>;
-    /** Abort a running scan job. */
+    /**
+     * Abort a running scan job.
+     * @param jobId - The job UUID.
+     * @returns The abort response.
+     */
     abort(jobId: string): Promise<JobAbortResponse>;
-    /** Get all categories with subcategories. */
+    /**
+     * Get all categories with subcategories.
+     * @returns The list of category models.
+     */
     getCategories(): Promise<CategoryModel[]>;
 }
 
@@ -57564,33 +57593,96 @@ declare class RedTeamReportsClient {
     private readonly oauthClient;
     private readonly numRetries;
     constructor(opts: RedTeamReportsClientOptions);
-    /** List attacks for a static scan. */
+    /**
+     * List attacks for a static scan.
+     * @param jobId - The job UUID.
+     * @param opts - Optional pagination, search, and filter options.
+     * @returns The paginated list of attacks.
+     */
     listAttacks(jobId: string, opts?: AttackListOptions): Promise<AttackListResponse>;
-    /** Get attack details for a static scan. */
+    /**
+     * Get attack details for a static scan.
+     * @param jobId - The job UUID.
+     * @param attackId - The attack UUID.
+     * @returns The attack detail response.
+     */
     getAttackDetail(jobId: string, attackId: string): Promise<AttackDetailResponse>;
-    /** Get multi-turn attack details for a static scan. */
+    /**
+     * Get multi-turn attack details for a static scan.
+     * @param jobId - The job UUID.
+     * @param attackId - The attack UUID.
+     * @returns The multi-turn attack detail response.
+     */
     getMultiTurnAttackDetail(jobId: string, attackId: string): Promise<AttackMultiTurnDetailResponse>;
-    /** Get the attack library report for a static scan. */
+    /**
+     * Get the attack library report for a static scan.
+     * @param jobId - The job UUID.
+     * @returns The static job report.
+     */
     getStaticReport(jobId: string): Promise<StaticJobReport>;
-    /** Get remediation recommendations for a static scan. */
+    /**
+     * Get remediation recommendations for a static scan.
+     * @param jobId - The job UUID.
+     * @returns The remediation response.
+     */
     getStaticRemediation(jobId: string): Promise<RemediationResponse>;
-    /** Get runtime security profile config for a static scan. */
+    /**
+     * Get runtime security profile config for a static scan.
+     * @param jobId - The job UUID.
+     * @returns The runtime security profile response.
+     */
     getStaticRuntimePolicy(jobId: string): Promise<RuntimeSecurityProfileResponse>;
-    /** Get the agent scan report for a dynamic scan. */
+    /**
+     * Get the agent scan report for a dynamic scan.
+     * @param jobId - The job UUID.
+     * @returns The dynamic job report.
+     */
     getDynamicReport(jobId: string): Promise<DynamicJobReport>;
-    /** Get remediation recommendations for a dynamic scan. */
+    /**
+     * Get remediation recommendations for a dynamic scan.
+     * @param jobId - The job UUID.
+     * @returns The remediation response.
+     */
     getDynamicRemediation(jobId: string): Promise<RemediationResponse>;
-    /** Get runtime security profile config for a dynamic scan. */
+    /**
+     * Get runtime security profile config for a dynamic scan.
+     * @param jobId - The job UUID.
+     * @returns The runtime security profile response.
+     */
     getDynamicRuntimePolicy(jobId: string): Promise<RuntimeSecurityProfileResponse>;
-    /** List goals for a dynamic scan. */
+    /**
+     * List goals for a dynamic scan.
+     * @param jobId - The job UUID.
+     * @param opts - Optional pagination, search, and filter options.
+     * @returns The paginated list of goals.
+     */
     listGoals(jobId: string, opts?: GoalListOptions): Promise<GoalListResponse>;
-    /** List streams for a goal in a dynamic scan. */
+    /**
+     * List streams for a goal in a dynamic scan.
+     * @param jobId - The job UUID.
+     * @param goalId - The goal UUID.
+     * @param opts - Optional pagination and search options.
+     * @returns The paginated list of streams.
+     */
     listGoalStreams(jobId: string, goalId: string, opts?: RedTeamListOptions): Promise<StreamListResponse>;
-    /** Get stream details by stream ID. */
+    /**
+     * Get stream details by stream ID.
+     * @param streamId - The stream UUID.
+     * @returns The stream detail response.
+     */
     getStreamDetail(streamId: string): Promise<StreamDetailResponse>;
-    /** Download a report in the specified format. */
+    /**
+     * Download a report in the specified format.
+     * @param jobId - The job UUID.
+     * @param format - The file format (e.g. "pdf", "csv").
+     * @returns The report data in the requested format (untyped — shape depends on `format`).
+     */
     downloadReport(jobId: string, format: string): Promise<unknown>;
-    /** Generate a partial report for a running scan. */
+    /**
+     * Generate a partial report for a running scan.
+     * @param jobId - The job UUID.
+     * @returns The partial report payload (untyped — schema not yet defined by the API).
+     */
     generatePartialReport(jobId: string): Promise<unknown>;
 }
 
@@ -57616,19 +57708,52 @@ declare class RedTeamCustomAttackReportsClient {
     private readonly oauthClient;
     private readonly numRetries;
     constructor(opts: RedTeamCustomAttackReportsClientOptions);
-    /** Get custom attack report for a scan. */
+    /**
+     * Get custom attack report for a scan.
+     * @param jobId - The job UUID.
+     * @returns The custom attack report response.
+     */
     getReport(jobId: string): Promise<CustomAttackReportResponse>;
-    /** Get prompt sets for a custom attack scan. */
+    /**
+     * Get prompt sets for a custom attack scan.
+     * @param jobId - The job UUID.
+     * @returns The prompt sets report response.
+     */
     getPromptSets(jobId: string): Promise<PromptSetsReportResponse>;
-    /** Get prompts for a specific prompt set in a scan. */
+    /**
+     * Get prompts for a specific prompt set in a scan.
+     * @param jobId - The job UUID.
+     * @param promptSetId - The prompt set UUID.
+     * @param opts - Optional pagination, search, and filter options.
+     * @returns The list of prompt detail responses.
+     */
     getPromptsBySet(jobId: string, promptSetId: string, opts?: PromptsBySetListOptions): Promise<PromptDetailResponse[]>;
-    /** Get details for a specific prompt. */
+    /**
+     * Get details for a specific prompt.
+     * @param jobId - The job UUID.
+     * @param promptId - The prompt UUID.
+     * @returns The prompt detail response.
+     */
     getPromptDetail(jobId: string, promptId: string): Promise<PromptDetailResponse>;
-    /** List custom attacks for a scan. */
+    /**
+     * List custom attacks for a scan.
+     * @param jobId - The job UUID.
+     * @param opts - Optional pagination, search, and filter options.
+     * @returns The paginated list of custom attacks.
+     */
     listCustomAttacks(jobId: string, opts?: CustomAttacksReportListOptions): Promise<CustomAttacksListResponse>;
-    /** Get attack outputs for a custom attack. */
+    /**
+     * Get attack outputs for a custom attack.
+     * @param jobId - The job UUID.
+     * @param attackId - The attack UUID.
+     * @returns The list of attack outputs.
+     */
     getAttackOutputs(jobId: string, attackId: string): Promise<CustomAttackOutput[]>;
-    /** Get property statistics for a custom attack scan. */
+    /**
+     * Get property statistics for a custom attack scan.
+     * @param jobId - The job UUID.
+     * @returns The list of property statistics.
+     */
     getPropertyStats(jobId: string): Promise<PropertyStatistic[]>;
 }
 
@@ -57661,19 +57786,50 @@ declare class RedTeamTargetsClient {
      * @returns The created target response.
      */
     create(request: TargetCreateRequest, opts?: TargetOperationOptions): Promise<TargetResponse>;
-    /** List targets with optional filters. */
+    /**
+     * List targets with optional filters.
+     * @param opts - Optional pagination, search, and filter options.
+     * @returns The paginated list of targets.
+     */
     list(opts?: TargetListOptions): Promise<TargetList>;
-    /** Get a target by UUID. */
+    /**
+     * Get a target by UUID.
+     * @param uuid - The target UUID.
+     * @returns The target response.
+     */
     get(uuid: string): Promise<TargetResponse>;
-    /** Update a target. */
+    /**
+     * Update a target.
+     * @param uuid - The target UUID.
+     * @param request - Target update request body.
+     * @param opts - Optional operation options (e.g. validate connection).
+     * @returns The updated target response.
+     */
     update(uuid: string, request: TargetUpdateRequest, opts?: TargetOperationOptions): Promise<TargetResponse>;
-    /** Delete a target. */
+    /**
+     * Delete a target.
+     * @param uuid - The target UUID.
+     * @returns The delete response.
+     */
     delete(uuid: string): Promise<BaseResponse>;
-    /** Run profiling probes on a target. */
+    /**
+     * Run profiling probes on a target.
+     * @param request - The probe request body.
+     * @returns The target response after probing.
+     */
     probe(request: TargetProbeRequest): Promise<TargetResponse>;
-    /** Get profiling results for a target. */
+    /**
+     * Get profiling results for a target.
+     * @param uuid - The target UUID.
+     * @returns The target profile response.
+     */
     getProfile(uuid: string): Promise<TargetProfileResponse>;
-    /** Update a target profile (background + additional context). */
+    /**
+     * Update a target profile (background + additional context).
+     * @param uuid - The target UUID.
+     * @param request - The context update request body.
+     * @returns The updated target response.
+     */
     updateProfile(uuid: string, request: TargetContextUpdate): Promise<TargetResponse>;
 }
 
@@ -57699,45 +57855,131 @@ declare class RedTeamCustomAttacksClient {
     private readonly oauthClient;
     private readonly numRetries;
     constructor(opts: RedTeamCustomAttacksClientOptions);
-    /** Create a new custom prompt set. */
+    /**
+     * Create a new custom prompt set.
+     * @param request - Prompt set creation request body.
+     * @returns The created prompt set response.
+     */
     createPromptSet(request: CustomPromptSetCreateRequest): Promise<CustomPromptSetResponse>;
-    /** List custom prompt sets. */
+    /**
+     * List custom prompt sets.
+     * @param opts - Optional pagination, search, and filter options.
+     * @returns The paginated list of prompt sets.
+     */
     listPromptSets(opts?: PromptSetListOptions): Promise<CustomPromptSetList>;
-    /** Get a prompt set by UUID. */
+    /**
+     * Get a prompt set by UUID.
+     * @param uuid - The prompt set UUID.
+     * @returns The prompt set response.
+     */
     getPromptSet(uuid: string): Promise<CustomPromptSetResponse>;
-    /** Update a prompt set. */
+    /**
+     * Update a prompt set.
+     * @param uuid - The prompt set UUID.
+     * @param request - Prompt set update request body.
+     * @returns The updated prompt set response.
+     */
     updatePromptSet(uuid: string, request: CustomPromptSetUpdateRequest): Promise<CustomPromptSetResponse>;
-    /** Archive or unarchive a prompt set. */
+    /**
+     * Archive or unarchive a prompt set.
+     * @param uuid - The prompt set UUID.
+     * @param request - Archive request body.
+     * @returns The updated prompt set response.
+     */
     archivePromptSet(uuid: string, request: CustomPromptSetArchiveRequest): Promise<CustomPromptSetResponse>;
-    /** Resolve a prompt set reference for data plane consumption. */
+    /**
+     * Resolve a prompt set reference for data plane consumption.
+     * @param uuid - The prompt set UUID.
+     * @returns The prompt set reference.
+     */
     getPromptSetReference(uuid: string): Promise<CustomPromptSetReference>;
-    /** Get version information for a prompt set. */
+    /**
+     * Get version information for a prompt set.
+     * @param uuid - The prompt set UUID.
+     * @returns The prompt set version info.
+     */
     getPromptSetVersionInfo(uuid: string): Promise<CustomPromptSetVersionInfo>;
-    /** List active prompt sets (for data plane). */
+    /**
+     * List active prompt sets (for data plane).
+     * @returns The list of active prompt sets.
+     */
     listActivePromptSets(): Promise<CustomPromptSetListActive>;
-    /** Download CSV template for a prompt set. */
+    /**
+     * Download CSV template for a prompt set.
+     * @param uuid - The prompt set UUID.
+     * @returns The CSV template content (untyped — raw response from the API).
+     */
     downloadTemplate(uuid: string): Promise<unknown>;
-    /** Upload a CSV file of custom prompts for a prompt set. */
+    /**
+     * Upload a CSV file of custom prompts for a prompt set.
+     * @param promptSetUuid - The prompt set UUID.
+     * @param file - The CSV file blob.
+     * @returns The upload response.
+     */
     uploadPromptsCsv(promptSetUuid: string, file: Blob): Promise<BaseResponse>;
-    /** Create a new custom prompt. */
+    /**
+     * Create a new custom prompt.
+     * @param request - Prompt creation request body.
+     * @returns The created prompt response.
+     */
     createPrompt(request: CustomPromptCreateRequest): Promise<CustomPromptResponse>;
-    /** List prompts in a prompt set. */
+    /**
+     * List prompts in a prompt set.
+     * @param promptSetUuid - The prompt set UUID.
+     * @param opts - Optional pagination, search, and filter options.
+     * @returns The paginated list of prompts.
+     */
     listPrompts(promptSetUuid: string, opts?: PromptListOptions): Promise<CustomPromptList>;
-    /** Get a prompt by UUID. */
+    /**
+     * Get a prompt by UUID.
+     * @param promptSetUuid - The prompt set UUID.
+     * @param promptUuid - The prompt UUID.
+     * @returns The prompt response.
+     */
     getPrompt(promptSetUuid: string, promptUuid: string): Promise<CustomPromptResponse>;
-    /** Update a prompt. */
+    /**
+     * Update a prompt.
+     * @param promptSetUuid - The prompt set UUID.
+     * @param promptUuid - The prompt UUID.
+     * @param request - Prompt update request body.
+     * @returns The updated prompt response.
+     */
     updatePrompt(promptSetUuid: string, promptUuid: string, request: CustomPromptUpdateRequest): Promise<CustomPromptResponse>;
-    /** Delete a prompt. */
+    /**
+     * Delete a prompt.
+     * @param promptSetUuid - The prompt set UUID.
+     * @param promptUuid - The prompt UUID.
+     * @returns The delete response.
+     */
     deletePrompt(promptSetUuid: string, promptUuid: string): Promise<BaseResponse>;
-    /** Get all property names. */
+    /**
+     * Get all property names.
+     * @returns The list of property names.
+     */
     getPropertyNames(): Promise<PropertyNamesListResponse>;
-    /** Create a new property name. */
+    /**
+     * Create a new property name.
+     * @param request - Property name creation request body.
+     * @returns The creation response.
+     */
     createPropertyName(request: PropertyNameCreateRequest): Promise<BaseResponse>;
-    /** Get values for a property name. */
+    /**
+     * Get values for a property name.
+     * @param propertyName - The property name to look up.
+     * @returns The property values response.
+     */
     getPropertyValues(propertyName: string): Promise<PropertyValuesResponse>;
-    /** Get values for multiple property names. */
+    /**
+     * Get values for multiple property names.
+     * @param propertyNames - Array of property names to look up.
+     * @returns The property values for all requested names.
+     */
     getPropertyValuesMultiple(propertyNames: string[]): Promise<PropertyValuesMultipleResponse>;
-    /** Create a property value. */
+    /**
+     * Create a property value.
+     * @param request - Property value creation request body.
+     * @returns The creation response.
+     */
     createPropertyValue(request: PropertyValueCreateRequest): Promise<BaseResponse>;
 }
 
@@ -57778,22 +58020,49 @@ declare class RedTeamClient {
     private readonly oauthClient;
     private readonly numRetries;
     constructor(opts?: RedTeamClientOptions);
-    /** Get scan statistics and risk profile (data plane dashboard). */
+    /**
+     * Get scan statistics and risk profile (data plane dashboard).
+     * @param params - Optional date range and target ID filters.
+     * @returns The scan statistics response.
+     */
     getScanStatistics(params?: {
         date_range?: string;
         target_id?: string;
     }): Promise<ScanStatisticsResponse>;
-    /** Get score trend for a target (data plane dashboard). */
+    /**
+     * Get score trend for a target (data plane dashboard).
+     * @param targetId - The target UUID.
+     * @returns The score trend response.
+     */
     getScoreTrend(targetId: string): Promise<ScoreTrendResponse>;
-    /** Get quota summary. */
+    /**
+     * Get quota summary.
+     * @returns The quota summary.
+     */
     getQuota(): Promise<QuotaSummary>;
-    /** List error logs for a scan job. */
+    /**
+     * List error logs for a scan job.
+     * @param jobId - The job UUID.
+     * @param opts - Optional pagination and search options.
+     * @returns The paginated list of error logs.
+     */
     getErrorLogs(jobId: string, opts?: RedTeamListOptions): Promise<ErrorLogListResponse>;
-    /** Update sentiment for a scan report. */
+    /**
+     * Update sentiment for a scan report.
+     * @param request - The sentiment request body.
+     * @returns The sentiment response.
+     */
     updateSentiment(request: SentimentRequest): Promise<SentimentResponse>;
-    /** Get sentiment for a scan report. */
+    /**
+     * Get sentiment for a scan report.
+     * @param jobId - The job UUID.
+     * @returns The sentiment response.
+     */
     getSentiment(jobId: string): Promise<SentimentResponse>;
-    /** Get management dashboard overview. */
+    /**
+     * Get management dashboard overview.
+     * @returns The dashboard overview response.
+     */
     getDashboardOverview(): Promise<DashboardOverviewResponse>;
 }