auth0
Version:
Auth0 Node.js SDK for the Management API v2.
129 lines (128 loc) • 5.95 kB
TypeScript
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 ConnectionProfilesClient {
type Options = BaseClientOptions;
interface RequestOptions extends BaseRequestOptions {
}
}
export declare class ConnectionProfilesClient {
protected readonly _options: NormalizedClientOptionsWithAuth<ConnectionProfilesClient.Options>;
constructor(options: ConnectionProfilesClient.Options);
/**
* Retrieve a list of Connection Profiles. This endpoint supports Checkpoint pagination.
*
* @param {Management.ListConnectionProfileRequestParameters} request
* @param {ConnectionProfilesClient.RequestOptions} requestOptions - Request-specific configuration.
*
* @throws {@link Management.BadRequestError}
* @throws {@link Management.UnauthorizedError}
* @throws {@link Management.ForbiddenError}
* @throws {@link Management.TooManyRequestsError}
*
* @example
* await client.connectionProfiles.list({
* from: "from",
* take: 1
* })
*/
list(request?: Management.ListConnectionProfileRequestParameters, requestOptions?: ConnectionProfilesClient.RequestOptions): Promise<core.Page<Management.ConnectionProfile, Management.ListConnectionProfilesPaginatedResponseContent>>;
/**
* Create a Connection Profile.
*
* @param {Management.CreateConnectionProfileRequestContent} request
* @param {ConnectionProfilesClient.RequestOptions} requestOptions - Request-specific configuration.
*
* @throws {@link Management.BadRequestError}
* @throws {@link Management.UnauthorizedError}
* @throws {@link Management.ForbiddenError}
* @throws {@link Management.ConflictError}
* @throws {@link Management.TooManyRequestsError}
*
* @example
* await client.connectionProfiles.create({
* name: "name"
* })
*/
create(request: Management.CreateConnectionProfileRequestContent, requestOptions?: ConnectionProfilesClient.RequestOptions): core.HttpResponsePromise<Management.CreateConnectionProfileResponseContent>;
private __create;
/**
* Retrieve a list of Connection Profile Templates.
*
* @param {ConnectionProfilesClient.RequestOptions} requestOptions - Request-specific configuration.
*
* @throws {@link Management.UnauthorizedError}
* @throws {@link Management.ForbiddenError}
* @throws {@link Management.TooManyRequestsError}
*
* @example
* await client.connectionProfiles.listTemplates()
*/
listTemplates(requestOptions?: ConnectionProfilesClient.RequestOptions): core.HttpResponsePromise<Management.ListConnectionProfileTemplateResponseContent>;
private __listTemplates;
/**
* Retrieve a Connection Profile Template.
*
* @param {string} id - ID of the connection-profile-template to retrieve.
* @param {ConnectionProfilesClient.RequestOptions} requestOptions - Request-specific configuration.
*
* @throws {@link Management.UnauthorizedError}
* @throws {@link Management.ForbiddenError}
* @throws {@link Management.NotFoundError}
* @throws {@link Management.TooManyRequestsError}
*
* @example
* await client.connectionProfiles.getTemplate("id")
*/
getTemplate(id: string, requestOptions?: ConnectionProfilesClient.RequestOptions): core.HttpResponsePromise<Management.GetConnectionProfileTemplateResponseContent>;
private __getTemplate;
/**
* Retrieve details about a single Connection Profile specified by ID.
*
* @param {string} id - ID of the connection-profile to retrieve.
* @param {ConnectionProfilesClient.RequestOptions} requestOptions - Request-specific configuration.
*
* @throws {@link Management.UnauthorizedError}
* @throws {@link Management.ForbiddenError}
* @throws {@link Management.NotFoundError}
* @throws {@link Management.TooManyRequestsError}
*
* @example
* await client.connectionProfiles.get("id")
*/
get(id: string, requestOptions?: ConnectionProfilesClient.RequestOptions): core.HttpResponsePromise<Management.GetConnectionProfileResponseContent>;
private __get;
/**
* Delete a single Connection Profile specified by ID.
*
* @param {string} id - ID of the connection-profile to delete.
* @param {ConnectionProfilesClient.RequestOptions} requestOptions - Request-specific configuration.
*
* @throws {@link Management.UnauthorizedError}
* @throws {@link Management.ForbiddenError}
* @throws {@link Management.TooManyRequestsError}
*
* @example
* await client.connectionProfiles.delete("id")
*/
delete(id: string, requestOptions?: ConnectionProfilesClient.RequestOptions): core.HttpResponsePromise<void>;
private __delete;
/**
* Update the details of a specific Connection Profile.
*
* @param {string} id - ID of the connection profile to update.
* @param {Management.UpdateConnectionProfileRequestContent} request
* @param {ConnectionProfilesClient.RequestOptions} requestOptions - Request-specific configuration.
*
* @throws {@link Management.BadRequestError}
* @throws {@link Management.UnauthorizedError}
* @throws {@link Management.ForbiddenError}
* @throws {@link Management.TooManyRequestsError}
*
* @example
* await client.connectionProfiles.update("id")
*/
update(id: string, request?: Management.UpdateConnectionProfileRequestContent, requestOptions?: ConnectionProfilesClient.RequestOptions): core.HttpResponsePromise<Management.UpdateConnectionProfileResponseContent>;
private __update;
}