cloudflare/resources/kv/namespaces/bulk.d.ts

The official TypeScript library for the Cloudflare API

import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import * as BulkAPI from 'cloudflare/resources/kv/namespaces/bulk';
export declare class Bulk extends APIResource {
    /**
     * Write multiple keys and values at once. Body should be an array of up to 10,000
     * key-value pairs to be stored, along with optional expiration information.
     * Existing values and expirations will be overwritten. If neither `expiration` nor
     * `expiration_ttl` is specified, the key-value pair will never expire. If both are
     * set, `expiration_ttl` is used and `expiration` is ignored. The entire request
     * size must be 100 megabytes or less.
     */
    update(namespaceId: string, params: BulkUpdateParams, options?: Core.RequestOptions): Core.APIPromise<BulkUpdateResponse>;
    /**
     * Remove multiple KV pairs from the namespace. Body should be an array of up to
     * 10,000 keys to be removed.
     */
    delete(namespaceId: string, params: BulkDeleteParams, options?: Core.RequestOptions): Core.APIPromise<BulkDeleteResponse>;
}
export type BulkUpdateResponse = unknown | string;
export type BulkDeleteResponse = unknown | string;
export interface BulkUpdateParams {
    /**
     * Path param: Identifier
     */
    account_id: string;
    /**
     * Body param:
     */
    body: Array<BulkUpdateParams.Body>;
}
export declare namespace BulkUpdateParams {
    interface Body {
        /**
         * Whether or not the server should base64 decode the value before storing it.
         * Useful for writing values that wouldn't otherwise be valid JSON strings, such as
         * images.
         */
        base64?: boolean;
        /**
         * The time, measured in number of seconds since the UNIX epoch, at which the key
         * should expire.
         */
        expiration?: number;
        /**
         * The number of seconds for which the key should be visible before it expires. At
         * least 60.
         */
        expiration_ttl?: number;
        /**
         * A key's name. The name may be at most 512 bytes. All printable, non-whitespace
         * characters are valid.
         */
        key?: string;
        /**
         * Arbitrary JSON that is associated with a key.
         */
        metadata?: unknown;
        /**
         * A UTF-8 encoded string to be stored, up to 25 MiB in length.
         */
        value?: string;
    }
}
export interface BulkDeleteParams {
    /**
     * Path param: Identifier
     */
    account_id: string;
    /**
     * Body param:
     */
    body: Array<string>;
}
export declare namespace Bulk {
    export import BulkUpdateResponse = BulkAPI.BulkUpdateResponse;
    export import BulkDeleteResponse = BulkAPI.BulkDeleteResponse;
    export import BulkUpdateParams = BulkAPI.BulkUpdateParams;
    export import BulkDeleteParams = BulkAPI.BulkDeleteParams;
}
//# sourceMappingURL=bulk.d.ts.map