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

//GlobalNamespace: 
//MakePropertiesOptional: False
//AddServiceStackTypes: True
//AddResponseStatus: False
//AddImplicitVersion: 
//AddDescriptionAsComments: True
IncludeTypes: GetPortalCertificatePinStatusAsync.*
//ExcludeTypes: 
//DefaultImports: 
*/


export interface IReturn<T>
{
    createResponse(): T;
}

/** @description Represents a base class for a file with raw data. */
// @Api(Description="Represents a base class for a file with raw data.")
export class FileBase
{
    /** @description The raw data content of the file in bytes. */
    // @ApiMember(Description="The raw data content of the file in bytes.", Name="Content")
    public content: string;

    public constructor(init?: Partial<FileBase>) { (Object as any).assign(this, init); }
}

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

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

    /** @description The description of the certificate. */
    // @StringLength(2147483647)
    // @ApiMember(Description="The description of the certificate.")
    public description?: string;

    /** @description 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 tags: string[] = [];

    public constructor(init?: Partial<PortalCertificate>) { super(init); (Object as any).assign(this, init); }
}

/** @description Represents the key type for a password-protected area. */
export enum EricKeyType
{
    eSIGNATURE_KEY = 'eSIGNATURE_KEY',
    eENCRYPTION_KEY = 'eENCRYPTION_KEY',
}

/** @description 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.")
export class GetPortalCertificatePinStatusBase implements IPost
{
    /** @description The portal certificate, whose PIN status is determined. */
    // @ApiMember(Description="The portal certificate, whose PIN status is determined.")
    public zertifikat: PortalCertificate;

    /** @description The option for the selection of the key-pair. */
    // @ApiMember(Description="The option for the selection of the key-pair.")
    public keyType: EricKeyType;

    public constructor(init?: Partial<GetPortalCertificatePinStatusBase>) { (Object as any).assign(this, init); }
}

/** @description Represents the PIN status. */
export enum EricPinStatus
{
    STATUS_PIN_OK = 'STATUS_PIN_OK',
    STATUS_PIN_LOCKED = 'STATUS_PIN_LOCKED',
    STATUS_PREVIOUS_PIN_ERROR = 'STATUS_PREVIOUS_PIN_ERROR',
    STATUS_LOCKED_IF_PIN_ERROR = 'STATUS_LOCKED_IF_PIN_ERROR',
}

export interface ISecuredCertificate
{
    pin: string;
}

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

    /** @description The status message that the ERiC API function returns. */
    // @ApiMember(Description="The status message that the ERiC API function returns.")
    public statusText?: string;

    public constructor(init?: Partial<EricFehlerCodeResponse>) { super(init); (Object as any).assign(this, init); }
}

/** @description 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.")
export class GetPinStatusResponse extends EricFehlerCodeResponse
{
    /** @description The PIN status of the provided certificate. */
    // @ApiMember(Description="The PIN status of the provided certificate.", Name="PinStatus")
    public pinStatus: EricPinStatus;

    public constructor(init?: Partial<GetPinStatusResponse>) { super(init); (Object as any).assign(this, init); }
}

/** @description An asynchronous service to get the PIN status of a password-protected portal certificate. */
// @Route("/GetPortalCertificatePinStatusAsync", "POST")
// @Api(Description="An asynchronous service to get the PIN status of a password-protected portal certificate.")
export class GetPortalCertificatePinStatusAsync extends GetPortalCertificatePinStatusBase implements IReturn<GetPinStatusResponse>
{

    public constructor(init?: Partial<GetPortalCertificatePinStatusAsync>) { super(init); (Object as any).assign(this, init); }
    public getTypeName() { return 'GetPortalCertificatePinStatusAsync'; }
    public getMethod() { return 'POST'; }
    public createResponse() { return new GetPinStatusResponse(); }
}