@relentless-identity/sdk 1.0.0

package/dist/models/index.d.ts

@@ -0,0 +1,1265 @@
+/**
+ * Alias information when email is resolved to a different address.
+ * @export
+ * @interface AliasInfo
+ */
+export interface AliasInfo {
+    /**
+     *
+     * @type {string}
+     * @memberof AliasInfo
+     */
+    original?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AliasInfo
+     */
+    resolved?: string | null;
+}
+/**
+ *
+ * @export
+ * @interface BatchSummary
+ */
+export interface BatchSummary {
+    /**
+     * Total number of requested items.
+     * @type {number}
+     * @memberof BatchSummary
+     */
+    total: number;
+    /**
+     * Items that resolved to a positive deliverable result.
+     * @type {number}
+     * @memberof BatchSummary
+     */
+    found: number;
+    /**
+     * Items that completed cleanly with a negative result.
+     * @type {number}
+     * @memberof BatchSummary
+     */
+    notFound: number;
+    /**
+     * Items that ended with an operational verification error rather than a mailbox verdict.
+     * @type {number}
+     * @memberof BatchSummary
+     */
+    errors: number;
+    /**
+     * Distinct mailbox domains represented in the batch.
+     * @type {number}
+     * @memberof BatchSummary
+     */
+    uniqueDomains: number;
+}
+/**
+ * Background job detail plus paginated item results.
+ * @export
+ * @interface ClientBackgroundJobDetailResponse
+ */
+export interface ClientBackgroundJobDetailResponse {
+    /**
+     *
+     * @type {ClientBackgroundJobResponse}
+     * @memberof ClientBackgroundJobDetailResponse
+     */
+    job: ClientBackgroundJobResponse;
+    /**
+     *
+     * @type {Array<ClientBackgroundJobItemResponse>}
+     * @memberof ClientBackgroundJobDetailResponse
+     */
+    items: Array<ClientBackgroundJobItemResponse>;
+    /**
+     *
+     * @type {number}
+     * @memberof ClientBackgroundJobDetailResponse
+     */
+    totalItems: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ClientBackgroundJobDetailResponse
+     */
+    page: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ClientBackgroundJobDetailResponse
+     */
+    pageSize: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ClientBackgroundJobDetailResponse
+     */
+    totalPages: number;
+    /**
+     * Whether the stored item payload rows have already expired and been pruned.
+     * @type {boolean}
+     * @memberof ClientBackgroundJobDetailResponse
+     */
+    resultsExpired?: boolean;
+}
+/**
+ * One item inside a background job payload.
+ * @export
+ * @interface ClientBackgroundJobItemResponse
+ */
+export interface ClientBackgroundJobItemResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof ClientBackgroundJobItemResponse
+     */
+    id: string;
+    /**
+     *
+     * @type {number}
+     * @memberof ClientBackgroundJobItemResponse
+     */
+    itemIndex: number;
+    /**
+     *
+     * @type {ClientBackgroundJobItemResponseStatusEnum}
+     * @memberof ClientBackgroundJobItemResponse
+     */
+    status: ClientBackgroundJobItemResponseStatusEnum;
+    /**
+     *
+     * @type {ClientBackgroundJobItemResponseRequestTypeEnum}
+     * @memberof ClientBackgroundJobItemResponse
+     */
+    requestType: ClientBackgroundJobItemResponseRequestTypeEnum;
+    /**
+     * Original submitted input for this item.
+     * @type {{ [key: string]: any; }}
+     * @memberof ClientBackgroundJobItemResponse
+     */
+    input: {
+        [key: string]: any;
+    };
+    /**
+     *
+     * @type {{ [key: string]: any; }}
+     * @memberof ClientBackgroundJobItemResponse
+     */
+    result?: {
+        [key: string]: any;
+    } | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ClientBackgroundJobItemResponse
+     */
+    resultState?: string | null;
+    /**
+     *
+     * @type {ClientBackgroundJobItemResponseResultOutcomeEnum}
+     * @memberof ClientBackgroundJobItemResponse
+     */
+    resultOutcome?: ClientBackgroundJobItemResponseResultOutcomeEnum | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ClientBackgroundJobItemResponse
+     */
+    resolvedAddress?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ClientBackgroundJobItemResponse
+     */
+    provider?: string | null;
+    /**
+     *
+     * @type {number}
+     * @memberof ClientBackgroundJobItemResponse
+     */
+    chargeMicros?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof ClientBackgroundJobItemResponse
+     */
+    errorMessage?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ClientBackgroundJobItemResponse
+     */
+    startedAt?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ClientBackgroundJobItemResponse
+     */
+    completedAt?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ClientBackgroundJobItemResponse
+     */
+    createdAt: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ClientBackgroundJobItemResponse
+     */
+    updatedAt: string;
+}
+/**
+ * @export
+ */
+export declare const ClientBackgroundJobItemResponseStatusEnum: {
+    readonly Queued: "queued";
+    readonly Processing: "processing";
+    readonly Completed: "completed";
+    readonly Error: "error";
+    readonly Canceled: "canceled";
+};
+export type ClientBackgroundJobItemResponseStatusEnum = typeof ClientBackgroundJobItemResponseStatusEnum[keyof typeof ClientBackgroundJobItemResponseStatusEnum];
+/**
+ * @export
+ */
+export declare const ClientBackgroundJobItemResponseRequestTypeEnum: {
+    readonly Finder: "finder";
+    readonly Probe: "probe";
+};
+export type ClientBackgroundJobItemResponseRequestTypeEnum = typeof ClientBackgroundJobItemResponseRequestTypeEnum[keyof typeof ClientBackgroundJobItemResponseRequestTypeEnum];
+/**
+ * @export
+ */
+export declare const ClientBackgroundJobItemResponseResultOutcomeEnum: {
+    readonly Found: "found";
+    readonly NotFound: "not_found";
+    readonly Error: "error";
+};
+export type ClientBackgroundJobItemResponseResultOutcomeEnum = typeof ClientBackgroundJobItemResponseResultOutcomeEnum[keyof typeof ClientBackgroundJobItemResponseResultOutcomeEnum];
+/**
+ * Paginated list of background jobs for the authenticated user.
+ * @export
+ * @interface ClientBackgroundJobPageResponse
+ */
+export interface ClientBackgroundJobPageResponse {
+    /**
+     *
+     * @type {Array<ClientBackgroundJobResponse>}
+     * @memberof ClientBackgroundJobPageResponse
+     */
+    items: Array<ClientBackgroundJobResponse>;
+    /**
+     *
+     * @type {number}
+     * @memberof ClientBackgroundJobPageResponse
+     */
+    total: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ClientBackgroundJobPageResponse
+     */
+    page: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ClientBackgroundJobPageResponse
+     */
+    pageSize: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ClientBackgroundJobPageResponse
+     */
+    totalPages: number;
+}
+/**
+ * Background job status envelope returned by the public jobs API.
+ * @export
+ * @interface ClientBackgroundJobResponse
+ */
+export interface ClientBackgroundJobResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof ClientBackgroundJobResponse
+     */
+    id: string;
+    /**
+     *
+     * @type {ClientBackgroundJobResponseJobTypeEnum}
+     * @memberof ClientBackgroundJobResponse
+     */
+    jobType: ClientBackgroundJobResponseJobTypeEnum;
+    /**
+     * Current high-level job lifecycle state.
+     * @type {ClientBackgroundJobResponseStatusEnum}
+     * @memberof ClientBackgroundJobResponse
+     */
+    status: ClientBackgroundJobResponseStatusEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof ClientBackgroundJobResponse
+     */
+    deadlineAt: string;
+    /**
+     *
+     * @type {number}
+     * @memberof ClientBackgroundJobResponse
+     */
+    estimatedRuntimeSeconds: number;
+    /**
+     *
+     * @type {string}
+     * @memberof ClientBackgroundJobResponse
+     */
+    scheduledStartAt: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ClientBackgroundJobResponse
+     */
+    callbackUrl?: string | null;
+    /**
+     *
+     * @type {ClientBackgroundJobResponseCallbackStatusEnum}
+     * @memberof ClientBackgroundJobResponse
+     */
+    callbackStatus: ClientBackgroundJobResponseCallbackStatusEnum;
+    /**
+     *
+     * @type {number}
+     * @memberof ClientBackgroundJobResponse
+     */
+    callbackAttempts: number;
+    /**
+     *
+     * @type {string}
+     * @memberof ClientBackgroundJobResponse
+     */
+    callbackLastError?: string | null;
+    /**
+     * Total number of submitted items for the job.
+     * @type {number}
+     * @memberof ClientBackgroundJobResponse
+     */
+    requestedCount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ClientBackgroundJobResponse
+     */
+    completedCount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ClientBackgroundJobResponse
+     */
+    successCount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ClientBackgroundJobResponse
+     */
+    notFoundCount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ClientBackgroundJobResponse
+     */
+    errorCount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ClientBackgroundJobResponse
+     */
+    reservedAmountMicros: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ClientBackgroundJobResponse
+     */
+    actualAmountMicros: number;
+    /**
+     * Approximate percent complete based on completed item count.
+     * @type {number}
+     * @memberof ClientBackgroundJobResponse
+     */
+    progressPercent?: number;
+    /**
+     * Aggregated counts and provider stats for the job.
+     * @type {{ [key: string]: any; }}
+     * @memberof ClientBackgroundJobResponse
+     */
+    summary?: {
+        [key: string]: any;
+    };
+    /**
+     *
+     * @type {{ [key: string]: any; }}
+     * @memberof ClientBackgroundJobResponse
+     */
+    metadata?: {
+        [key: string]: any;
+    };
+    /**
+     *
+     * @type {string}
+     * @memberof ClientBackgroundJobResponse
+     */
+    startedAt?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ClientBackgroundJobResponse
+     */
+    completedAt?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ClientBackgroundJobResponse
+     */
+    historyExpiresAt?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ClientBackgroundJobResponse
+     */
+    resultsPrunedAt?: string | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ClientBackgroundJobResponse
+     */
+    artifactAvailable?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof ClientBackgroundJobResponse
+     */
+    artifactJsonUrl?: string | null;
+    /**
+     *
+     * @type {number}
+     * @memberof ClientBackgroundJobResponse
+     */
+    artifactSizeBytes?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ClientBackgroundJobResponse
+     */
+    artifactUploadedAt?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ClientBackgroundJobResponse
+     */
+    createdAt: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ClientBackgroundJobResponse
+     */
+    updatedAt: string;
+}
+/**
+ * @export
+ */
+export declare const ClientBackgroundJobResponseJobTypeEnum: {
+    readonly FinderBatch: "finder_batch";
+    readonly ProbeBatch: "probe_batch";
+};
+export type ClientBackgroundJobResponseJobTypeEnum = typeof ClientBackgroundJobResponseJobTypeEnum[keyof typeof ClientBackgroundJobResponseJobTypeEnum];
+/**
+ * @export
+ */
+export declare const ClientBackgroundJobResponseStatusEnum: {
+    readonly Queued: "queued";
+    readonly Processing: "processing";
+    readonly Completed: "completed";
+    readonly Failed: "failed";
+    readonly Canceled: "canceled";
+};
+export type ClientBackgroundJobResponseStatusEnum = typeof ClientBackgroundJobResponseStatusEnum[keyof typeof ClientBackgroundJobResponseStatusEnum];
+/**
+ * @export
+ */
+export declare const ClientBackgroundJobResponseCallbackStatusEnum: {
+    readonly None: "none";
+    readonly Pending: "pending";
+    readonly Delivered: "delivered";
+    readonly Failed: "failed";
+};
+export type ClientBackgroundJobResponseCallbackStatusEnum = typeof ClientBackgroundJobResponseCallbackStatusEnum[keyof typeof ClientBackgroundJobResponseCallbackStatusEnum];
+/**
+ * Synchronous batch Probe response with compact per-item results and a small summary block.
+ * @export
+ * @interface ClientBatchIdentityResponse
+ */
+export interface ClientBatchIdentityResponse {
+    /**
+     * Per-email compact probe results in request order.
+     * @type {Array<ClientIdentityResponse>}
+     * @memberof ClientBatchIdentityResponse
+     */
+    results: Array<ClientIdentityResponse>;
+    /**
+     *
+     * @type {BatchSummary}
+     * @memberof ClientBatchIdentityResponse
+     */
+    summary: BatchSummary;
+}
+/**
+ * Compact public result envelope used by Finder and Probe style responses.
+ * @export
+ * @interface ClientFinderResponse
+ */
+export interface ClientFinderResponse {
+    /**
+     * Final public deliverability verdict.
+     * @type {ClientFinderResponseStateEnum}
+     * @memberof ClientFinderResponse
+     */
+    state: ClientFinderResponseStateEnum;
+    /**
+     * Operational outcome. `error` means the verification could not complete cleanly and should not be treated as a negative mailbox verdict.
+     * @type {ClientFinderResponseOutcomeEnum}
+     * @memberof ClientFinderResponse
+     */
+    outcome?: ClientFinderResponseOutcomeEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof ClientFinderResponse
+     */
+    address?: string | null;
+    /**
+     * Whether the resolved address is an alias rather than a primary mailbox.
+     * @type {boolean}
+     * @memberof ClientFinderResponse
+     */
+    isAlias?: boolean;
+    /**
+     *
+     * @type {ClientFinderResponseAlias}
+     * @memberof ClientFinderResponse
+     */
+    alias?: ClientFinderResponseAlias;
+    /**
+     * Whether the mailbox domain behaved like a catch-all during verification.
+     * @type {boolean}
+     * @memberof ClientFinderResponse
+     */
+    isCatchall?: boolean;
+    /**
+     * Identity providers associated with the mailbox domain when available.
+     * @type {Array<IdentityProvider>}
+     * @memberof ClientFinderResponse
+     */
+    identityProviders?: Array<IdentityProvider>;
+    /**
+     * Observed MX hosts for the mailbox domain.
+     * @type {Array<string>}
+     * @memberof ClientFinderResponse
+     */
+    mxHosts?: Array<string>;
+    /**
+     *
+     * @type {string}
+     * @memberof ClientFinderResponse
+     */
+    requestId?: string | null;
+}
+/**
+ * @export
+ */
+export declare const ClientFinderResponseStateEnum: {
+    readonly Deliverable: "deliverable";
+    readonly Undeliverable: "undeliverable";
+};
+export type ClientFinderResponseStateEnum = typeof ClientFinderResponseStateEnum[keyof typeof ClientFinderResponseStateEnum];
+/**
+ * @export
+ */
+export declare const ClientFinderResponseOutcomeEnum: {
+    readonly Found: "found";
+    readonly NotFound: "not_found";
+    readonly Error: "error";
+};
+export type ClientFinderResponseOutcomeEnum = typeof ClientFinderResponseOutcomeEnum[keyof typeof ClientFinderResponseOutcomeEnum];
+/**
+ * Alias metadata when `is_alias=true`.
+ * @export
+ * @interface ClientFinderResponseAlias
+ */
+export interface ClientFinderResponseAlias {
+    /**
+     *
+     * @type {string}
+     * @memberof ClientFinderResponseAlias
+     */
+    original?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ClientFinderResponseAlias
+     */
+    resolved?: string | null;
+}
+/**
+ * Compact public result envelope used by Finder and Probe style responses.
+ * @export
+ * @interface ClientIdentityResponse
+ */
+export interface ClientIdentityResponse {
+    /**
+     * Final public deliverability verdict.
+     * @type {ClientIdentityResponseStateEnum}
+     * @memberof ClientIdentityResponse
+     */
+    state: ClientIdentityResponseStateEnum;
+    /**
+     * Operational outcome. `error` means the verification could not complete cleanly and should not be treated as a negative mailbox verdict.
+     * @type {ClientIdentityResponseOutcomeEnum}
+     * @memberof ClientIdentityResponse
+     */
+    outcome?: ClientIdentityResponseOutcomeEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof ClientIdentityResponse
+     */
+    address?: string | null;
+    /**
+     * Whether the resolved address is an alias rather than a primary mailbox.
+     * @type {boolean}
+     * @memberof ClientIdentityResponse
+     */
+    isAlias?: boolean;
+    /**
+     *
+     * @type {ClientFinderResponseAlias}
+     * @memberof ClientIdentityResponse
+     */
+    alias?: ClientFinderResponseAlias;
+    /**
+     * Whether the mailbox domain behaved like a catch-all during verification.
+     * @type {boolean}
+     * @memberof ClientIdentityResponse
+     */
+    isCatchall?: boolean;
+    /**
+     * Identity providers associated with the mailbox domain when available.
+     * @type {Array<IdentityProvider>}
+     * @memberof ClientIdentityResponse
+     */
+    identityProviders?: Array<IdentityProvider>;
+    /**
+     * Observed MX hosts for the mailbox domain.
+     * @type {Array<string>}
+     * @memberof ClientIdentityResponse
+     */
+    mxHosts?: Array<string>;
+    /**
+     *
+     * @type {string}
+     * @memberof ClientIdentityResponse
+     */
+    requestId?: string | null;
+}
+/**
+ * @export
+ */
+export declare const ClientIdentityResponseStateEnum: {
+    readonly Deliverable: "deliverable";
+    readonly Undeliverable: "undeliverable";
+};
+export type ClientIdentityResponseStateEnum = typeof ClientIdentityResponseStateEnum[keyof typeof ClientIdentityResponseStateEnum];
+/**
+ * @export
+ */
+export declare const ClientIdentityResponseOutcomeEnum: {
+    readonly Found: "found";
+    readonly NotFound: "not_found";
+    readonly Error: "error";
+};
+export type ClientIdentityResponseOutcomeEnum = typeof ClientIdentityResponseOutcomeEnum[keyof typeof ClientIdentityResponseOutcomeEnum];
+/**
+ * One completed direct request visible in the user's request history.
+ * @export
+ * @interface ClientRequestHistoryItem
+ */
+export interface ClientRequestHistoryItem {
+    /**
+     *
+     * @type {string}
+     * @memberof ClientRequestHistoryItem
+     */
+    id: string;
+    /**
+     *
+     * @type {ClientRequestHistoryItemRequestTypeEnum}
+     * @memberof ClientRequestHistoryItem
+     */
+    requestType: ClientRequestHistoryItemRequestTypeEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof ClientRequestHistoryItem
+     */
+    inputName?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ClientRequestHistoryItem
+     */
+    inputDomain?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ClientRequestHistoryItem
+     */
+    inputEmail?: string | null;
+    /**
+     * Compact human-readable identifier for the original request input.
+     * @type {string}
+     * @memberof ClientRequestHistoryItem
+     */
+    inputLabel: string;
+    /**
+     *
+     * @type {ClientRequestHistoryItemStateEnum}
+     * @memberof ClientRequestHistoryItem
+     */
+    state: ClientRequestHistoryItemStateEnum;
+    /**
+     *
+     * @type {ClientRequestHistoryItemOutcomeEnum}
+     * @memberof ClientRequestHistoryItem
+     */
+    outcome: ClientRequestHistoryItemOutcomeEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof ClientRequestHistoryItem
+     */
+    resolvedAddress?: string | null;
+    /**
+     *
+     * @type {number}
+     * @memberof ClientRequestHistoryItem
+     */
+    durationMs?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ClientRequestHistoryItem
+     */
+    provider?: string | null;
+    /**
+     *
+     * @type {Array<{ [key: string]: any; }>}
+     * @memberof ClientRequestHistoryItem
+     */
+    identityProviders?: Array<{
+        [key: string]: any;
+    }>;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof ClientRequestHistoryItem
+     */
+    mxHosts?: Array<string>;
+    /**
+     * Small transport and outcome metadata associated with the request.
+     * @type {{ [key: string]: any; }}
+     * @memberof ClientRequestHistoryItem
+     */
+    metadata?: {
+        [key: string]: any;
+    };
+    /**
+     *
+     * @type {boolean}
+     * @memberof ClientRequestHistoryItem
+     */
+    isAlias?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ClientRequestHistoryItem
+     */
+    isCatchall?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof ClientRequestHistoryItem
+     */
+    requestId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ClientRequestHistoryItem
+     */
+    createdAt: string;
+}
+/**
+ * @export
+ */
+export declare const ClientRequestHistoryItemRequestTypeEnum: {
+    readonly Finder: "finder";
+    readonly Probe: "probe";
+};
+export type ClientRequestHistoryItemRequestTypeEnum = typeof ClientRequestHistoryItemRequestTypeEnum[keyof typeof ClientRequestHistoryItemRequestTypeEnum];
+/**
+ * @export
+ */
+export declare const ClientRequestHistoryItemStateEnum: {
+    readonly Deliverable: "deliverable";
+    readonly Undeliverable: "undeliverable";
+};
+export type ClientRequestHistoryItemStateEnum = typeof ClientRequestHistoryItemStateEnum[keyof typeof ClientRequestHistoryItemStateEnum];
+/**
+ * @export
+ */
+export declare const ClientRequestHistoryItemOutcomeEnum: {
+    readonly Found: "found";
+    readonly NotFound: "not_found";
+    readonly Error: "error";
+};
+export type ClientRequestHistoryItemOutcomeEnum = typeof ClientRequestHistoryItemOutcomeEnum[keyof typeof ClientRequestHistoryItemOutcomeEnum];
+/**
+ * Paginated request history result.
+ * @export
+ * @interface ClientRequestHistoryPageResponse
+ */
+export interface ClientRequestHistoryPageResponse {
+    /**
+     *
+     * @type {Array<ClientRequestHistoryItem>}
+     * @memberof ClientRequestHistoryPageResponse
+     */
+    items: Array<ClientRequestHistoryItem>;
+    /**
+     *
+     * @type {number}
+     * @memberof ClientRequestHistoryPageResponse
+     */
+    total: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ClientRequestHistoryPageResponse
+     */
+    page: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ClientRequestHistoryPageResponse
+     */
+    pageSize: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ClientRequestHistoryPageResponse
+     */
+    totalPages: number;
+}
+/**
+ * Current bearer token claims as seen by the API.
+ * @export
+ * @interface ClientTokenStatusResponse
+ */
+export interface ClientTokenStatusResponse {
+    /**
+     * Whether the current bearer token is valid for this request.
+     * @type {boolean}
+     * @memberof ClientTokenStatusResponse
+     */
+    valid?: boolean;
+    /**
+     * User id associated with the bearer token.
+     * @type {string}
+     * @memberof ClientTokenStatusResponse
+     */
+    userId: string;
+    /**
+     * How the bearer token was issued.
+     * @type {ClientTokenStatusResponseTokenTypeEnum}
+     * @memberof ClientTokenStatusResponse
+     */
+    tokenType: ClientTokenStatusResponseTokenTypeEnum;
+    /**
+     * Scopes currently attached to the bearer token.
+     * @type {Array<string>}
+     * @memberof ClientTokenStatusResponse
+     */
+    scopes?: Array<string>;
+    /**
+     *
+     * @type {string}
+     * @memberof ClientTokenStatusResponse
+     */
+    expiresAt?: string | null;
+    /**
+     *
+     * @type {number}
+     * @memberof ClientTokenStatusResponse
+     */
+    expiresInSeconds?: number | null;
+}
+/**
+ * @export
+ */
+export declare const ClientTokenStatusResponseTokenTypeEnum: {
+    readonly Pat: "pat";
+    readonly Oauth: "oauth";
+};
+export type ClientTokenStatusResponseTokenTypeEnum = typeof ClientTokenStatusResponseTokenTypeEnum[keyof typeof ClientTokenStatusResponseTokenTypeEnum];
+/**
+ * Current authenticated account usage, free-tier windows, and paid balance snapshot.
+ * @export
+ * @interface ClientUsageResponse
+ */
+export interface ClientUsageResponse {
+    /**
+     * Current plan family, such as free or paid.
+     * @type {string}
+     * @memberof ClientUsageResponse
+     */
+    planTier: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ClientUsageResponse
+     */
+    billingMode: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ClientUsageResponse
+     */
+    billingStatus?: string | null;
+    /**
+     *
+     * @type {number}
+     * @memberof ClientUsageResponse
+     */
+    freeWindowLimit: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ClientUsageResponse
+     */
+    freeWindowHours: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ClientUsageResponse
+     */
+    freeWeeklyLimit: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ClientUsageResponse
+     */
+    windowRequestsUsed: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ClientUsageResponse
+     */
+    weeklyRequestsUsed: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ClientUsageResponse
+     */
+    windowRequestsRemaining: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ClientUsageResponse
+     */
+    weeklyRequestsRemaining: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ClientUsageResponse
+     */
+    billingCycleValueMicros?: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof ClientUsageResponse
+     */
+    billingExtraValueMicros: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ClientUsageResponse
+     */
+    billingValueMicrosUsed: number;
+    /**
+     * Paid usage value currently reserved by queued or running background jobs.
+     * @type {number}
+     * @memberof ClientUsageResponse
+     */
+    billingValueMicrosReserved?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ClientUsageResponse
+     */
+    billingValueMicrosRemaining?: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof ClientUsageResponse
+     */
+    usagePercentRemaining?: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof ClientUsageResponse
+     */
+    currentPlanFinderDeliverableCostMicros?: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof ClientUsageResponse
+     */
+    currentPlanFinderUndeliverableCostMicros?: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof ClientUsageResponse
+     */
+    currentPlanProbeCostMicros?: number | null;
+}
+/**
+ *
+ * @export
+ * @interface ErrorResponse
+ */
+export interface ErrorResponse {
+    /**
+     * Stable machine-readable error key.
+     * @type {string}
+     * @memberof ErrorResponse
+     */
+    error?: string;
+    /**
+     * Human-friendly error summary safe to show to an operator or end user.
+     * @type {string}
+     * @memberof ErrorResponse
+     */
+    message?: string;
+    /**
+     * Optional raw backend detail when available.
+     * @type {string}
+     * @memberof ErrorResponse
+     */
+    detail?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof ErrorResponse
+     */
+    retryAfterSeconds?: number | null;
+}
+/**
+ * Queue a background Finder workload that can wait for capacity and complete asynchronously.
+ * @export
+ * @interface FinderBatchJobRequest
+ */
+export interface FinderBatchJobRequest {
+    /**
+     * Optional hard deadline for the job. Omit it to start as soon as capacity allows. If provided, the API returns 422 when the deadline is too tight even with immediate execution.
+     * @type {string}
+     * @memberof FinderBatchJobRequest
+     */
+    deadline?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof FinderBatchJobRequest
+     */
+    callbackUrl?: string | null;
+    /**
+     * One or more Finder-style inputs that will be processed asynchronously.
+     * @type {Array<FinderBatchJobRequestInputsInner>}
+     * @memberof FinderBatchJobRequest
+     */
+    inputs: Array<FinderBatchJobRequestInputsInner>;
+}
+/**
+ *
+ * @export
+ * @interface FinderBatchJobRequestInputsInner
+ */
+export interface FinderBatchJobRequestInputsInner {
+    /**
+     * The real person's full name.
+     * @type {string}
+     * @memberof FinderBatchJobRequestInputsInner
+     */
+    fullName: string;
+    /**
+     * The company website or mailbox domain.
+     * @type {string}
+     * @memberof FinderBatchJobRequestInputsInner
+     */
+    emailDomain: string;
+}
+/**
+ * Resolve the most likely verified work email for one person at one company domain.
+ * @export
+ * @interface FinderRequest
+ */
+export interface FinderRequest {
+    /**
+     * The real person's full name. Include middle names or initials when known.
+     * @type {string}
+     * @memberof FinderRequest
+     */
+    fullName: string;
+    /**
+     * The company's public website or mailbox domain.
+     * @type {string}
+     * @memberof FinderRequest
+     */
+    emailDomain: string;
+}
+/**
+ *
+ * @export
+ * @interface HTTPValidationError
+ */
+export interface HTTPValidationError {
+    /**
+     *
+     * @type {Array<ValidationError>}
+     * @memberof HTTPValidationError
+     */
+    detail?: Array<ValidationError>;
+}
+/**
+ *
+ * @export
+ * @interface IdentityProvider
+ */
+export interface IdentityProvider {
+    /**
+     *
+     * @type {string}
+     * @memberof IdentityProvider
+     */
+    provider?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof IdentityProvider
+     */
+    hostname?: string | null;
+}
+/**
+ *
+ * @export
+ * @interface LocationInner
+ */
+export interface LocationInner {
+}
+/**
+ * Queue a background Probe Batch workload that can wait for capacity and complete asynchronously.
+ * @export
+ * @interface ProbeBatchJobBackgroundRequest
+ */
+export interface ProbeBatchJobBackgroundRequest {
+    /**
+     * Optional hard deadline for the job. Omit it to start as soon as capacity allows. If provided, the API returns 422 when the deadline is too tight even with immediate execution.
+     * @type {string}
+     * @memberof ProbeBatchJobBackgroundRequest
+     */
+    deadline?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ProbeBatchJobBackgroundRequest
+     */
+    callbackUrl?: string | null;
+    /**
+     * One or more exact mailbox addresses to verify asynchronously.
+     * @type {Array<string>}
+     * @memberof ProbeBatchJobBackgroundRequest
+     */
+    emails: Array<string>;
+}
+/**
+ * Verify many known email addresses synchronously and receive compact per-item results.
+ * @export
+ * @interface ProbeBatchRequest
+ */
+export interface ProbeBatchRequest {
+    /**
+     * One or more exact mailbox addresses to verify.
+     * @type {Array<string>}
+     * @memberof ProbeBatchRequest
+     */
+    emails: Array<string>;
+}
+/**
+ * Verify one known email address directly.
+ * @export
+ * @interface ProbeRequest
+ */
+export interface ProbeRequest {
+    /**
+     * The email address you want to verify.
+     * @type {string}
+     * @memberof ProbeRequest
+     */
+    email: string;
+}
+/**
+ *
+ * @export
+ * @interface ValidationError
+ */
+export interface ValidationError {
+    /**
+     *
+     * @type {Array<LocationInner>}
+     * @memberof ValidationError
+     */
+    loc: Array<LocationInner>;
+    /**
+     *
+     * @type {string}
+     * @memberof ValidationError
+     */
+    msg: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ValidationError
+     */
+    type: string;
+    /**
+     *
+     * @type {any}
+     * @memberof ValidationError
+     */
+    input?: any | null;
+    /**
+     *
+     * @type {object}
+     * @memberof ValidationError
+     */
+    ctx?: object;
+}