sailpoint-api-client 2.0.7 → 2.0.9

package/dist/prompt_insights/api.d.ts

@@ -1,367 +0,0 @@
-/**
- * Identity Security Cloud API - Prompt Insights
- * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.
- *
- * The version of the OpenAPI document: v1
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-import type { Configuration } from '../configuration';
-import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
-import type { RequestArgs } from './base';
-import { BaseAPI } from './base';
-/**
- *
- * @export
- * @interface Errormessagedto
- */
-export interface Errormessagedto {
-    /**
-     * The locale for the message text, a BCP 47 language tag.
-     * @type {string}
-     * @memberof Errormessagedto
-     */
-    'locale'?: string | null;
-    /**
-     *
-     * @type {Localeorigin}
-     * @memberof Errormessagedto
-     */
-    'localeOrigin'?: Localeorigin | null;
-    /**
-     * Actual text of the error message in the indicated locale.
-     * @type {string}
-     * @memberof Errormessagedto
-     */
-    'text'?: string;
-}
-/**
- *
- * @export
- * @interface Errorresponsedto
- */
-export interface Errorresponsedto {
-    /**
-     * Fine-grained error code providing more detail of the error.
-     * @type {string}
-     * @memberof Errorresponsedto
-     */
-    'detailCode'?: string;
-    /**
-     * Unique tracking id for the error.
-     * @type {string}
-     * @memberof Errorresponsedto
-     */
-    'trackingId'?: string;
-    /**
-     * Generic localized reason for error
-     * @type {Array<Errormessagedto>}
-     * @memberof Errorresponsedto
-     */
-    'messages'?: Array<Errormessagedto>;
-    /**
-     * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
-     * @type {Array<Errormessagedto>}
-     * @memberof Errorresponsedto
-     */
-    'causes'?: Array<Errormessagedto>;
-}
-/**
- *
- * @export
- * @interface GetPromptInsightsMetricsV1401Response
- */
-export interface GetPromptInsightsMetricsV1401Response {
-    /**
-     * A message describing the error
-     * @type {any}
-     * @memberof GetPromptInsightsMetricsV1401Response
-     */
-    'error'?: any;
-}
-/**
- *
- * @export
- * @interface GetPromptInsightsMetricsV1429Response
- */
-export interface GetPromptInsightsMetricsV1429Response {
-    /**
-     * A message describing the error
-     * @type {any}
-     * @memberof GetPromptInsightsMetricsV1429Response
-     */
-    'message'?: any;
-}
-/**
- * An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.
- * @export
- * @enum {string}
- */
-export declare const Localeorigin: {
-    readonly Default: "DEFAULT";
-    readonly Request: "REQUEST";
-};
-export type Localeorigin = typeof Localeorigin[keyof typeof Localeorigin];
-/**
- * A prompt security insight event.
- * @export
- * @interface Promptinsight
- */
-export interface Promptinsight {
-    /**
-     * Event time in UTC.
-     * @type {string}
-     * @memberof Promptinsight
-     */
-    'timestamp'?: string;
-    /**
-     * User identifier or display name.
-     * @type {string}
-     * @memberof Promptinsight
-     */
-    'user'?: string;
-    /**
-     * The AI agent that processed the prompt.
-     * @type {string}
-     * @memberof Promptinsight
-     */
-    'agent'?: string;
-    /**
-     * The policy decision applied to the prompt.
-     * @type {string}
-     * @memberof Promptinsight
-     */
-    'policyDecision'?: PromptinsightPolicyDecisionEnum;
-    /**
-     * The category of the prompt security finding.
-     * @type {string}
-     * @memberof Promptinsight
-     */
-    'category'?: PromptinsightCategoryEnum;
-    /**
-     * The severity of the prompt security finding.
-     * @type {string}
-     * @memberof Promptinsight
-     */
-    'severity'?: PromptinsightSeverityEnum;
-    /**
-     * Human-readable or structured reason for the policy decision.
-     * @type {string}
-     * @memberof Promptinsight
-     */
-    'reason'?: string;
-    /**
-     * The rule that matched the prompt.
-     * @type {string}
-     * @memberof Promptinsight
-     */
-    'rule'?: string;
-    /**
-     * The policy that matched the prompt.
-     * @type {string}
-     * @memberof Promptinsight
-     */
-    'policy'?: string;
-}
-export declare const PromptinsightPolicyDecisionEnum: {
-    readonly Allowed: "ALLOWED";
-    readonly Redacted: "REDACTED";
-};
-export type PromptinsightPolicyDecisionEnum = typeof PromptinsightPolicyDecisionEnum[keyof typeof PromptinsightPolicyDecisionEnum];
-export declare const PromptinsightCategoryEnum: {
-    readonly Anomalies: "ANOMALIES";
-    readonly DataUploads: "DATA_UPLOADS";
-    readonly McpToolCalls: "MCP_TOOL_CALLS";
-};
-export type PromptinsightCategoryEnum = typeof PromptinsightCategoryEnum[keyof typeof PromptinsightCategoryEnum];
-export declare const PromptinsightSeverityEnum: {
-    readonly Low: "LOW";
-    readonly Medium: "MEDIUM";
-    readonly High: "HIGH";
-    readonly Critical: "CRITICAL";
-};
-export type PromptinsightSeverityEnum = typeof PromptinsightSeverityEnum[keyof typeof PromptinsightSeverityEnum];
-/**
- * Aggregate prompt insights metrics for the requested time window.
- * @export
- * @interface Promptinsightsmetrics
- */
-export interface Promptinsightsmetrics {
-    /**
-     * Count of prompts scanned in the interval.
-     * @type {number}
-     * @memberof Promptinsightsmetrics
-     */
-    'promptsScanned'?: number;
-    /**
-     * Count of prompts redacted in the interval.
-     * @type {number}
-     * @memberof Promptinsightsmetrics
-     */
-    'promptsRedacted'?: number;
-}
-/**
- * PromptInsightsApi - axios parameter creator
- * @export
- */
-export declare const PromptInsightsApiAxiosParamCreator: (configuration?: Configuration) => {
-    /**
-     * Returns aggregate prompt insights metrics for the requested time window.
-     * @summary Get prompt insights metrics
-     * @param {GetPromptInsightsMetricsV1IntervalEnum} interval Relative lookback window for metrics aggregation.
-     * @param {*} [axiosOptions] Override http request option.
-     * @throws {RequiredError}
-     */
-    getPromptInsightsMetricsV1: (interval: GetPromptInsightsMetricsV1IntervalEnum, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * Returns a paginated list of prompt insights within a lookback window, with optional structured filters. Results are sorted by timestamp descending (most recent first).
-     * @summary List prompt insights
-     * @param {ListPromptInsightsV1IntervalEnum} interval Relative lookback window for prompt insights.
-     * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
-     * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
-     * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)  Filtering is supported for the following fields and operators:  **policyDecision**: *eq*  **category**: *eq*  **severity**: *eq*  **user**: *eq, sw, co*  **agent**: *eq, sw, co*  **reason**: *eq, sw, co*  **rule**: *eq, sw, co*  **policy**: *eq, sw, co*
-     * @param {*} [axiosOptions] Override http request option.
-     * @throws {RequiredError}
-     */
-    listPromptInsightsV1: (interval: ListPromptInsightsV1IntervalEnum, limit?: number, offset?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-};
-/**
- * PromptInsightsApi - functional programming interface
- * @export
- */
-export declare const PromptInsightsApiFp: (configuration?: Configuration) => {
-    /**
-     * Returns aggregate prompt insights metrics for the requested time window.
-     * @summary Get prompt insights metrics
-     * @param {GetPromptInsightsMetricsV1IntervalEnum} interval Relative lookback window for metrics aggregation.
-     * @param {*} [axiosOptions] Override http request option.
-     * @throws {RequiredError}
-     */
-    getPromptInsightsMetricsV1(interval: GetPromptInsightsMetricsV1IntervalEnum, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Promptinsightsmetrics>>;
-    /**
-     * Returns a paginated list of prompt insights within a lookback window, with optional structured filters. Results are sorted by timestamp descending (most recent first).
-     * @summary List prompt insights
-     * @param {ListPromptInsightsV1IntervalEnum} interval Relative lookback window for prompt insights.
-     * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
-     * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
-     * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)  Filtering is supported for the following fields and operators:  **policyDecision**: *eq*  **category**: *eq*  **severity**: *eq*  **user**: *eq, sw, co*  **agent**: *eq, sw, co*  **reason**: *eq, sw, co*  **rule**: *eq, sw, co*  **policy**: *eq, sw, co*
-     * @param {*} [axiosOptions] Override http request option.
-     * @throws {RequiredError}
-     */
-    listPromptInsightsV1(interval: ListPromptInsightsV1IntervalEnum, limit?: number, offset?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Promptinsight>>>;
-};
-/**
- * PromptInsightsApi - factory interface
- * @export
- */
-export declare const PromptInsightsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
-    /**
-     * Returns aggregate prompt insights metrics for the requested time window.
-     * @summary Get prompt insights metrics
-     * @param {PromptInsightsApiGetPromptInsightsMetricsV1Request} requestParameters Request parameters.
-     * @param {*} [axiosOptions] Override http request option.
-     * @throws {RequiredError}
-     */
-    getPromptInsightsMetricsV1(requestParameters: PromptInsightsApiGetPromptInsightsMetricsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Promptinsightsmetrics>;
-    /**
-     * Returns a paginated list of prompt insights within a lookback window, with optional structured filters. Results are sorted by timestamp descending (most recent first).
-     * @summary List prompt insights
-     * @param {PromptInsightsApiListPromptInsightsV1Request} requestParameters Request parameters.
-     * @param {*} [axiosOptions] Override http request option.
-     * @throws {RequiredError}
-     */
-    listPromptInsightsV1(requestParameters: PromptInsightsApiListPromptInsightsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<Promptinsight>>;
-};
-/**
- * Request parameters for getPromptInsightsMetricsV1 operation in PromptInsightsApi.
- * @export
- * @interface PromptInsightsApiGetPromptInsightsMetricsV1Request
- */
-export interface PromptInsightsApiGetPromptInsightsMetricsV1Request {
-    /**
-     * Relative lookback window for metrics aggregation.
-     * @type {'-1h' | '-1d' | '-7d' | '-30d'}
-     * @memberof PromptInsightsApiGetPromptInsightsMetricsV1
-     */
-    readonly interval: GetPromptInsightsMetricsV1IntervalEnum;
-}
-/**
- * Request parameters for listPromptInsightsV1 operation in PromptInsightsApi.
- * @export
- * @interface PromptInsightsApiListPromptInsightsV1Request
- */
-export interface PromptInsightsApiListPromptInsightsV1Request {
-    /**
-     * Relative lookback window for prompt insights.
-     * @type {'-1h' | '-1d' | '-7d' | '-30d'}
-     * @memberof PromptInsightsApiListPromptInsightsV1
-     */
-    readonly interval: ListPromptInsightsV1IntervalEnum;
-    /**
-     * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
-     * @type {number}
-     * @memberof PromptInsightsApiListPromptInsightsV1
-     */
-    readonly limit?: number;
-    /**
-     * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
-     * @type {number}
-     * @memberof PromptInsightsApiListPromptInsightsV1
-     */
-    readonly offset?: number;
-    /**
-     * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)  Filtering is supported for the following fields and operators:  **policyDecision**: *eq*  **category**: *eq*  **severity**: *eq*  **user**: *eq, sw, co*  **agent**: *eq, sw, co*  **reason**: *eq, sw, co*  **rule**: *eq, sw, co*  **policy**: *eq, sw, co*
-     * @type {string}
-     * @memberof PromptInsightsApiListPromptInsightsV1
-     */
-    readonly filters?: string;
-}
-/**
- * PromptInsightsApi - object-oriented interface
- * @export
- * @class PromptInsightsApi
- * @extends {BaseAPI}
- */
-export declare class PromptInsightsApi extends BaseAPI {
-    /**
-     * Returns aggregate prompt insights metrics for the requested time window.
-     * @summary Get prompt insights metrics
-     * @param {PromptInsightsApiGetPromptInsightsMetricsV1Request} requestParameters Request parameters.
-     * @param {*} [axiosOptions] Override http request option.
-     * @throws {RequiredError}
-     * @memberof PromptInsightsApi
-     */
-    getPromptInsightsMetricsV1(requestParameters: PromptInsightsApiGetPromptInsightsMetricsV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Promptinsightsmetrics, any>>;
-    /**
-     * Returns a paginated list of prompt insights within a lookback window, with optional structured filters. Results are sorted by timestamp descending (most recent first).
-     * @summary List prompt insights
-     * @param {PromptInsightsApiListPromptInsightsV1Request} requestParameters Request parameters.
-     * @param {*} [axiosOptions] Override http request option.
-     * @throws {RequiredError}
-     * @memberof PromptInsightsApi
-     */
-    listPromptInsightsV1(requestParameters: PromptInsightsApiListPromptInsightsV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Promptinsight[], any>>;
-}
-/**
- * @export
- */
-export declare const GetPromptInsightsMetricsV1IntervalEnum: {
-    readonly _1h: "-1h";
-    readonly _1d: "-1d";
-    readonly _7d: "-7d";
-    readonly _30d: "-30d";
-};
-export type GetPromptInsightsMetricsV1IntervalEnum = typeof GetPromptInsightsMetricsV1IntervalEnum[keyof typeof GetPromptInsightsMetricsV1IntervalEnum];
-/**
- * @export
- */
-export declare const ListPromptInsightsV1IntervalEnum: {
-    readonly _1h: "-1h";
-    readonly _1d: "-1d";
-    readonly _7d: "-7d";
-    readonly _30d: "-30d";
-};
-export type ListPromptInsightsV1IntervalEnum = typeof ListPromptInsightsV1IntervalEnum[keyof typeof ListPromptInsightsV1IntervalEnum];