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

//GlobalNamespace: 
//MakeDataContractsExtensible: False
//AddReturnMarker: True
//AddDescriptionAsComments: True
//AddDataContractAttributes: False
//AddIndexesToDataMembers: False
//AddGeneratedCodeAttributes: False
//AddResponseStatus: False
//AddImplicitVersion: 
//ExportValueTypes: False
IncludeTypes: BrowseFilesAsync.*
//ExcludeTypes: 
//InitializeCollections: True
//AddNamespaces: 
*)

namespace PwC.DigitalHub.Utilities.IO.Core.Concretes.Models

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
open System.Xml.Schema
open System.Net

    ///<summary>
    ///Represents a PEM-encoded certificate.
    ///</summary>
    [<Api(Description="Represents a PEM-encoded certificate.")>]
    [<AllowNullLiteral>]
    type PemCertificate() = 
        ///<summary>
        ///The unique identifier (e.g. the file name) of the certificate.
        ///</summary>
        [<ApiMember(Description="The unique identifier (e.g. the file name) of the certificate.", IsRequired=true, Name="Id")>]
        member val Id:String = null with get,set

        ///<summary>
        ///The PEM-encoded content of the certificate.
        ///</summary>
        [<ApiMember(Description="The PEM-encoded content of the certificate.", IsRequired=true, Name="Content")>]
        member val Content:String = null with get,set

        ///<summary>
        ///The description of the certificate.
        ///</summary>
        [<ApiMember(Description="The description of the certificate.", Name="Description")>]
        member val Description:String = null with get,set

        ///<summary>
        ///Tags to label or identify the certificate.
        ///</summary>
        [<ApiMember(Description="Tags to label or identify the certificate.", Name="Tags")>]
        member val Tags:ResizeArray<String> = new ResizeArray<String>() with get,set

    ///<summary>
    ///Represents the credentials of a user to authenticate the access of an ELMA server.
    ///</summary>
    [<Api(Description="Represents the credentials of a user to authenticate the access of an ELMA server.")>]
    [<AllowNullLiteral>]
    type ElmaCredential() = 
        ///<summary>
        ///The unique identifier of this instance.  This identifer is only relevant in the context of data storage and retrieval.
        ///</summary>
        [<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")>]
        member val Id:String = null with get,set

        ///<summary>
        ///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)
        ///</summary>
        [<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.MaxValue)>]
        member val Certificate:PemCertificate = null with get,set

        ///<summary>
        ///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"
        ///</summary>
        [<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)>]
        member val AuthSteuernummer:String = null with get,set

        ///<summary>
        ///The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).
        ///</summary>
        [<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)>]
        member val AccountId:String = null with get,set

        ///<summary>
        ///The password to protect the certificate from unauthorized access.
        ///</summary>
        [<ApiMember(Description="The password to protect the certificate from unauthorized access.", IsRequired=true, Name="Password")>]
        member val Password:String = null with get,set

    [<AllowNullLiteral>]
    type IAuthenticateRequest = 
        abstract Credential:ElmaCredential with get,set

    [<AllowNullLiteral>]
    type IStageableRequest = 
        abstract StagingEnabled:Nullable<Boolean> with get,set

    type DirectoryType =
        | Upload = 0
        | Download = 1

    ///<summary>
    ///Specifies a request to browse directories for files on the ELMA server.
    ///</summary>
    [<Api(Description="Specifies a request to browse directories for files on the ELMA server.")>]
    [<AllowNullLiteral>]
    type BrowseFilesBase() = 
        interface IPost
        ///<summary>
        ///The directory to browse for files.
        ///</summary>
        [<ApiMember(Description="The directory to browse for files.", IsRequired=true, Name="DirectoryType")>]
        member val DirectoryType:DirectoryType = new DirectoryType() with get,set

        ///<summary>
        ///The credential to gain access on the ELMA server.
        ///</summary>
        [<ApiMember(Description="The credential to gain access on the ELMA server.", IsRequired=true, Name="Credential")>]
        member val Credential:ElmaCredential = null with get,set

        ///<summary>
        ///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.
        ///</summary>
        [<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")>]
        member val StagingEnabled:Nullable<Boolean> = new Nullable<Boolean>() with get,set

    ///<summary>
    ///Represents information about a file or directory.
    ///</summary>
    [<Api(Description="Represents information about a file or directory.")>]
    [<AllowNullLiteral>]
    type FileMetadata() = 
        ///<summary>
        ///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.
        ///</summary>
        [<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")>]
        member val Name:String = null with get,set

        ///<summary>
        ///The full path of the directory or file.
        ///</summary>
        [<ApiMember(Description="The full path of the directory or file.", Name="FullName")>]
        member val FullName:String = null with get,set

        ///<summary>
        ///The time the current file or directory was last accessed.
        ///</summary>
        [<ApiMember(Description="The time the current file or directory was last accessed.", Name="LastAccessTime")>]
        member val LastAccessTime:DateTime = new DateTime() with get,set

        ///<summary>
        ///The name of the file.
        ///</summary>
        [<ApiMember(Description="The name of the file.", Name="LastAccessTimeUtc")>]
        member val LastAccessTimeUtc:DateTime = new DateTime() with get,set

        ///<summary>
        ///The time when the current file or directory was last written to.
        ///</summary>
        [<ApiMember(Description="The time when the current file or directory was last written to.", Name="LastAccessTime")>]
        member val LastWriteTime:DateTime = new DateTime() with get,set

        ///<summary>
        ///The time, in coordinated universal time (UTC), when the current file or directory was last written to.
        ///</summary>
        [<ApiMember(Description="The time, in coordinated universal time (UTC), when the current file or directory was last written to.", Name="LastWriteTimeUtc")>]
        member val LastWriteTimeUtc:DateTime = new DateTime() with get,set

        ///<summary>
        ///The size, in bytes, of the current file.
        ///</summary>
        [<ApiMember(Description="The size, in bytes, of the current file.", Name="Length")>]
        member val Length:Int64 = new Int64() with get,set

        ///<summary>
        ///The size, in bytes, of the current file.
        ///</summary>
        [<ApiMember(Description="The size, in bytes, of the current file.", Name="UserId")>]
        member val UserId:Int32 = new Int32() with get,set

        ///<summary>
        ///The file group id.
        ///</summary>
        [<ApiMember(Description="The file group id.", Name="GroupId")>]
        member val GroupId:Int32 = new Int32() with get,set

        ///<summary>
        ///A value that indicates whether the others can read from this file.
        ///</summary>
        [<ApiMember(Description="A value that indicates whether the others can read from this file.", Name="OthersCanRead")>]
        member val OthersCanRead:Boolean = new Boolean() with get,set

        ///<summary>
        ///A value that indicates whether the group members can execute this file.
        ///</summary>
        [<ApiMember(Description="A value that indicates whether the group members can execute this file.", Name="GroupCanExecute")>]
        member val GroupCanExecute:Boolean = new Boolean() with get,set

        ///<summary>
        ///A value that indicates whether the group members can write into this file.
        ///</summary>
        [<ApiMember(Description="A value that indicates whether the group members can write into this file.", Name="GroupCanWrite")>]
        member val GroupCanWrite:Boolean = new Boolean() with get,set

        ///<summary>
        ///A value that indicates whether the group members can read from this file.
        ///</summary>
        [<ApiMember(Description="A value that indicates whether the group members can read from this file.", Name="GroupCanRead")>]
        member val GroupCanRead:Boolean = new Boolean() with get,set

        ///<summary>
        ///A value that indicates whether the owner can execute this file.
        ///</summary>
        [<ApiMember(Description="A value that indicates whether the owner can execute this file.", Name="OwnerCanExecute")>]
        member val OwnerCanExecute:Boolean = new Boolean() with get,set

        ///<summary>
        ///A value that indicates whether the owner can write into this file.
        ///</summary>
        [<ApiMember(Description="A value that indicates whether the owner can write into this file.", Name="OwnerCanWrite")>]
        member val OwnerCanWrite:Boolean = new Boolean() with get,set

        ///<summary>
        ///A value that indicates whether the owner can read from this file.
        ///</summary>
        [<ApiMember(Description="A value that indicates whether the owner can read from this file.", Name="OthersCanRead")>]
        member val OwnerCanRead:Boolean = new Boolean() with get,set

        ///<summary>
        ///A value that indicates whether others can read from this file.
        ///</summary>
        [<ApiMember(Description="A value that indicates whether others can read from this file.", Name="OthersCanExecute")>]
        member val OthersCanExecute:Boolean = new Boolean() with get,set

        ///<summary>
        ///A value that indicates whether others can write into this file.
        ///</summary>
        [<ApiMember(Description="A value that indicates whether others can write into this file.", Name="OthersCanWrite")>]
        member val OthersCanWrite:Boolean = new Boolean() with get,set

        ///<summary>
        ///Extensions to the file attributes.
        ///</summary>
        [<ApiMember(Description="Extensions to the file attributes.", Name="Extensions")>]
        member val Extensions:Dictionary<String, String> = new Dictionary<String, String>() with get,set

    [<AllowNullLiteral>]
    type IElmaCredential = 
        abstract Certificate:PemCertificate with get,set
        abstract AuthSteuernummer:String with get,set
        abstract AccountId:String with get,set
        abstract Password:String with get,set

    [<AllowNullLiteral>]
    type IFileMetadata = 
        abstract Name:String with get,set
        abstract FullName:String with get,set
        abstract LastAccessTime:DateTime with get,set
        abstract LastAccessTimeUtc:DateTime with get,set
        abstract LastWriteTime:DateTime with get,set
        abstract LastWriteTimeUtc:DateTime with get,set
        abstract Length:Int64 with get,set
        abstract UserId:Int32 with get,set
        abstract GroupId:Int32 with get,set
        abstract GroupCanExecute:Boolean with get,set
        abstract GroupCanWrite:Boolean with get,set
        abstract GroupCanRead:Boolean with get,set
        abstract OwnerCanRead:Boolean with get,set
        abstract OwnerCanExecute:Boolean with get,set
        abstract OwnerCanWrite:Boolean with get,set
        abstract OthersCanRead:Boolean with get,set
        abstract OthersCanExecute:Boolean with get,set
        abstract OthersCanWrite:Boolean with get,set
        abstract Extensions:Dictionary<String, String> with get,set

    ///<summary>
    ///Encapsulates the results of browsing an ELMA server directory
    ///</summary>
    [<Api(Description="Encapsulates the results of browsing an ELMA server directory")>]
    [<AllowNullLiteral>]
    type BrowseResponse() = 
        ///<summary>
        ///The files from the file browse operation.
        ///</summary>
        [<ApiMember(Description="The files from the file browse operation.", Name="Files")>]
        member val Files:ResizeArray<FileMetadata> = new ResizeArray<FileMetadata>() with get,set

        ///<summary>
        ///The status of the file browse operation.
        ///</summary>
        [<ApiMember(Description="The status of the file browse operation.", Name="ResponseStatus")>]
        member val ResponseStatus:ResponseStatus = null with get,set

    ///<summary>
    ///Represents a request to browse directories for files on the ELMA server in an asynchronous operation.
    ///</summary>
    [<Route("/async/elma/files/browse", "POST")>]
    [<Api(Description="Represents a request to browse directories for files on the ELMA server in an asynchronous operation.")>]
    [<AllowNullLiteral>]
    type BrowseFilesAsync() = 
        inherit BrowseFilesBase()
        interface IReturn<BrowseResponse>