Class AuthRuleV2BacktestCreateParams
-
- All Implemented Interfaces:
-
com.lithic.api.core.Params
public final class AuthRuleV2BacktestCreateParams implements Params
Initiates a request to asynchronously generate a backtest for an Auth rule. During backtesting, both the active version (if one exists) and the draft version of the Auth Rule are evaluated by replaying historical transaction data against the rule's conditions. This process allows customers to simulate and understand the effects of proposed rule changes before deployment. The generated backtest report provides detailed results showing whether the draft version of the Auth Rule would have approved or declined historical transactions which were processed during the backtest period. These reports help evaluate how changes to rule configurations might affect overall transaction approval rates.
The generated backtest report will be delivered asynchronously through a webhook with
event_type=auth_rules.backtest_report.created. See the docs on setting up webhook subscriptions. It is also possible to request backtest reports on-demand through the/v2/auth_rules/{auth_rule_token}/backtests/{auth_rule_backtest_token}endpoint.Lithic currently supports backtesting for
CONDITIONAL_BLOCK/CONDITIONAL_ACTIONrules. Backtesting forVELOCITY_LIMITrules is generally not supported. In specific cases (i.e. where Lithic has pre-calculated the requested velocity metrics for historical transactions), a backtest may be feasible. However, such cases are uncommon and customers should not anticipate support for velocity backtests under most configurations. If a historical transaction does not feature the required inputs to evaluate the rule, then it will not be included in the final backtest report.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classAuthRuleV2BacktestCreateParams.BuilderA builder for AuthRuleV2BacktestCreateParams.
public final classAuthRuleV2BacktestCreateParams.BacktestRequest
-
Method Summary
Modifier and Type Method Description final Optional<String>authRuleToken()final Optional<OffsetDateTime>end()The end time of the backtest. final Optional<OffsetDateTime>start()The start time of the backtest. final JsonField<OffsetDateTime>_end()Returns the raw JSON value of end. final JsonField<OffsetDateTime>_start()Returns the raw JSON value of start. final Map<String, JsonValue>_additionalBodyProperties()final Headers_additionalHeaders()Additional headers to send with the request. final QueryParams_additionalQueryParams()Additional query param to send with the request. final AuthRuleV2BacktestCreateParams.BuildertoBuilder()final AuthRuleV2BacktestCreateParams.BacktestRequest_body()final String_pathParam(Integer index)Headers_headers()The full set of headers in the parameters, including both fixed and additional headers. QueryParams_queryParams()The full set of query params in the parameters, including both fixed and additional query params. Booleanequals(Object other)IntegerhashCode()StringtoString()final static AuthRuleV2BacktestCreateParamsnone()final static AuthRuleV2BacktestCreateParams.Builderbuilder()Returns a mutable builder for constructing an instance of AuthRuleV2BacktestCreateParams. -
-
Method Detail
-
authRuleToken
final Optional<String> authRuleToken()
-
end
final Optional<OffsetDateTime> end()
The end time of the backtest.
-
start
final Optional<OffsetDateTime> start()
The start time of the backtest.
-
_end
final JsonField<OffsetDateTime> _end()
Returns the raw JSON value of end.
Unlike end, this method doesn't throw if the JSON field has an unexpected type.
-
_start
final JsonField<OffsetDateTime> _start()
Returns the raw JSON value of start.
Unlike start, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
-
_additionalHeaders
final Headers _additionalHeaders()
Additional headers to send with the request.
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
Additional query param to send with the request.
-
toBuilder
final AuthRuleV2BacktestCreateParams.Builder toBuilder()
-
_body
final AuthRuleV2BacktestCreateParams.BacktestRequest _body()
-
_pathParam
final String _pathParam(Integer index)
-
_headers
Headers _headers()
The full set of headers in the parameters, including both fixed and additional headers.
-
_queryParams
QueryParams _queryParams()
The full set of query params in the parameters, including both fixed and additional query params.
-
none
final static AuthRuleV2BacktestCreateParams none()
-
builder
final static AuthRuleV2BacktestCreateParams.Builder builder()
Returns a mutable builder for constructing an instance of AuthRuleV2BacktestCreateParams.
-
-
-
-