Interface ConditionsAPI

interface ConditionsAPI {
    clearCache: () => void;
    createCondition: (
        body: ConditionCreateRequest,
        options?: ApiCallOptions,
    ) => Promise<CreateConditionHttpResponse>;
    createConditionEvaluation: (
        id: string,
        body: CreateEvaluationRequest,
        options?: ApiCallOptions,
    ) => Promise<CreateConditionEvaluationHttpResponse>;
    createConditionPreview: (
        body: ConditionCreateRequest,
        options?: ApiCallOptions,
    ) => Promise<CreateConditionPreviewHttpResponse>;
    deleteCondition: (
        id: string,
        options?: ApiCallOptions,
    ) => Promise<DeleteConditionHttpResponse>;
    deleteConditionEvaluation: (
        id: string,
        evaluationId: string,
        options?: ApiCallOptions,
    ) => Promise<DeleteConditionEvaluationHttpResponse>;
    getCondition: (
        id: string,
        options?: ApiCallOptions,
    ) => Promise<GetConditionHttpResponse>;
    getConditionEvaluation: (
        id: string,
        evaluationId: string,
        options?: ApiCallOptions,
    ) => Promise<GetConditionEvaluationHttpResponse>;
    getConditionPreview: (
        id: string,
        options?: ApiCallOptions,
    ) => Promise<GetConditionPreviewHttpResponse>;
    getConditionsSettings: (
        options?: ApiCallOptions,
    ) => Promise<GetConditionsSettingsHttpResponse>;
    patchCondition: (
        id: string,
        body: ConditionPatch,
        options?: ApiCallOptions,
    ) => Promise<PatchConditionHttpResponse>;
    setConditionsSettings: (
        body: APISettingsUpload,
        options?: ApiCallOptions,
    ) => Promise<SetConditionsSettingsHttpResponse>;
}
Index

Properties

clearCache createCondition createConditionEvaluation createConditionPreview deleteCondition deleteConditionEvaluation getCondition getConditionEvaluation getConditionPreview getConditionsSettings patchCondition setConditionsSettings

Properties

clearCache: () => void

Clears the cache for conditions api requests.

Type Declaration

    • (): void

    • Clears the cache for conditions api requests.

      Returns void

createCondition: (
    body: ConditionCreateRequest,
    options?: ApiCallOptions,
) => Promise<CreateConditionHttpResponse>

Creates a new condition.

Type Declaration

Param: body

an object with the body content

CreateConditionHttpError

createConditionEvaluation: (
    id: string,
    body: CreateEvaluationRequest,
    options?: ApiCallOptions,
) => Promise<CreateConditionEvaluationHttpResponse>

Executes the condition

Type Declaration

The id of the condition

Param: body

an object with the body content

CreateConditionEvaluationHttpError

createConditionPreview: (
    body: ConditionCreateRequest,
    options?: ApiCallOptions,
) => Promise<CreateConditionPreviewHttpResponse>

Create condition preview request.

Type Declaration

Param: body

an object with the body content

CreateConditionPreviewHttpError

deleteCondition: (
    id: string,
    options?: ApiCallOptions,
) => Promise<DeleteConditionHttpResponse>

Delete the condition

Type Declaration

The id of the condition

DeleteConditionHttpError

deleteConditionEvaluation: (
    id: string,
    evaluationId: string,
    options?: ApiCallOptions,
) => Promise<DeleteConditionEvaluationHttpResponse>

Delete an Evaluation

Type Declaration

The id of the condition

The id of the evaluation

DeleteConditionEvaluationHttpError

getCondition: (
    id: string,
    options?: ApiCallOptions,
) => Promise<GetConditionHttpResponse>

Retrieve a specific condition by id.

Type Declaration

The id of the condition

GetConditionHttpError

getConditionEvaluation: (
    id: string,
    evaluationId: string,
    options?: ApiCallOptions,
) => Promise<GetConditionEvaluationHttpResponse>

Get an Evaluation

Type Declaration

The id of the condition

The id of the evaluation

GetConditionEvaluationHttpError

getConditionPreview: (
    id: string,
    options?: ApiCallOptions,
) => Promise<GetConditionPreviewHttpResponse>

Get condition preview response.

Type Declaration

The id of the condition

GetConditionPreviewHttpError

getConditionsSettings: (
    options?: ApiCallOptions,
) => Promise<GetConditionsSettingsHttpResponse>

Retrieves condition manager settings

Type Declaration

GetConditionsSettingsHttpError

patchCondition: (
    id: string,
    body: ConditionPatch,
    options?: ApiCallOptions,
) => Promise<PatchConditionHttpResponse>

Patch values in the condition

Type Declaration

The id of the condition

Param: body

an object with the body content

PatchConditionHttpError

setConditionsSettings: (
    body: APISettingsUpload,
    options?: ApiCallOptions,
) => Promise<SetConditionsSettingsHttpResponse>

Updates API configuration. Accessible only by tenant admins.

Type Declaration

Param: body

an object with the body content

SetConditionsSettingsHttpError

Settings

Member Visibility

On This Page

Properties