cloudflare
Version:
The official TypeScript library for the Cloudflare API
57 lines • 1.85 kB
TypeScript
import { APIResource } from "../../resource.js";
import * as Core from "../../core.js";
import * as Shared from "../shared.js";
export declare class Miscategorizations extends APIResource {
/**
* Allows you to submit requests to change a domain’s category.
*/
create(params: MiscategorizationCreateParams, options?: Core.RequestOptions): Core.APIPromise<MiscategorizationCreateResponse>;
}
export interface MiscategorizationCreateResponse {
errors: Array<Shared.ResponseInfo>;
messages: Array<Shared.ResponseInfo>;
/**
* Whether the API call was successful
*/
success: true;
}
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