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

//GlobalNamespace: 
//MakePropertiesOptional: False
//AddServiceStackTypes: True
//AddResponseStatus: False
//AddImplicitVersion: 
//AddDescriptionAsComments: True
IncludeTypes: BatchSignReports.*
//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); }
}

/** @description Represents an ELMA report. */
// @Api(Description="Represents an ELMA report.")
export class Report
{
    /** @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. */
    // @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 id: string;

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

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

/** @description Specifies a request to sign a batch of reports using the security certificate from the provided credential. */
// @Api(Description="Specifies a request to sign a batch of reports using the security certificate from the provided credential.")
export class BatchSignReportsBase implements IPost
{
    /** @description The reports to sign. */
    // @ApiMember(Description="The reports to sign.", IsRequired=true, Name="Report")
    public reports: Report[];

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

    public constructor(init?: Partial<BatchSignReportsBase>) { (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 signature of an ELMA report.The RSASSA-PSS1 algorithm is used to create the signature. */
// @Api(Description="Represents a signature of an ELMA report.The RSASSA-PSS1 algorithm is used to create the signature.")
export class Signature
{
    /** @description The conventional ELMA file name of the signature.  The format of the ELMA formula is as follows:  m5_&lt;pb&gt;_&lt;BZSt-Nr&gt;_&lt;AccountID&gt;_&lt;DateiId&gt;.xml.sig  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 signature.  The format of the ELMA formula is as follows:  m5_&lt;pb&gt;_&lt;BZSt-Nr&gt;_&lt;AccountID&gt;_&lt;DateiId&gt;.xml.sig  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 id: string;

    /** @description The underlying raw data content of the signature. */
    // @ApiMember(Description="The underlying raw data content of the signature.", IsRequired=true, Name="Data")
    public data: string;

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

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

/** @description Encapsulates the results of signing a report. */
// @Api(Description="Encapsulates the results of signing a report.")
export class SigningResponse
{
    /** @description The report that was signed. */
    // @ApiMember(Description="The report that was signed.", Name="Report")
    public report: Report;

    /** @description The signature obtained from signing the report. */
    // @ApiMember(Description="The signature obtained from signing the report.", Name="Report")
    public signature: Signature;

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

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

/** @description Represents a request to sign a batch of reports. */
// @Route("/sync/elma/reports/batch/sign", "POST")
// @Api(Description="Represents a request to sign a batch of reports.")
export class BatchSignReports extends BatchSignReportsBase implements IReturn<SigningResponse[]>
{

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