/* Options:
Date: 2026-01-25 19:13:32
Version: 8.90
Tip: To override a DTO option, remove "//" prefix before updating
BaseUrl: https://taxfiling.staging.pwc.de

//Package: 
//AddServiceStackTypes: True
//AddResponseStatus: False
//AddImplicitVersion: 
//AddDescriptionAsComments: True
IncludeTypes: GetPortalCertificatePinStatusAsync.*
//ExcludeTypes: 
//InitializeCollections: False
//TreatTypesAsStrings: 
//DefaultImports: java.math.*,java.util.*,java.io.InputStream,net.servicestack.client.*
*/

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* An asynchronous service to get the PIN status of a password-protected portal certificate.
*/
@Route(Path="/GetPortalCertificatePinStatusAsync", Verbs="POST")
@Api(Description="An asynchronous service to get the PIN status of a password-protected portal certificate.")
open class GetPortalCertificatePinStatusAsync : GetPortalCertificatePinStatusBase(), IReturn<GetPinStatusResponse>
{
    companion object { private val responseType = GetPinStatusResponse::class.java }
    override fun getResponseType(): Any? = GetPortalCertificatePinStatusAsync.responseType
}

/**
* Represents a type that encapsulates the return values of the ERiC API function that obtains the PIN status of a given certificate.
*/
@Api(Description="Represents a type that encapsulates the return values of the ERiC API function that obtains the PIN status of a given certificate.")
open class GetPinStatusResponse : EricFehlerCodeResponse()
{
    /**
    * The PIN status of the provided certificate.
    */
    @ApiMember(Description="The PIN status of the provided certificate.", Name="PinStatus")
    open var pinStatus:EricPinStatus? = null
}

/**
* Represents a portal certificate that is protected by a password.
*/
@Api(Description="Represents a portal certificate that is protected by a password.")
open class PortalCertificate : FileBase(), ISecuredCertificate
{
    /**
    * The file name of the certificate.
    */
    @ApiMember(Description="The file name of the certificate.")
    @StringLength(MaximumLength=128)
    open var name:String? = null

    /**
    * The password to protect the certificate from unauthorized access.
    */
    @StringLength(MaximumLength=255)
    @ApiMember(Description="The password to protect the certificate from unauthorized access.")
    override var pin:String? = null

    /**
    * The description of the certificate.
    */
    @StringLength(MaximumLength=2147483647)
    @ApiMember(Description="The description of the certificate.")
    open var description:String? = null

    /**
    * Tags that can be used to label or identify the certificate.
    */
    @ApiMember(Description="Tags that can be used to label or identify the certificate.")
    open var tags:ArrayList<String> = ArrayList<String>()
}

/**
* Represents the key type for a password-protected area.
*/
enum class EricKeyType
{
    ESIGNATUREKey,
    EENCRYPTIONKey,
}

/**
* A base service to get the PIN status of a password-protected portal certificate.
*/
@Api(Description="A base service to get the PIN status of a password-protected portal certificate.")
open class GetPortalCertificatePinStatusBase : IPost
{
    /**
    * The portal certificate, whose PIN status is determined.
    */
    @ApiMember(Description="The portal certificate, whose PIN status is determined.")
    open var zertifikat:PortalCertificate? = null

    /**
    * The option for the selection of the key-pair.
    */
    @ApiMember(Description="The option for the selection of the key-pair.")
    open var keyType:EricKeyType? = null
}

/**
* Represents the PIN status.
*/
enum class EricPinStatus
{
    StatusPinOk,
    StatusPinLocked,
    StatusPreviousPinError,
    StatusLockedIfPinError,
}

/**
* Represents a base class for a file with raw data.
*/
@Api(Description="Represents a base class for a file with raw data.")
open class FileBase
{
    /**
    * The raw data content of the file in bytes.
    */
    @ApiMember(Description="The raw data content of the file in bytes.", Name="Content")
    open var content:ByteArray? = null
}

interface ISecuredCertificate
{
    var pin:String?
}

/**
* Represent a base response that encapsulate any ERiC API function return value.
*/
@Api(Description="Represent a base response that encapsulate any ERiC API function return value.")
open class EricFehlerCodeResponse : ServiceReponseBase()
{
    /**
    * The status code that the ERiC API function returns.
    */
    @ApiMember(Description="The status code that the ERiC API function returns.")
    open var statusCode:EricFehlerCode? = null

    /**
    * The status message that the ERiC API function returns.
    */
    @ApiMember(Description="The status message that the ERiC API function returns.")
    open var statusText:String? = null
}