Class PaginatedWebhookSubscriptionClient

Namespace

Crews.PlanningCenter.Api.Webhooks.V2022_10_20

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with WebhookSubscription collection resources.

public class PaginatedWebhookSubscriptionClient : PaginatedResourceClient<WebhookSubscription, WebhookSubscriptionResource, WebhookSubscriptionCollectionResponse, WebhookSubscriptionResponse>

Inheritance

object

ResourceClient<WebhookSubscription>

PaginatedResourceClient<WebhookSubscription, WebhookSubscriptionResource, WebhookSubscriptionCollectionResponse, WebhookSubscriptionResponse>

PaginatedWebhookSubscriptionClient

Inherited Members

PaginatedResourceClient<WebhookSubscription, WebhookSubscriptionResource, WebhookSubscriptionCollectionResponse, WebhookSubscriptionResponse>.PerPage(int)

PaginatedResourceClient<WebhookSubscription, WebhookSubscriptionResource, WebhookSubscriptionCollectionResponse, WebhookSubscriptionResponse>.Offset(int)

PaginatedResourceClient<WebhookSubscription, WebhookSubscriptionResource, WebhookSubscriptionCollectionResponse, WebhookSubscriptionResponse>.Filter(string)

PaginatedResourceClient<WebhookSubscription, WebhookSubscriptionResource, WebhookSubscriptionCollectionResponse, WebhookSubscriptionResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<WebhookSubscription, WebhookSubscriptionResource, WebhookSubscriptionCollectionResponse, WebhookSubscriptionResponse>.PostAsync(WebhookSubscription, CancellationToken)

PaginatedResourceClient<WebhookSubscription, WebhookSubscriptionResource, WebhookSubscriptionCollectionResponse, WebhookSubscriptionResponse>.PostAsync(JsonApiDocument<WebhookSubscriptionResource>, CancellationToken)

ResourceClient<WebhookSubscription>.AddQueryParameter(string, string)

ResourceClient<WebhookSubscription>.ReplaceQueryParameter(string, string)

ResourceClient<WebhookSubscription>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<WebhookSubscription>.Uri

ResourceClient<WebhookSubscription>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedWebhookSubscriptionClient(HttpClient, Uri)

Client for interacting with WebhookSubscription collection resources.

public PaginatedWebhookSubscriptionClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedWebhookSubscriptionClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedWebhookSubscriptionClient

The current PaginatedWebhookSubscriptionClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedWebhookSubscriptionClient ClearParameters()

Returns

PaginatedWebhookSubscriptionClient

The current PaginatedWebhookSubscriptionClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedWebhookSubscriptionClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedWebhookSubscriptionClient

The current PaginatedWebhookSubscriptionClient instance.

Remarks

See Planning Center API documentation for details on supported filter values for this resource.

GetAsync(CancellationToken)

Fetches a paginated list of WebhookSubscription resources asynchronously.

public Task<WebhookSubscriptionCollectionResponse> GetAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<WebhookSubscriptionCollectionResponse>

A task representing the asynchronous operation, containing a paginated list of WebhookSubscription resources.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedWebhookSubscriptionClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedWebhookSubscriptionClient

The current PaginatedWebhookSubscriptionClient instance.

PerPage(int)

Sets the number of items to be returned per page in the paginated response.

public PaginatedWebhookSubscriptionClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedWebhookSubscriptionClient

The current PaginatedWebhookSubscriptionClient instance.

PostAsync(WebhookSubscription, CancellationToken)

Creates a new WebhookSubscription resource asynchronously.

public Task<WebhookSubscriptionResponse> PostAsync(WebhookSubscription resource, CancellationToken cancellationToken = default)

Parameters

resource WebhookSubscription

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<WebhookSubscriptionResponse>

A task representing the asynchronous operation, containing the created WebhookSubscription resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<WebhookSubscriptionResource>, CancellationToken)

Creates a new WebhookSubscription resource asynchronously.

public Task<WebhookSubscriptionResponse> PostAsync(JsonApiDocument<WebhookSubscriptionResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<WebhookSubscriptionResource>

The JSON:API document to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<WebhookSubscriptionResponse>

A task representing the asynchronous operation, containing the created WebhookSubscription resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WhereApplicationId(string)

Query response items by the ApplicationId attribute.

public WebhookSubscriptionClient WhereApplicationId(string value)

Parameters

value string

Returns

WebhookSubscriptionClient

WithId(string)

Creates a new instance of a WebhookSubscription client for a specific resource ID.

public WebhookSubscriptionClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

WebhookSubscriptionClient

A new instance of the resource client for the specified resource ID.