Class PaginatedInKindDonationClient

Namespace

Crews.PlanningCenter.Api.Giving.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with InKindDonation collection resources.

public class PaginatedInKindDonationClient : PaginatedResourceClient<InKindDonation, InKindDonationResource, InKindDonationCollectionResponse, InKindDonationResponse>

Inheritance

object

ResourceClient<InKindDonation>

PaginatedResourceClient<InKindDonation, InKindDonationResource, InKindDonationCollectionResponse, InKindDonationResponse>

PaginatedInKindDonationClient

Inherited Members

PaginatedResourceClient<InKindDonation, InKindDonationResource, InKindDonationCollectionResponse, InKindDonationResponse>.PerPage(int)

PaginatedResourceClient<InKindDonation, InKindDonationResource, InKindDonationCollectionResponse, InKindDonationResponse>.Offset(int)

PaginatedResourceClient<InKindDonation, InKindDonationResource, InKindDonationCollectionResponse, InKindDonationResponse>.Filter(string)

PaginatedResourceClient<InKindDonation, InKindDonationResource, InKindDonationCollectionResponse, InKindDonationResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<InKindDonation, InKindDonationResource, InKindDonationCollectionResponse, InKindDonationResponse>.PostAsync(InKindDonation, CancellationToken)

PaginatedResourceClient<InKindDonation, InKindDonationResource, InKindDonationCollectionResponse, InKindDonationResponse>.PostAsync(JsonApiDocument<InKindDonationResource>, CancellationToken)

ResourceClient<InKindDonation>.AddQueryParameter(string, string)

ResourceClient<InKindDonation>.ReplaceQueryParameter(string, string)

ResourceClient<InKindDonation>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<InKindDonation>.Uri

ResourceClient<InKindDonation>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedInKindDonationClient(HttpClient, Uri)

Client for interacting with InKindDonation collection resources.

public PaginatedInKindDonationClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedInKindDonationClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedInKindDonationClient

The current PaginatedInKindDonationClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedInKindDonationClient ClearParameters()

Returns

PaginatedInKindDonationClient

The current PaginatedInKindDonationClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedInKindDonationClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedInKindDonationClient

The current PaginatedInKindDonationClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of InKindDonation resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<InKindDonationCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeCampus()

Include related Campus resources in the response.

public InKindDonationClient IncludeCampus()

Returns

InKindDonationClient

IncludeFund()

Include related Fund resources in the response.

public InKindDonationClient IncludeFund()

Returns

InKindDonationClient

IncludePerson()

Include related Person resources in the response.

public InKindDonationClient IncludePerson()

Returns

InKindDonationClient

Offset(int)

Sets the item offset in the paginated response.

public PaginatedInKindDonationClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedInKindDonationClient

The current PaginatedInKindDonationClient instance.

OrderByCreatedAt()

Sort response items by the CreatedAt attribute.

public InKindDonationClient OrderByCreatedAt()

Returns

InKindDonationClient

OrderByCreatedAtDescending()

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

public InKindDonationClient OrderByCreatedAtDescending()

Returns

InKindDonationClient

OrderByReceivedOn()

Sort response items by the ReceivedOn attribute.

public InKindDonationClient OrderByReceivedOn()

Returns

InKindDonationClient

OrderByReceivedOnDescending()

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

public InKindDonationClient OrderByReceivedOnDescending()

Returns

InKindDonationClient

OrderByUpdatedAt()

Sort response items by the UpdatedAt attribute.

public InKindDonationClient OrderByUpdatedAt()

Returns

InKindDonationClient

OrderByUpdatedAtDescending()

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

public InKindDonationClient OrderByUpdatedAtDescending()

Returns

InKindDonationClient

PerPage(int)

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

public PaginatedInKindDonationClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedInKindDonationClient

The current PaginatedInKindDonationClient instance.

PostAsync(InKindDonation, CancellationToken)

Creates a new InKindDonation resource asynchronously.

public Task<InKindDonationResponse> PostAsync(InKindDonation resource, CancellationToken cancellationToken = default)

Parameters

resource InKindDonation

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<InKindDonationResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<InKindDonationResource>, CancellationToken)

Creates a new InKindDonation resource asynchronously.

public Task<InKindDonationResponse> PostAsync(JsonApiDocument<InKindDonationResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<InKindDonationResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<InKindDonationResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WhereCampusId(int)

Query response items by the CampusId attribute.

public InKindDonationClient WhereCampusId(int value)

Parameters

value int

Returns

InKindDonationClient

WhereCreatedAt(DateTime)

Query response items by the CreatedAt attribute.

public InKindDonationClient WhereCreatedAt(DateTime value)

Parameters

value DateTime

Returns

InKindDonationClient

WhereFundId(int)

Query response items by the FundId attribute.

public InKindDonationClient WhereFundId(int value)

Parameters

value int

Returns

InKindDonationClient

WhereReceivedOn(DateOnly)

Query response items by the ReceivedOn attribute.

public InKindDonationClient WhereReceivedOn(DateOnly value)

Parameters

value DateOnly

Returns

InKindDonationClient

WhereUpdatedAt(DateTime)

Query response items by the UpdatedAt attribute.

public InKindDonationClient WhereUpdatedAt(DateTime value)

Parameters

value DateTime

Returns

InKindDonationClient

WithId(string)

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

public InKindDonationClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

InKindDonationClient

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