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.
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
Creates a new project.