/* Options:
Date: 2024-11-26 01:58:07
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: RetrieveDac6FilesAsync.*
//ExcludeTypes: 
//TreatTypesAsStrings: 
//DefaultImports: java.math.*,java.util.*,net.servicestack.client.*
*/

import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Represents a request to retrieve DAC6 protocol files from the ELMA server in a zip file in an asynchronous operation.
    */
    @Route(Path="/async/elma/dac6/files/retrieve", Verbs="POST")
    @Api(Description="Represents a request to retrieve DAC6 protocol files from the ELMA server in a zip file in an asynchronous operation.")
    public static class RetrieveDac6FilesAsync extends RetrieveDac6FilesBase
    {
        
    }

    /**
    * Represent parameters to search or filter on submissions. 
    */
    @Api(Description="Represent parameters to search or filter on submissions. ")
    public static class SearchCriteria
    {
        /**
        * Full or partial name of the item (report or protocol) to search.
        */
        @ApiMember(Description="Full or partial name of the item (report or protocol) to search.", Name="Name")
        public String name = null;

        /**
        * TThe ELMA product designation.
        */
        @ApiMember(Description="TThe ELMA product designation.", Name="Designation")
        public Verfahren designation = null;
        
        public String getName() { return name; }
        public SearchCriteria setName(String value) { this.name = value; return this; }
        public Verfahren getDesignation() { return designation; }
        public SearchCriteria setDesignation(Verfahren value) { this.designation = value; return this; }
    }

    /**
    * 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;
    }

    public static interface ISearchRequest
    {
        public SearchCriteria searchCriteria = null;
    }

    /**
    * Specifies a request to to retrieve DAC6 protocol files from the ELMA server in a zip file.
    */
    @Api(Description="Specifies a request to to retrieve DAC6 protocol files from the ELMA server in a zip file.")
    public static class RetrieveDac6FilesBase implements IPost, IAuthenticateRequest, IStageableRequest, ISearchRequest
    {
        /**
        * The parameters to search or filter on the protocols.
        */
        @ApiMember(Description="The parameters to search or filter on the protocols.", IsRequired=true, Name="SearchCriteria")
        public SearchCriteria searchCriteria = 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 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 SearchCriteria getSearchCriteria() { return searchCriteria; }
        public RetrieveDac6FilesBase setSearchCriteria(SearchCriteria value) { this.searchCriteria = value; return this; }
        public ElmaCredential getCredential() { return credential; }
        public RetrieveDac6FilesBase setCredential(ElmaCredential value) { this.credential = value; return this; }
        public Boolean isStagingEnabled() { return stagingEnabled; }
        public RetrieveDac6FilesBase setStagingEnabled(Boolean value) { this.stagingEnabled = value; return this; }
    }

    /**
    * 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; }
    }

    public static enum Verfahren
    {
        Cc,
        Cs,
        Dc,
        Fc,
        Fs,
        Fa,
        Km;
    }

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

}