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

Piiano Vault generated typescript client

import type { Bundle } from '../models/Bundle';
import type { PartialBundle } from '../models/PartialBundle';
import type { CancelablePromise } from '../core/CancelablePromise';
import type { BaseHttpRequest } from '../core/BaseHttpRequest';
export declare class BundlesClient {
    readonly httpRequest: BaseHttpRequest;
    constructor(httpRequest: BaseHttpRequest);
    /**
     * List bundles
     * Lists the Vault bundles.
     *
     * The role that performs this operation must have the `CapCodeReader` capability.
     * See [Access control](/data-security/identity-and-access-management#access-control) for more information about how
     * capabilities control access to operations.
     * @returns Bundle The request is successful.
     * @throws ApiError
     */
    listBundles({ customAudit, additionalHeaders, }?: {
        /**
         * Custom audit information to be included in the audit log.
         */
        customAudit?: string;
        additionalHeaders?: Record<string, string>;
    }): CancelablePromise<Array<Bundle>>;
    /**
     * Add bundle
     * Adds a bundle.
     *
     * See [Create the bundles](/guides/create-custom-data-types/create-a-custom-data-type#create-the-bundles) in the Create a custom data type guide for more information on using this operation.
     *
     * The role performing this operation must have the `CapCodeWriter` capability.
     * See [Access control](/data-security/identity-and-access-management#access-control) for more information about how
     * capabilities control access to operations.
     * @returns Bundle The request is successful.
     * @throws ApiError
     */
    addBundle({ requestBody, customAudit, additionalHeaders, }: {
        /**
         * Details of the bundle including the code that defines the functions as properties of the exports object.
         */
        requestBody: Bundle;
        /**
         * Custom audit information to be included in the audit log.
         */
        customAudit?: string;
        additionalHeaders?: Record<string, string>;
    }): CancelablePromise<Bundle>;
    /**
     * Get bundle
     * Gets a bundle.
     *
     * The role that performs this operation must have the `CapCodeReader` capability.
     * See [Access control](/data-security/identity-and-access-management#access-control) for more information about how
     * capabilities control access to operations.
     * @returns Bundle The request is successful.
     * @throws ApiError
     */
    getBundle({ bundle, customAudit, additionalHeaders, }: {
        bundle: string;
        /**
         * Custom audit information to be included in the audit log.
         */
        customAudit?: string;
        additionalHeaders?: Record<string, string>;
    }): CancelablePromise<Bundle>;
    /**
     * Update bundle
     * Updates a bundle.
     *
     * An update is allowed only if the prototypes of the JavaScript functions in the request are a superset of those in the
     * bundle.
     * The name of the bundle can't be updated.
     *
     * The role performing this operation must have the `CapCodeWriter` capability.
     * See [Access control](/data-security/identity-and-access-management#access-control) for more information about how
     * capabilities control access to operations.
     * @returns Bundle The request is successful.
     * @throws ApiError
     */
    updateBundle({ bundle, requestBody, customAudit, additionalHeaders, }: {
        bundle: string;
        /**
         * Details of the bundle including the code that defines the functions as properties of the exports object. Name can't be updated.
         */
        requestBody: PartialBundle;
        /**
         * Custom audit information to be included in the audit log.
         */
        customAudit?: string;
        additionalHeaders?: Record<string, string>;
    }): CancelablePromise<Bundle>;
    /**
     * Delete bundle
     * Deletes a bundle.
     *
     * The role that performs this operation must have the `CapCodeWriter` capability.
     * See [Access control](/data-security/identity-and-access-management#access-control) for more information about how
     * capabilities control access to operations.
     * @returns any The request is successful.
     * @throws ApiError
     */
    deleteBundle({ bundle, customAudit, options, additionalHeaders, }: {
        bundle: string;
        /**
         * Custom audit information to be included in the audit log.
         */
        customAudit?: string;
        /**
         * Options for the operation. Options include:
         * - `force` – delete the bundle if there is an unused data type referencing it. An unused data type is one that is not used in any object schema. When the bundle is deleted, the data type referencing it is also deleted.
         *
         */
        options?: Array<'force'>;
        additionalHeaders?: Record<string, string>;
    }): CancelablePromise<any>;
}
//# sourceMappingURL=BundlesClient.d.ts.map