import { APIResource } from "../../resource.js"; import * as Core from "../../core.js"; import * as LogoMatchesAPI from "./logo-matches.js"; import { LogoMatchDownloadParams, LogoMatchDownloadResponse, LogoMatchGetParams, LogoMatchGetResponse, LogoMatches } from "./logo-matches.js"; import * as LogosAPI from "./logos.js"; import { LogoCreateParams, LogoCreateResponse, LogoDeleteParams, Logos } from "./logos.js"; import * as MatchesAPI from "./matches.js"; import { MatchDownloadParams, MatchDownloadResponse, MatchGetParams, MatchGetResponse, Matches } from "./matches.js"; import * as QueriesAPI from "./queries.js"; import { Queries, QueryBulkParams, QueryCreateParams, QueryDeleteParams } from "./queries.js"; import { SinglePage } from "../../pagination.js"; export declare class BrandProtection extends APIResource { queries: QueriesAPI.Queries; matches: MatchesAPI.Matches; logos: LogosAPI.Logos; logoMatches: LogoMatchesAPI.LogoMatches; /** * Return new URL submissions */ submit(params: BrandProtectionSubmitParams, options?: Core.RequestOptions): Core.APIPromise; /** * Return submitted URLs based on ID */ urlInfo(params: BrandProtectionURLInfoParams, options?: Core.RequestOptions): Core.PagePromise; } export declare class BrandProtectionURLInfoResponsesSinglePage extends SinglePage { } export interface Info { /** * List of categorizations applied to this submission. */ categorizations?: Array; /** * List of model results for completed scans. */ model_results?: Array; /** * List of signatures that matched against site content found when crawling the * URL. */ rule_matches?: Array; /** * Status of the most recent scan found. */ scan_status?: Info.ScanStatus; /** * For internal use. */ screenshot_download_signature?: string; /** * For internal use. */ screenshot_path?: string; /** * URL that was submitted. */ url?: string; } export declare namespace Info { interface Categorization { /** * Name of the category applied. */ category?: string; /** * Result of human review for this categorization. */ verification_status?: string; } interface ModelResult { /** * Name of the model. */ model_name?: string; /** * This is the score that is outputted by the model for this submission. */ model_score?: number; } interface RuleMatch { /** * For internal use. */ banning?: boolean; /** * For internal use. */ blocking?: boolean; /** * Description of the signature that matched. */ description?: string; /** * Name of the signature that matched. */ name?: string; } /** * Status of the most recent scan found. */ interface ScanStatus { /** * Timestamp of when the submission was processed. */ last_processed?: string; /** * For internal use. */ scan_complete?: boolean; /** * Status code that the crawler received when loading the submitted URL. */ status_code?: number; /** * ID of the most recent submission. */ submission_id?: number; } } export interface Submit { /** * URLs that were excluded from scanning because their domain is in our no-scan * list. */ excluded_urls?: Array; /** * URLs that were skipped because the same URL is currently being scanned. */ skipped_urls?: Array; /** * URLs that were successfully submitted for scanning. */ submitted_urls?: Array; } export declare namespace Submit { interface ExcludedURL { /** * URL that was excluded. */ url?: string; } interface SkippedURL { /** * URL that was skipped. */ url?: string; /** * ID of the submission of that URL that is currently scanning. */ url_id?: number; } interface SubmittedURL { /** * URL that was submitted. */ url?: string; /** * ID assigned to this URL submission. Used to retrieve scanning results. */ url_id?: number; } } export interface BrandProtectionSubmitResponse { skipped_urls?: Array<{ [key: string]: unknown; }>; submitted_urls?: Array<{ [key: string]: unknown; }>; } export type BrandProtectionURLInfoResponse = { [key: string]: unknown; }; export interface BrandProtectionSubmitParams { account_id: string; } export interface BrandProtectionURLInfoParams { account_id: string; } export declare namespace BrandProtection { export { type Info as Info, type Submit as Submit, type BrandProtectionSubmitResponse as BrandProtectionSubmitResponse, type BrandProtectionURLInfoResponse as BrandProtectionURLInfoResponse, BrandProtectionURLInfoResponsesSinglePage as BrandProtectionURLInfoResponsesSinglePage, type BrandProtectionSubmitParams as BrandProtectionSubmitParams, type BrandProtectionURLInfoParams as BrandProtectionURLInfoParams, }; export { Queries as Queries, type QueryCreateParams as QueryCreateParams, type QueryDeleteParams as QueryDeleteParams, type QueryBulkParams as QueryBulkParams, }; export { Matches as Matches, type MatchDownloadResponse as MatchDownloadResponse, type MatchGetResponse as MatchGetResponse, type MatchDownloadParams as MatchDownloadParams, type MatchGetParams as MatchGetParams, }; export { Logos as Logos, type LogoCreateResponse as LogoCreateResponse, type LogoCreateParams as LogoCreateParams, type LogoDeleteParams as LogoDeleteParams, }; export { LogoMatches as LogoMatches, type LogoMatchDownloadResponse as LogoMatchDownloadResponse, type LogoMatchGetResponse as LogoMatchGetResponse, type LogoMatchDownloadParams as LogoMatchDownloadParams, type LogoMatchGetParams as LogoMatchGetParams, }; } //# sourceMappingURL=brand-protection.d.ts.map