cloudflare/resources/intel/miscategorizations.d.ts

The official TypeScript library for the Cloudflare API

import { APIResource } from "../../core/resource.js";
import { APIPromise } from "../../core/api-promise.js";
import { RequestOptions } from "../../internal/request-options.js";
export declare class BaseMiscategorizations extends APIResource {
    static readonly _key: readonly ['intel', 'miscategorizations'];
    /**
     * Allows you to submit requests to change a domain’s category.
     *
     * Requests that include category `169` (New Domains) or category `177` (Newly
     * Seen) in any of `content_adds`, `content_removes`, `security_adds`, or
     * `security_removes` will be rejected with a `400 Bad Request`. These categories
     * are automatically managed and fall off 30 days after they are applied.
     *
     * @example
     * ```ts
     * const miscategorization =
     *   await client.intel.miscategorizations.create({
     *     account_id: '023e105f4ecef8ad9ca31a8372d0c353',
     *   });
     * ```
     */
    create(params: MiscategorizationCreateParams, options?: RequestOptions): APIPromise<MiscategorizationCreateResponse>;
}
export declare class Miscategorizations extends BaseMiscategorizations {
}
export interface MiscategorizationCreateResponse {
    errors: Array<MiscategorizationCreateResponse.Error>;
    messages: Array<MiscategorizationCreateResponse.Message>;
    /**
     * Whether the API call was successful.
     */
    success: true;
}
export declare namespace MiscategorizationCreateResponse {
    interface Error {
        code: number;
        message: string;
        documentation_url?: string;
        source?: Error.Source;
    }
    namespace Error {
        interface Source {
            pointer?: string;
        }
    }
    interface Message {
        code: number;
        message: string;
        documentation_url?: string;
        source?: Message.Source;
    }
    namespace Message {
        interface Source {
            pointer?: string;
        }
    }
}
export interface MiscategorizationCreateParams {
    /**
     * Path param: Identifier.
     */
    account_id: string;
    /**
     * Body param: Content category IDs to add.
     */
    content_adds?: Array<number>;
    /**
     * Body param: Content category IDs to remove.
     */
    content_removes?: Array<number>;
    /**
     * Body param
     */
    indicator_type?: 'domain' | 'ipv4' | 'ipv6' | 'url';
    /**
     * Body param: Provide only if indicator_type is `ipv4` or `ipv6`.
     */
    ip?: string | null;
    /**
     * Body param: Security category IDs to add.
     */
    security_adds?: Array<number>;
    /**
     * Body param: Security category IDs to remove.
     */
    security_removes?: Array<number>;
    /**
     * Body param: Provide only if indicator_type is `domain` or `url`. Example if
     * indicator_type is `domain`: `example.com`. Example if indicator_type is `url`:
     * `https://example.com/news/`.
     */
    url?: string;
}
export declare namespace Miscategorizations {
    export { type MiscategorizationCreateResponse as MiscategorizationCreateResponse, type MiscategorizationCreateParams as MiscategorizationCreateParams, };
}
//# sourceMappingURL=miscategorizations.d.ts.map