Report Filing Service
| POST | /sync/webhooks/subscriptions/{Id}/update |
|---|
namespace PwC.Elmaas.Core.Services.Contracts.Webhooks.Requests
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type SubscriptionConfig() =
member val Url:String = null with get,set
member val ContentType:String = null with get,set
member val Secret:String = null with get,set
[<AllowNullLiteral>]
type WebhookSubscription() =
member val Id:String = null with get,set
member val Name:String = null with get,set
member val Event:String = null with get,set
member val IsActive:Boolean = new Boolean() with get,set
member val CreatedDateUtc:DateTime = new DateTime() with get,set
member val CreatedById:String = null with get,set
member val LastModifiedDateUtc:DateTime = new DateTime() with get,set
member val Config:SubscriptionConfig = null with get,set
[<AllowNullLiteral>]
type SubscriptionDeliveryResult() =
member val AttemptedDateUtc:DateTime = new DateTime() with get,set
member val StatusDescription:String = null with get,set
member val StatusCode:HttpStatusCode = new HttpStatusCode() with get,set
member val SubscriptionId:String = null with get,set
member val Id:String = null with get,set
member val EventId:String = null with get,set
///<summary>
///Represents a service response that encapsulates a webhook subscription.
///</summary>
[<Api(Description="Represents a service response that encapsulates a webhook subscription.")>]
[<AllowNullLiteral>]
type SubscriptionResponse() =
///<summary>
///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.
///</summary>
[<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")>]
member val Subscription:WebhookSubscription = null with get,set
///<summary>
///The history of the subscription event.
///</summary>
[<ApiMember(Description="The history of the subscription event.", Name="History")>]
member val History:ResizeArray<SubscriptionDeliveryResult> = new ResizeArray<SubscriptionDeliveryResult>() with get,set
///<summary>
///The status of the response.
///</summary>
[<ApiMember(Description="The status of the response.", Name="ResponseStatus")>]
member val ResponseStatus:ResponseStatus = null with get,set
///<summary>
///Specifies a request to update a webhook subscription specified by its unique identifier.
///</summary>
[<Api(Description="Specifies a request to update a webhook subscription specified by its unique identifier.")>]
[<AllowNullLiteral>]
type UpdateWebhookSubscriptionBase() =
interface IPost
///<summary>
///The unique identifier of the subscriber.
///</summary>
[<ApiMember(Description="The unique identifier of the subscriber.", IsRequired=true, Name="Id")>]
member val Id:String = null with get,set
///<summary>
///The name of the subscription.
///</summary>
[<ApiMember(Description="The name of the subscription.", Name="Name")>]
member val Name:String = null with get,set
///<summary>
///The name of the subscribed event.
///</summary>
[<ApiMember(Description="The name of the subscribed event.", Name="Event")>]
member val Event:String = null with get,set
///<summary>
///The callback URL to be called when an "event" of a certain type is going to be raised.
///</summary>
[<ApiMember(Description="The callback URL to be called when an \"event\" of a certain type is going to be raised.", Name="Url")>]
member val Url:String = null with get,set
///<summary>
///The MIME type of content pushed to the recipient service e.g. application/json
///</summary>
[<ApiMember(Description="The MIME type of content pushed to the recipient service e.g. application/json", Name="ContentType")>]
member val ContentType:String = null with get,set
///<summary>
///The current secret that is used to sign and authenticate messages from webhook endpoints.
///</summary>
[<ApiMember(Description="The current secret that is used to sign and authenticate messages from webhook endpoints.", IsRequired=true, Name="CurrentSecret")>]
member val CurrentSecret:String = null with get,set
///<summary>
///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.
///</summary>
[<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")>]
member val NewSecret:String = null with get,set
///<summary>
///Indicates whether the subscription is enabled or disabled.
///</summary>
[<ApiMember(Description="Indicates whether the subscription is enabled or disabled.", Name="IsActive")>]
member val IsActive:Nullable<Boolean> = new Nullable<Boolean>() with get,set
///<summary>
///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.
///</summary>
[<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")>]
member val PublicKeyXml:String = null with get,set
///<summary>
///Represents a request to update a webhook subscription specified by its unique identifier.
///</summary>
[<Api(Description="Represents a request to update a webhook subscription specified by its unique identifier.")>]
[<AllowNullLiteral>]
type UpdateWebhookSubscription() =
inherit UpdateWebhookSubscriptionBase()
F# UpdateWebhookSubscription DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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.pwc.de
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
id: String,
name: String,
event: String,
url: String,
contentType: String,
currentSecret: String,
newSecret: String,
isActive: False,
publicKeyXml: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
subscription:
{
id: String,
name: String,
event: String,
isActive: False,
createdDateUtc: 0001-01-01,
createdById: String,
lastModifiedDateUtc: 0001-01-01,
config:
{
url: String,
contentType: String,
secret: String
}
},
history:
[
{
attemptedDateUtc: 0001-01-01,
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
}
}
}