/* Options:
Date: 2024-10-18 17:24:38
Version: 6.110
Tip: To override a DTO option, remove "//" prefix before updating
BaseUrl: https://reportfiling.pwc.de

//Package: 
//GlobalNamespace: dtos
//AddPropertyAccessors: True
//SettersReturnThis: True
//AddServiceStackTypes: True
//AddResponseStatus: False
//AddDescriptionAsComments: True
//AddImplicitVersion: 
IncludeTypes: BatchSubmitReportsAsync.*
//ExcludeTypes: 
//TreatTypesAsStrings: 
//DefaultImports: java.math.*,java.util.*,net.servicestack.client.*,com.google.gson.annotations.*,com.google.gson.reflect.*
*/

import java.math.*;
import java.util.*;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;

public class dtos
{

    /**
    * Represents a request to submit reports to the ELMA server.
    */
    @Route(Path="/async/elma/reports/batch/submit", Verbs="POST")
    @Api(Description="Represents a request to submit reports to the ELMA server.")
    public static class BatchSubmitReportsAsync extends BatchSubmitReportsBase implements IReturn<ArrayList<SubmissionResponse>>
    {
        
        private static Object responseType = new TypeToken<ArrayList<SubmissionResponse>>(){}.getType();
        public Object getResponseType() { return responseType; }
    }

    /**
    * Represents the credentials of a user to authenticate the access of an ELMA server.
    */
    @Api(Description="Represents the credentials of a user to authenticate the access of an ELMA server.")
    public static class ElmaCredential implements IElmaCredential
    {
        /**
        * The unique identifier of this instance.  This identifer is only relevant in the context of data storage and retrieval.
        */
        @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 String id = null;

        /**
        * 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)
        */
        @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(2147483647)
        public PemCertificate certificate = null;

        /**
        * 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"
        */
        @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 String authSteuernummer = null;

        /**
        * The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).
        */
        @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 String accountId = null;

        /**
        * The password to protect the certificate from unauthorized access.
        */
        @ApiMember(Description="The password to protect the certificate from unauthorized access.", IsRequired=true, Name="Password")
        public String password = null;
        
        public String getId() { return id; }
        public ElmaCredential setId(String value) { this.id = value; return this; }
        public PemCertificate getCertificate() { return certificate; }
        public ElmaCredential setCertificate(PemCertificate value) { this.certificate = value; return this; }
        public String getAuthSteuernummer() { return authSteuernummer; }
        public ElmaCredential setAuthSteuernummer(String value) { this.authSteuernummer = value; return this; }
        public String getAccountId() { return accountId; }
        public ElmaCredential setAccountId(String value) { this.accountId = value; return this; }
        public String getPassword() { return password; }
        public ElmaCredential setPassword(String value) { this.password = value; return this; }
    }

    public static interface IAuthenticateRequest
    {
        public ElmaCredential credential = null;
    }

    public static interface IStageableRequest
    {
        public Boolean stagingEnabled = null;
    }

    /**
    * Represents an ELMA report.
    */
    @Api(Description="Represents an ELMA report.")
    public static class Report
    {
        /**
        * The conventional ELMA file name of the report.  The format of the ELMA formula is as follows:  m5_&lt;pb&gt;_&lt;BZSt-Nr&gt;_&lt;AccountID&gt;_&lt;DateiId&gt;.xml  where:  m5 is a constant for all reporting types.  pb is a constant that represents the ELMA product designation e.g. CC, DC, FC etc.  BZSt-Nr is the 11-character BZSt (Bundeszentralamt für Steuern) - tax number of the ELMA user e.g. bz123456789  AccountID is the 10-digit account identifier of the BZSt-Online Portal (BOP) user e.g. 1234567890  DateiId is the 1 - 12 character internal short name for the data file.
        */
        @ApiMember(Description="The conventional ELMA file name of the report.  The format of the ELMA formula is as follows:  m5_&lt;pb&gt;_&lt;BZSt-Nr&gt;_&lt;AccountID&gt;_&lt;DateiId&gt;.xml  where:  m5 is a constant for all reporting types.  pb is a constant that represents the ELMA product designation e.g. CC, DC, FC etc.  BZSt-Nr is the 11-character BZSt (Bundeszentralamt für Steuern) - tax number of the ELMA user e.g. bz123456789  AccountID is the 10-digit account identifier of the BZSt-Online Portal (BOP) user e.g. 1234567890  DateiId is the 1 - 12 character internal short name for the data file.", IsRequired=true, Name="Id")
        public String id = null;

        /**
        * The XML-content of the report.
        */
        @ApiMember(Description="The XML-content of the report.", IsRequired=true, Name="Data")
        public String data = null;
        
        public String getId() { return id; }
        public Report setId(String value) { this.id = value; return this; }
        public String getData() { return data; }
        public Report setData(String value) { this.data = value; return this; }
    }

    public static interface IUploadRequest
    {
        public Boolean validationEnabled = null;
    }

    /**
    * Specifies a request to submit reports to the ELMA server.
    */
    @Api(Description="Specifies a request to submit reports to the ELMA server.")
    public static class BatchSubmitReportsBase implements IPost, IAuthenticateRequest, IBatchUploadRequest, IStageableRequest
    {
        /**
        * The reports to submit to the ELMA server.
        */
        @ApiMember(Description="The reports to submit to the ELMA server.", IsRequired=true, Name="Reports")
        public ArrayList<Report> reports = null;

        /**
        * The credential to gain access on the ELMA server.
        */
        @ApiMember(Description="The credential to gain access on the ELMA server.", IsRequired=true, Name="Credential")
        public ElmaCredential credential = null;

        /**
        * Should the report data be validated before sending it to the ELMA server? true: report data is validated before submission to the ELMA server. false: report data sent without validation to the ELMA server.
        */
        @ApiMember(Description="Should the report data be validated before sending it to the ELMA server? true: report data is validated before submission to the ELMA server. false: report data sent without validation to the ELMA server.", Name="ValidationEnabled")
        public Boolean validationEnabled = null;

        /**
        * 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.
        */
        @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 Boolean stagingEnabled = null;
        
        public ArrayList<Report> getReports() { return reports; }
        public BatchSubmitReportsBase setReports(ArrayList<Report> value) { this.reports = value; return this; }
        public ElmaCredential getCredential() { return credential; }
        public BatchSubmitReportsBase setCredential(ElmaCredential value) { this.credential = value; return this; }
        public Boolean isValidationEnabled() { return validationEnabled; }
        public BatchSubmitReportsBase setValidationEnabled(Boolean value) { this.validationEnabled = value; return this; }
        public Boolean isStagingEnabled() { return stagingEnabled; }
        public BatchSubmitReportsBase setStagingEnabled(Boolean value) { this.stagingEnabled = value; return this; }
    }

    public static interface IBatchUploadRequest implements IUploadRequest
    {
        public ArrayList<Report> reports = null;
    }

    /**
    * Represents a PEM-encoded certificate.
    */
    @Api(Description="Represents a PEM-encoded certificate.")
    public static class PemCertificate
    {
        /**
        * The unique identifier (e.g. the file name) of the certificate.
        */
        @ApiMember(Description="The unique identifier (e.g. the file name) of the certificate.", IsRequired=true, Name="Id")
        public String id = null;

        /**
        * The PEM-encoded content of the certificate.
        */
        @ApiMember(Description="The PEM-encoded content of the certificate.", IsRequired=true, Name="Content")
        public String content = null;

        /**
        * The description of the certificate.
        */
        @ApiMember(Description="The description of the certificate.", Name="Description")
        public String description = null;

        /**
        * Tags to label or identify the certificate.
        */
        @ApiMember(Description="Tags to label or identify the certificate.", Name="Tags")
        public ArrayList<String> tags = null;
        
        public String getId() { return id; }
        public PemCertificate setId(String value) { this.id = value; return this; }
        public String getContent() { return content; }
        public PemCertificate setContent(String value) { this.content = value; return this; }
        public String getDescription() { return description; }
        public PemCertificate setDescription(String value) { this.description = value; return this; }
        public ArrayList<String> getTags() { return tags; }
        public PemCertificate setTags(ArrayList<String> value) { this.tags = value; return this; }
    }

    /**
    * Represents a  failure encountered during the validation of an ELMA report against its XML schema. 
    */
    @Api(Description="Represents a  failure encountered during the validation of an ELMA report against its XML schema. ")
    public static class ValidationError
    {
        /**
        * The unique identifier of the validation faílure. This is equivalent to the file name of the validated report.
        */
        @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 String id = null;

        /**
        * The message of the validation failure.
        */
        @ApiMember(Description="The message of the validation failure.", Name="Message")
        public String message = null;

        /**
        * The severity of the validation faílure.
        */
        @ApiMember(Description="The severity of the validation faílure.", Name="Severity")
        public XmlSeverityType severity = null;

        /**
        * The line number indicating where the error occurred.
        */
        @ApiMember(Description="The line number indicating where the error occurred.", Name="LineNumber")
        public Integer lineNumber = null;

        /**
        * The line position indicating where the error occurred.
        */
        @ApiMember(Description="The line position indicating where the error occurred.", Name="LinePosition")
        public Integer linePosition = null;
        
        public String getId() { return id; }
        public ValidationError setId(String value) { this.id = value; return this; }
        public String getMessage() { return message; }
        public ValidationError setMessage(String value) { this.message = value; return this; }
        public XmlSeverityType getSeverity() { return severity; }
        public ValidationError setSeverity(XmlSeverityType value) { this.severity = value; return this; }
        public Integer getLineNumber() { return lineNumber; }
        public ValidationError setLineNumber(Integer value) { this.lineNumber = value; return this; }
        public Integer getLinePosition() { return linePosition; }
        public ValidationError setLinePosition(Integer value) { this.linePosition = value; return this; }
    }

    public static interface IElmaCredential
    {
        public PemCertificate certificate = null;
        public String authSteuernummer = null;
        public String accountId = null;
        public String password = null;
    }

    /**
    * Encapsulates the results of submitting a report
    */
    @Api(Description="Encapsulates the results of submitting a report")
    public static class SubmissionResponse
    {
        /**
        * The unique identifier of the report that was processed.
        */
        @ApiMember(Description="The unique identifier of the report that was processed.", Name="Id")
        public String id = null;

        /**
        * The submitted XML-based report content.
        */
        @ApiMember(Description="The submitted XML-based report content.", Name="Xml")
        public String xml = null;

        /**
        * The errors encountered during the validation phase of the report submission operation.
        */
        @ApiMember(Description="The errors encountered during the validation phase of the report submission operation.", Name="ValidationErrors")
        public ArrayList<ValidationError> validationErrors = null;

        /**
        * The status of the report submission operation.
        */
        @ApiMember(Description="The status of the report submission operation.", Name="ResponseStatus")
        public ResponseStatus responseStatus = null;
        
        public String getId() { return id; }
        public SubmissionResponse setId(String value) { this.id = value; return this; }
        public String getXml() { return xml; }
        public SubmissionResponse setXml(String value) { this.xml = value; return this; }
        public ArrayList<ValidationError> getValidationErrors() { return validationErrors; }
        public SubmissionResponse setValidationErrors(ArrayList<ValidationError> value) { this.validationErrors = value; return this; }
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public SubmissionResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

}