/* Options:
Date: 2024-11-26 02:01:37
Version: 6.110
Tip: To override a DTO option, remove "//" prefix before updating
BaseUrl: https://reportfiling.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: True
//ExportValueTypes: False
IncludeTypes: BatchSubmitFilesAsync.*
//ExcludeTypes: 
//AddNamespaces: 
//AddDefaultXmlNamespace: http://schemas.servicestack.net/types
*/

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using System.Xml.Schema;
using System.Net;
using PwC.Elmaas.Core.Domain.Concretes.Models;
using PwC.Elmaas.Core.Services.Contracts.Requests;
using PwC.Elmaas.Core.Domain.Contracts.Models;
using PwC.Elmaas.Core.Services.Contracts.Responses;

namespace PwC.Elmaas.Core.Domain.Concretes.Models
{
    ///<summary>
    ///Represents the credentials of a user to authenticate the access of an ELMA server.
    ///</summary>
    [Api(Description="Represents the credentials of a user to authenticate the access of an ELMA server.")]
    public partial class ElmaCredential
        : IElmaCredential
    {
        ///<summary>
        ///The unique identifier of this instance.  This identifer is only relevant in the context of data storage and retrieval.
        ///</summary>
        [ApiMember(Description="The unique identifier of this instance.  This identifer is only relevant in the context of data storage and retrieval.", IsRequired=true, Name="Id")]
        public virtual string Id { get; set; }

        ///<summary>
        ///The security certificate to authenticate the user and grant access to the ELMA server.  This certificate is generated from the BZSt-issued *.pfx BOP certificate. More details on BOP (BZSt-Online Portal - https://www.elster.de/bportal/start)
        ///</summary>
        [ApiMember(Description="The security certificate to authenticate the user and grant access to the ELMA server.  This certificate is generated from the BZSt-issued *.pfx BOP certificate. More details on BOP (BZSt-Online Portal - https://www.elster.de/bportal/start)", IsRequired=true, Name="Certificate")]
        [Required]
        [StringLength(int.MaxValue)]
        public virtual PemCertificate Certificate { get; set; }

        ///<summary>
        ///The BZSt (Bundeszentralamt für Steuern) - tax number of the user. 11-character text field that may only consist of two capital letters and 9 digits (0-9).  The fiscal authority BZSt provides this number during registration at the BOP (BZSt-Online Portal - https://www.elster.de/bportal/start).  The number is available in the private area of the BOP user account under "My BOP" under the "Registration Information"
        ///</summary>
        [ApiMember(Description="The BZSt (Bundeszentralamt für Steuern) - tax number of the user. 11-character text field that may only consist of two capital letters and 9 digits (0-9).  The fiscal authority BZSt provides this number during registration at the BOP (BZSt-Online Portal - https://www.elster.de/bportal/start).  The number is available in the private area of the BOP user account under \"My BOP\" under the \"Registration Information\"", IsRequired=true, Name="AuthSteuernummer")]
        [Required]
        [StringLength(11)]
        public virtual string AuthSteuernummer { get; set; }

        ///<summary>
        ///The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).
        ///</summary>
        [ApiMember(Description="The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).", IsRequired=true, Name="AccountId")]
        [Required]
        [StringLength(10)]
        public virtual string AccountId { get; set; }

        ///<summary>
        ///The password to protect the certificate from unauthorized access.
        ///</summary>
        [ApiMember(Description="The password to protect the certificate from unauthorized access.", IsRequired=true, Name="Password")]
        public virtual string Password { get; set; }
    }

}

namespace PwC.Elmaas.Core.Domain.Contracts.Models
{
    public partial interface IElmaCredential
    {
        PemCertificate Certificate { get; set; }
        string AuthSteuernummer { get; set; }
        string AccountId { get; set; }
        string Password { get; set; }
    }

    ///<summary>
    ///Represents a PEM-encoded certificate.
    ///</summary>
    [Api(Description="Represents a PEM-encoded certificate.")]
    public partial class PemCertificate
    {
        public PemCertificate()
        {
            Tags = new List<string>{};
        }

        ///<summary>
        ///The unique identifier (e.g. the file name) of the certificate.
        ///</summary>
        [ApiMember(Description="The unique identifier (e.g. the file name) of the certificate.", IsRequired=true, Name="Id")]
        public virtual string Id { get; set; }

        ///<summary>
        ///The PEM-encoded content of the certificate.
        ///</summary>
        [ApiMember(Description="The PEM-encoded content of the certificate.", IsRequired=true, Name="Content")]
        public virtual string Content { get; set; }

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

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

    ///<summary>
    ///Represents a  failure encountered during the validation of an ELMA report against its XML schema. 
    ///</summary>
    [Api(Description="Represents a  failure encountered during the validation of an ELMA report against its XML schema. ")]
    public partial class ValidationError
    {
        ///<summary>
        ///The unique identifier of the validation faílure. This is equivalent to the file name of the validated report.
        ///</summary>
        [ApiMember(Description="The unique identifier of the validation faílure.\n This is equivalent to the file name of the validated report.", Name="Id")]
        public virtual string Id { get; set; }

        ///<summary>
        ///The message of the validation failure.
        ///</summary>
        [ApiMember(Description="The message of the validation failure.", Name="Message")]
        public virtual string Message { get; set; }

        ///<summary>
        ///The severity of the validation faílure.
        ///</summary>
        [ApiMember(Description="The severity of the validation faílure.", Name="Severity")]
        public virtual XmlSeverityType Severity { get; set; }

        ///<summary>
        ///The line number indicating where the error occurred.
        ///</summary>
        [ApiMember(Description="The line number indicating where the error occurred.", Name="LineNumber")]
        public virtual int LineNumber { get; set; }

        ///<summary>
        ///The line position indicating where the error occurred.
        ///</summary>
        [ApiMember(Description="The line position indicating where the error occurred.", Name="LinePosition")]
        public virtual int LinePosition { get; set; }
    }

}

namespace PwC.Elmaas.Core.Services.Contracts.Requests
{
    ///<summary>
    ///Represents a request to submit report files to ELMa via HTTP file upload in an asynchronous operation.
    ///</summary>
    [Route("/async/elma/files/batch/submit", "POST")]
    [Api(Description="Represents a request to submit report files to ELMa via HTTP file upload in an asynchronous operation.")]
    public partial class BatchSubmitFilesAsync
        : BatchSubmitFilesBase, IReturn<List<SubmissionResponse>>
    {
    }

    ///<summary>
    ///Specifies a request to submit report files to ELMa via HTTP file upload.
    ///</summary>
    [Api(Description="Specifies a request to submit report files to ELMa via HTTP file upload.")]
    public partial class BatchSubmitFilesBase
        : IPost, IAuthenticateRequest, IUploadRequest, IStageableRequest
    {
        ///<summary>
        ///The credential to gain access on the ELMA server.
        ///</summary>
        [ApiMember(Description="The credential to gain access on the ELMA server.", IsRequired=true, Name="Credential")]
        public virtual ElmaCredential Credential { get; set; }

        ///<summary>
        ///Should the report data be validated before sending it to the ELMA server?  true: report data is validated before it is sent to the ELMA server.  false: report data sent without validation to the ELMA server.
        ///</summary>
        [ApiMember(Description="Should the report data be validated before sending it to the ELMA server?  true: report data is validated before it is sent to the ELMA server.  false: report data sent without validation to the ELMA server.", IsRequired=true, Name="ValidationEnabled")]
        public virtual bool ValidationEnabled { get; set; }

        ///<summary>
        ///Should operations be staged on the ELMA server?  true: operations are executed on the Test ELMA server.  false: operations are executed on the Live (Production) ELMA server.
        ///</summary>
        [ApiMember(Description="Should operations be staged on the ELMA server?  true: operations are executed on the Test ELMA server.  false: operations are executed on the Live (Production) ELMA server.", Name="StagingEnabled")]
        public virtual bool? StagingEnabled { get; set; }
    }

    public partial interface IAuthenticateRequest
    {
        ElmaCredential Credential { get; set; }
    }

    public partial interface IStageableRequest
    {
        bool? StagingEnabled { get; set; }
    }

    public partial interface IUploadRequest
    {
        bool ValidationEnabled { get; set; }
    }

}

namespace PwC.Elmaas.Core.Services.Contracts.Responses
{
    ///<summary>
    ///Encapsulates the results of submitting a report
    ///</summary>
    [Api(Description="Encapsulates the results of submitting a report")]
    public partial class SubmissionResponse
    {
        public SubmissionResponse()
        {
            ValidationErrors = new List<ValidationError>{};
        }

        ///<summary>
        ///The unique identifier of the report that was processed.
        ///</summary>
        [ApiMember(Description="The unique identifier of the report that was processed.", Name="Id")]
        public virtual string Id { get; set; }

        ///<summary>
        ///The submitted XML-based report content.
        ///</summary>
        [ApiMember(Description="The submitted XML-based report content.", Name="Xml")]
        public virtual string Xml { get; set; }

        ///<summary>
        ///The errors encountered during the validation phase of the report submission operation.
        ///</summary>
        [ApiMember(Description="The errors encountered during the validation phase of the report submission operation.", Name="ValidationErrors")]
        public virtual List<ValidationError> ValidationErrors { get; set; }

        ///<summary>
        ///The status of the report submission operation.
        ///</summary>
        [ApiMember(Description="The status of the report submission operation.", Name="ResponseStatus")]
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}