Class ConditionSetsApi

The ConditionSetsApi class provides methods for interacting with condition sets using the Permit REST API.

Hierarchy

  • BasePermitApi
    • ConditionSetsApi

Implements

Constructors

Methods

  • Deletes a condition set.

    Parameters

    • conditionSetKey: string

      The key of the condition set to delete.

    Returns Promise<void>

    A promise that resolves when the condition set is deleted.

    Throws

    PermitApiError If the API returns an error HTTP status code.

    Throws

    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.

    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.

  • 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.

Generated using TypeDoc