Class PersonClient

Namespace

Crews.PlanningCenter.Api.Giving.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Person resource.

public class PersonClient : SingletonResourceClient<Person, PersonResource, PersonResponse>

Inheritance

object

ResourceClient<Person>

SingletonResourceClient<Person, PersonResource, PersonResponse>

PersonClient

Inherited Members

SingletonResourceClient<Person, PersonResource, PersonResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Person, PersonResource, PersonResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Person, PersonResource, PersonResponse>.PatchAsync(Person, CancellationToken)

SingletonResourceClient<Person, PersonResource, PersonResponse>.PatchAsync(JsonApiDocument<PersonResource>, CancellationToken)

SingletonResourceClient<Person, PersonResource, PersonResponse>.DeleteAsync(CancellationToken)

ResourceClient<Person>.AddQueryParameter(string, string)

ResourceClient<Person>.ReplaceQueryParameter(string, string)

ResourceClient<Person>.AddCustomParameter(string, string)

ResourceClient<Person>.ClearParameters()

ResourceClient<Person>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Person>.Uri

ResourceClient<Person>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PersonClient(HttpClient, Uri)

Client for interacting with the Person resource.

public PersonClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

BatchGroups

Associated BatchGroups.

public PaginatedBatchGroupClient BatchGroups { get; }

Property Value

PaginatedBatchGroupClient

Batches

Associated Batches.

public PaginatedBatchClient Batches { get; }

Property Value

PaginatedBatchClient

Donations

Associated Donations.

public PaginatedDonationClient Donations { get; }

Property Value

PaginatedDonationClient

InKindDonations

Associated InKindDonations.

public PaginatedInKindDonationClient InKindDonations { get; }

Property Value

PaginatedInKindDonationClient

PaymentMethods

Associated PaymentMethods.

public PaginatedPaymentMethodClient PaymentMethods { get; }

Property Value

PaginatedPaymentMethodClient

PrimaryCampus

Associated PrimaryCampus.

public PaginatedCampusClient PrimaryCampus { get; }

Property Value

PaginatedCampusClient

RecurringDonations

Associated RecurringDonations.

public PaginatedRecurringDonationClient RecurringDonations { get; }

Property Value

PaginatedRecurringDonationClient

Methods

GetAsync(CancellationToken)

Fetches the Person resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PersonResponse>

A task representing the asynchronous operation, containing the Person resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(Person, CancellationToken)

Updates an existing Person resource asynchronously.

public Task<PersonResponse> PatchAsync(Person resource, CancellationToken cancellationToken = default)

Parameters

resource Person

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PersonResponse>

A task representing the asynchronous operation, containing the updated Person resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<PersonResource>, CancellationToken)

Updates an existing Person resource asynchronously.

public Task<PersonResponse> PatchAsync(JsonApiDocument<PersonResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<PersonResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PersonResponse>

A task representing the asynchronous operation, containing the updated Person resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.