/* Options: Date: 2024-11-26 01:38:35 SwiftVersion: 5.0 Version: 6.110 Tip: To override a DTO option, remove "//" prefix before updating BaseUrl: https://reportfiling.staging.pwc.de //BaseClass: //AddModelExtensions: True //AddServiceStackTypes: True IncludeTypes: RetrieveDac6Protocols.* //ExcludeTypes: //ExcludeGenericBaseTypes: False //AddResponseStatus: False //AddImplicitVersion: //AddDescriptionAsComments: True //InitializeCollections: True //TreatTypesAsStrings: //DefaultImports: Foundation,ServiceStack */ import Foundation import ServiceStack /** * Represents a request to retrieve DAC6 protocols. */ // @Route("/sync/elma/dac6/protocols/retrieve", "POST") // @Api(Description="Represents a request to retrieve DAC6 protocols.") public class RetrieveDac6Protocols : RetrieveDac6ProtocolsBase, IReturn { public typealias Return = RetrievalResponse required public init(){ super.init() } required public init(from decoder: Decoder) throws { try super.init(from: decoder) } public override func encode(to encoder: Encoder) throws { try super.encode(to: encoder) } } /** * Encapsulates the results of a protocol retrieval operation. */ // @Api(Description="Encapsulates the results of a protocol retrieval operation.") public class RetrievalResponse : Codable { /** * Processing logs that indicate the status of submitted reports. */ // @ApiMember(Description="Processing logs that indicate the status of submitted reports.", Name="Protocols") public var protocols:[Elma] = [] /** * Other artefacts including the auxillary files from the BZSt. */ // @ApiMember(Description="Other artefacts including the auxillary files from the BZSt.", Name="Files") public var files:[BinaryFile] = [] /** * The status of the response. */ // @ApiMember(Description="The status of the response.", Name="ResponseStatus") public var responseStatus:ResponseStatus required public init(){} } /** * Represent parameters to search or filter on submissions. */ // @Api(Description="Represent parameters to search or filter on submissions. ") public class SearchCriteria : Codable { /** * 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 var name:String /** * TThe ELMA product designation. */ // @ApiMember(Description="TThe ELMA product designation.", Name="Designation") public var designation:Verfahren? required public init(){} } /** * 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 class ElmaCredential : IElmaCredential, Codable { /** * 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 var id:String /** * 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(Int32.max) public var certificate:PemCertificate? /** * 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 var authSteuernummer:String? /** * 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 var accountId:String? /** * 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 var password:String required public init(){} } public protocol IAuthenticateRequest { var credential:ElmaCredential { get set } } public protocol IStageableRequest { var stagingEnabled:Bool? { get set } } public protocol ISearchRequest { var searchCriteria:SearchCriteria { get set } } /** * Specifies a request to retrieve DAC6 protocols. */ // @Api(Description="Specifies a request to retrieve DAC6 protocols.") public class RetrieveDac6ProtocolsBase : IPost, IAuthenticateRequest, IStageableRequest, ISearchRequest, Codable { /** * The parameters to search for protocols. */ // @ApiMember(Description="The parameters to search for protocols.", IsRequired=true, Name="SearchCriteria") public var searchCriteria:SearchCriteria /** * 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 var credential:ElmaCredential /** * 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 var stagingEnabled:Bool? required public init(){} } /** * Represents a PEM-encoded certificate. */ // @Api(Description="Represents a PEM-encoded certificate.") public class PemCertificate : Codable { /** * 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 var id:String /** * The PEM-encoded content of the certificate. */ // @ApiMember(Description="The PEM-encoded content of the certificate.", IsRequired=true, Name="Content") public var content:String /** * The description of the certificate. */ // @ApiMember(Description="The description of the certificate.", Name="Description") public var Description:String /** * Tags to label or identify the certificate. */ // @ApiMember(Description="Tags to label or identify the certificate.", Name="Tags") public var tags:[String] = [] required public init(){} } /** * Represents an ELMA report document. */ // @Api(Description="Represents an ELMA report document.") public class Elma : Codable { /** * 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 var id:String /** * The location of the XML Schema to use for the root namespace. */ // @ApiMember(Description="The location of the XML Schema to use for the root namespace.", Name="SchemaLocation") public var schemaLocation:String /** * The type of reporting process. */ // @ApiMember(Description="The type of reporting process.", IsRequired=true, Name="Verfahren") public var verfahren:Verfahren? /** * The communication section of the ELMA report document. */ // @ApiMember(Description="The communication section of the ELMA report document.", IsRequired=true, Name="ElmaKom") public var elmaKom:ElmaKom /** * The communication section of the ELMA report document. */ // @ApiMember(Description="The communication section of the ELMA report document.", Name="ElmaProtokoll") public var elmaProtokoll:ElmaProtokoll /** * The communication section of the ELMA report document. */ // @ApiMember(Description="The communication section of the ELMA report document.", Name="ElmaFehler") public var elmaFehler:ElmaFehler required public init(){} } /** * Represents a file that contains raw data content in bytes */ // @Api(Description="Represents a file that contains raw data content in bytes") public class BinaryFile : FileBase { /** * The attributes of the file. */ // @ApiMember(Description="The attributes of the file.", Name="Metadata") public var metadata:FileMetadata /** * The name of the file without information on its directory path. */ // @ApiMember(Description="The name of the file without information on its directory path.", Name="Name") public var name:String required public init(){ super.init() } private enum CodingKeys : String, CodingKey { case metadata case name } required public init(from decoder: Decoder) throws { try super.init(from: decoder) let container = try decoder.container(keyedBy: CodingKeys.self) metadata = try container.decodeIfPresent(FileMetadata.self, forKey: .metadata) name = try container.decodeIfPresent(String.self, forKey: .name) } public override func encode(to encoder: Encoder) throws { try super.encode(to: encoder) var container = encoder.container(keyedBy: CodingKeys.self) if metadata != nil { try container.encode(metadata, forKey: .metadata) } if name != nil { try container.encode(name, forKey: .name) } } } /** * Represents information about a file or directory. */ // @Api(Description="Represents information about a file or directory.") public class FileMetadata : IFileMetadata, Codable { /** * The name of the file.For files, gets the name of the file.For directories, gets the name of the last directory in the hierarchy if a hierarchy exists; otherwise, the name of the directory. */ // @ApiMember(Description="The name of the file.\nFor files, gets the name of the file.\nFor directories, gets the name of the last directory in the hierarchy if a hierarchy exists; otherwise, the name of the directory.", Name="Name") public var name:String /** * The full path of the directory or file. */ // @ApiMember(Description="The full path of the directory or file.", Name="FullName") public var fullName:String /** * The time the current file or directory was last accessed. */ // @ApiMember(Description="The time the current file or directory was last accessed.", Name="LastAccessTime") public var lastAccessTime:Date /** * The name of the file. */ // @ApiMember(Description="The name of the file.", Name="LastAccessTimeUtc") public var lastAccessTimeUtc:Date /** * The time when the current file or directory was last written to. */ // @ApiMember(Description="The time when the current file or directory was last written to.", Name="LastAccessTime") public var lastWriteTime:Date /** * The time, in coordinated universal time (UTC), when the current file or directory was last written to. */ // @ApiMember(Description="The time, in coordinated universal time (UTC), when the current file or directory was last written to.", Name="LastWriteTimeUtc") public var lastWriteTimeUtc:Date /** * The size, in bytes, of the current file. */ // @ApiMember(Description="The size, in bytes, of the current file.", Name="Length") public var length:Int /** * The size, in bytes, of the current file. */ // @ApiMember(Description="The size, in bytes, of the current file.", Name="UserId") public var userId:Int /** * The file group id. */ // @ApiMember(Description="The file group id.", Name="GroupId") public var groupId:Int /** * A value that indicates whether the others can read from this file. */ // @ApiMember(Description="A value that indicates whether the others can read from this file.", Name="OthersCanRead") public var othersCanRead:Bool /** * A value that indicates whether the group members can execute this file. */ // @ApiMember(Description="A value that indicates whether the group members can execute this file.", Name="GroupCanExecute") public var groupCanExecute:Bool /** * A value that indicates whether the group members can write into this file. */ // @ApiMember(Description="A value that indicates whether the group members can write into this file.", Name="GroupCanWrite") public var groupCanWrite:Bool /** * A value that indicates whether the group members can read from this file. */ // @ApiMember(Description="A value that indicates whether the group members can read from this file.", Name="GroupCanRead") public var groupCanRead:Bool /** * A value that indicates whether the owner can execute this file. */ // @ApiMember(Description="A value that indicates whether the owner can execute this file.", Name="OwnerCanExecute") public var ownerCanExecute:Bool /** * A value that indicates whether the owner can write into this file. */ // @ApiMember(Description="A value that indicates whether the owner can write into this file.", Name="OwnerCanWrite") public var ownerCanWrite:Bool /** * A value that indicates whether the owner can read from this file. */ // @ApiMember(Description="A value that indicates whether the owner can read from this file.", Name="OthersCanRead") public var ownerCanRead:Bool /** * A value that indicates whether others can read from this file. */ // @ApiMember(Description="A value that indicates whether others can read from this file.", Name="OthersCanExecute") public var othersCanExecute:Bool /** * A value that indicates whether others can write into this file. */ // @ApiMember(Description="A value that indicates whether others can write into this file.", Name="OthersCanWrite") public var othersCanWrite:Bool /** * Extensions to the file attributes. */ // @ApiMember(Description="Extensions to the file attributes.", Name="Extensions") public var extensions:[String:String] = [:] required public init(){} } public enum Verfahren : String, Codable { case CC case CS case DC case FC case FS case FA case KM } public protocol IElmaCredential { var certificate:PemCertificate { get set } var authSteuernummer:String { get set } var accountId:String { get set } var password:String { get set } } /** * Represents the communication section of an ELMA report document. */ // @Api(Description="Represents the communication section of an ELMA report document.") public class ElmaKom : Codable { /** * The version number of the ELMAKOM definition. */ // @ApiMember(Description="The version number of the ELMAKOM definition.", IsRequired=true, Name="ElmakomVersion") public var elmakomVersion:String /** * The header part of the ELMAKOM definition. */ // @ApiMember(Description="The header part of the ELMAKOM definition.", IsRequired=true, Name="ElmaHeader") public var elmaHeader:ElmaHeader /** * The process part of the ELMAKOM definition. */ // @ApiMember(Description="The process part of the ELMAKOM definition.", IsRequired=true, Name="ElmaVerfahren") public var elmaVerfahren:ElmaVerfahren required public init(){} } /** * Represents an ELMA protocol report, which the ELMA servers return after a formal verification of a submitted ELMA report. */ // @Api(Description="Represents an ELMA protocol report, which the ELMA servers return after a formal verification of a submitted ELMA report.") public class ElmaProtokoll : Codable { /** * File name of the processed input ELMA report. */ // @ApiMember(Description="File name of the processed input ELMA report.", Name="Dateiname") public var dateiname:String /** * 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") public var authSteuernummer:String /** * 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") public var accountId:String /** * Date on which the request was processed by ELAN (ELMA receiving server at BZSt). */ // @ApiMember(Description="Date on which the request was processed by ELAN (ELMA receiving server at BZSt).", Name="VerarbeitungsDatum") public var verarbeitungsDatum:Date? /** * Time of processing by ELAN (ELMA receiving server at BZSt). */ // @ApiMember(Description="Time of processing by ELAN (ELMA receiving server at BZSt).", Name="VerarbeitungsZeit") public var verarbeitungsZeit:Date? /** * The status code of the ELMA process. */ // @ApiMember(Description="The status code of the ELMA process.", Name="Status") public var status:Status /** * A brief description of the status. */ // @ApiMember(Description="A brief description of the status.", Name="StatusText") public var statusText:String /** * A detailed information on the status. */ // @ApiMember(Description="A detailed information on the status.", Name="StatusDetail") public var statusDetail:String /** * User custom ID.This field can be filled with internal reference information of the user. */ // @ApiMember(Description="User custom ID.This field can be filled with internal reference information of the user.", Name="KundeneigeneId") public var kundeneigeneId:String /** * Data transfer identifier.Hexadecimal formatted number. Example: 550e8400-e29b-11d4-a716-446655440000 */ // @ApiMember(Description="Data transfer identifier.Hexadecimal formatted number. Example: 550e8400-e29b-11d4-a716-446655440000", Name="UUID") public var uuid:String? required public init(){} } /** * Represents an ELMA protocol report, which the ELMA servers return after a formal verification of a submitted ELMA report. */ // @Api(Description="Represents an ELMA protocol report, which the ELMA servers return after a formal verification of a submitted ELMA report.") public class ElmaFehler : Codable { /** * File name of the processed input ELMA report. */ // @ApiMember(Description="File name of the processed input ELMA report.", Name="Dateiname") public var dateiname:String /** * 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") public var authSteuernummer:String /** * 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") public var accountId:String /** * Date on which the request was processed by ELAN (ELMA receiving server at BZSt). */ // @ApiMember(Description="Date on which the request was processed by ELAN (ELMA receiving server at BZSt).", Name="VerarbeitungsDatum") public var verarbeitungsDatum:Date? /** * Time of processing by ELAN (ELMA receiving server at BZSt). */ // @ApiMember(Description="Time of processing by ELAN (ELMA receiving server at BZSt).", Name="VerarbeitungsZeit") public var verarbeitungsZeit:Date? /** * The status code of the ELMA process. */ // @ApiMember(Description="The status code of the ELMA process.", Name="FehlerID") public var fehlerID:Status /** * A brief description of the error status. */ // @ApiMember(Description="A brief description of the error status.", Name="FehlerText") public var fehlerText:String /** * A detailed information on the status. */ // @ApiMember(Description="A detailed information on the status.", Name="FehlerProzess") public var fehlerProzess:String /** * User custom ID.This field can be filled with internal reference information of the user. */ // @ApiMember(Description="User custom ID.This field can be filled with internal reference information of the user.", Name="KundeneigeneId") public var kundeneigeneId:String /** * Data transfer identifier.Hexadecimal formatted number. Example: 550e8400-e29b-11d4-a716-446655440000 */ // @ApiMember(Description="Data transfer identifier.Hexadecimal formatted number. Example: 550e8400-e29b-11d4-a716-446655440000", Name="UUID") public var uuid:String? required public init(){} } /** * Represents a base class for a file with raw data. */ // @Api(Description="Represents a base class for a file with raw data.") public class FileBase : Codable { /** * The raw data content of the file. */ // @ApiMember(Description="The raw data content of the file.", Name="Content") public var content:[UInt8] = [] required public init(){} } public protocol IFileMetadata { var name:String { get set } var fullName:String { get set } var lastAccessTime:Date { get set } var lastAccessTimeUtc:Date { get set } var lastWriteTime:Date { get set } var lastWriteTimeUtc:Date { get set } var length:Int { get set } var userId:Int { get set } var groupId:Int { get set } var groupCanExecute:Bool { get set } var groupCanWrite:Bool { get set } var groupCanRead:Bool { get set } var ownerCanRead:Bool { get set } var ownerCanExecute:Bool { get set } var ownerCanWrite:Bool { get set } var othersCanRead:Bool { get set } var othersCanExecute:Bool { get set } var othersCanWrite:Bool { get set } var extensions:[String:String] { get set } } /** * Represents the header of an ELMA communication section. */ // @Api(Description="Represents the header of an ELMA communication section.") public class ElmaHeader : Codable { /** * The process-specific report type of an ELMA document.It distinguishes by the type of input. */ // @ApiMember(Description="The process-specific report type of an ELMA document.It distinguishes by the type of input.", IsRequired=true, Name="DatenArt") public var datenArt:DatenArt /** * 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") public var authSteuernummer:String /** * 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") public var accountId:String /** * The time of creation.Corresponds to the time, at which the user created a file. */ // @ApiMember(Description="The time of creation.Corresponds to the time, at which the user created a file.", Name="ErstellungsDatum") public var erstellungsDatum:Date? /** * User custom ID.This field can be filled with internal reference information of the user. */ // @ApiMember(Description="User custom ID.This field can be filled with internal reference information of the user.", Name="KundeneigeneId") public var kundeneigeneId:String /** * Data transfer identifier.Hexadecimal formatted number. Example: 550e8400-e29b-11d4-a716-446655440000 */ // @ApiMember(Description="Data transfer identifier.Hexadecimal formatted number. Example: 550e8400-e29b-11d4-a716-446655440000", Name="UUID") public var uuid:String? /** * Distinguishes between test and live data transfer. */ // @ApiMember(Description="Distinguishes between test and live data transfer.", Name="Verarbeitungslauf") public var verarbeitungslauf:Verarbeitungslauf required public init(){} } public class ElmaVerfahren : Codable { //inhalt:Object ignored. Type could not be extended in Swift required public init(){} } public enum Status : Int, Codable { case ELMA_GLOBAL_UNBEKANNT = 0 case ELMA_OK = 8000 case ELMA_PARSER_FEHLER = 8001 case ELMA_UNGUELTIGE_KODIERUNG = 8002 case ELMA_UNGUELTIGE_DATEINAME = 8003 case ELMA_FALSCHE_BZSTNR_ODER_ACCOUNTID = 8004 case ELMA_SIGNATUR_DATEI_FEHLT = 8005 case ELMA_SIGNATUR_PRUEFUNG_FEHLERHAFT = 8006 case ELMA_NOTWENDIGE_FACHLICHE_BERECHTIGUNGEN_FEHLEN = 8007 case ELMA_FREISCHALTUNG_FEHLT = 8008 case ELMA_SPERRE_VORHANDEN = 8009 case ELMA_DATEINAME_BEREITS_VERWENDET = 8010 case ELMA_DATEIINHALT_IDENTISCH = 8011 case ELMA_BZSTNR_ODER_ACCOUNTID_STIMMT_NICHT_UBEREIN = 8012 case ELMA_TESTDATEN = 8013 } public enum DatenArt : String, Codable { case ELMA_CC case ELMA_CCRM case ELMA_CRS case ELMA_CRSRM case ELMA_DC case ELMA_DCRM case ELMA_FC case ELMA_FCRM } public enum Verarbeitungslauf : String, Codable { case PRODUKTIONSLAUF case TESTLAUF }