Creates an instance of the ProjectsApi.
The configuration object for the Permit SDK.
The logger instance for logging.
Creates a new project.
The data for the new project.
A promise that resolves to the created project.
PermitApiError If the API returns an error HTTP status code.
PermitContextError If the configured ApiContext does not match the required endpoint context.
Deletes a project.
The key of the project to delete.
A promise that resolves when the project is deleted.
PermitApiError If the API returns an error HTTP status code.
PermitContextError If the configured ApiContext does not match the required endpoint context.
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.
The required API Key Access level for the endpoint.
PermitContextError If the currently set API key access level does not match the required access level.
Ensure that the API context matches the required endpoint context.
The required API context level for the endpoint.
PermitContextError If the currently set API context level does not match the required context level.
Retrieves a project by its key.
The key of the project.
A promise that resolves to the project.
PermitApiError If the API returns an error HTTP status code.
PermitContextError If the configured ApiContext does not match the required endpoint context.
Retrieves a project by its ID. Alias for the get method.
The ID of the project.
A promise that resolves to the project.
PermitApiError If the API returns an error HTTP status code.
PermitContextError If the configured ApiContext does not match the required endpoint context.
Retrieves a project by its key. Alias for the get method.
The key of the project.
A promise that resolves to the project.
PermitApiError If the API returns an error HTTP status code.
PermitContextError If the configured ApiContext does not match the required endpoint context.
Retrieves a list of projects.
Optional pagination: IPaginationThe pagination options,
A promise that resolves to an array of projects.
PermitApiError If the API returns an error HTTP status code.
PermitContextError If the configured ApiContext does not match the required endpoint context.
Updates a project.
The key of the project.
The updated data for the project.
A promise that resolves to the updated project.
PermitApiError If the API returns an error HTTP status code.
PermitContextError If the configured ApiContext does not match the required endpoint context.
Generated using TypeDoc
The ProjectsApi class provides methods for interacting with Permit Projects.