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

Piiano Vault generated typescript client

import type { DataType } from '../models/DataType';
import type { CancelablePromise } from '../core/CancelablePromise';
import type { BaseHttpRequest } from '../core/BaseHttpRequest';
export declare class CustomDataTypesClient {
    readonly httpRequest: BaseHttpRequest;
    constructor(httpRequest: BaseHttpRequest);
    /**
     * List data types
     * Lists the Vault data types.
     *
     * See Data types for more information.
     *
     * The role that performs this operation must have the `CapTypesReader` capability.
     * See [Access control](/data-security/identity-and-access-management#access-control) for more information about how
     * capabilities are used to control access to operations.
     * @returns DataType The request is successful.
     * @throws ApiError
     */
    listDataTypes({ customAudit, bundle, options, additionalHeaders, }?: {
        /**
         * Custom audit information to be included in the audit log.
         */
        customAudit?: string;
        /**
         * If provided, return only types that depend on the bundle with the specified name.
         */
        bundle?: string;
        /**
         * Options for the operation. Options include:
         * - `show_builtins` – show built-in properties.
         *
         */
        options?: Array<'show_builtins'>;
        additionalHeaders?: Record<string, string>;
    }): CancelablePromise<Array<DataType>>;
    /**
     * Add data type
     * Adds a data type.
     *
     * The role performing this operation must have the `CapTypesWriter` capability.
     * See [Access control](/data-security/identity-and-access-management#access-control) for more information about how
     * capabilities are used to control access to operations.
     * @returns DataType The request is successful.
     * @throws ApiError
     */
    addDataType({ requestBody, customAudit, additionalHeaders, }: {
        /**
         * Details of the data type, including the names and locations of the JavaScript functions it uses.
         */
        requestBody: DataType;
        /**
         * Custom audit information to be included in the audit log.
         */
        customAudit?: string;
        additionalHeaders?: Record<string, string>;
    }): CancelablePromise<DataType>;
    /**
     * Get data type
     * Gets a data type.
     *
     * The role performing this operation must have the `CapTypesReader` capability.
     * See [Access control](/data-security/identity-and-access-management#access-control) for more information about how
     * capabilities are used to control access to operations.
     *
     * @returns DataType The request is successful.
     * @throws ApiError
     */
    getDataType({ type, customAudit, additionalHeaders, }: {
        type: string;
        /**
         * Custom audit information to be included in the audit log.
         */
        customAudit?: string;
        additionalHeaders?: Record<string, string>;
    }): CancelablePromise<DataType>;
    /**
     * Update data type
     * Updates a data type.
     *
     * The update includes:
     * - For built-in and custom data types, adding or removing custom transformers.
     * - For custom data types, updating the `description`, `default_transformer`, and `validator` attributes.
     *
     * :::note
     * - The update of `validator` is allowed only if the custom data type does not have a `normalizer`.
     * - Built-in transformers can not be added or removed.
     * - Custom transformers may be added or removed but must be exported by a loaded bundle.
     * :::
     *
     * @returns DataType The request is successful.
     * @throws ApiError
     */
    updateDataType({ type, requestBody, customAudit, additionalHeaders, }: {
        type: string;
        /**
         * Details of the properties to update for the data type, including the names and locations of the JavaScript functions it uses.
         */
        requestBody: DataType;
        /**
         * Custom audit information to be included in the audit log.
         */
        customAudit?: string;
        additionalHeaders?: Record<string, string>;
    }): CancelablePromise<DataType>;
    /**
     * Delete data type
     * Deletes a data type.
     *
     * The role that performs this operation must have the `CapTypesWriter` capability.
     * See [Access control](/data-security/identity-and-access-management#access-control) for more information about how
     * capabilities are used to control access to operations.
     * @returns any The request is successful.
     * @throws ApiError
     */
    deleteDataType({ type, customAudit, additionalHeaders, }: {
        type: string;
        /**
         * Custom audit information to be included in the audit log.
         */
        customAudit?: string;
        additionalHeaders?: Record<string, string>;
    }): CancelablePromise<any>;
}
//# sourceMappingURL=CustomDataTypesClient.d.ts.map