/*
 * Copyright 2021 Wultra s.r.o.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import { PowerAuthActivationState } from './PowerAuthActivationState';

/**
 * The `PowerAuthActivationStatus` object represents complete status of the activation.
 */
export interface PowerAuthActivationStatus {
    /**
     * State of the activation.
     */
    state: PowerAuthActivationState
    /**
     * Number of failed authentication attempts in a row.
     */
    failCount: number
    /**
     * Maximum number of allowed failed authentication attempts in a row.
     */
    maxFailCount: number
    /**
     * Contains `(maxFailCount - failCount)` if state is `ACTIVE`, otherwise 0.
     */
    remainingAttempts: number
    /**
     * Contains custom object returned from the server. The value is optional and PowerAuth Application Server must support this custom object.
     */
    customObject?: any
}