@piiano/vault-client/dist/generated/services/AnalysisClient.d.ts

Piiano Vault generated typescript client

import type { AnalysisContainsResponseBody } from '../models/AnalysisContainsResponseBody';
import type { AnalysisLocateResponseBody } from '../models/AnalysisLocateResponseBody';
import type { AnalysisRequest } from '../models/AnalysisRequest';
import type { CancelablePromise } from '../core/CancelablePromise';
import type { BaseHttpRequest } from '../core/BaseHttpRequest';
export declare class AnalysisClient {
    readonly httpRequest: BaseHttpRequest;
    constructor(httpRequest: BaseHttpRequest);
    /**
     * Contains PII data
     * Checks if text strings contain PII and classifies the findings.
     *
     * If you need to obtain details about the location of PII in your strings, use the [locate operation](/api/operations/analysis-locate).
     *
     * See the [Find PII](/guides/analyze-for-pii-data) guide for more information on using this operation.
     *
     * The role performing this operation must have the `CapAnalysisDetect` capability.
     *
     * See [identity and access management](/data-security/identity-and-access-management) for more information about how capabilities are used to control access to operations and policies are used to control access to data.
     * :::note
     * This operation uses AI to detect PII. As such, it's possible for PII to be missed or for non-PII text to be classified as PII.
     * :::
     * :::info
     * This feature is enabled on [Vault SaaS](/guides/install/hosted) only. If you're interested in running it with a self-hosted deployment, please [contact us](https://www.piiano.com/contact-us).
     * :::
     *
     * @returns AnalysisContainsResponseBody The request is successful.
     * @throws ApiError
     */
    analysisContains({ adhocReason, reason, customAudit, reloadCache, requestBody, additionalHeaders, }?: {
        /**
         * An ad-hoc reason for accessing the Vault data. Required when `reason` is set to `Other`.
         */
        adhocReason?: string;
        /**
         * Details of the reason for requesting the property. The default is set when no access reason is provided and PVAULT_SERVICE_FORCE_ACCESS_REASON is false.
         */
        reason?: 'AppFunctionality' | 'Analytics' | 'Notifications' | 'Marketing' | 'ThirdPartyMarketing' | 'FraudPreventionSecurityAndCompliance' | 'AccountManagement' | 'Maintenance' | 'DataSubjectRequest' | 'Other';
        /**
         * Custom audit information to be included in the audit log.
         */
        customAudit?: string;
        /**
         * Reloads the cache before the action.
         */
        reloadCache?: boolean;
        /**
         * List of the text strings to check for PII.
         */
        requestBody?: AnalysisRequest;
        additionalHeaders?: Record<string, string>;
    }): CancelablePromise<AnalysisContainsResponseBody>;
    /**
     * Locate PII data
     * Locates the positions of PII data in text strings and classifies the findings.
     *
     * If you only need an indication of whether your strings contain PII, use the [contains operation](/api/operations/analysis-contains).
     *
     * See the [Find PII](/guides/analyze-for-pii-data) guide for more information on using this operation.
     *
     * The role performing this operation must have the `CapAnalysisLocate` capability.
     *
     * See [identity and access management](/data-security/identity-and-access-management) for more information about how capabilities are used to control access to operations and policies are used to control access to data.
     *
     * :::info
     * This feature is enabled on [Vault SaaS](/guides/install/hosted) only. If you're interested in running it with a self-hosted deployment, please [contact us](https://www.piiano.com/contact-us).
     * :::
     *
     * @returns AnalysisLocateResponseBody The request is successful.
     * @throws ApiError
     */
    analysisLocate({ adhocReason, reason, customAudit, reloadCache, requestBody, additionalHeaders, }?: {
        /**
         * An ad-hoc reason for accessing the Vault data. Required when `reason` is set to `Other`.
         */
        adhocReason?: string;
        /**
         * Details of the reason for requesting the property. The default is set when no access reason is provided and PVAULT_SERVICE_FORCE_ACCESS_REASON is false.
         */
        reason?: 'AppFunctionality' | 'Analytics' | 'Notifications' | 'Marketing' | 'ThirdPartyMarketing' | 'FraudPreventionSecurityAndCompliance' | 'AccountManagement' | 'Maintenance' | 'DataSubjectRequest' | 'Other';
        /**
         * Custom audit information to be included in the audit log.
         */
        customAudit?: string;
        /**
         * Reloads the cache before the action.
         */
        reloadCache?: boolean;
        /**
         * The locate request.
         */
        requestBody?: AnalysisRequest;
        additionalHeaders?: Record<string, string>;
    }): CancelablePromise<AnalysisLocateResponseBody>;
}
//# sourceMappingURL=AnalysisClient.d.ts.map