cloudflare/resources/rules/lists/bulk-operations.d.ts

The official TypeScript library for the Cloudflare API

import { APIResource } from "../../../resource.js";
import * as Core from "../../../core.js";
export declare class BulkOperations extends APIResource {
    /**
     * Gets the current status of an asynchronous operation on a list.
     *
     * The `status` property can have one of the following values: `pending`,
     * `running`, `completed`, or `failed`. If the status is `failed`, the `error`
     * property will contain a message describing the error.
     */
    get(accountIdentifier: string, operationId: string, options?: Core.RequestOptions): Core.APIPromise<BulkOperationGetResponse>;
}
/**
 * The current status of the asynchronous operation.
 */
export type OperationStatus = 'pending' | 'running' | 'completed' | 'failed';
export interface BulkOperationGetResponse {
    /**
     * The unique operation ID of the asynchronous action.
     */
    id: string;
    /**
     * The current status of the asynchronous operation.
     */
    status: OperationStatus;
    /**
     * The RFC 3339 timestamp of when the operation was completed.
     */
    completed?: string;
    /**
     * A message describing the error when the status is `failed`.
     */
    error?: string;
}
export declare namespace BulkOperations {
    export { type OperationStatus as OperationStatus, type BulkOperationGetResponse as BulkOperationGetResponse, };
}
//# sourceMappingURL=bulk-operations.d.ts.map