lithic-kotlin-root/com.lithic.api.services.async.authRules/V2ServiceAsync

V2ServiceAsync

interface V2ServiceAsync

Inheritors

Types

Link copied to clipboard
interface WithRawResponse

A view of V2ServiceAsync that provides access to raw HTTP responses for each method.

Functions

Link copied to clipboard
abstract suspend fun apply(params: AuthRuleV2ApplyParams, requestOptions: RequestOptions = RequestOptions.none()): V2ApplyResponse

open suspend fun apply(authRuleToken: String, params: AuthRuleV2ApplyParams, requestOptions: RequestOptions = RequestOptions.none()): V2ApplyResponse

Associates a V2 Auth rule with a card program, the provided account(s) or card(s).

Link copied to clipboard
Link copied to clipboard
abstract suspend fun create(params: AuthRuleV2CreateParams, requestOptions: RequestOptions = RequestOptions.none()): V2CreateResponse

Creates a new V2 Auth rule in draft mode

Link copied to clipboard
abstract suspend fun delete(params: AuthRuleV2DeleteParams, requestOptions: RequestOptions = RequestOptions.none())
open suspend fun delete(authRuleToken: String, requestOptions: RequestOptions)

open suspend fun delete(authRuleToken: String, params: AuthRuleV2DeleteParams = AuthRuleV2DeleteParams.none(), requestOptions: RequestOptions = RequestOptions.none())

Deletes a V2 Auth rule

Link copied to clipboard
abstract suspend fun draft(params: AuthRuleV2DraftParams, requestOptions: RequestOptions = RequestOptions.none()): V2DraftResponse
open suspend fun draft(authRuleToken: String, requestOptions: RequestOptions): V2DraftResponse

open suspend fun draft(authRuleToken: String, params: AuthRuleV2DraftParams = AuthRuleV2DraftParams.none(), requestOptions: RequestOptions = RequestOptions.none()): V2DraftResponse

Creates a new draft version of a rule that will be ran in shadow mode.

Link copied to clipboard
open suspend fun list(requestOptions: RequestOptions): AuthRuleV2ListPageAsync

abstract suspend fun list(params: AuthRuleV2ListParams = AuthRuleV2ListParams.none(), requestOptions: RequestOptions = RequestOptions.none()): AuthRuleV2ListPageAsync

Lists V2 Auth rules

Link copied to clipboard
abstract suspend fun promote(params: AuthRuleV2PromoteParams, requestOptions: RequestOptions = RequestOptions.none()): V2PromoteResponse
open suspend fun promote(authRuleToken: String, requestOptions: RequestOptions): V2PromoteResponse

open suspend fun promote(authRuleToken: String, params: AuthRuleV2PromoteParams = AuthRuleV2PromoteParams.none(), requestOptions: RequestOptions = RequestOptions.none()): V2PromoteResponse

Promotes the draft version of an Auth rule to the currently active version such that it is enforced in the respective stream.

Link copied to clipboard
abstract suspend fun report(params: AuthRuleV2ReportParams, requestOptions: RequestOptions = RequestOptions.none()): V2ReportResponse
open suspend fun report(authRuleToken: String, requestOptions: RequestOptions): V2ReportResponse

open suspend fun report(authRuleToken: String, params: AuthRuleV2ReportParams = AuthRuleV2ReportParams.none(), requestOptions: RequestOptions = RequestOptions.none()): V2ReportResponse

This endpoint is deprecated and will be removed in the future. Requests a performance report of an Auth rule to be asynchronously generated. Reports can only be run on rules in draft or active mode and will included approved and declined statistics as well as examples. The generated report will be delivered asynchronously through a webhook with event_type = auth_rules.performance_report.created. See the docs on setting up webhook subscriptions.

Link copied to clipboard
abstract suspend fun retrieve(params: AuthRuleV2RetrieveParams, requestOptions: RequestOptions = RequestOptions.none()): V2RetrieveResponse
open suspend fun retrieve(authRuleToken: String, requestOptions: RequestOptions): V2RetrieveResponse

open suspend fun retrieve(authRuleToken: String, params: AuthRuleV2RetrieveParams = AuthRuleV2RetrieveParams.none(), requestOptions: RequestOptions = RequestOptions.none()): V2RetrieveResponse

Fetches a V2 Auth rule by its token

Link copied to clipboard
abstract suspend fun retrieveFeatures(params: AuthRuleV2RetrieveFeaturesParams, requestOptions: RequestOptions = RequestOptions.none()): V2RetrieveFeaturesResponse
open suspend fun retrieveFeatures(authRuleToken: String, requestOptions: RequestOptions): V2RetrieveFeaturesResponse

open suspend fun retrieveFeatures(authRuleToken: String, params: AuthRuleV2RetrieveFeaturesParams = AuthRuleV2RetrieveFeaturesParams.none(), requestOptions: RequestOptions = RequestOptions.none()): V2RetrieveFeaturesResponse

Fetches the current calculated Feature values for the given Auth Rule

Link copied to clipboard
abstract suspend fun retrieveReport(params: AuthRuleV2RetrieveReportParams, requestOptions: RequestOptions = RequestOptions.none()): V2RetrieveReportResponse

open suspend fun retrieveReport(authRuleToken: String, params: AuthRuleV2RetrieveReportParams, requestOptions: RequestOptions = RequestOptions.none()): V2RetrieveReportResponse

Retrieves a performance report for an Auth rule containing daily statistics and evaluation outcomes.

Link copied to clipboard
abstract suspend fun update(params: AuthRuleV2UpdateParams, requestOptions: RequestOptions = RequestOptions.none()): V2UpdateResponse

open suspend fun update(authRuleToken: String, params: AuthRuleV2UpdateParams, requestOptions: RequestOptions = RequestOptions.none()): V2UpdateResponse

Updates a V2 Auth rule's properties

Link copied to clipboard
abstract fun withOptions(modifier: (ClientOptions.Builder) -> Unit): V2ServiceAsync

Returns a view of this service with the given option modifications applied.

Link copied to clipboard
abstract fun withRawResponse(): V2ServiceAsync.WithRawResponse

Returns a view of this service that provides access to raw HTTP responses for each method.