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

//BaseClass: 
//AddModelExtensions: True
//AddServiceStackTypes: True
IncludeTypes: BrowseFilesAsync.*
//ExcludeTypes: 
//ExcludeGenericBaseTypes: False
//AddResponseStatus: False
//AddImplicitVersion: 
//AddDescriptionAsComments: True
//InitializeCollections: True
//TreatTypesAsStrings: 
//DefaultImports: Foundation,ServiceStack
*/

import Foundation
import ServiceStack

/**
* Represents a request to browse directories for files on the ELMA server in an asynchronous operation.
*/
// @Route("/async/elma/files/browse", "POST")
// @Api(Description="Represents a request to browse directories for files on the ELMA server in an asynchronous operation.")
public class BrowseFilesAsync : BrowseFilesBase, IReturn
{
    public typealias Return = BrowseResponse

    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 browsing an ELMA server directory
*/
// @Api(Description="Encapsulates the results of browsing an ELMA server directory")
public class BrowseResponse : Codable
{
    /**
    * The files from the file browse operation.
    */
    // @ApiMember(Description="The files from the file browse operation.", Name="Files")
    public var files:[FileMetadata] = []

    /**
    * The status of the file browse operation.
    */
    // @ApiMember(Description="The status of the file browse operation.", Name="ResponseStatus")
    public var responseStatus:ResponseStatus

    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 enum DirectoryType : String, Codable
{
    case Upload
    case Download
}

/**
* Specifies a request to browse directories for files on the ELMA server.
*/
// @Api(Description="Specifies a request to browse directories for files on the ELMA server.")
public class BrowseFilesBase : IPost, IAuthenticateRequest, IStageableRequest, Codable
{
    /**
    * The directory to browse for files.
    */
    // @ApiMember(Description="The directory to browse for files.", IsRequired=true, Name="DirectoryType")
    public var directoryType:DirectoryType

    /**
    * 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 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 protocol IElmaCredential
{
    var certificate:PemCertificate { get set }
    var authSteuernummer:String { get set }
    var accountId:String { get set }
    var password:String { get set }

}

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 }

}