import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js"; import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js"; import * as core from "../../../../core/index.js"; import * as Management from "../../../index.js"; export declare namespace LogsClient { type Options = BaseClientOptions; interface RequestOptions extends BaseRequestOptions { } } export declare class LogsClient { protected readonly _options: NormalizedClientOptionsWithAuth; constructor(options: LogsClient.Options); /** * Retrieve log entries that match the specified search criteria (or all log entries if no criteria specified). * * Set custom search criteria using the q parameter, or search from a specific log ID ("search from checkpoint"). * * For more information on all possible event types, their respective acronyms, and descriptions, see Log Event Type Codes. * *
To set custom search criteria, use the following parameters:
* * * * For more information on the list of fields that can be used in fields and sort, see Searchable Fields. * * Auth0 limits the number of logs you can return by search criteria to 100 logs per request. Furthermore, you may paginate only through 1,000 search results. If you exceed this threshold, please redefine your search or use the get logs by checkpoint method. * *
To search from a checkpoint log ID, use the following parameters:
* * * Important: When fetching logs from a checkpoint log ID, any parameter other than from and take will be ignored, and date ordering is not guaranteed. * * @param {Management.ListLogsRequestParameters} request * @param {LogsClient.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Management.BadRequestError} * @throws {@link Management.UnauthorizedError} * @throws {@link Management.ForbiddenError} * @throws {@link Management.TooManyRequestsError} * * @example * await client.logs.list({ * page: 1, * per_page: 1, * sort: "sort", * fields: "fields", * include_fields: true, * include_totals: true, * search: "search" * }) */ list(request?: Management.ListLogsRequestParameters, requestOptions?: LogsClient.RequestOptions): Promise>; /** * Retrieve an individual log event. * * @param {string} id - log_id of the log to retrieve. * @param {LogsClient.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Management.BadRequestError} * @throws {@link Management.UnauthorizedError} * @throws {@link Management.ForbiddenError} * @throws {@link Management.NotFoundError} * @throws {@link Management.TooManyRequestsError} * * @example * await client.logs.get("id") */ get(id: string, requestOptions?: LogsClient.RequestOptions): core.HttpResponsePromise; private __get; }