cloudflare
Version:
The official TypeScript library for the Cloudflare API
84 lines • 2 kB
TypeScript
import { APIResource } from "../../core/resource.js";
import { APIPromise } from "../../core/api-promise.js";
import { RequestOptions } from "../../internal/request-options.js";
export declare class BaseMatches extends APIResource {
static readonly _key: readonly ['brandProtection', 'matches'];
/**
* Return matches as CSV for string queries based on ID
*/
download(params: MatchDownloadParams, options?: RequestOptions): APIPromise<MatchDownloadResponse>;
/**
* Return matches for string queries based on ID
*/
get(params: MatchGetParams, options?: RequestOptions): APIPromise<MatchGetResponse>;
}
export declare class Matches extends BaseMatches {
}
export interface MatchDownloadResponse {
matches?: Array<{
[key: string]: unknown;
}>;
total?: number;
}
export interface MatchGetResponse {
matches?: Array<{
[key: string]: unknown;
}>;
total?: number;
}
export interface MatchDownloadParams {
/**
* Path param
*/
account_id: string;
/**
* Query param
*/
id?: string;
/**
* Query param
*/
include_dismissed?: boolean;
/**
* Query param
*/
include_domain_id?: boolean;
/**
* Query param
*/
limit?: number;
/**
* Query param
*/
offset?: number;
}
export interface MatchGetParams {
/**
* Path param
*/
account_id: string;
/**
* Query param
*/
id?: string;
/**
* Query param
*/
include_dismissed?: boolean;
/**
* Query param
*/
include_domain_id?: boolean;
/**
* Query param
*/
limit?: number;
/**
* Query param
*/
offset?: number;
}
export declare namespace Matches {
export { type MatchDownloadResponse as MatchDownloadResponse, type MatchGetResponse as MatchGetResponse, type MatchDownloadParams as MatchDownloadParams, type MatchGetParams as MatchGetParams, };
}
//# sourceMappingURL=matches.d.ts.map