Class PaginatedDonorSummaryClient

Namespace

Crews.PlanningCenter.Api.Giving.V2019_10_18

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with DonorSummary collection resources.

public class PaginatedDonorSummaryClient : PaginatedResourceClient<DonorSummary, DonorSummaryResource, DonorSummaryCollectionResponse, DonorSummaryResponse>

Inheritance

object

ResourceClient<DonorSummary>

PaginatedResourceClient<DonorSummary, DonorSummaryResource, DonorSummaryCollectionResponse, DonorSummaryResponse>

PaginatedDonorSummaryClient

Inherited Members

PaginatedResourceClient<DonorSummary, DonorSummaryResource, DonorSummaryCollectionResponse, DonorSummaryResponse>.PerPage(int)

PaginatedResourceClient<DonorSummary, DonorSummaryResource, DonorSummaryCollectionResponse, DonorSummaryResponse>.Offset(int)

PaginatedResourceClient<DonorSummary, DonorSummaryResource, DonorSummaryCollectionResponse, DonorSummaryResponse>.Filter(string)

PaginatedResourceClient<DonorSummary, DonorSummaryResource, DonorSummaryCollectionResponse, DonorSummaryResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<DonorSummary, DonorSummaryResource, DonorSummaryCollectionResponse, DonorSummaryResponse>.PostAsync(DonorSummary, CancellationToken)

PaginatedResourceClient<DonorSummary, DonorSummaryResource, DonorSummaryCollectionResponse, DonorSummaryResponse>.PostAsync(JsonApiDocument<DonorSummaryResource>, CancellationToken)

ResourceClient<DonorSummary>.AddQueryParameter(string, string)

ResourceClient<DonorSummary>.ReplaceQueryParameter(string, string)

ResourceClient<DonorSummary>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<DonorSummary>.Uri

ResourceClient<DonorSummary>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedDonorSummaryClient(HttpClient, Uri)

Client for interacting with DonorSummary collection resources.

public PaginatedDonorSummaryClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedDonorSummaryClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedDonorSummaryClient

The current PaginatedDonorSummaryClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedDonorSummaryClient ClearParameters()

Returns

PaginatedDonorSummaryClient

The current PaginatedDonorSummaryClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedDonorSummaryClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedDonorSummaryClient

The current PaginatedDonorSummaryClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of DonorSummary resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<DonorSummaryCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeJointGiver()

Include related JointGiver resources in the response.

public DonorSummaryClient IncludeJointGiver()

Returns

DonorSummaryClient

Offset(int)

Sets the item offset in the paginated response.

public PaginatedDonorSummaryClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedDonorSummaryClient

The current PaginatedDonorSummaryClient instance.

OrderByDonationCount()

Sort response items by the DonationCount attribute.

public DonorSummaryClient OrderByDonationCount()

Returns

DonorSummaryClient

OrderByDonationCountDescending()

Sort response items by the DonationCount attribute. Use reverse order.

public DonorSummaryClient OrderByDonationCountDescending()

Returns

DonorSummaryClient

OrderByFirstDonated()

Sort response items by the FirstDonated attribute.

public DonorSummaryClient OrderByFirstDonated()

Returns

DonorSummaryClient

OrderByFirstDonatedDescending()

Sort response items by the FirstDonated attribute. Use reverse order.

public DonorSummaryClient OrderByFirstDonatedDescending()

Returns

DonorSummaryClient

OrderByName()

Sort response items by the Name attribute.

public DonorSummaryClient OrderByName()

Returns

DonorSummaryClient

OrderByNameDescending()

Sort response items by the Name attribute. Use reverse order.

public DonorSummaryClient OrderByNameDescending()

Returns

DonorSummaryClient

OrderByTotalReceivedDonationAmountCents()

Sort response items by the TotalReceivedDonationAmountCents attribute.

public DonorSummaryClient OrderByTotalReceivedDonationAmountCents()

Returns

DonorSummaryClient

OrderByTotalReceivedDonationAmountCentsDescending()

Sort response items by the TotalReceivedDonationAmountCents attribute. Use reverse order.

public DonorSummaryClient OrderByTotalReceivedDonationAmountCentsDescending()

Returns

DonorSummaryClient

PerPage(int)

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

public PaginatedDonorSummaryClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedDonorSummaryClient

The current PaginatedDonorSummaryClient instance.

WhereCampusId(string)

Query response items by the CampusId attribute.

public DonorSummaryClient WhereCampusId(string value)

Parameters

value string

Returns

DonorSummaryClient

WherePersonId(string)

Query response items by the PersonId attribute.

public DonorSummaryClient WherePersonId(string value)

Parameters

value string

Returns

DonorSummaryClient

WhereReceivedAt(DateTime)

Query response items by the ReceivedAt attribute.

public DonorSummaryClient WhereReceivedAt(DateTime value)

Parameters

value DateTime

Returns

DonorSummaryClient