ISubscriptionsService.Subscriptions

Collection of functions to interact with the Subscriptions API endpoint.

All URI’s are relative to the VTN URL configured.

Method	HTTP request	Description
CreateSubscriptionAsync	POST /subscriptions	Create subscription
DeleteSubscriptionAsync	DELETE /subscriptions/{subscriptionID}	Delete subscription
SearchSubscriptionsAsync	GET /subscriptions	Searches all subscriptions
FindSubscriptionByIdAsync	GET /subscriptions/{subscriptionID}	Searches subscriptions by subscription ID
UpdateSubscriptionAsync	PUT /subscriptions/{subscriptionID}	Update subscription

CreateSubscriptionAsync

Task<Subscription> CreateSubscriptionAsync(
    Subscription subscription,
    RequestOptions? options = default,
    CancellationToken cancellationToken = default)

Create a new subscription in the server.

DeleteSubscriptionAsync

Task<Subscription> DeleteSubscriptionAsync(
    string subscriptionId,
    RequestOptions? options = default,
    CancellationToken cancellationToken = default)

Delete an existing subscription with the subscription ID.

SearchSubscriptionsAsync

Task<List<Subscription>> SearchSubscriptionsAsync(
    string? programId = default,
    string? clientName = default,
    string? targetType = default,
    List<string>? targetValues = default,
    List<ObjectType>? objects = default,
    int? skip = default,
    int? limit = default,
    RequestOptions? options = default,
    CancellationToken cancellationToken = default)

Searches all subscriptions known to the server. Use skip and pagination query params to limit response size.

FindSubscriptionByIdAsync

Task<Subscription> FindSubscriptionByIdAsync(
    string subscriptionId,
    RequestOptions? options = default,
    CancellationToken cancellationToken = default)

Find subscription associated by the subscription ID.

UpdateSubscriptionAsync

Task<Subscription> UpdateSubscriptionAsync(
    string subscriptionId,
    Subscription? subscription,
    RequestOptions? options = default,
    CancellationToken cancellationToken = default)

Update an existing subscription with specified subscription ID.