import * as S from "@distilled.cloud/core/schema"; import * as API from "@distilled.cloud/core/api"; import { type CloudflareOpError, type CloudflareOpContext } from "../protocol.ts"; import { ResultInfo } from "../pagination.ts"; export type { CloudflareOpError, CloudflareOpContext }; export type QueriesBulkRequestQueriesItemMap = { [key: string]: unknown | undefined; }; export declare const QueriesBulkRequestQueriesItemMap: S.Schema; export type QueriesBulkRequestQueriesList = Array; export declare const QueriesBulkRequestQueriesList: S.Schema; export interface BulkQueryRequest { accountId: string; queries?: QueriesBulkRequestQueriesList; } export declare const BulkQueryRequest: S.Schema; export interface BulkQueryResponse { } export declare const BulkQueryResponse: S.Schema; export interface CreateLogoRequest { accountId: string; matchType?: string; tag?: string; threshold?: number; } export declare const CreateLogoRequest: S.Schema; /** Raw response payload (operation does not use the standard v4 result envelope). */ export interface CreateLogoResponse { id?: number | null; tag?: string | null; uploadPath?: string | null; } export declare const CreateLogoResponse: S.Schema; export interface CreateQueryRequest { accountId: string; id?: string; scan?: boolean; tag?: string; maxTime?: string; minTime?: string; stringMatches?: unknown; bodyScan?: boolean; bodyTag?: string; } export declare const CreateQueryRequest: S.Schema; export interface CreateQueryResponse { } export declare const CreateQueryResponse: S.Schema; export interface CreateV2LogoRequest { accountId: string; /** Base64 encoded image data. Can include data URI prefix (e.g., 'data:image/png;base64,...') or just the base64 string. */ imageData: string; /** Minimum similarity score (0-1) required for visual matches */ similarityThreshold: number; /** Unique identifier for the logo query */ tag: string; /** If true, search historic scanned images for matches above the similarity threshold */ searchLookback?: boolean; } export declare const CreateV2LogoRequest: S.Schema; /** Raw response payload (operation does not use the standard v4 result envelope). */ export interface CreateV2LogoResponse { message: string; queryId?: number | null; } export declare const CreateV2LogoResponse: S.Schema; export interface DeleteLogoRequest { accountId: string; logoId: string; } export declare const DeleteLogoRequest: S.Schema; export interface DeleteLogoResponse { } export declare const DeleteLogoResponse: S.Schema; export interface DeleteQueryRequest { accountId: string; id?: string; scan?: boolean; tag?: string; } export declare const DeleteQueryRequest: S.Schema; export interface DeleteQueryResponse { } export declare const DeleteQueryResponse: S.Schema; export interface DeleteV2LogoRequest { accountId: string; queryId: string; } export declare const DeleteV2LogoRequest: S.Schema; /** Raw response payload (operation does not use the standard v4 result envelope). */ export interface DeleteV2LogoResponse { message: string; } export declare const DeleteV2LogoResponse: S.Schema; export type LogoMatchesDownloadRequestLogoIdList = Array; export declare const LogoMatchesDownloadRequestLogoIdList: S.Schema; export interface DownloadLogoMatchRequest { accountId: string; limit?: string; logoId?: LogoMatchesDownloadRequestLogoIdList; offset?: string; } export declare const DownloadLogoMatchRequest: S.Schema; export type LogoMatchesDownloadResponseMatchesItemMap = { [key: string]: unknown | undefined; }; export declare const LogoMatchesDownloadResponseMatchesItemMap: S.Schema; export type LogoMatchesDownloadResponseMatchesList = Array; export declare const LogoMatchesDownloadResponseMatchesList: S.Schema; /** Raw response payload (operation does not use the standard v4 result envelope). */ export interface DownloadLogoMatchResponse { matches?: LogoMatchesDownloadResponseMatchesList | null; total?: number | null; } export declare const DownloadLogoMatchResponse: S.Schema; export interface DownloadMatchRequest { accountId: string; id?: string; includeDomainId?: boolean; limit?: number; offset?: number; } export declare const DownloadMatchRequest: S.Schema; export type MatchesDownloadResponseMatchesItemMap = { [key: string]: unknown | undefined; }; export declare const MatchesDownloadResponseMatchesItemMap: S.Schema; export type MatchesDownloadResponseMatchesList = Array; export declare const MatchesDownloadResponseMatchesList: S.Schema; /** Raw response payload (operation does not use the standard v4 result envelope). */ export interface DownloadMatchResponse { matches?: MatchesDownloadResponseMatchesList | null; total?: number | null; } export declare const DownloadMatchResponse: S.Schema; export type LogoMatchesGetRequestLogoIdList = Array; export declare const LogoMatchesGetRequestLogoIdList: S.Schema; export interface GetLogoMatchRequest { accountId: string; limit?: string; logoId?: LogoMatchesGetRequestLogoIdList; offset?: string; } export declare const GetLogoMatchRequest: S.Schema; export type LogoMatchesGetResponseMatchesItemMap = { [key: string]: unknown | undefined; }; export declare const LogoMatchesGetResponseMatchesItemMap: S.Schema; export type LogoMatchesGetResponseMatchesList = Array; export declare const LogoMatchesGetResponseMatchesList: S.Schema; /** Raw response payload (operation does not use the standard v4 result envelope). */ export interface GetLogoMatchResponse { matches?: LogoMatchesGetResponseMatchesList | null; total?: number | null; } export declare const GetLogoMatchResponse: S.Schema; export interface GetMatchRequest { accountId: string; id?: string; includeDomainId?: boolean; limit?: number; offset?: number; } export declare const GetMatchRequest: S.Schema; export type MatchesGetResponseMatchesItemMap = { [key: string]: unknown | undefined; }; export declare const MatchesGetResponseMatchesItemMap: S.Schema; export type MatchesGetResponseMatchesList = Array; export declare const MatchesGetResponseMatchesList: S.Schema; /** Raw response payload (operation does not use the standard v4 result envelope). */ export interface GetMatchResponse { matches?: MatchesGetResponseMatchesList | null; total?: number | null; } export declare const GetMatchResponse: S.Schema; export interface GetV2LogoRequest { accountId: string; /** Optional query ID to retrieve a specific logo query */ id?: string; /** If true, include base64-encoded image data in the response */ download?: string; } export declare const GetV2LogoRequest: S.Schema; /** Raw response payload (operation does not use the standard v4 result envelope). */ export interface GetV2LogoResponse { id: number; r2Path: string; similarityThreshold: number; tag: string; uploadedAt: string; /** MIME type of the image (only present when download=true) */ contentType?: string | null; /** Base64-encoded image data (only present when download=true) */ imageData?: string | null; } export declare const GetV2LogoResponse: S.Schema; export type V2LogoMatchesGetRequestOrder = "asc" | "desc"; export declare const V2LogoMatchesGetRequestOrder: any; export type V2LogoMatchesGetRequestOrderBy = "matchedAt" | "domain" | "similarityScore" | "registrar"; export declare const V2LogoMatchesGetRequestOrderBy: any; export interface GetV2LogoMatchRequest { accountId: string; queryId: string; download?: string; limit?: string; offset?: string; /** Sort order. Options: 'asc' (ascending) or 'desc' (descending) */ order?: V2LogoMatchesGetRequestOrder | (string & {}); /** Column to sort by. Options: 'matchedAt', 'domain', 'similarityScore', or 'registrar' */ orderBy?: V2LogoMatchesGetRequestOrderBy | (string & {}); } export declare const GetV2LogoMatchRequest: S.Schema; export interface V2LogoMatchesGetResponseMatchesItem { id: number; domain: string; matchedAt: string; queryId: number; registrar: string; similarityScore: number; urlScanId: string; contentType?: string | null; imageData?: string | null; } export declare const V2LogoMatchesGetResponseMatchesItem: S.Schema; export type V2LogoMatchesGetResponseMatchesList = Array; export declare const V2LogoMatchesGetResponseMatchesList: S.Schema; /** Raw response payload (operation does not use the standard v4 result envelope). */ export interface GetV2LogoMatchResponse { matches: V2LogoMatchesGetResponseMatchesList; total: number; } export declare const GetV2LogoMatchResponse: S.Schema; export type V2MatchesGetRequestQueryIdList = Array; export declare const V2MatchesGetRequestQueryIdList: S.Schema; export type V2MatchesGetRequestOrder = "asc" | "desc"; export declare const V2MatchesGetRequestOrder: any; export type V2MatchesGetRequestOrderBy = "domain" | "first_seen" | "registrar"; export declare const V2MatchesGetRequestOrderBy: any; export interface GetV2MatchRequest { accountId: string; /** Query ID or comma-separated list of Query IDs. When multiple IDs are provided, matches are deduplicated across queries and each match includes a match_details array with per-match query metadata and dismissed state. */ queryId: V2MatchesGetRequestQueryIdList; /** Filter matches by domain name (substring match) */ domainSearch?: string; includeDismissed?: string; includeDomainId?: string; limit?: string; offset?: string; /** Sort order. Options: 'asc' (ascending) or 'desc' (descending) */ order?: V2MatchesGetRequestOrder | (string & {}); /** Column to sort by. Options: 'domain', 'first_seen', or 'registrar' */ orderBy?: V2MatchesGetRequestOrderBy | (string & {}); } export declare const GetV2MatchRequest: S.Schema; export interface V2MatchesGetResponseMatchesItemPublicScans { submissionId: string; } export declare const V2MatchesGetResponseMatchesItemPublicScans: S.Schema; export interface V2MatchesGetResponseMatchesItemMatchDetailsItem { /** Individual dismissed state for this specific match. */ dismissed: boolean; matchId: number; queryId: number; /** Tag associated with the query, if one exists. */ queryTag: string; } export declare const V2MatchesGetResponseMatchesItemMatchDetailsItem: S.Schema; export type V2MatchesGetResponseMatchesItemMatchDetailsList = Array; export declare const V2MatchesGetResponseMatchesItemMatchDetailsList: S.Schema; export interface V2MatchesGetResponseMatchesItem { domain: string; firstSeen: string; publicScans: V2MatchesGetResponseMatchesItemPublicScans; registrar: string; scanStatus: string; scanSubmissionId: number; source: string; /** Whether the match is dismissed. Only present for single-query requests. For multi-query requests, use the dismissed field in each match_details entry. */ dismissed?: boolean | null; /** Per-match detail objects with query metadata and individual dismissed state. Only present when multiple query_ids are requested. */ matchDetails?: V2MatchesGetResponseMatchesItemMatchDetailsList | null; } export declare const V2MatchesGetResponseMatchesItem: S.Schema; export type V2MatchesGetResponseMatchesList = Array; export declare const V2MatchesGetResponseMatchesList: S.Schema; /** Raw response payload (operation does not use the standard v4 result envelope). */ export interface GetV2MatchResponse { matches: V2MatchesGetResponseMatchesList; total: number; } export declare const GetV2MatchResponse: S.Schema; export interface GetV2QueryRequest { accountId: string; id?: string; } export declare const GetV2QueryRequest: S.Schema; export interface V2QueriesGetResponseParametersStringMatchesItem { pattern: string; } export declare const V2QueriesGetResponseParametersStringMatchesItem: S.Schema; export type V2QueriesGetResponseParametersStringMatchesList = Array; export declare const V2QueriesGetResponseParametersStringMatchesList: S.Schema; export interface V2QueriesGetResponseParameters { stringMatches: V2QueriesGetResponseParametersStringMatchesList; maxTime?: string | null; minTime?: string | null; } export declare const V2QueriesGetResponseParameters: S.Schema; /** Raw response payload (operation does not use the standard v4 result envelope). */ export interface GetV2QueryResponse { created: string; parameters: V2QueriesGetResponseParameters; queryId: number; queryTag: string; scan: boolean; updated: string; } export declare const GetV2QueryResponse: S.Schema; export interface SubmitBrandProtectionRequest { accountId: string; } export declare const SubmitBrandProtectionRequest: S.Schema; export type SubmitResponseSkippedUrlsItemMap = { [key: string]: unknown | undefined; }; export declare const SubmitResponseSkippedUrlsItemMap: S.Schema; export type SubmitResponseSkippedUrlsList = Array; export declare const SubmitResponseSkippedUrlsList: S.Schema; export type SubmitResponseSubmittedUrlsItemMap = { [key: string]: unknown | undefined; }; export declare const SubmitResponseSubmittedUrlsItemMap: S.Schema; export type SubmitResponseSubmittedUrlsList = Array; export declare const SubmitResponseSubmittedUrlsList: S.Schema; /** Raw response payload (operation does not use the standard v4 result envelope). */ export interface SubmitBrandProtectionResponse { skippedUrls?: SubmitResponseSkippedUrlsList | null; submittedUrls?: SubmitResponseSubmittedUrlsList | null; } export declare const SubmitBrandProtectionResponse: S.Schema; export interface UrlInfoBrandProtectionRequest { accountId: string; } export declare const UrlInfoBrandProtectionRequest: S.Schema; export type UrlInfoResultItemMap = { [key: string]: unknown | undefined; }; export declare const UrlInfoResultItemMap: S.Schema; export type UrlInfoResultList = Array; export declare const UrlInfoResultList: S.Schema; export interface UrlInfoBrandProtectionResponse { /** The unwrapped `result` payload of the v4 response envelope. */ result: UrlInfoResultList; /** Pagination info from the envelope's `result_info`. */ resultInfo?: ResultInfo | null; } export declare const UrlInfoBrandProtectionResponse: S.Schema; export type BulkQueryError = CloudflareOpError; /** Return a success message after creating new saved string queries in bulk */ export declare const bulkQuery: API.OperationMethod; export type CreateLogoError = CloudflareOpError; /** Return new saved logo queries created from image files */ export declare const createLogo: API.OperationMethod; export type CreateQueryError = CloudflareOpError; /** Return a success message after creating new saved string queries */ export declare const createQuery: API.OperationMethod; export type CreateV2LogoError = CloudflareOpError; /** Create a new saved brand protection logo query for visual similarity matching */ export declare const createV2Logo: API.OperationMethod; export type DeleteLogoError = CloudflareOpError; /** Return a success message after deleting saved logo queries by ID */ export declare const deleteLogo: API.OperationMethod; export type DeleteQueryError = CloudflareOpError; /** Return a success message after deleting saved string queries by ID */ export declare const deleteQuery: API.OperationMethod; export type DeleteV2LogoError = CloudflareOpError; /** Delete a saved brand protection logo query. Returns 404 if the query ID doesn't exist. */ export declare const deleteV2Logo: API.OperationMethod; export type DownloadLogoMatchError = CloudflareOpError; /** Return matches as CSV for logo queries based on ID */ export declare const downloadLogoMatch: API.OperationMethod; export type DownloadMatchError = CloudflareOpError; /** Return matches as CSV for string queries based on ID */ export declare const downloadMatch: API.OperationMethod; export type GetLogoMatchError = CloudflareOpError; /** Return matches for logo queries based on ID */ export declare const getLogoMatch: API.OperationMethod; export type GetMatchError = CloudflareOpError; /** Return matches for string queries based on ID */ export declare const getMatch: API.OperationMethod; export type GetV2LogoError = CloudflareOpError; /** Get all saved brand protection logo queries for an account. Optionally specify id to get a single query. Set download=true to include base64-encoded image data. */ export declare const getV2Logo: API.OperationMethod; export type GetV2LogoMatchError = CloudflareOpError; /** Get paginated list of logo matches for a specific brand protection logo query */ export declare const getV2LogoMatch: API.OperationMethod; export type GetV2MatchError = CloudflareOpError; /** Get paginated list of domain matches for one or more brand protection queries. When multiple query_ids are provided (comma-separated), matches are deduplicated across queries and each match includes a match_details array with per-match query metadata and individual dismissed state. */ export declare const getV2Match: API.OperationMethod; export type GetV2QueryError = CloudflareOpError; /** Get all saved brand protection queries for an account */ export declare const getV2Query: API.OperationMethod; export type SubmitBrandProtectionError = CloudflareOpError; /** Return new URL submissions */ export declare const submitBrandProtection: API.OperationMethod; export type UrlInfoBrandProtectionError = CloudflareOpError; /** Return submitted URLs based on ID */ export declare const urlInfoBrandProtection: API.PaginatedOperationMethod; //# sourceMappingURL=brand_protection.d.ts.map