Report Filing Service
| POST | /async/webhooks/subscriptions/{Id}/update |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
/**
* Represents a request to update a webhook subscription specified by its unique identifier in an asynchronous operation.
*/
@Api(Description="Represents a request to update a webhook subscription specified by its unique identifier in an asynchronous operation.")
public static class UpdateWebhookSubscriptionAsync extends UpdateWebhookSubscriptionBase
{
}
/**
* 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.")
public static class UpdateWebhookSubscriptionBase implements IPost, IConfigurable
{
/**
* The unique identifier of the subscriber.
*/
@ApiMember(Description="The unique identifier of the subscriber.", IsRequired=true, Name="Id")
public String id = null;
/**
* The name of the subscription.
*/
@ApiMember(Description="The name of the subscription.", Name="Name")
public String name = null;
/**
* The name of the subscribed event.
*/
@ApiMember(Description="The name of the subscribed event.", Name="Event")
public String event = null;
/**
* 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")
public String url = null;
/**
* 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")
public String contentType = null;
/**
* 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")
public String currentSecret = null;
/**
* 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")
public String newSecret = null;
/**
* Indicates whether the subscription is enabled or disabled.
*/
@ApiMember(Description="Indicates whether the subscription is enabled or disabled.", Name="IsActive")
public Boolean isActive = null;
/**
* 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")
public String publicKeyXml = null;
public String getId() { return id; }
public UpdateWebhookSubscriptionBase setId(String value) { this.id = value; return this; }
public String getName() { return name; }
public UpdateWebhookSubscriptionBase setName(String value) { this.name = value; return this; }
public String getEvent() { return event; }
public UpdateWebhookSubscriptionBase setEvent(String value) { this.event = value; return this; }
public String getUrl() { return url; }
public UpdateWebhookSubscriptionBase setUrl(String value) { this.url = value; return this; }
public String getContentType() { return contentType; }
public UpdateWebhookSubscriptionBase setContentType(String value) { this.contentType = value; return this; }
public String getCurrentSecret() { return currentSecret; }
public UpdateWebhookSubscriptionBase setCurrentSecret(String value) { this.currentSecret = value; return this; }
public String getNewSecret() { return newSecret; }
public UpdateWebhookSubscriptionBase setNewSecret(String value) { this.newSecret = value; return this; }
public Boolean getIsActive() { return isActive; }
public UpdateWebhookSubscriptionBase setIsActive(Boolean value) { this.isActive = value; return this; }
public String getPublicKeyXml() { return publicKeyXml; }
public UpdateWebhookSubscriptionBase setPublicKeyXml(String value) { this.publicKeyXml = value; return this; }
}
/**
* Represents a service response that encapsulates a webhook subscription.
*/
@Api(Description="Represents a service response that encapsulates a webhook subscription.")
public static class SubscriptionResponse
{
/**
* 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 WebhookSubscription subscription = null;
/**
* The history of the subscription event.
*/
@ApiMember(Description="The history of the subscription event.", Name="History")
public ArrayList<SubscriptionDeliveryResult> history = null;
/**
* The status of the response.
*/
@ApiMember(Description="The status of the response.", Name="ResponseStatus")
public ResponseStatus responseStatus = null;
public WebhookSubscription getSubscription() { return subscription; }
public SubscriptionResponse setSubscription(WebhookSubscription value) { this.subscription = value; return this; }
public ArrayList<SubscriptionDeliveryResult> getHistory() { return history; }
public SubscriptionResponse setHistory(ArrayList<SubscriptionDeliveryResult> value) { this.history = value; return this; }
public ResponseStatus getResponseStatus() { return responseStatus; }
public SubscriptionResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
}
public static class WebhookSubscription
{
public String id = null;
public String name = null;
public String event = null;
public Boolean isActive = null;
public Date createdDateUtc = null;
public String createdById = null;
public Date lastModifiedDateUtc = null;
public SubscriptionConfig config = null;
public String getId() { return id; }
public WebhookSubscription setId(String value) { this.id = value; return this; }
public String getName() { return name; }
public WebhookSubscription setName(String value) { this.name = value; return this; }
public String getEvent() { return event; }
public WebhookSubscription setEvent(String value) { this.event = value; return this; }
public Boolean getIsActive() { return isActive; }
public WebhookSubscription setIsActive(Boolean value) { this.isActive = value; return this; }
public Date getCreatedDateUtc() { return createdDateUtc; }
public WebhookSubscription setCreatedDateUtc(Date value) { this.createdDateUtc = value; return this; }
public String getCreatedById() { return createdById; }
public WebhookSubscription setCreatedById(String value) { this.createdById = value; return this; }
public Date getLastModifiedDateUtc() { return lastModifiedDateUtc; }
public WebhookSubscription setLastModifiedDateUtc(Date value) { this.lastModifiedDateUtc = value; return this; }
public SubscriptionConfig getConfig() { return config; }
public WebhookSubscription setConfig(SubscriptionConfig value) { this.config = value; return this; }
}
public static class SubscriptionConfig
{
public String url = null;
public String contentType = null;
public String secret = null;
public String getUrl() { return url; }
public SubscriptionConfig setUrl(String value) { this.url = value; return this; }
public String getContentType() { return contentType; }
public SubscriptionConfig setContentType(String value) { this.contentType = value; return this; }
public String getSecret() { return secret; }
public SubscriptionConfig setSecret(String value) { this.secret = value; return this; }
}
public static class SubscriptionDeliveryResult
{
public Date attemptedDateUtc = null;
public String statusDescription = null;
public HttpStatusCode statusCode = null;
public String subscriptionId = null;
public String id = null;
public String eventId = null;
public Date getAttemptedDateUtc() { return attemptedDateUtc; }
public SubscriptionDeliveryResult setAttemptedDateUtc(Date value) { this.attemptedDateUtc = value; return this; }
public String getStatusDescription() { return statusDescription; }
public SubscriptionDeliveryResult setStatusDescription(String value) { this.statusDescription = value; return this; }
public HttpStatusCode getStatusCode() { return statusCode; }
public SubscriptionDeliveryResult setStatusCode(HttpStatusCode value) { this.statusCode = value; return this; }
public String getSubscriptionId() { return subscriptionId; }
public SubscriptionDeliveryResult setSubscriptionId(String value) { this.subscriptionId = value; return this; }
public String getId() { return id; }
public SubscriptionDeliveryResult setId(String value) { this.id = value; return this; }
public String getEventId() { return eventId; }
public SubscriptionDeliveryResult setEventId(String value) { this.eventId = value; return this; }
}
}
Java UpdateWebhookSubscriptionAsync 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 /async/webhooks/subscriptions/{Id}/update HTTP/1.1
Host: reportfiling.staging.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
}
}
}