auth0 3.4.0 → 4.0.0-beta.1

package/dist/typings/management/__generated/managers/hooks-manager.d.ts

@@ -0,0 +1,94 @@
+import * as runtime from '../../../lib/runtime.js';
+import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
+import type { Hook, HookCreate, HookUpdate, GetHooks200ResponseOneOf, DeleteHooksByIdRequest, DeleteSecretsRequest, GetHooksRequest, GetHooksByIdRequest, GetSecretsRequest, PatchHooksByIdRequest, PatchSecretsRequest, PostSecretsRequest } from '../models/index.js';
+declare const BaseAPI: typeof runtime.BaseAPI;
+/**
+ *
+ */
+export declare class HooksManager extends BaseAPI {
+    /**
+     * Delete a hook.
+     *
+     * Delete a hook
+     *
+     * @throws {RequiredError}
+     */
+    delete(requestParameters: DeleteHooksByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
+    /**
+     * Delete one or more existing secrets for a given hook. Accepts an array of secret names to delete.
+     * Delete hook secrets
+     *
+     * @throws {RequiredError}
+     */
+    deleteSecrets(requestParameters: DeleteSecretsRequest, bodyParameters: Array<string>, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
+    /**
+     * Retrieve all <a href="https://auth0.com/docs/hooks">hooks</a>. Accepts a list of fields to include or exclude in the result.
+     *
+     * Get hooks
+     *
+     * @throws {RequiredError}
+     */
+    getAll(requestParameters: GetHooksRequest & {
+        include_totals: true;
+    }, initOverrides?: InitOverride): Promise<ApiResponse<GetHooks200ResponseOneOf>>;
+    getAll(requestParameters?: GetHooksRequest, initOverrides?: InitOverride): Promise<ApiResponse<Array<Hook>>>;
+    /**
+     * Retrieve <a href="https://auth0.com/docs/hooks">a hook</a> by its ID. Accepts a list of fields to include in the result.
+     *
+     * Get a hook
+     *
+     * @throws {RequiredError}
+     */
+    get(requestParameters: GetHooksByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<Hook>>;
+    /**
+     * Retrieve a hook's secrets by the ID of the hook.
+     *
+     * Get hook secrets
+     *
+     * @throws {RequiredError}
+     */
+    getSecrets(requestParameters: GetSecretsRequest, initOverrides?: InitOverride): Promise<ApiResponse<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Update an existing hook.
+     *
+     * Update a hook
+     *
+     * @throws {RequiredError}
+     */
+    update(requestParameters: PatchHooksByIdRequest, bodyParameters: HookUpdate, initOverrides?: InitOverride): Promise<ApiResponse<Hook>>;
+    /**
+     * Update one or more existing secrets for an existing hook. Accepts an object of key-value pairs, where the key is the name of the existing secret.
+     *
+     * Update hook secrets
+     *
+     * @throws {RequiredError}
+     */
+    updateSecrets(requestParameters: PatchSecretsRequest, bodyParameters: {
+        [key: string]: any;
+    }, initOverrides?: InitOverride): Promise<ApiResponse<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Create a new hook.
+     *
+     * Create a hook
+     *
+     * @throws {RequiredError}
+     */
+    create(bodyParameters: HookCreate, initOverrides?: InitOverride): Promise<ApiResponse<Hook>>;
+    /**
+     * Add one or more secrets to an existing hook. Accepts an object of key-value pairs, where the key is the name of the secret. A hook can have a maximum of 20 secrets.
+     *
+     * Add hook secrets
+     *
+     * @throws {RequiredError}
+     */
+    addSecrets(requestParameters: PostSecretsRequest, bodyParameters: {
+        [key: string]: any;
+    }, initOverrides?: InitOverride): Promise<ApiResponse<{
+        [key: string]: any;
+    }>>;
+}
+export {};

package/dist/typings/management/__generated/managers/index.d.ts

@@ -0,0 +1,31 @@
+export * from './actions-manager.js';
+export * from './anomaly-manager.js';
+export * from './attack-protection-manager.js';
+export * from './blacklists-manager.js';
+export * from './branding-manager.js';
+export * from './client-grants-manager.js';
+export * from './clients-manager.js';
+export * from './connections-manager.js';
+export * from './custom-domains-manager.js';
+export * from './device-credentials-manager.js';
+export * from './email-templates-manager.js';
+export * from './emails-manager.js';
+export * from './grants-manager.js';
+export * from './guardian-manager.js';
+export * from './hooks-manager.js';
+export * from './jobs-manager.js';
+export * from './keys-manager.js';
+export * from './log-streams-manager.js';
+export * from './logs-manager.js';
+export * from './organizations-manager.js';
+export * from './prompts-manager.js';
+export * from './resource-servers-manager.js';
+export * from './roles-manager.js';
+export * from './rules-manager.js';
+export * from './rules-configs-manager.js';
+export * from './stats-manager.js';
+export * from './tenants-manager.js';
+export * from './tickets-manager.js';
+export * from './user-blocks-manager.js';
+export * from './users-manager.js';
+export * from './users-by-email-manager.js';

package/dist/typings/management/__generated/managers/jobs-manager.d.ts

@@ -0,0 +1,47 @@
+import * as runtime from '../../../lib/runtime.js';
+import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
+import type { GetErrors200Response, Job, PostUsersExportsRequest, PostVerificationEmailRequest, GetErrorsRequest, GetJobsByIdRequest, PostUsersImportsData } from '../models/index.js';
+declare const BaseAPI: typeof runtime.BaseAPI;
+/**
+ *
+ */
+export declare class JobsManager extends BaseAPI {
+    /**
+     * Retrieve error details of a failed job.
+     * Get job error details
+     *
+     * @throws {RequiredError}
+     */
+    getErrors(requestParameters: GetErrorsRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetErrors200Response>>;
+    /**
+     * Retrieves a job. Useful to check its status.
+     * Get a job
+     *
+     * @throws {RequiredError}
+     */
+    get(requestParameters: GetJobsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<Job>>;
+    /**
+     * Export all users to a file via a long-running job.
+     * Create export users job
+     *
+     * @throws {RequiredError}
+     */
+    exportUsers(bodyParameters: PostUsersExportsRequest, initOverrides?: InitOverride): Promise<ApiResponse<Job>>;
+    /**
+     * Import users from a <a href="https://manage.local.dev.auth0.com/docs/users/references/bulk-import-database-schema-examples">formatted file</a> into a connection via a long-running job.
+     * Create import users job
+     *
+     * @throws {RequiredError}
+     */
+    importUsers(bodyParameters: PostUsersImportsData, initOverrides?: InitOverride): Promise<ApiResponse<Job>>;
+    /**
+     * Send an email to the specified user that asks them to click a link to <a href="https://auth0.com/docs/email/custom#verification-email">verify their email address</a>.
+     *
+     * Note: You must have the `Status` toggle enabled for the verification email template for the email to be sent.
+     * Send an email address verification email
+     *
+     * @throws {RequiredError}
+     */
+    verifyEmail(bodyParameters: PostVerificationEmailRequest, initOverrides?: InitOverride): Promise<ApiResponse<Job>>;
+}
+export {};

package/dist/typings/management/__generated/managers/keys-manager.d.ts

@@ -0,0 +1,34 @@
+import * as runtime from '../../../lib/runtime.js';
+import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
+import type { GetSigningKeys200ResponseInner, PostSigningKeys201Response, PutSigningKeys200Response, GetSigningKeyRequest, PutSigningKeysRequest } from '../models/index.js';
+declare const BaseAPI: typeof runtime.BaseAPI;
+/**
+ *
+ */
+export declare class KeysManager extends BaseAPI {
+    /**
+     * Get an Application Signing Key by its key id
+     *
+     * @throws {RequiredError}
+     */
+    get(requestParameters: GetSigningKeyRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetSigningKeys200ResponseInner>>;
+    /**
+     * Get all Application Signing Keys
+     *
+     * @throws {RequiredError}
+     */
+    getAll(initOverrides?: InitOverride): Promise<ApiResponse<Array<GetSigningKeys200ResponseInner>>>;
+    /**
+     * Rotate the Application Signing Key
+     *
+     * @throws {RequiredError}
+     */
+    rotate(initOverrides?: InitOverride): Promise<ApiResponse<PostSigningKeys201Response>>;
+    /**
+     * Revoke an Application Signing Key by its key id
+     *
+     * @throws {RequiredError}
+     */
+    revoke(requestParameters: PutSigningKeysRequest, initOverrides?: InitOverride): Promise<ApiResponse<PutSigningKeys200Response>>;
+}
+export {};

package/dist/typings/management/__generated/managers/log-streams-manager.d.ts

@@ -0,0 +1,326 @@
+import * as runtime from '../../../lib/runtime.js';
+import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
+import type { GetLogStreams200ResponseInner, PatchLogStreamsByIdRequest, PostLogStreamsRequest, DeleteLogStreamsByIdRequest, GetLogStreamsByIdRequest, PatchLogStreamsByIdOperationRequest } from '../models/index.js';
+declare const BaseAPI: typeof runtime.BaseAPI;
+/**
+ *
+ */
+export declare class LogStreamsManager extends BaseAPI {
+    /**
+     * Delete a log stream.
+     *
+     * Delete log stream
+     *
+     * @throws {RequiredError}
+     */
+    delete(requestParameters: DeleteLogStreamsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
+    /**
+     * Retrieve details on <a href="https://auth0.com/docs/logs/streams">log streams</a>.
+     * <h5>Sample Response</h5><pre><code>[{
+     * 	"id": "string",
+     * 	"name": "string",
+     * 	"type": "eventbridge",
+     * 	"status": "active|paused|suspended",
+     * 	"sink": {
+     * 		"awsAccountId": "string",
+     * 		"awsRegion": "string",
+     * 		"awsPartnerEventSource": "string"
+     * 	}
+     * }, {
+     * 	"id": "string",
+     * 	"name": "string",
+     * 	"type": "http",
+     * 	"status": "active|paused|suspended",
+     * 	"sink": {
+     * 		"httpContentFormat": "JSONLINES|JSONARRAY",
+     * 		"httpContentType": "string",
+     * 		"httpEndpoint": "string",
+     * 		"httpAuthorization": "string"
+     * 	}
+     * },
+     * {
+     * 	"id": "string",
+     * 	"name": "string",
+     * 	"type": "eventgrid",
+     * 	"status": "active|paused|suspended",
+     * 	"sink": {
+     * 		"azureSubscriptionId": "string",
+     * 		"azureResourceGroup": "string",
+     * 		"azureRegion": "string",
+     * 		"azurePartnerTopic": "string"
+     * 	}
+     * },
+     * {
+     * 	"id": "string",
+     * 	"name": "string",
+     * 	"type": "splunk",
+     * 	"status": "active|paused|suspended",
+     * 	"sink": {
+     * 		"splunkDomain": "string",
+     * 		"splunkToken": "string",
+     * 		"splunkPort": "string",
+     * 		"splunkSecure": "boolean"
+     * 	}
+     * },
+     * {
+     * 	"id": "string",
+     * 	"name": "string",
+     * 	"type": "sumo",
+     * 	"status": "active|paused|suspended",
+     * 	"sink": {
+     * 		"sumoSourceAddress": "string",
+     * 	}
+     * },
+     * {
+     * 	"id": "string",
+     * 	"name": "string",
+     * 	"type": "datadog",
+     * 	"status": "active|paused|suspended",
+     * 	"sink": {
+     * 		"datadogRegion": "string",
+     * 		"datadogApiKey": "string"
+     * 	}
+     * }]</code></pre>
+     *
+     * Get log streams
+     *
+     * @throws {RequiredError}
+     */
+    getAll(initOverrides?: InitOverride): Promise<ApiResponse<Array<GetLogStreams200ResponseInner>>>;
+    /**
+     * Retrieve a log stream configuration and status.
+     * <h5>Sample responses</h5><h5>Amazon EventBridge Log Stream</h5><pre><code>{
+     * 	"id": "string",
+     * 	"name": "string",
+     * 	"type": "eventbridge",
+     * 	"status": "active|paused|suspended",
+     * 	"sink": {
+     * 		"awsAccountId": "string",
+     * 		"awsRegion": "string",
+     * 		"awsPartnerEventSource": "string"
+     * 	}
+     * }</code></pre> <h5>HTTP Log Stream</h5><pre><code>{
+     * 	"id": "string",
+     * 	"name": "string",
+     * 	"type": "http",
+     * 	"status": "active|paused|suspended",
+     * 	"sink": {
+     * 		"httpContentFormat": "JSONLINES|JSONARRAY",
+     * 		"httpContentType": "string",
+     * 		"httpEndpoint": "string",
+     * 		"httpAuthorization": "string"
+     * 	}
+     * }</code></pre> <h5>Datadog Log Stream</h5><pre><code>{
+     * 	"id": "string",
+     * 	"name": "string",
+     * 	"type": "datadog",
+     * 	"status": "active|paused|suspended",
+     * 	"sink": {
+     * 		"datadogRegion": "string",
+     * 		"datadogApiKey": "string"
+     * 	}
+     * }</code></pre> <h5>Splunk Log Stream</h5><pre><code>{
+     * 	"id": "string",
+     * 	"name": "string",
+     * 	"type": "splunk",
+     * 	"status": "active|paused|suspended",
+     * 	"sink": {
+     * 		"splunkDomain": "string",
+     * 		"splunkToken": "string",
+     * 		"splunkPort": "string",
+     * 		"splunkSecure": "boolean"
+     * 	}
+     * }</code></pre> <h5>Sumo Logic Log Stream</h5><pre><code>{
+     * 	"id": "string",
+     * 	"name": "string",
+     * 	"type": "sumo",
+     * 	"status": "active|paused|suspended",
+     * 	"sink": {
+     * 		"sumoSourceAddress": "string",
+     * 	}
+     * }</code></pre> <h5>Status</h5> The <code>status</code> of a log stream maybe any of the following:
+     * 1. <code>active</code> - Stream is currently enabled.
+     * 2. <code>paused</code> - Stream is currently user disabled and will not attempt log delivery.
+     * 3. <code>suspended</code> - Stream is currently disabled because of errors and will not attempt log delivery.
+     *
+     * Get log stream by ID
+     *
+     * @throws {RequiredError}
+     */
+    get(requestParameters: GetLogStreamsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetLogStreams200ResponseInner>>;
+    /**
+     * Update a log stream.
+     * <h4>Examples of how to use the PATCH endpoint.</h4> The following fields may be updated in a PATCH operation: <ul><li>name</li><li>status</li><li>sink</li></ul> Note: For log streams of type <code>eventbridge</code> and <code>eventgrid</code>, updating the <code>sink</code> is not permitted.
+     * <h5>Update the status of a log stream</h5><pre><code>{
+     * 	"status": "active|paused"
+     * }</code></pre>
+     * <h5>Update the name of a log stream</h5><pre><code>{
+     * 	"name": "string"
+     * }</code></pre>
+     * <h5>Update the sink properties of a stream of type <code>http</code></h5><pre><code>{
+     *   "sink": {
+     *     "httpEndpoint": "string",
+     *     "httpContentType": "string",
+     *     "httpContentFormat": "JSONARRAY|JSONLINES",
+     *     "httpAuthorization": "string"
+     *   }
+     * }</code></pre>
+     * <h5>Update the sink properties of a stream of type <code>datadog</code></h5><pre><code>{
+     *   "sink": {
+     * 		"datadogRegion": "string",
+     * 		"datadogApiKey": "string"
+     *   }
+     * }</code></pre>
+     * <h5>Update the sink properties of a stream of type <code>splunk</code></h5><pre><code>{
+     *   "sink": {
+     *     "splunkDomain": "string",
+     *     "splunkToken": "string",
+     *     "splunkPort": "string",
+     *     "splunkSecure": "boolean"
+     *   }
+     * }</code></pre>
+     * <h5>Update the sink properties of a stream of type <code>sumo</code></h5><pre><code>{
+     *   "sink": {
+     *     "sumoSourceAddress": "string"
+     *   }
+     * }</code></pre>
+     * Update a log stream
+     *
+     * @throws {RequiredError}
+     */
+    update(requestParameters: PatchLogStreamsByIdOperationRequest, bodyParameters: PatchLogStreamsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetLogStreams200ResponseInner>>;
+    /**
+     * Create a log stream.
+     * <h5>Log Stream Types</h5> The <code>type</code> of log stream being created determines the properties required in the <code>sink</code> payload.
+     * <h5>HTTP Stream</h5> For an <code>http</code> Stream, the <code>sink</code> properties are listed in the payload below
+     * Request: <pre><code>{
+     * 	"name": "string",
+     * 	"type": "http",
+     * 	"sink": {
+     * 		"httpEndpoint": "string",
+     * 		"httpContentType": "string",
+     * 		"httpContentFormat": "JSONLINES|JSONARRAY",
+     * 		"httpAuthorization": "string"
+     * 	}
+     * }</code></pre>
+     * Response: <pre><code>{
+     * 	"id": "string",
+     * 	"name": "string",
+     * 	"type": "http",
+     * 	"status": "active",
+     * 	"sink": {
+     * 		"httpEndpoint": "string",
+     * 		"httpContentType": "string",
+     * 		"httpContentFormat": "JSONLINES|JSONARRAY",
+     * 		"httpAuthorization": "string"
+     * 	}
+     * }</code></pre>
+     * <h5>Amazon EventBridge Stream</h5> For an <code>eventbridge</code> Stream, the <code>sink</code> properties are listed in the payload below
+     * Request: <pre><code>{
+     * 	"name": "string",
+     * 	"type": "eventbridge",
+     * 	"sink": {
+     * 		"awsRegion": "string",
+     * 		"awsAccountId": "string"
+     * 	}
+     * }</code></pre>
+     * The response will include an additional field <code>awsPartnerEventSource</code> in the <code>sink</code>: <pre><code>{
+     * 	"id": "string",
+     * 	"name": "string",
+     * 	"type": "eventbridge",
+     * 	"status": "active",
+     * 	"sink": {
+     * 		"awsAccountId": "string",
+     * 		"awsRegion": "string",
+     * 		"awsPartnerEventSource": "string"
+     * 	}
+     * }</code></pre>
+     * <h5>Azure Event Grid Stream</h5> For an <code>Azure Event Grid</code> Stream, the <code>sink</code> properties are listed in the payload below
+     * Request: <pre><code>{
+     * 	"name": "string",
+     * 	"type": "eventgrid",
+     * 	"sink": {
+     * 		"azureSubscriptionId": "string",
+     * 		"azureResourceGroup": "string",
+     * 		"azureRegion": "string"
+     * 	}
+     * }</code></pre>
+     * Response: <pre><code>{
+     * 	"id": "string",
+     * 	"name": "string",
+     * 	"type": "http",
+     * 	"status": "active",
+     * 	"sink": {
+     * 		"azureSubscriptionId": "string",
+     * 		"azureResourceGroup": "string",
+     * 		"azureRegion": "string",
+     * 		"azurePartnerTopic": "string"
+     * 	}
+     * }</code></pre>
+     * <h5>Datadog Stream</h5> For a <code>Datadog</code> Stream, the <code>sink</code> properties are listed in the payload below
+     * Request: <pre><code>{
+     * 	"name": "string",
+     * 	"type": "datadog",
+     * 	"sink": {
+     * 		"datadogRegion": "string",
+     * 		"datadogApiKey": "string"
+     * 	}
+     * }</code></pre>
+     * Response: <pre><code>{
+     * 	"id": "string",
+     * 	"name": "string",
+     * 	"type": "datadog",
+     * 	"status": "active",
+     * 	"sink": {
+     * 		"datadogRegion": "string",
+     * 		"datadogApiKey": "string"
+     * 	}
+     * }</code></pre>
+     * <h5>Splunk Stream</h5> For a <code>Splunk</code> Stream, the <code>sink</code> properties are listed in the payload below
+     * Request: <pre><code>{
+     * 	"name": "string",
+     * 	"type": "splunk",
+     * 	"sink": {
+     * 		"splunkDomain": "string",
+     * 		"splunkToken": "string",
+     * 		"splunkPort": "string",
+     * 		"splunkSecure": "boolean"
+     * 	}
+     * }</code></pre>
+     * Response: <pre><code>{
+     * 	"id": "string",
+     * 	"name": "string",
+     * 	"type": "splunk",
+     * 	"status": "active",
+     * 	"sink": {
+     * 		"splunkDomain": "string",
+     * 		"splunkToken": "string",
+     * 		"splunkPort": "string",
+     * 		"splunkSecure": "boolean"
+     * 	}
+     * }</code></pre>
+     * <h5>Sumo Logic Stream</h5> For a <code>Sumo Logic</code> Stream, the <code>sink</code> properties are listed in the payload below
+     * Request: <pre><code>{
+     * 	"name": "string",
+     * 	"type": "sumo",
+     * 	"sink": {
+     * 		"sumoSourceAddress": "string",
+     * 	}
+     * }</code></pre>
+     * Response: <pre><code>{
+     * 	"id": "string",
+     * 	"name": "string",
+     * 	"type": "sumo",
+     * 	"status": "active",
+     * 	"sink": {
+     * 		"sumoSourceAddress": "string",
+     * 	}
+     * }</code></pre>
+     *
+     * Create a log stream
+     *
+     * @throws {RequiredError}
+     */
+    create(bodyParameters: PostLogStreamsRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetLogStreams200ResponseInner>>;
+}
+export {};

package/dist/typings/management/__generated/managers/logs-manager.d.ts

@@ -0,0 +1,56 @@
+import * as runtime from '../../../lib/runtime.js';
+import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
+import type { Log, GetLogs200ResponseOneOf, GetLogsRequest, GetLogsByIdRequest } from '../models/index.js';
+declare const BaseAPI: typeof runtime.BaseAPI;
+/**
+ *
+ */
+export declare class LogsManager extends BaseAPI {
+    /**
+     * Retrieve log entries that match the specified search criteria (or all log entries if no criteria specified).
+     *
+     * Set custom search criteria using the <code>q</code> parameter, or search from a specific log ID (<i>"search from checkpoint"</i>).
+     *
+     * For more information on all possible event types, their respective acronyms, and descriptions, see <a href="https://auth0.com/docs/logs/log-event-type-codes">Log Event Type Codes</a>.
+     *
+     * <h5>To set custom search criteria, use the following parameters:</h5>
+     *
+     * <ul>
+     *     <li><b>q:</b> Search Criteria using <a href="https://auth0.com/docs/logs/log-search-query-syntax">Query String Syntax</a></li>
+     *     <li><b>page:</b> Page index of the results to return. First page is 0.</li>
+     *     <li><b>per_page:</b> Number of results per page.</li>
+     *     <li><b>sort:</b> Field to use for sorting appended with `:1` for ascending and `:-1` for descending. e.g. `date:-1`</li>
+     *     <li><b>fields:</b> Comma-separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields.</li>
+     *     <li><b>include_fields:</b> Whether specified fields are to be included (true) or excluded (false).</li>
+     *     <li><b>include_totals:</b> Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). <b>Deprecated:</b> this field is deprecated and should be removed from use. See <a href="https://auth0.com/docs/product-lifecycle/deprecations-and-migrations/migrate-to-tenant-log-search-v3#pagination">Search Engine V3 Breaking Changes</a></li>
+     * </ul>
+     *
+     * For more information on the list of fields that can be used in <code>fields</code> and <code>sort</code>, see <a href="https://auth0.com/docs/logs/log-search-query-syntax#searchable-fields">Searchable Fields</a>.
+     *
+     * Auth0 <a href="https://auth0.com/docs/logs/retrieve-log-events-using-mgmt-api#limitations">limits the number of logs</a> 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 <a href="https://auth0.com/docs/logs/retrieve-log-events-using-mgmt-api#retrieve-logs-by-checkpoint">get logs by checkpoint method</a>.
+     *
+     * <h5>To search from a checkpoint log ID, use the following parameters:</h5>
+     * <ul>
+     *     <li><b>from:</b> Log Event ID from which to start retrieving logs. You can limit the number of logs returned using the <code>take</code> parameter. If you use <code>from</code> at the same time as <code>q</code>, <code>from</code> takes precedence and <code>q</code> is ignored.</li>
+     *     <li><b>take:</b> Number of entries to retrieve when using the <code>from</code> parameter.</li>
+     * </ul>
+     *
+     * <strong>Important:</strong> When fetching logs from a checkpoint log ID, any parameter other than <code>from</code> and <code>take</code> will be ignored, and date ordering is not guaranteed.
+     *
+     * Search log events
+     *
+     * @throws {RequiredError}
+     */
+    getAll(requestParameters: GetLogsRequest & {
+        include_totals: true;
+    }, initOverrides?: InitOverride): Promise<ApiResponse<GetLogs200ResponseOneOf>>;
+    getAll(requestParameters?: GetLogsRequest, initOverrides?: InitOverride): Promise<ApiResponse<Array<Log>>>;
+    /**
+     * Retrieve an individual log event.
+     * Get a log event by id
+     *
+     * @throws {RequiredError}
+     */
+    get(requestParameters: GetLogsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<Log>>;
+}
+export {};