Class PaginatedSubscriptionClient

Namespace

Crews.PlanningCenter.Api.Webhooks.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Subscription collection resources.

[Obsolete("This resource is deprecated and may be removed in a future version.")]
public class PaginatedSubscriptionClient : PaginatedResourceClient<Subscription, SubscriptionResource, SubscriptionCollectionResponse, SubscriptionResponse>

Inheritance

object

ResourceClient<Subscription>

PaginatedResourceClient<Subscription, SubscriptionResource, SubscriptionCollectionResponse, SubscriptionResponse>

PaginatedSubscriptionClient

Inherited Members

PaginatedResourceClient<Subscription, SubscriptionResource, SubscriptionCollectionResponse, SubscriptionResponse>.PerPage(int)

PaginatedResourceClient<Subscription, SubscriptionResource, SubscriptionCollectionResponse, SubscriptionResponse>.Offset(int)

PaginatedResourceClient<Subscription, SubscriptionResource, SubscriptionCollectionResponse, SubscriptionResponse>.Filter(string)

PaginatedResourceClient<Subscription, SubscriptionResource, SubscriptionCollectionResponse, SubscriptionResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Subscription, SubscriptionResource, SubscriptionCollectionResponse, SubscriptionResponse>.PostAsync(Subscription, CancellationToken)

PaginatedResourceClient<Subscription, SubscriptionResource, SubscriptionCollectionResponse, SubscriptionResponse>.PostAsync(JsonApiDocument<SubscriptionResource>, CancellationToken)

ResourceClient<Subscription>.AddQueryParameter(string, string)

ResourceClient<Subscription>.ReplaceQueryParameter(string, string)

ResourceClient<Subscription>.AddCustomParameter(string, string)

ResourceClient<Subscription>.ClearParameters()

ResourceClient<Subscription>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Subscription>.Uri

ResourceClient<Subscription>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedSubscriptionClient(HttpClient, Uri)

Client for interacting with Subscription collection resources.

public PaginatedSubscriptionClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of Subscription resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SubscriptionCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(Subscription, CancellationToken)

Creates a new Subscription resource asynchronously.

public Task<SubscriptionResponse> PostAsync(Subscription resource, CancellationToken cancellationToken = default)

Parameters

resource Subscription

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SubscriptionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<SubscriptionResource>, CancellationToken)

Creates a new Subscription resource asynchronously.

public Task<SubscriptionResponse> PostAsync(JsonApiDocument<SubscriptionResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<SubscriptionResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SubscriptionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WhereApplicationId(string)

Query response items by the ApplicationId attribute.

public SubscriptionClient WhereApplicationId(string value)

Parameters

value string

Returns

SubscriptionClient

WithId(string)

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

public SubscriptionClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

SubscriptionClient

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