/* Options:
Date: 2024-10-18 17:19:21
Version: 6.110
Tip: To override a DTO option, remove "//" prefix before updating
BaseUrl: https://reportfiling.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: BatchRecallReportsAsync.*
//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.Services.Contracts.Requests;
using PwC.Elmaas.Core.Domain.Concretes.Models;
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 an ELMA report.
    ///</summary>
    [Api(Description="Represents an ELMA report.")]
    public partial class Report
    {
        ///<summary>
        ///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.
        ///</summary>
        [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 virtual string Id { get; set; }

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

    public enum Verfahren
    {
        CC,
        CS,
        DC,
        FC,
        FS,
        FA,
        KM,
    }

}

namespace PwC.Elmaas.Core.Services.Contracts.Requests
{
    ///<summary>
    ///Represents a request to recall reports from the ELMA server before it is processed in an asynchronous operation.
    ///</summary>
    [Route("/async/elma/reports/batch/recall", "POST")]
    [Api(Description="Represents a request to recall reports from the ELMA server before it is processed in an asynchronous operation.")]
    public partial class BatchRecallReportsAsync
        : BatchRecallReportsBase, IReturn<RecallResponse>
    {
    }

    ///<summary>
    ///Specifies a request to recall reports from the ELMA server before it is processed.
    ///</summary>
    [Api(Description="Specifies a request to recall reports from the ELMA server before it is processed.")]
    public partial class BatchRecallReportsBase
        : IPost, IAuthenticateRequest, IStageableRequest
    {
        ///<summary>
        ///The parameters to search or filter on reports.
        ///</summary>
        [ApiMember(Description="The parameters to search or filter on reports.", IsRequired=true, Name="SearchCriteria")]
        public virtual SearchCriteria SearchCriteria { get; set; }

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

    ///<summary>
    ///Represent parameters to search or filter on submissions. 
    ///</summary>
    [Api(Description="Represent parameters to search or filter on submissions. ")]
    public partial class SearchCriteria
    {
        ///<summary>
        ///Full or partial name of the item (report or protocol) to search.
        ///</summary>
        [ApiMember(Description="Full or partial name of the item (report or protocol) to search.", Name="Name")]
        public virtual string Name { get; set; }

        ///<summary>
        ///TThe ELMA product designation.
        ///</summary>
        [ApiMember(Description="TThe ELMA product designation.", Name="Designation")]
        public virtual Verfahren? Designation { get; set; }
    }

}

namespace PwC.Elmaas.Core.Services.Contracts.Responses
{
    ///<summary>
    ///Encapsulates the results of a report recall operation.
    ///</summary>
    [Api(Description="Encapsulates the results of a report recall operation.")]
    public partial class RecallResponse
    {
        public RecallResponse()
        {
            Reports = new List<Report>{};
        }

        ///<summary>
        ///The recalled reports.
        ///</summary>
        [ApiMember(Description="The recalled reports.", Name="Reports")]
        public virtual List<Report> Reports { get; set; }

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

}