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

//GlobalNamespace: 
//AddServiceStackTypes: True
//AddResponseStatus: False
//AddImplicitVersion: 
//AddDescriptionAsComments: True
IncludeTypes: SubmitReportAsync.*
//ExcludeTypes: 
//DefaultImports: package:servicestack/servicestack.dart,dart:typed_data
*/

import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

/**
* Represents a PEM-encoded certificate.
*/
// @Api(Description="Represents a PEM-encoded certificate.")
class PemCertificate implements IConvertible
{
    /**
    * 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")
    String? id;

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

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

    /**
    * Tags to label or identify the certificate.
    */
    // @ApiMember(Description="Tags to label or identify the certificate.", Name="Tags")
    List<String>? tags;

    PemCertificate({this.id,this.content,this.description,this.tags});
    PemCertificate.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        content = json['content'];
        description = json['description'];
        tags = JsonConverters.fromJson(json['tags'],'List<String>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'content': content,
        'description': description,
        'tags': JsonConverters.toJson(tags,'List<String>',context!)
    };

    getTypeName() => "PemCertificate";
    TypeContext? context = _ctx;
}

/**
* 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.")
class ElmaCredential implements IElmaCredential, IConvertible
{
    /**
    * 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")
    String? id;

    /**
    * 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)
    PemCertificate? certificate;

    /**
    * 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)
    String? authSteuernummer;

    /**
    * 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)
    String? accountId;

    /**
    * The password to protect the certificate from unauthorized access.
    */
    // @ApiMember(Description="The password to protect the certificate from unauthorized access.", IsRequired=true, Name="Password")
    String? password;

    ElmaCredential({this.id,this.certificate,this.authSteuernummer,this.accountId,this.password});
    ElmaCredential.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        certificate = JsonConverters.fromJson(json['certificate'],'PemCertificate',context!);
        authSteuernummer = json['authSteuernummer'];
        accountId = json['accountId'];
        password = json['password'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'certificate': JsonConverters.toJson(certificate,'PemCertificate',context!),
        'authSteuernummer': authSteuernummer,
        'accountId': accountId,
        'password': password
    };

    getTypeName() => "ElmaCredential";
    TypeContext? context = _ctx;
}

abstract class IAuthenticateRequest
{
    ElmaCredential? credential;
}

abstract class IStageableRequest
{
    bool? stagingEnabled;
}

/**
* Represents an ELMA report.
*/
// @Api(Description="Represents an ELMA report.")
class Report implements IConvertible
{
    /**
    * 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")
    String? id;

    /**
    * The XML-content of the report.
    */
    // @ApiMember(Description="The XML-content of the report.", IsRequired=true, Name="Data")
    String? data;

    Report({this.id,this.data});
    Report.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        data = json['data'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'data': data
    };

    getTypeName() => "Report";
    TypeContext? context = _ctx;
}

/**
* Specifies a request to submit a report on the ELMA server.
*/
// @Api(Description="Specifies a request to submit a report on the ELMA server.")
abstract class SubmitReportBase implements IPost, IAuthenticateRequest, ISingleUploadRequest, IStageableRequest
{
    /**
    * The report to submit.
    */
    // @ApiMember(Description="The report to submit.", IsRequired=true, Name="Report")
    Report? report;

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

    /**
    * 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.
    */
    // @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")
    bool? validationEnabled;

    /**
    * 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")
    bool? stagingEnabled;

    SubmitReportBase({this.report,this.credential,this.validationEnabled,this.stagingEnabled});
    SubmitReportBase.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        report = JsonConverters.fromJson(json['report'],'Report',context!);
        credential = JsonConverters.fromJson(json['credential'],'ElmaCredential',context!);
        validationEnabled = json['validationEnabled'];
        stagingEnabled = json['stagingEnabled'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'report': JsonConverters.toJson(report,'Report',context!),
        'credential': JsonConverters.toJson(credential,'ElmaCredential',context!),
        'validationEnabled': validationEnabled,
        'stagingEnabled': stagingEnabled
    };

    getTypeName() => "SubmitReportBase";
    TypeContext? context = _ctx;
}

abstract class ISingleUploadRequest extends IUploadRequest
{
    Report? report;
}

abstract class IUploadRequest
{
    bool? validationEnabled;
}

/**
* 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. ")
class ValidationError implements IConvertible
{
    /**
    * 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")
    String? id;

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

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

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

    /**
    * The line position indicating where the error occurred.
    */
    // @ApiMember(Description="The line position indicating where the error occurred.", Name="LinePosition")
    int? linePosition;

    ValidationError({this.id,this.message,this.severity,this.lineNumber,this.linePosition});
    ValidationError.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        message = json['message'];
        severity = JsonConverters.fromJson(json['severity'],'XmlSeverityType',context!);
        lineNumber = json['lineNumber'];
        linePosition = json['linePosition'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'message': message,
        'severity': JsonConverters.toJson(severity,'XmlSeverityType',context!),
        'lineNumber': lineNumber,
        'linePosition': linePosition
    };

    getTypeName() => "ValidationError";
    TypeContext? context = _ctx;
}

abstract class IElmaCredential
{
    PemCertificate? certificate;
    String? authSteuernummer;
    String? accountId;
    String? password;
}

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

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

    /**
    * 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")
    List<ValidationError>? validationErrors;

    /**
    * The status of the report submission operation.
    */
    // @ApiMember(Description="The status of the report submission operation.", Name="ResponseStatus")
    ResponseStatus? responseStatus;

    SubmissionResponse({this.id,this.xml,this.validationErrors,this.responseStatus});
    SubmissionResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        xml = json['xml'];
        validationErrors = JsonConverters.fromJson(json['validationErrors'],'List<ValidationError>',context!);
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'xml': xml,
        'validationErrors': JsonConverters.toJson(validationErrors,'List<ValidationError>',context!),
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "SubmissionResponse";
    TypeContext? context = _ctx;
}

/**
* Represents a request to submit a report on the ELMA server in an asynchronous operation.
*/
// @Route("/async/elma/reports/submit", "POST")
// @Api(Description="Represents a request to submit a report on the ELMA server in an asynchronous operation.")
class SubmitReportAsync extends SubmitReportBase implements IReturn<SubmissionResponse>, IConvertible, IPost
{
    SubmitReportAsync();
    SubmitReportAsync.fromJson(Map<String, dynamic> json) : super.fromJson(json);
    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson();
    createResponse() => SubmissionResponse();
    getResponseTypeName() => "SubmissionResponse";
    getTypeName() => "SubmitReportAsync";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'reportfiling.staging.pwc.de', types: <String, TypeInfo> {
    'PemCertificate': TypeInfo(TypeOf.Class, create:() => PemCertificate()),
    'ElmaCredential': TypeInfo(TypeOf.Class, create:() => ElmaCredential()),
    'IAuthenticateRequest': TypeInfo(TypeOf.Interface),
    'IStageableRequest': TypeInfo(TypeOf.Interface),
    'Report': TypeInfo(TypeOf.Class, create:() => Report()),
    'SubmitReportBase': TypeInfo(TypeOf.AbstractClass),
    'ISingleUploadRequest': TypeInfo(TypeOf.Interface),
    'IUploadRequest': TypeInfo(TypeOf.Interface),
    'ValidationError': TypeInfo(TypeOf.Class, create:() => ValidationError()),
    'XmlSeverityType': TypeInfo(TypeOf.Class, create:() => XmlSeverityType()),
    'IElmaCredential': TypeInfo(TypeOf.Interface),
    'SubmissionResponse': TypeInfo(TypeOf.Class, create:() => SubmissionResponse()),
    'List<ValidationError>': TypeInfo(TypeOf.Class, create:() => <ValidationError>[]),
    'SubmitReportAsync': TypeInfo(TypeOf.Class, create:() => SubmitReportAsync()),
});