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

Piiano Vault generated typescript client

import type { BulkObjectResponse } from '../models/BulkObjectResponse';
import type { Count } from '../models/Count';
import type { ObjectFields } from '../models/ObjectFields';
import type { ObjectFieldsPage } from '../models/ObjectFieldsPage';
import type { ObjectID } from '../models/ObjectID';
import type { PropertyName } from '../models/PropertyName';
import type { Query } from '../models/Query';
import type { CancelablePromise } from '../core/CancelablePromise';
import type { BaseHttpRequest } from '../core/BaseHttpRequest';
export declare class ObjectsClient {
    readonly httpRequest: BaseHttpRequest;
    constructor(httpRequest: BaseHttpRequest);
    /**
     * Get object count
     * Gets the number of objects in a collection.
     *
     * The role performing this operation must have at least one allowing policy and no denying policies for the `stats` operation.
     *
     * See [identity and access management](/data-security/identity-and-access-management) for more information about how Vault uses policies to control access to data.
     * @returns Count The request is successful.
     * @throws ApiError
     */
    getObjectsCount({ collection, adhocReason, reason, customAudit, reloadCache, additionalHeaders, }: {
        /**
         * The name of the collection containing the objects.
         */
        collection: string;
        /**
         * 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;
        additionalHeaders?: Record<string, string>;
    }): CancelablePromise<Count>;
    /**
     * List objects
     * Returns a [paginated list](/api/api-pagination) of objects from a collection with all or a subset of object property values. To encrypt object property values, set export to true. Values are encrypted using the key specified in the [PVAULT_KMS_EXPORT_URI or PVAULT_KMS_EXPORT_SEED environment variables](/guides/configure/environment-variables#key-management-service).
     *
     * The role performing this operation must have both of the following:
     * - The `CapDataReader` capability.
     * - At least one allowing policy and no denying policies for the `read` operation for each of the properties and the
     * collection requested in the call.
     *
     * 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.
     *
     * **Warning**: Use of the `unsafe` option, to include all object property values, may expose more private information than is required, use with caution.
     * @returns ObjectFieldsPage The request is successful.
     * @throws ApiError
     */
    listObjects({ collection, adhocReason, reason, customAudit, reloadCache, pageSize, cursor, _export, xTransParam, xTenantId, ids, options, props, additionalHeaders, }: {
        collection: string;
        /**
         * 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 maximum number of items to return in this request. If not specified, the default value is used. The default value is specified in the [`PVAULT_SERVICE_DEFAULT_PAGE_SIZE` environment variable](/guides/configure/environment-variables#service-and-features). Must not exceed the value specified in the [`PVAULT_SERVICE_MAX_PAGE_SIZE` environment variable](/guides/configure/environment-variables#service-and-features).
         */
        pageSize?: number;
        /**
         * The cursor represents the state of consecutive queries for the same request parameters. In the first call, the cursor may be omitted or specified as an empty string. In consecutive calls, it should be set to the value of the cursor field of the objectFieldsPage returned by the previous call. Note: when the `id` is specified, paging is not supported. In this case, if the number of `id` values specified exceeds the maximum page size, the method returns 400 (BAD REQUEST).
         */
        cursor?: string;
        /**
         * Whether to encrypt the property values for export.
         */
        _export?: boolean;
        /**
         * Extra parameter to pass on to the transformers.
         */
        xTransParam?: string;
        /**
         * List of tenant IDs to enforce on the request.
         */
        xTenantId?: Array<string>;
        /**
         * A comma-separated list of object IDs
         */
        ids?: Array<string>;
        /**
         * Options for the operation. Options include:
         * - `archived` – whether to list only archived objects. If not specified, list only active objects.
         * - `show_builtins` – show built-in properties, can only be specified with `unsafe`.
         * - `unsafe` – fetch all the properties, cannot be specified with `props`.
         *
         */
        options?: Array<'unsafe' | 'show_builtins' | 'archived'>;
        /**
         * The list of property names and transformations. To include multiple names and transformations, provide a comma-separated list. For example, `props=first_name,last_name,email.mask`.
         */
        props?: Array<string>;
        additionalHeaders?: Record<string, string>;
    }): CancelablePromise<ObjectFieldsPage>;
    /**
     * Add object
     * Adds an object to a collection. The request must include all the non-nullable properties, as defined by the [collection schema](/api/operations/list-collection-properties).
     *
     * By default, accepts the object fields in JSON format. To pass a raw, unformatted value for a single property, set the `Content-Type` header to `application/octet-stream` and the property name in the `prop` query parameter.
     *
     * When adding an object from an external system that uses UUID IDs, you can include the object ID in the request to set the ID in Vault. For example, `"id","463a83d0-a816-4902-abba-2486e0c0a0bb"`. Vault normalizes the ID to lowercase.
     *
     * If the object to add is exported from an external system or Vault:
     * - set `import` to `true` to import values for the built-in properties `_creation_time`, `_modification_time`, and `_expiration_time`.
     * - if the data is encrypted, to decrypt the data provide the encryption key in `export_key`.
     *
     * The role performing this operation must have both of the following:
     * - The `CapDataWriter` or the `CapDataCreator` capability.
     * - At least one allowing policy and no denying policies for the `write` operation for each of the collection properties
     * provided in the call.
     *
     * 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.
     * @returns ObjectID The request is successful.
     * @throws ApiError
     */
    addObject({ collection, requestBody, adhocReason, reason, customAudit, reloadCache, xTenantId, expirationSecs, _import, exportKey, prop, additionalHeaders, }: {
        collection: string;
        /**
         * The object details.
         */
        requestBody: ObjectFields;
        /**
         * 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 tenant IDs to enforce on the request.
         */
        xTenantId?: Array<string>;
        /**
         * Object expiration time in seconds, cannot be set to 0. If not set, the default value is used. See the `PVAULT_EXPIRATION_ASSOCIATED_OBJECTS` and `PVAULT_EXPIRATION_UNASSOCIATED_OBJECTS` environment variables. If set to an empty value, the token will be marked to not expire.
         */
        expirationSecs?: string;
        /**
         * Whether to write built-in property values.
         */
        _import?: boolean;
        /**
         * The encrypted copy of the key used to encrypt exported data. The key is encrypted using the export KMS key defined by the [`PVAULT_KMS_EXPORT_URI` or `PVAULT_KMS_EXPORT_SEED` environment variables](/guides/configure/environment-variables#key-management-service). When importing data, the key is decrypted by the KMS, then used to decrypt the data. This parameter is not intended to be used manually, but through the CLI command `pvault import`.
         */
        exportKey?: string;
        prop?: PropertyName;
        additionalHeaders?: Record<string, string>;
    }): CancelablePromise<ObjectID>;
    /**
     * Get object
     * Returns an object from a collection with all or a subset of object property values.
     *
     * By default, returns the properties in JSON format. To get a single property's value without formatting, specify the property name in the `prop` query parameter, and set the `Accept` header to `application/octet-stream`.
     *
     * The role performing this operation must have both of the following:
     * - The `CapDataReader` capability.
     * - At least one allowing policy and no denying policies for the `read` operation for each of the properties and the
     * collection requested in the call.
     *
     * 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.
     *
     * **Warning**: Use of the `unsafe` option, to include all object property values, may expose more private information than is required, use with caution.
     * @returns ObjectFields The request is successful.
     * @throws ApiError
     */
    getObjectById({ collection, id, adhocReason, reason, customAudit, reloadCache, xTransParam, xTenantId, options, props, additionalHeaders, }: {
        collection: string;
        /**
         * The ID of the object.
         */
        id: string;
        /**
         * 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;
        /**
         * Extra parameter to pass on to the transformers.
         */
        xTransParam?: string;
        /**
         * List of tenant IDs to enforce on the request.
         */
        xTenantId?: Array<string>;
        /**
         * Options for the operation. Options include:
         * - `archived` – whether to list only archived objects. If not specified, list only active objects.
         * - `show_builtins` – show built-in properties, can only be specified with `unsafe`.
         * - `unsafe` – fetch all the properties, cannot be specified with `props`.
         *
         */
        options?: Array<'unsafe' | 'show_builtins' | 'archived'>;
        /**
         * The list of property names and transformations. To include multiple names and transformations, provide a comma-separated list. For example, `props=first_name,last_name,email.mask`.
         */
        props?: Array<string>;
        additionalHeaders?: Record<string, string>;
    }): CancelablePromise<ObjectFields>;
    /**
     * Update object
     * Updates properties of an object in a collection.
     *
     * By default, accepts the object fields in JSON format. To update a property using a raw, unformatted value, set the `Content-Type` header to `application/octet-stream`, and the a single property name in the `prop` query parameter.
     *
     * The role performing this operation must have both of the following:
     * - The `CapDataWriter` or the `CapDataUpdater` capability.
     * - At least one allowing policy and no denying policies for the `write` operation for each of the collection properties
     * specified in the call.
     *
     * 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.
     *
     * @returns any The request is successful.
     * @throws ApiError
     */
    updateObjectById({ collection, id, requestBody, adhocReason, reason, customAudit, reloadCache, xTenantId, expirationSecs, options, _import, exportKey, prop, additionalHeaders, }: {
        collection: string;
        /**
         * The ID of the object.
         */
        id: string;
        /**
         * The object properties to update.
         */
        requestBody: ObjectFields;
        /**
         * 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 tenant IDs to enforce on the request.
         */
        xTenantId?: Array<string>;
        /**
         * Object expiration time in seconds. If not set, the expiration will not be changed. See the `PVAULT_EXPIRATION_ASSOCIATED_OBJECTS` and `PVAULT_EXPIRATION_UNASSOCIATED_OBJECTS` environment variables. If set to an empty value, the object will be marked to not expire.
         */
        expirationSecs?: string;
        /**
         * Options for the operation. Options include:
         * - `archived` – whether to update only archived objects. If not specified, update only active objects.
         *
         */
        options?: Array<'archived'>;
        /**
         * Whether to write built-in property values.
         */
        _import?: boolean;
        /**
         * The encrypted copy of the key used to encrypt exported data. The key is encrypted using the export KMS key defined by the [`PVAULT_KMS_EXPORT_URI` or `PVAULT_KMS_EXPORT_SEED` environment variables](/guides/configure/environment-variables#key-management-service). When importing data, the key is decrypted by the KMS, then used to decrypt the data. This parameter is not intended to be used manually, but through the CLI command `pvault import`.
         */
        exportKey?: string;
        prop?: PropertyName;
        additionalHeaders?: Record<string, string>;
    }): CancelablePromise<any>;
    /**
     * Delete object
     * Deletes an object from a collection. This operation is irreversible.
     *
     * The role performing this operation must have both of the following:
     * - The `CapDataWriter` or the `CapDataDeleter` capability.
     * - At least one allowing policy and no denying policies for the `delete` operation for each of the properties defined for
     * the collection specified in the call.
     *
     *
     * 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.
     * @returns any The request is successful.
     * @throws ApiError
     */
    deleteObjectById({ collection, id, options, adhocReason, reason, customAudit, reloadCache, xTenantId, additionalHeaders, }: {
        collection: string;
        /**
         * The ID of the object.
         */
        id: string;
        /**
         * Options for the operation. Options include:
         * - `archived` – whether to delete only archived objects. If not specified, delete only active objects.
         *
         */
        options?: Array<'archived'>;
        /**
         * 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 tenant IDs to enforce on the request.
         */
        xTenantId?: Array<string>;
        additionalHeaders?: Record<string, string>;
    }): CancelablePromise<any>;
    /**
     * Add objects (bulk)
     * Adds objects to a collection. The request must include all the non-nullable properties for each object, as defined by the collection schema. Use the [list collection properties](/api/operations/list-collection-properties) operation to check the collection schema.
     *
     * By default, accepts the object fields in JSON format. To pass a raw, unformatted value for a single property, set the `Content-Type` header to `application/octet-stream` and the property name in the `prop` query parameter.
     *
     * When adding objects from an external system that uses UUID IDs, you can include the object IDs in the request to set the IDs in Vault. For example, `"id","463a83d0-a816-4902-abba-2486e0c0a0bb"`. Vault normalizes the IDs to lowercase.
     *
     * If the objects to add are exported from an external system or Vault:
     * - set `import` to `true` to import values for the built-in properties `_creation_time`, `_modification_time`, and `_expiration_time`.
     * - if the data is encrypted, to decrypt the data provide the encryption key in `export_key`.
     *
     * If any object add fails, the operation fails and no objects are added.
     *
     * The maximum number of objects that can be added in one operation is determined by the [`PVAULT_SERVICE_MAX_PAGE_SIZE` environment variable](/guides/configure/environment-variables#pvault_service_max_page_size).
     *
     * See the [add object](/api/operations/add-object) operation to add an object to a collection.
     *
     * The role performing this operation must have both of the following:
     * - The `CapDataWriter` or the `CapDataCreator` capability.
     * - For each object in the request, at least one allowing policy and no denying policies for the `write` operation for each object property.
     *
     * 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.
     *
     * @returns BulkObjectResponse The bulk operation is successful.
     * This status doesn't indicate that the operation is successful for all objects.
     * Check the response body for details of the status of each object.
     *
     * @throws ApiError
     */
    addObjects({ collection, requestBody, adhocReason, reason, customAudit, reloadCache, xTenantId, expirationSecs, _import, exportKey, prop, additionalHeaders, }: {
        collection: string;
        /**
         * List of objects to add.
         * The order of the objects in this array is preserved in the response.
         *
         */
        requestBody: Array<ObjectFields>;
        /**
         * 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 tenant IDs to enforce on the request.
         */
        xTenantId?: Array<string>;
        /**
         * Object expiration time in seconds, cannot be set to 0. If not set, the default value is used. See the `PVAULT_EXPIRATION_ASSOCIATED_OBJECTS` and `PVAULT_EXPIRATION_UNASSOCIATED_OBJECTS` environment variables. If set to an empty value, the objects will be marked to not expire.
         */
        expirationSecs?: string;
        /**
         * Whether to write built-in property values.
         */
        _import?: boolean;
        /**
         * The encrypted copy of the key used to encrypt exported data. The key is encrypted using the export KMS key defined by the [`PVAULT_KMS_EXPORT_URI` or `PVAULT_KMS_EXPORT_SEED` environment variables](/guides/configure/environment-variables#key-management-service). When importing data, the key is decrypted by the KMS, then used to decrypt the data. This parameter is not intended to be used manually, but through the CLI command `pvault import`.
         */
        exportKey?: string;
        prop?: PropertyName;
        additionalHeaders?: Record<string, string>;
    }): CancelablePromise<BulkObjectResponse>;
    /**
     * Update objects (bulk)
     * Updates properties of objects in a collection.
     *
     * If any object update fails, the operation fails and no objects are updated.
     *
     * The maximum number of objects that can be updated in one operation is determined by the [`PVAULT_SERVICE_MAX_PAGE_SIZE` environment variable](/guides/configure/environment-variables#pvault_service_max_page_size).
     *
     * The role performing this operation must have both of the following:
     * - The `CapDataWriter` or the `CapDataUpdater` capability.
     * - For each object in the request, at least one allowing policy and no denying policies for the `write` operation for each of the object's properties.
     *
     * 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.
     *
     * @returns BulkObjectResponse The bulk operation is successful.
     * This status doesn't indicate that the operation is successful for all objects.
     * Check the response body for details of the status of each object.
     *
     * @throws ApiError
     */
    updateObjects({ collection, expirationSecs, options, prop, adhocReason, reason, customAudit, reloadCache, _import, exportKey, xTenantId, requestBody, additionalHeaders, }: {
        collection: string;
        /**
         * Expiration time in seconds for the tokens. If not set, the expiry dates of the tokens are not changed.
         */
        expirationSecs?: string;
        /**
         * Options for the operation. Options include:
         * - `archived` – whether to update only archived objects. If not specified, updates only active objects.
         *
         */
        options?: Array<'archived'>;
        prop?: PropertyName;
        /**
         * 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;
        /**
         * Whether to write built-in property values.
         */
        _import?: boolean;
        /**
         * The encrypted copy of the key used to encrypt exported data. The key is encrypted using the export KMS key defined by the [`PVAULT_KMS_EXPORT_URI` or `PVAULT_KMS_EXPORT_SEED` environment variables](/guides/configure/environment-variables#key-management-service). When importing data, the key is decrypted by the KMS, then used to decrypt the data. This parameter is not intended to be used manually, but through the CLI command `pvault import`.
         */
        exportKey?: string;
        /**
         * List of tenant IDs to enforce on the request.
         */
        xTenantId?: Array<string>;
        /**
         * List of objects properties to update.
         * The order of the objects in the array is preserved in the response.
         *
         */
        requestBody?: Array<ObjectFields>;
        additionalHeaders?: Record<string, string>;
    }): CancelablePromise<BulkObjectResponse>;
    /**
     * Delete objects (bulk)
     * Deletes objects from a collection. This operation is irreversible.
     *
     * If any object delete fails, the operation fails and no objects are deleted.
     *
     * The maximum number of objects that can be deleted in one operation is determined by the [`PVAULT_SERVICE_MAX_PAGE_SIZE` environment variable](/guides/configure/environment-variables#pvault_service_max_page_size).
     *
     *
     * The role performing this operation must have both of the following:
     * - The `CapDataWriter` or the `CapDataDeleter` capability.
     * - At least one allowing policy and no denying policies for the `delete` operation for each of the properties defined for
     * the collection specified in the call.
     *
     * 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.
     *
     * @returns BulkObjectResponse The bulk operation is successful.
     * This status doesn't indicate that the operation is successful for all objects.
     * Check the response body for details of the status of each object.
     *
     * @throws ApiError
     */
    deleteObjects({ collection, options, adhocReason, reason, customAudit, reloadCache, xTenantId, requestBody, additionalHeaders, }: {
        collection: string;
        /**
         * Options for the operation. Options include:
         * - `archived` – whether to delete only archived objects. If not specified, deletes only active objects.
         *
         */
        options?: Array<'archived'>;
        /**
         * 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 tenant IDs to enforce on the request.
         */
        xTenantId?: Array<string>;
        /**
         * List of objects to delete.
         * The order of the objects in the array is preserved in the response.
         *
         */
        requestBody?: Array<ObjectID>;
        additionalHeaders?: Record<string, string>;
    }): CancelablePromise<BulkObjectResponse>;
    /**
     * Search objects
     * Returns a [paginated list](/api/api-pagination) of objects, with property values, from a collection that satisfies a query.
     *
     * You can read more about full-match searches in the [Search objects](/guides/write-and-read-personal-data/search-objects/string-search-objects) guide and about substring searches in the [Substring search objects](/guides/write-and-read-personal-data/search-objects/substring-search-objects) guide.
     *
     * The role performing this operation must have all the following:
     * - The `CapDataSearcher` capability.
     * - Policies:
     * + At least one allowing policy and no denying policies for the `read` operation for each of the collection properties
     * specified in the `props` query parameter.
     * + At least one allowing policy and no denying policies for the `search` operation for each of the collection
     * properties
     * specified in the `query` body parameter.
     *
     * 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.
     *
     * **Warning**: Use of the `unsafe` option, to include all object property values, may expose more private information than is required, use with caution..
     * @returns ObjectFieldsPage The request is successful.
     * @throws ApiError
     */
    searchObjects({ collection, requestBody, adhocReason, reason, customAudit, reloadCache, pageSize, cursor, xTransParam, xTenantId, options, props, additionalHeaders, }: {
        collection: string;
        /**
         * This is a JSON object consisting of maps in which the keys are property names.
         * The `in` map maps a property name to an array of possible values for that property.
         * The `match` map maps a property name to the required value for that property.
         * The `like` map maps a property name to a search pattern that the property value should match.
         * An object matches the query if the object meets the requirements of both maps.
         * For example:
         * ```json
         * {
           * "in": {
             * "email": ["john@work.com", "john@home.com"],
             * },
             * "match": {
               * "first_name": "John",
               * "last_name": "Doe"
               * }
               * }
               * ```
               * is equivalent to:
               * ```sql
               * WHERE first_name = 'John' AND last_name='Doe' AND email IN ('john@work.com', 'john@home.com')
               * ```
               *
               * Another example:
               * ```json
               * {
                 * "like": {
                   * "email": "*john*",
                   * },
                   * "match": {
                     * "region": "US"
                     * }
                     * }
                     * ```
                     * is equivalent to:
                     * ```sql
                     * WHERE email LIKE '%john%' AND region = 'US'
                     * ```
                     *
                     */
        requestBody: Query;
        /**
         * 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 maximum number of items to return in this request. If not specified, the default value is used. The default value is specified in the [`PVAULT_SERVICE_DEFAULT_PAGE_SIZE` environment variable](/guides/configure/environment-variables#service-and-features). Must not exceed the value specified in the [`PVAULT_SERVICE_MAX_PAGE_SIZE` environment variable](/guides/configure/environment-variables#service-and-features).
         */
        pageSize?: number;
        /**
         * The cursor represents the state of consecutive queries for the same request parameters. In the first call, the cursor may be omitted or specified as an empty string. In consecutive calls, it should be set to the value of the cursor field of the objectFieldsPage returned by the previous call. Note: when the `id` is specified, paging is not supported. In this case, if the number of `id` values specified exceeds the maximum page size, the method returns 400 (BAD REQUEST).
         */
        cursor?: string;
        /**
         * Extra parameter to pass on to the transformers.
         */
        xTransParam?: string;
        /**
         * List of tenant IDs to enforce on the request.
         */
        xTenantId?: Array<string>;
        /**
         * Options for the operation. Options include:
         * - `archived` – whether to search only archived objects. If not specified, search only active objects.
         * - `show_builtins` – show built-in properties, can only be specified with `unsafe`.
         * - `unsafe` – fetch all the properties, cannot be specified with `props`.
         *
         */
        options?: Array<'unsafe' | 'show_builtins' | 'archived'>;
        /**
         * The list of property names and transformations. To include multiple names and transformations, provide a comma-separated list. For example, `props=first_name,last_name,email.mask`.
         */
        props?: Array<string>;
        additionalHeaders?: Record<string, string>;
    }): CancelablePromise<ObjectFieldsPage>;
}
//# sourceMappingURL=ObjectsClient.d.ts.map