/* Options:
Date: 2024-11-26 01:44:21
Version: 6.110
Tip: To override a DTO option, remove "//" prefix before updating
BaseUrl: https://reportfiling.pwc.de

//GlobalNamespace: 
//MakePropertiesOptional: False
//AddServiceStackTypes: True
//AddResponseStatus: False
//AddImplicitVersion: 
//AddDescriptionAsComments: True
IncludeTypes: BatchSubmitFiles.*
//ExcludeTypes: 
//DefaultImports: 
*/


export interface IReturn<T>
{
    createResponse(): T;
}

/** @description Represents a PEM-encoded certificate. */
// @Api(Description="Represents a PEM-encoded certificate.")
export class PemCertificate
{
    /** @description 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 id: string;

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

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

    /** @description Tags to label or identify the certificate. */
    // @ApiMember(Description="Tags to label or identify the certificate.", Name="Tags")
    public tags: string[];

    public constructor(init?: Partial<PemCertificate>) { (Object as any).assign(this, init); }
}

/** @description 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.")
export class ElmaCredential implements IElmaCredential
{
    /** @description 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 id: string;

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

    /** @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" */
    // @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 authSteuernummer: string;

    /** @description 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 accountId: string;

    /** @description 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 password: string;

    public constructor(init?: Partial<ElmaCredential>) { (Object as any).assign(this, init); }
}

export interface IAuthenticateRequest
{
    credential: ElmaCredential;
}

export interface IStageableRequest
{
    stagingEnabled?: boolean;
}

export interface IUploadRequest
{
    validationEnabled: boolean;
}

/** @description Specifies a request to submit report files to ELMa via HTTP file upload. */
// @Api(Description="Specifies a request to submit report files to ELMa via HTTP file upload.")
export class BatchSubmitFilesBase implements IPost, IAuthenticateRequest, IUploadRequest, IStageableRequest
{
    /** @description 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 credential: ElmaCredential;

    /** @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. */
    // @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 validationEnabled: boolean;

    /** @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. */
    // @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 stagingEnabled?: boolean;

    public constructor(init?: Partial<BatchSubmitFilesBase>) { (Object as any).assign(this, init); }
}

// @DataContract
export class ResponseError
{
    // @DataMember(Order=1)
    public errorCode: string;

    // @DataMember(Order=2)
    public fieldName: string;

    // @DataMember(Order=3)
    public message: string;

    // @DataMember(Order=4)
    public meta: { [index: string]: string; };

    public constructor(init?: Partial<ResponseError>) { (Object as any).assign(this, init); }
}

// @DataContract
export class ResponseStatus
{
    // @DataMember(Order=1)
    public errorCode: string;

    // @DataMember(Order=2)
    public message: string;

    // @DataMember(Order=3)
    public stackTrace: string;

    // @DataMember(Order=4)
    public errors: ResponseError[];

    // @DataMember(Order=5)
    public meta: { [index: string]: string; };

    public constructor(init?: Partial<ResponseStatus>) { (Object as any).assign(this, init); }
}

/** @description 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. ")
export class ValidationError
{
    /** @description 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 id: string;

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

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

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

    /** @description The line position indicating where the error occurred. */
    // @ApiMember(Description="The line position indicating where the error occurred.", Name="LinePosition")
    public linePosition: number;

    public constructor(init?: Partial<ValidationError>) { (Object as any).assign(this, init); }
}

export interface IElmaCredential
{
    certificate: PemCertificate;
    authSteuernummer: string;
    accountId: string;
    password: string;
}

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

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

    /** @description 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 validationErrors: ValidationError[];

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

    public constructor(init?: Partial<SubmissionResponse>) { (Object as any).assign(this, init); }
}

/** @description Represents a request to submit report files to ELMa via HTTP file upload. */
// @Route("/sync/elma/files/batch/submit", "POST")
// @Api(Description="Represents a request to submit report files to ELMa via HTTP file upload.")
export class BatchSubmitFiles extends BatchSubmitFilesBase implements IReturn<SubmissionResponse[]>
{

    public constructor(init?: Partial<BatchSubmitFiles>) { super(init); (Object as any).assign(this, init); }
    public getTypeName() { return 'BatchSubmitFiles'; }
    public getMethod() { return 'POST'; }
    public createResponse() { return new Array<SubmissionResponse>(); }
}