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

//GlobalNamespace: 
//MakePropertiesOptional: False
//AddServiceStackTypes: True
//AddResponseStatus: False
//AddImplicitVersion: 
//AddDescriptionAsComments: True
IncludeTypes: FindWebhookSubscriptionAsync.*
//ExcludeTypes: 
//DefaultImports: 
*/


export interface IReturn<T>
{
    createResponse(): T;
}

export class SubscriptionConfig
{
    public url: string;
    public contentType: string;
    public secret: string;

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

export class WebhookSubscription
{
    public id: string;
    public name: string;
    public event: string;
    public isActive: boolean;
    public createdDateUtc: string;
    public createdById: string;
    public lastModifiedDateUtc: string;
    public config: SubscriptionConfig;

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

/** @description Specifies a request to find and retrieve a webhook subscription by its user unique identifier and name of subscribed event. */
// @Api(Description="Specifies a request to find and retrieve a webhook subscription by its user unique identifier and name of subscribed event.")
export class FindWebhookSubscriptionBase implements IGet
{
    /** @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")
    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")
    public accountId: string;

    /** @description The unique identifier of the subscriber. */
    // @ApiMember(Description="The unique identifier of the subscriber.", IsRequired=true, Name="EventName")
    public eventName: string;

    public constructor(init?: Partial<FindWebhookSubscriptionBase>) { (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); }
}

export class SubscriptionDeliveryResult
{
    public attemptedDateUtc: string;
    public statusDescription: string;
    public statusCode: HttpStatusCode;
    public subscriptionId: string;
    public id: string;
    public eventId: string;

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

/** @description Represents a service response that encapsulates a webhook subscription. */
// @Api(Description="Represents a service response that encapsulates a webhook subscription.")
export class SubscriptionResponse
{
    /** @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. */
    // @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 subscription: WebhookSubscription;

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

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

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

/** @description Represents a request to find and retrieve a webhook subscription by its user unique identifier and name of subscribed event in an asynchronous operation. */
// @Route("/async/webhooks/subscriptions/find", "GET")
// @Api(Description="Represents a request to find and retrieve a webhook subscription by its user unique identifier and name of subscribed event in an asynchronous operation.")
export class FindWebhookSubscriptionAsync extends FindWebhookSubscriptionBase implements IReturn<SubscriptionResponse>
{

    public constructor(init?: Partial<FindWebhookSubscriptionAsync>) { super(init); (Object as any).assign(this, init); }
    public getTypeName() { return 'FindWebhookSubscriptionAsync'; }
    public getMethod() { return 'GET'; }
    public createResponse() { return new SubscriptionResponse(); }
}