Class ElementsClient

API client for interacting with the Permit Elements API.

Hierarchy

BasePermitApi
- ElementsClient

Implements

IPermitElementsApi

Index

Constructors

Methods

ensureAccessLevel ensureContext loginAs

Constructors

constructor

new ElementsClient(config, logger): ElementsClient
Creates an instance of the ElementsClient.
Parameters
- config: IPermitConfig
  
  The configuration object for the Permit SDK.
- logger: Logger<LoggerOptions>
  
  The logger instance for logging.
Returns ElementsClient
Overrides BasePermitApi.constructor
- Defined in src/api/elements.ts:66

Methods

ensureAccessLevel

ensureAccessLevel(requiredAccessLevel): Promise<void>
Ensure that the API Key has the necessary permissions to successfully call the API endpoint. Note that this check is not foolproof, and the API may still throw 401.
Parameters
- requiredAccessLevel: ApiKeyLevel
  
  The required API Key Access level for the endpoint.
Returns Promise<void>

Throws
PermitContextError If the currently set API key access level does not match the required access level.
Inherited from BasePermitApi.ensureAccessLevel
- Defined in src/api/base.ts:116

ensureContext

ensureContext(requiredContext): Promise<void>
Ensure that the API context matches the required endpoint context.
Parameters
- requiredContext: ApiContextLevel
  
  The required API context level for the endpoint.
Returns Promise<void>

Throws
PermitContextError If the currently set API context level does not match the required context level.
Inherited from BasePermitApi.ensureContext
- Defined in src/api/base.ts:143

loginAs

loginAs(loginData): Promise<EmbeddedLoginRequestOutputWithContent>
Logs in as a user in the context of a specific tenant.
Parameters
- loginData: loginAsSchema
  
  The login data containing the user key and tenant key.
Returns Promise<EmbeddedLoginRequestOutputWithContent>
The embedded login authentication session data.

Throws
PermitApiError If the API returns an error HTTP status code.

Throws
PermitContextError If the configured ApiContext does not match the required endpoint context.
Implementation of IPermitElementsApi.loginAs
- Defined in src/api/elements.ts:82

Generated using TypeDoc