/* Options:
Date: 2026-01-24 21:49:55
Version: 8.90
Tip: To override a DTO option, remove "//" prefix before updating
BaseUrl: https://taxfiling.staging.pwc.de

//Package: 
//GlobalNamespace: dtos
//AddPropertyAccessors: True
//SettersReturnThis: True
//AddServiceStackTypes: True
//AddResponseStatus: False
//AddDescriptionAsComments: True
//AddImplicitVersion: 
IncludeTypes: GetPortalCertificatePinStatusAsync.*
//ExcludeTypes: 
//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.*;

public class dtos
{

    /**
    * 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.")
    public static class GetPortalCertificatePinStatusAsync extends GetPortalCertificatePinStatusBase implements IReturn<GetPinStatusResponse>
    {
        
        private static Object responseType = GetPinStatusResponse.class;
        public Object getResponseType() { return 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.")
    public static class GetPinStatusResponse extends EricFehlerCodeResponse
    {
        /**
        * The PIN status of the provided certificate.
        */
        @ApiMember(Description="The PIN status of the provided certificate.", Name="PinStatus")
        public EricPinStatus pinStatus = null;
        
        public EricPinStatus getPinStatus() { return pinStatus; }
        public GetPinStatusResponse setPinStatus(EricPinStatus value) { this.pinStatus = value; return this; }
    }

    /**
    * Represents a portal certificate that is protected by a password.
    */
    @Api(Description="Represents a portal certificate that is protected by a password.")
    public static class PortalCertificate extends FileBase implements ISecuredCertificate
    {
        /**
        * The file name of the certificate.
        */
        @ApiMember(Description="The file name of the certificate.")
        @StringLength(MaximumLength=128)
        public String name = null;

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

        /**
        * The description of the certificate.
        */
        @StringLength(MaximumLength=2147483647)
        @ApiMember(Description="The description of the certificate.")
        public String description = 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.")
        public ArrayList<String> tags = new ArrayList<String>();
        
        public String getName() { return name; }
        public PortalCertificate setName(String value) { this.name = value; return this; }
        public String getPin() { return pin; }
        public PortalCertificate setPin(String value) { this.pin = value; return this; }
        public String getDescription() { return description; }
        public PortalCertificate setDescription(String value) { this.description = value; return this; }
        public ArrayList<String> getTags() { return tags; }
        public PortalCertificate setTags(ArrayList<String> value) { this.tags = value; return this; }
    }

    /**
    * Represents the key type for a password-protected area.
    */
    public static enum 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.")
    public static class GetPortalCertificatePinStatusBase implements IPost
    {
        /**
        * The portal certificate, whose PIN status is determined.
        */
        @ApiMember(Description="The portal certificate, whose PIN status is determined.")
        public PortalCertificate zertifikat = null;

        /**
        * The option for the selection of the key-pair.
        */
        @ApiMember(Description="The option for the selection of the key-pair.")
        public EricKeyType keyType = null;
        
        public PortalCertificate getZertifikat() { return zertifikat; }
        public GetPortalCertificatePinStatusBase setZertifikat(PortalCertificate value) { this.zertifikat = value; return this; }
        public EricKeyType getKeyType() { return keyType; }
        public GetPortalCertificatePinStatusBase setKeyType(EricKeyType value) { this.keyType = value; return this; }
    }

    /**
    * Represents the PIN status.
    */
    public static enum 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.")
    public static class FileBase
    {
        /**
        * The raw data content of the file in bytes.
        */
        @ApiMember(Description="The raw data content of the file in bytes.", Name="Content")
        public byte[] content = null;
        
        public byte[] getContent() { return content; }
        public FileBase setContent(byte[] value) { this.content = value; return this; }
    }

    public static interface ISecuredCertificate
    {
        public String pin = null;
    }

    /**
    * 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.")
    public static class EricFehlerCodeResponse extends ServiceReponseBase
    {
        /**
        * The status code that the ERiC API function returns.
        */
        @ApiMember(Description="The status code that the ERiC API function returns.")
        public EricFehlerCode statusCode = null;

        /**
        * The status message that the ERiC API function returns.
        */
        @ApiMember(Description="The status message that the ERiC API function returns.")
        public String statusText = null;
        
        public EricFehlerCode getStatusCode() { return statusCode; }
        public EricFehlerCodeResponse setStatusCode(EricFehlerCode value) { this.statusCode = value; return this; }
        public String getStatusText() { return statusText; }
        public EricFehlerCodeResponse setStatusText(String value) { this.statusText = value; return this; }
    }

}