@piiano/vault-client/dist/generated/models/BulkObjectResult.d.ts

Piiano Vault generated typescript client

import type { rest_HTTPError } from './rest_HTTPError';
/**
 * A result object representing the processing of an object in the bulk operation.
 * Each result object includes there fields:
 * - `ok` a boolean that indicates whether the operation completed successfully for the object.
 * - `id` the unique identifier for the processed object.
 * This field might be omitted if the operation failed before an `id` was assigned to the object.
 * - `error` is present when `ok` is `false` and provides more information about any error.
 * The `error` field follows the same structure as the [error objects](/api/status-codes#error-response-schema) returned in single object operations.
 *
 */
export type BulkObjectResult = {
    /**
     * The unique identifier for the object.
     */
    id?: string;
    /**
     * Indicates whether the operation was completed successfully for this object.
     * If `true`, the operation completed successfully.
     * If `false`, the operation failed and the `error` field will contain more information.
     *
     */
    ok: boolean;
    error?: rest_HTTPError;
};
//# sourceMappingURL=BulkObjectResult.d.ts.map