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

//GlobalNamespace: 
//MakePartial: True
//MakeVirtual: True
//MakeInternal: False
//MakeDataContractsExtensible: False
//AddNullableAnnotations: False
//AddReturnMarker: True
//AddDescriptionAsComments: True
//AddDataContractAttributes: False
//AddIndexesToDataMembers: False
//AddGeneratedCodeAttributes: False
//AddResponseStatus: False
//AddImplicitVersion: 
//InitializeCollections: False
//ExportValueTypes: False
IncludeTypes: GetPortalCertificatePinStatusAsync.*
//ExcludeTypes: 
//AddNamespaces: 
//AddDefaultXmlNamespace: http://schemas.servicestack.net/types
*/

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using System.Net;
using PwC.xEric.Core.Domain.Concretes.Certificates;
using PwC.xEric.Core.Domain.Contracts.Enums;
using PwC.xEric.Core.Services.Contracts.Requests;
using PwC.DigitalHub.Utilities.Domain.IO.Contracts;
using PwC.xEric.Core.Domain.Contracts.Models;
using PwC.xEric.Core.Services.Contracts.Responses;

namespace PwC.DigitalHub.Utilities.Domain.IO.Contracts
{
    ///<summary>
    ///Represents a base class for a file with raw data.
    ///</summary>
    [Api(Description="Represents a base class for a file with raw data.")]
    public partial class FileBase
    {
        ///<summary>
        ///The raw data content of the file in bytes.
        ///</summary>
        [ApiMember(Description="The raw data content of the file in bytes.", Name="Content")]
        public virtual byte[] Content { get; set; }
    }

}

namespace PwC.xEric.Core.Domain.Concretes.Certificates
{
    ///<summary>
    ///Represents a portal certificate that is protected by a password.
    ///</summary>
    [Api(Description="Represents a portal certificate that is protected by a password.")]
    public partial class PortalCertificate
        : FileBase, ISecuredCertificate
    {
        ///<summary>
        ///The file name of the certificate.
        ///</summary>
        [ApiMember(Description="The file name of the certificate.")]
        [StringLength(128)]
        public virtual string Name { get; set; }

        ///<summary>
        ///The password to protect the certificate from unauthorized access.
        ///</summary>
        [StringLength(255)]
        [ApiMember(Description="The password to protect the certificate from unauthorized access.")]
        public virtual string Pin { get; set; }

        ///<summary>
        ///The description of the certificate.
        ///</summary>
        [StringLength(int.MaxValue)]
        [ApiMember(Description="The description of the certificate.")]
        public virtual string Description { get; set; }

        ///<summary>
        ///Tags that can be used to label or identify the certificate.
        ///</summary>
        [ApiMember(Description="Tags that can be used to label or identify the certificate.")]
        public virtual List<string> Tags { get; set; } = [];
    }

}

namespace PwC.xEric.Core.Domain.Contracts.Enums
{
    ///<summary>
    ///Represents the key type for a password-protected area.
    ///</summary>
    public enum EricKeyType
    {
        eSIGNATURE_KEY,
        eENCRYPTION_KEY,
    }

    ///<summary>
    ///Represents the PIN status.
    ///</summary>
    public enum EricPinStatus
    {
        STATUS_PIN_OK,
        STATUS_PIN_LOCKED,
        STATUS_PREVIOUS_PIN_ERROR,
        STATUS_LOCKED_IF_PIN_ERROR,
    }

}

namespace PwC.xEric.Core.Domain.Contracts.Models
{
    public partial interface ISecuredCertificate
    {
        string Pin { get; set; }
    }

}

namespace PwC.xEric.Core.Services.Contracts.Requests
{
    ///<summary>
    ///An asynchronous service to get the PIN status of a password-protected portal certificate.
    ///</summary>
    [Route("/GetPortalCertificatePinStatusAsync", "POST")]
    [Api(Description="An asynchronous service to get the PIN status of a password-protected portal certificate.")]
    public partial class GetPortalCertificatePinStatusAsync
        : GetPortalCertificatePinStatusBase, IReturn<GetPinStatusResponse>
    {
    }

    ///<summary>
    ///A base service to get the PIN status of a password-protected portal certificate.
    ///</summary>
    [Api(Description="A base service to get the PIN status of a password-protected portal certificate.")]
    public partial class GetPortalCertificatePinStatusBase
        : IPost
    {
        ///<summary>
        ///The portal certificate, whose PIN status is determined.
        ///</summary>
        [ApiMember(Description="The portal certificate, whose PIN status is determined.")]
        public virtual PortalCertificate Zertifikat { get; set; }

        ///<summary>
        ///The option for the selection of the key-pair.
        ///</summary>
        [ApiMember(Description="The option for the selection of the key-pair.")]
        public virtual EricKeyType KeyType { get; set; }
    }

}

namespace PwC.xEric.Core.Services.Contracts.Responses
{
    ///<summary>
    ///Represent a base response that encapsulate any ERiC API function return value.
    ///</summary>
    [Api(Description="Represent a base response that encapsulate any ERiC API function return value.")]
    public partial class EricFehlerCodeResponse
        : ServiceReponseBase
    {
        ///<summary>
        ///The status code that the ERiC API function returns.
        ///</summary>
        [ApiMember(Description="The status code that the ERiC API function returns.")]
        public virtual EricFehlerCode StatusCode { get; set; }

        ///<summary>
        ///The status message that the ERiC API function returns.
        ///</summary>
        [ApiMember(Description="The status message that the ERiC API function returns.")]
        public virtual string StatusText { get; set; }
    }

    ///<summary>
    ///Represents a type that encapsulates the return values of the ERiC API function that obtains the PIN status of a given certificate.
    ///</summary>
    [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 partial class GetPinStatusResponse
        : EricFehlerCodeResponse
    {
        ///<summary>
        ///The PIN status of the provided certificate.
        ///</summary>
        [ApiMember(Description="The PIN status of the provided certificate.", Name="PinStatus")]
        public virtual EricPinStatus PinStatus { get; set; }
    }

}