cloudflare/resources/cloudforce-one/binary-storage.d.mts

The official TypeScript library for the Cloudflare API

import { APIResource } from "../../core/resource.mjs";
import { APIPromise } from "../../core/api-promise.mjs";
import { type Uploadable } from "../../core/uploads.mjs";
import { RequestOptions } from "../../internal/request-options.mjs";
export declare class BaseBinaryStorage extends APIResource {
    static readonly _key: readonly ['cloudforceOne', 'binaryStorage'];
    /**
     * Uploads a binary file to Cloudforce One's binary database for malware analysis
     * and threat intelligence correlation.
     *
     * @example
     * ```ts
     * const binaryStorage =
     *   await client.cloudforceOne.binaryStorage.create({
     *     account_id: 'account_id',
     *     file: fs.createReadStream('path/to/file'),
     *   });
     * ```
     */
    create(params: BinaryStorageCreateParams, options?: RequestOptions): APIPromise<BinaryStorageCreateResponse>;
    /**
     * Retrieves a binary file from the Cloudforce One binary storage for analysis.
     *
     * @example
     * ```ts
     * await client.cloudforceOne.binaryStorage.get('hash', {
     *   account_id: 'account_id',
     * });
     * ```
     */
    get(hash: string, params: BinaryStorageGetParams, options?: RequestOptions): APIPromise<void>;
}
export declare class BinaryStorage extends BaseBinaryStorage {
}
export interface BinaryStorageCreateResponse {
    content_type: string;
    md5: string;
    sha1: string;
    sha256: string;
}
export interface BinaryStorageCreateParams {
    /**
     * Path param: Account ID.
     */
    account_id: string;
    /**
     * Body param: The binary file content to upload.
     */
    file: Uploadable;
}
export interface BinaryStorageGetParams {
    /**
     * Account ID.
     */
    account_id: string;
}
export declare namespace BinaryStorage {
    export { type BinaryStorageCreateResponse as BinaryStorageCreateResponse, type BinaryStorageCreateParams as BinaryStorageCreateParams, type BinaryStorageGetParams as BinaryStorageGetParams, };
}
//# sourceMappingURL=binary-storage.d.mts.map