cloudflare
Version:
The official TypeScript library for the Cloudflare API
64 lines • 1.9 kB
text/typescript
import { APIResource } from "../../../core/resource.mjs";
import { APIPromise } from "../../../core/api-promise.mjs";
import { RequestOptions } from "../../../internal/request-options.mjs";
export declare class BaseLogoMatches extends APIResource {
static readonly _key: readonly ['brandProtection', 'v2', 'logoMatches'];
/**
* Get paginated list of logo matches for a specific brand protection logo query
*/
get(params: LogoMatchGetParams, options?: RequestOptions): APIPromise<LogoMatchGetResponse>;
}
export declare class LogoMatches extends BaseLogoMatches {
}
export interface LogoMatchGetResponse {
matches: Array<LogoMatchGetResponse.Match>;
total: number;
}
export declare namespace LogoMatchGetResponse {
interface Match {
id: number;
domain: string | null;
matched_at: string | null;
query_id: number;
registrar: string | null;
similarity_score: number;
url_scan_id: string | null;
content_type?: string;
image_data?: string;
}
}
export interface LogoMatchGetParams {
/**
* Path param
*/
account_id: string;
/**
* Query param
*/
query_id: string;
/**
* Query param
*/
download?: string;
/**
* Query param
*/
limit?: string;
/**
* Query param
*/
offset?: string;
/**
* Query param: Sort order. Options: 'asc' (ascending) or 'desc' (descending)
*/
order?: 'asc' | 'desc';
/**
* Query param: Column to sort by. Options: 'matchedAt', 'domain',
* 'similarityScore', or 'registrar'
*/
orderBy?: 'matchedAt' | 'domain' | 'similarityScore' | 'registrar';
}
export declare namespace LogoMatches {
export { type LogoMatchGetResponse as LogoMatchGetResponse, type LogoMatchGetParams as LogoMatchGetParams };
}
//# sourceMappingURL=logo-matches.d.mts.map