/**
 * Copyright © 2016-2026 The Thingsboard Authors
 *
 * 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.
 */
package org.thingsboard.server.common.data.security.model.mfa.account;

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonSubTypes;
import com.fasterxml.jackson.annotation.JsonSubTypes.Type;
import com.fasterxml.jackson.annotation.JsonTypeInfo;
import io.swagger.v3.oas.annotations.media.DiscriminatorMapping;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;
import org.thingsboard.server.common.data.security.model.mfa.provider.TwoFaProviderType;

import java.io.Serializable;

@JsonIgnoreProperties(ignoreUnknown = true)
@JsonTypeInfo(
        use = JsonTypeInfo.Id.NAME,
        property = "providerType")
@JsonSubTypes({
        @Type(name = "TOTP", value = TotpTwoFaAccountConfig.class),
        @Type(name = "SMS", value = SmsTwoFaAccountConfig.class),
        @Type(name = "EMAIL", value = EmailTwoFaAccountConfig.class),
        @Type(name = "BACKUP_CODE", value = BackupCodeTwoFaAccountConfig.class)
})
@Schema(
        description = "Base configuration for two-factor authentication accounts",
        discriminatorProperty = "providerType",
        discriminatorMapping = {
                @DiscriminatorMapping(value = "TOTP", schema = TotpTwoFaAccountConfig.class),
                @DiscriminatorMapping(value = "SMS", schema = SmsTwoFaAccountConfig.class),
                @DiscriminatorMapping(value = "EMAIL", schema = EmailTwoFaAccountConfig.class),
                @DiscriminatorMapping(value = "BACKUP_CODE", schema = BackupCodeTwoFaAccountConfig.class)
        }
)
@Data
public abstract class TwoFaAccountConfig implements Serializable {

    private boolean useByDefault;

    @JsonIgnore
    protected transient boolean serializeHiddenFields;

    @JsonIgnore
    public abstract TwoFaProviderType getProviderType();

}
