Report Filing Service
| POST | /sync/webhooks/subscriptions/{Id}/update |
|---|
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';
/**
* Specifies a request to update a webhook subscription specified by its unique identifier.
*/
// @Api(Description="Specifies a request to update a webhook subscription specified by its unique identifier.")
abstract class UpdateWebhookSubscriptionBase implements IPost, IConfigurable
{
/**
* The unique identifier of the subscriber.
*/
// @ApiMember(Description="The unique identifier of the subscriber.", IsRequired=true, Name="Id")
String? id;
/**
* The name of the subscription.
*/
// @ApiMember(Description="The name of the subscription.", Name="Name")
String? name;
/**
* The name of the subscribed event.
*/
// @ApiMember(Description="The name of the subscribed event.", Name="Event")
String? event;
/**
* The callback URL to be called when an "event" of a certain type is going to be raised.
*/
// @ApiMember(Description="The callback URL to be called when an \"event\" of a certain type is going to be raised.", Name="Url")
String? url;
/**
* The MIME type of content pushed to the recipient service e.g. application/json
*/
// @ApiMember(Description="The MIME type of content pushed to the recipient service e.g. application/json", Name="ContentType")
String? contentType;
/**
* The current secret that is used to sign and authenticate messages from webhook endpoints.
*/
// @ApiMember(Description="The current secret that is used to sign and authenticate messages from webhook endpoints.", IsRequired=true, Name="CurrentSecret")
String? currentSecret;
/**
* A random Base64-encoded secret key (8 or more characters) to sign and authenticate messages from webhook endpoints. .When receiving a webhook event in your subscribers service, calculate the HMAC signature of the request body using this secret. Compare the calculated signature with the signature included in the "X-Hub-Signature" header of the web hook event. If the signatures do not match, then disregard it, and don't process the request any further.
*/
// @ApiMember(Description="A random Base64-encoded secret key (8 or more characters) to sign and authenticate messages from webhook endpoints. .When receiving a webhook event in your subscribers service, calculate the HMAC signature of the request body using this secret. Compare the calculated signature with the signature included in the \"X-Hub-Signature\" header of the web hook event. If the signatures do not match, then disregard it, and don't process the request any further.", Name="NewSecret")
String? newSecret;
/**
* Indicates whether the subscription is enabled or disabled.
*/
// @ApiMember(Description="Indicates whether the subscription is enabled or disabled.", Name="IsActive")
bool? isActive;
/**
* The XML-encoded RSA public key to encrypt the new secret of the webhook subscription. Note: Only the owner of the key pair (public and private encryption keys) can decrypt the encrypted secret with the private key! Encryption algorithm: RSA with OAEP-SHA256 padding.
*/
// @ApiMember(Description="The XML-encoded RSA public key to encrypt the new secret of the webhook subscription. Note: Only the owner of the key pair (public and private encryption keys) can decrypt the encrypted secret with the private key! Encryption algorithm: RSA with OAEP-SHA256 padding.", IsRequired=true, Name="PublicKeyXml")
String? publicKeyXml;
UpdateWebhookSubscriptionBase({this.id,this.name,this.event,this.url,this.contentType,this.currentSecret,this.newSecret,this.isActive,this.publicKeyXml});
UpdateWebhookSubscriptionBase.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
id = json['id'];
name = json['name'];
event = json['event'];
url = json['url'];
contentType = json['contentType'];
currentSecret = json['currentSecret'];
newSecret = json['newSecret'];
isActive = json['isActive'];
publicKeyXml = json['publicKeyXml'];
return this;
}
Map<String, dynamic> toJson() => {
'id': id,
'name': name,
'event': event,
'url': url,
'contentType': contentType,
'currentSecret': currentSecret,
'newSecret': newSecret,
'isActive': isActive,
'publicKeyXml': publicKeyXml
};
getTypeName() => "UpdateWebhookSubscriptionBase";
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 update a webhook subscription specified by its unique identifier.
*/
// @Api(Description="Represents a request to update a webhook subscription specified by its unique identifier.")
class UpdateWebhookSubscription extends UpdateWebhookSubscriptionBase implements IConvertible
{
UpdateWebhookSubscription();
UpdateWebhookSubscription.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() => "UpdateWebhookSubscription";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'reportfiling.staging.pwc.de', types: <String, TypeInfo> {
'UpdateWebhookSubscriptionBase': 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>[]),
'UpdateWebhookSubscription': TypeInfo(TypeOf.Class, create:() => UpdateWebhookSubscription()),
});
Dart UpdateWebhookSubscription DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /sync/webhooks/subscriptions/{Id}/update HTTP/1.1
Host: reportfiling.staging.pwc.de
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<UpdateWebhookSubscription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Services.Contracts.Webhooks.Requests">
<ContentType>String</ContentType>
<CurrentSecret>String</CurrentSecret>
<Event>String</Event>
<Id>String</Id>
<IsActive>false</IsActive>
<Name>String</Name>
<NewSecret>String</NewSecret>
<PublicKeyXml>String</PublicKeyXml>
<Url>String</Url>
</UpdateWebhookSubscription>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<SubscriptionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Services.Contracts.Webhooks.Responses">
<History xmlns:d2p1="http://schemas.datacontract.org/2004/07/ServiceStack.Webhooks.ServiceModel.Types">
<d2p1:SubscriptionDeliveryResult>
<d2p1:AttemptedDateUtc>0001-01-01T00:00:00</d2p1:AttemptedDateUtc>
<d2p1:EventId>String</d2p1:EventId>
<d2p1:Id>String</d2p1:Id>
<d2p1:StatusCode>Continue</d2p1:StatusCode>
<d2p1:StatusDescription>String</d2p1:StatusDescription>
<d2p1:SubscriptionId>String</d2p1:SubscriptionId>
</d2p1:SubscriptionDeliveryResult>
</History>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<Subscription xmlns:d2p1="http://schemas.datacontract.org/2004/07/ServiceStack.Webhooks.ServiceModel.Types">
<d2p1:Config>
<d2p1:ContentType>String</d2p1:ContentType>
<d2p1:Secret>String</d2p1:Secret>
<d2p1:Url>String</d2p1:Url>
</d2p1:Config>
<d2p1:CreatedById>String</d2p1:CreatedById>
<d2p1:CreatedDateUtc>0001-01-01T00:00:00</d2p1:CreatedDateUtc>
<d2p1:Event>String</d2p1:Event>
<d2p1:Id>String</d2p1:Id>
<d2p1:IsActive>false</d2p1:IsActive>
<d2p1:LastModifiedDateUtc>0001-01-01T00:00:00</d2p1:LastModifiedDateUtc>
<d2p1:Name>String</d2p1:Name>
</Subscription>
</SubscriptionResponse>