/* Options:
Date: 2024-11-26 02:04:53
Version: 6.110
Tip: To override a DTO option, remove "//" prefix before updating
BaseUrl: https://reportfiling.pwc.de
//GlobalNamespace:
//MakePartial: True
//MakeVirtual: True
//MakeInternal: False
//MakeDataContractsExtensible: False
//AddNullableAnnotations: False
//AddReturnMarker: True
//AddDescriptionAsComments: True
//AddDataContractAttributes: False
//AddIndexesToDataMembers: False
//AddGeneratedCodeAttributes: False
//AddResponseStatus: False
//AddImplicitVersion:
//InitializeCollections: True
//ExportValueTypes: False
IncludeTypes: UpdateWebhookSubscription.*
//ExcludeTypes:
//AddNamespaces:
//AddDefaultXmlNamespace: http://schemas.servicestack.net/types
*/
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using System.Xml.Schema;
using System.Net;
using ServiceStack.Webhooks.ServiceModel.Types;
using PwC.Elmaas.Core.Services.Contracts.Webhooks.Requests;
using PwC.Elmaas.Core.Services.Contracts.Webhooks.Responses;
namespace PwC.Elmaas.Core.Services.Contracts.Webhooks.Requests
{
public partial interface IConfigurable
{
string Url { get; set; }
string ContentType { get; set; }
}
///
///Represents a request to update a webhook subscription specified by its unique identifier.
///
[Route("/sync/webhooks/subscriptions/{Id}/update", "POST")]
[Api(Description="Represents a request to update a webhook subscription specified by its unique identifier.")]
public partial class UpdateWebhookSubscription
: UpdateWebhookSubscriptionBase, IReturn
{
}
///
///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 partial class UpdateWebhookSubscriptionBase
: IPost, IConfigurable
{
///
///The unique identifier of the subscriber.
///
[ApiMember(Description="The unique identifier of the subscriber.", IsRequired=true, Name="Id")]
public virtual string Id { get; set; }
///
///The name of the subscription.
///
[ApiMember(Description="The name of the subscription.", Name="Name")]
public virtual string Name { get; set; }
///
///The name of the subscribed event.
///
[ApiMember(Description="The name of the subscribed event.", Name="Event")]
public virtual string Event { get; set; }
///
///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 virtual string Url { get; set; }
///
///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 virtual string ContentType { get; set; }
///
///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 virtual string CurrentSecret { get; set; }
///
///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 virtual string NewSecret { get; set; }
///
///Indicates whether the subscription is enabled or disabled.
///
[ApiMember(Description="Indicates whether the subscription is enabled or disabled.", Name="IsActive")]
public virtual bool? IsActive { get; set; }
///
///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 virtual string PublicKeyXml { get; set; }
}
}
namespace PwC.Elmaas.Core.Services.Contracts.Webhooks.Responses
{
///
///Represents a service response that encapsulates a webhook subscription.
///
[Api(Description="Represents a service response that encapsulates a webhook subscription.")]
public partial class SubscriptionResponse
{
public SubscriptionResponse()
{
History = new List{};
}
///
///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 virtual WebhookSubscription Subscription { get; set; }
///
///The history of the subscription event.
///
[ApiMember(Description="The history of the subscription event.", Name="History")]
public virtual List History { get; set; }
///
///The status of the response.
///
[ApiMember(Description="The status of the response.", Name="ResponseStatus")]
public virtual ResponseStatus ResponseStatus { get; set; }
}
}
namespace ServiceStack.Webhooks.ServiceModel.Types
{
public partial class SubscriptionConfig
{
public virtual string Url { get; set; }
public virtual string ContentType { get; set; }
public virtual string Secret { get; set; }
}
public partial class SubscriptionDeliveryResult
{
public virtual DateTime AttemptedDateUtc { get; set; }
public virtual string StatusDescription { get; set; }
public virtual HttpStatusCode StatusCode { get; set; }
public virtual string SubscriptionId { get; set; }
public virtual string Id { get; set; }
public virtual string EventId { get; set; }
}
public partial class WebhookSubscription
{
public virtual string Id { get; set; }
public virtual string Name { get; set; }
public virtual string Event { get; set; }
public virtual bool IsActive { get; set; }
public virtual DateTime CreatedDateUtc { get; set; }
public virtual string CreatedById { get; set; }
public virtual DateTime LastModifiedDateUtc { get; set; }
public virtual SubscriptionConfig Config { get; set; }
}
}