<back to all web services

DeleteWebhookSubscriptionAsync

Represents a request to delete a webhook subscription in an asynchronous operation.

import 'package:servicestack/servicestack.dart';

/**
* Specifies a request to delete a webhook subscription.
*/
// @Api(Description="Specifies a request to delete a webhook subscription.")
abstract class DeleteWebhookSubscriptionBase implements IPost
{
    /**
    * The unique identifier of the subscriber.
    */
    // @ApiMember(Description="The unique identifier of the subscriber.", IsRequired=true, Name="Id")
    String? id;

    /**
    * The secret of the to-be-deleted webhook subscription. This secret is used to authenticate the owner of the webhook subscription.
    */
    // @ApiMember(Description="The secret of the to-be-deleted webhook subscription. This secret is used to authenticate the owner of the webhook subscription.", IsRequired=true, Name="Secret")
    String? secret;

    DeleteWebhookSubscriptionBase({this.id,this.secret});
    DeleteWebhookSubscriptionBase.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        secret = json['secret'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'secret': secret
    };

    getTypeName() => "DeleteWebhookSubscriptionBase";
    TypeContext? context = _ctx;
}

class SubscriptionConfig implements IConvertible
{
    String? url;
    String? contentType;
    String? secret;

    SubscriptionConfig({this.url,this.contentType,this.secret});
    SubscriptionConfig.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        url = json['url'];
        contentType = json['contentType'];
        secret = json['secret'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'url': url,
        'contentType': contentType,
        'secret': secret
    };

    getTypeName() => "SubscriptionConfig";
    TypeContext? context = _ctx;
}

class WebhookSubscription implements IConvertible
{
    String? id;
    String? name;
    String? event;
    bool? isActive;
    DateTime? createdDateUtc;
    String? createdById;
    DateTime? lastModifiedDateUtc;
    SubscriptionConfig? config;

    WebhookSubscription({this.id,this.name,this.event,this.isActive,this.createdDateUtc,this.createdById,this.lastModifiedDateUtc,this.config});
    WebhookSubscription.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        name = json['name'];
        event = json['event'];
        isActive = json['isActive'];
        createdDateUtc = JsonConverters.fromJson(json['createdDateUtc'],'DateTime',context!);
        createdById = json['createdById'];
        lastModifiedDateUtc = JsonConverters.fromJson(json['lastModifiedDateUtc'],'DateTime',context!);
        config = JsonConverters.fromJson(json['config'],'SubscriptionConfig',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'name': name,
        'event': event,
        'isActive': isActive,
        'createdDateUtc': JsonConverters.toJson(createdDateUtc,'DateTime',context!),
        'createdById': createdById,
        'lastModifiedDateUtc': JsonConverters.toJson(lastModifiedDateUtc,'DateTime',context!),
        'config': JsonConverters.toJson(config,'SubscriptionConfig',context!)
    };

    getTypeName() => "WebhookSubscription";
    TypeContext? context = _ctx;
}

class SubscriptionDeliveryResult implements IConvertible
{
    DateTime? attemptedDateUtc;
    String? statusDescription;
    HttpStatusCode? statusCode;
    String? subscriptionId;
    String? id;
    String? eventId;

    SubscriptionDeliveryResult({this.attemptedDateUtc,this.statusDescription,this.statusCode,this.subscriptionId,this.id,this.eventId});
    SubscriptionDeliveryResult.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        attemptedDateUtc = JsonConverters.fromJson(json['attemptedDateUtc'],'DateTime',context!);
        statusDescription = json['statusDescription'];
        statusCode = JsonConverters.fromJson(json['statusCode'],'HttpStatusCode',context!);
        subscriptionId = json['subscriptionId'];
        id = json['id'];
        eventId = json['eventId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'attemptedDateUtc': JsonConverters.toJson(attemptedDateUtc,'DateTime',context!),
        'statusDescription': statusDescription,
        'statusCode': JsonConverters.toJson(statusCode,'HttpStatusCode',context!),
        'subscriptionId': subscriptionId,
        'id': id,
        'eventId': eventId
    };

    getTypeName() => "SubscriptionDeliveryResult";
    TypeContext? context = _ctx;
}

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

    /**
    * The history of the subscription event.
    */
    // @ApiMember(Description="The history of the subscription event.", Name="History")
    List<SubscriptionDeliveryResult>? history;

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

    SubscriptionResponse({this.subscription,this.history,this.responseStatus});
    SubscriptionResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        subscription = JsonConverters.fromJson(json['subscription'],'WebhookSubscription',context!);
        history = JsonConverters.fromJson(json['history'],'List<SubscriptionDeliveryResult>',context!);
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'subscription': JsonConverters.toJson(subscription,'WebhookSubscription',context!),
        'history': JsonConverters.toJson(history,'List<SubscriptionDeliveryResult>',context!),
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "SubscriptionResponse";
    TypeContext? context = _ctx;
}

/**
* Represents a request to delete a webhook subscription in an asynchronous operation.
*/
// @Api(Description="Represents a request to delete a webhook subscription in an asynchronous operation.")
class DeleteWebhookSubscriptionAsync extends DeleteWebhookSubscriptionBase implements IConvertible
{
    DeleteWebhookSubscriptionAsync();
    DeleteWebhookSubscriptionAsync.fromJson(Map<String, dynamic> json) : super.fromJson(json);
    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson();
    getTypeName() => "DeleteWebhookSubscriptionAsync";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'reportfiling.staging.pwc.de', types: <String, TypeInfo> {
    'DeleteWebhookSubscriptionBase': TypeInfo(TypeOf.AbstractClass),
    'SubscriptionConfig': TypeInfo(TypeOf.Class, create:() => SubscriptionConfig()),
    'WebhookSubscription': TypeInfo(TypeOf.Class, create:() => WebhookSubscription()),
    'SubscriptionDeliveryResult': TypeInfo(TypeOf.Class, create:() => SubscriptionDeliveryResult()),
    'HttpStatusCode': TypeInfo(TypeOf.Class, create:() => HttpStatusCode()),
    'SubscriptionResponse': TypeInfo(TypeOf.Class, create:() => SubscriptionResponse()),
    'List<SubscriptionDeliveryResult>': TypeInfo(TypeOf.Class, create:() => <SubscriptionDeliveryResult>[]),
    'DeleteWebhookSubscriptionAsync': TypeInfo(TypeOf.Class, create:() => DeleteWebhookSubscriptionAsync()),
});

Dart DeleteWebhookSubscriptionAsync DTOs

POST /async/webhooks/subscriptions/{Id}/delete HTTP/1.1 
Host: reportfiling.staging.pwc.de 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"id":"String","secret":"String"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"subscription":{"id":"String","name":"String","event":"String","isActive":false,"createdDateUtc":"\/Date(-62135596800000-0000)\/","createdById":"String","lastModifiedDateUtc":"\/Date(-62135596800000-0000)\/","config":{"url":"String","contentType":"String","secret":"String"}},"history":[{"attemptedDateUtc":"\/Date(-62135596800000-0000)\/","statusDescription":"String","statusCode":"Continue","subscriptionId":"String","id":"String","eventId":"String"}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}