Type Alias ConditionsAPI

type ConditionsAPI = {
    clearCache: typeof clearCache;
    createCondition: typeof createCondition;
    createConditionEvaluation: typeof createConditionEvaluation;
    createConditionPreview: typeof createConditionPreview;
    deleteCondition: typeof deleteCondition;
    deleteConditionEvaluation: typeof deleteConditionEvaluation;
    getCondition: typeof getCondition;
    getConditionEvaluation: typeof getConditionEvaluation;
    getConditionPreview: typeof getConditionPreview;
    getConditionsSettings: typeof getConditionsSettings;
    patchCondition: typeof patchCondition;
    setConditionsSettings: typeof setConditionsSettings;
}

Index

Properties

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

Properties

clearCache

clearCache: typeof clearCache

Clears the cache for conditions api requests.

createCondition

createCondition: typeof createCondition

Creates a new condition.

Param: body

an object with the body content

Throws

CreateConditionHttpError

createConditionEvaluation

createConditionEvaluation: typeof createConditionEvaluation

Executes the condition

Param: id

The id of the condition

Param: body

an object with the body content

Throws

CreateConditionEvaluationHttpError

createConditionPreview

createConditionPreview: typeof createConditionPreview

Create condition preview request.

Param: body

an object with the body content

Throws

CreateConditionPreviewHttpError

deleteCondition

deleteCondition: typeof deleteCondition

Delete the condition

Param: id

The id of the condition

Throws

DeleteConditionHttpError

deleteConditionEvaluation

deleteConditionEvaluation: typeof deleteConditionEvaluation

Delete an Evaluation

Param: id

The id of the condition

Param: evaluationId

The id of the evaluation

Throws

DeleteConditionEvaluationHttpError

getCondition

getCondition: typeof getCondition

Retrieve a specific condition by id.

Param: id

The id of the condition

Throws

GetConditionHttpError

getConditionEvaluation

getConditionEvaluation: typeof getConditionEvaluation

Get an Evaluation

Param: id

The id of the condition

Param: evaluationId

The id of the evaluation

Throws

GetConditionEvaluationHttpError

getConditionPreview

getConditionPreview: typeof getConditionPreview

Get condition preview response.

Param: id

The id of the condition

Throws

GetConditionPreviewHttpError

getConditionsSettings

getConditionsSettings: typeof getConditionsSettings

Retrieves condition manager settings

Throws

GetConditionsSettingsHttpError

patchCondition

patchCondition: typeof patchCondition

Patch values in the condition

Param: id

The id of the condition

Param: body

an object with the body content

Throws

PatchConditionHttpError

setConditionsSettings

setConditionsSettings: typeof setConditionsSettings

Updates API configuration. Accessible only by tenant admins.

Param: body

an object with the body content

Throws

SetConditionsSettingsHttpError

Type Alias ConditionsAPI

Index

Properties

Properties

clearCache

createCondition

Param: body

Throws

createConditionEvaluation

Param: id

Param: body

Throws

createConditionPreview

Param: body

Throws

deleteCondition

Param: id

Throws

deleteConditionEvaluation

Param: id

Param: evaluationId

Throws

getCondition

Param: id

Throws

getConditionEvaluation

Param: id

Param: evaluationId

Throws

getConditionPreview

Param: id

Throws

getConditionsSettings

Throws

patchCondition

Param: id

Param: body

Throws

setConditionsSettings

Param: body

Throws

Settings

On This Page