/* Options:
Date: 2024-10-18 17:18:11
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: BatchGetWebhookSubscriptionsAsync.*
//ExcludeTypes: 
//ExcludeGenericBaseTypes: False
//AddResponseStatus: False
//AddImplicitVersion: 
//AddDescriptionAsComments: True
//InitializeCollections: True
//TreatTypesAsStrings: 
//DefaultImports: Foundation,ServiceStack
*/

import Foundation
import ServiceStack

/**
* Represents a request to lists all subscriptions of an ELMA user that is specified by the provided user details in an asynchronous operation.
*/
// @Route("/async/webhooks/subscriptions", "GET")
// @Api(Description="Represents a request to lists all subscriptions of an ELMA user that is specified by the provided user details in an asynchronous operation.")
public class BatchGetWebhookSubscriptionsAsync : BatchGetWebhookSubscriptionsBase, IReturn
{
    public typealias Return = [SubscriptionResponse]

    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)
    }
}

public class WebhookSubscription : Codable
{
    public var id:String
    public var name:String
    public var event:String
    public var isActive:Bool
    public var createdDateUtc:Date
    public var createdById:String
    public var lastModifiedDateUtc:Date
    public var config:SubscriptionConfig

    required public init(){}
}

/**
* Specifies a request to lists all subscriptions of an ELMA user that is specified by the provided user details.
*/
// @Api(Description="Specifies a request to lists all subscriptions of an ELMA user that is specified by the provided user details.")
public class BatchGetWebhookSubscriptionsBase : IGet, Codable
{
    /**
    * 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

    required public init(){}
}

public class SubscriptionDeliveryResult : Codable
{
    public var attemptedDateUtc:Date
    public var statusDescription:String
    public var statusCode:HttpStatusCode
    public var subscriptionId:String
    public var id:String
    public var eventId:String

    required public init(){}
}

public class SubscriptionConfig : Codable
{
    public var url:String
    public var contentType:String
    public var secret:String

    required public init(){}
}

/**
* Represents a service response that encapsulates a webhook subscription.
*/
// @Api(Description="Represents a service response that encapsulates a webhook subscription.")
public class SubscriptionResponse : Codable
{
    /**
    * The encapsulated webhook subscription of the response. The secret of the webhook subscription is encrypted and can only be decrypted by the owner of the private key.
    */
    // @ApiMember(Description="The encapsulated webhook subscription of the response. The secret of the webhook subscription is encrypted and can only be decrypted by the owner of the private key.", Name="Subscription")
    public var subscription:WebhookSubscription

    /**
    * The history of the subscription event.
    */
    // @ApiMember(Description="The history of the subscription event.", Name="History")
    public var history:[SubscriptionDeliveryResult] = []

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

    required public init(){}
}