Class PaginatedDesignationRefundClient

Namespace

Crews.PlanningCenter.Api.Giving.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with DesignationRefund collection resources.

public class PaginatedDesignationRefundClient : PaginatedResourceClient<DesignationRefund, DesignationRefundResource, DesignationRefundCollectionResponse, DesignationRefundResponse>

Inheritance

object

ResourceClient<DesignationRefund>

PaginatedResourceClient<DesignationRefund, DesignationRefundResource, DesignationRefundCollectionResponse, DesignationRefundResponse>

PaginatedDesignationRefundClient

Inherited Members

PaginatedResourceClient<DesignationRefund, DesignationRefundResource, DesignationRefundCollectionResponse, DesignationRefundResponse>.PerPage(int)

PaginatedResourceClient<DesignationRefund, DesignationRefundResource, DesignationRefundCollectionResponse, DesignationRefundResponse>.Offset(int)

PaginatedResourceClient<DesignationRefund, DesignationRefundResource, DesignationRefundCollectionResponse, DesignationRefundResponse>.Filter(string)

PaginatedResourceClient<DesignationRefund, DesignationRefundResource, DesignationRefundCollectionResponse, DesignationRefundResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<DesignationRefund, DesignationRefundResource, DesignationRefundCollectionResponse, DesignationRefundResponse>.PostAsync(DesignationRefund, CancellationToken)

PaginatedResourceClient<DesignationRefund, DesignationRefundResource, DesignationRefundCollectionResponse, DesignationRefundResponse>.PostAsync(JsonApiDocument<DesignationRefundResource>, CancellationToken)

ResourceClient<DesignationRefund>.AddQueryParameter(string, string)

ResourceClient<DesignationRefund>.ReplaceQueryParameter(string, string)

ResourceClient<DesignationRefund>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<DesignationRefund>.Uri

ResourceClient<DesignationRefund>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedDesignationRefundClient(HttpClient, Uri)

Client for interacting with DesignationRefund collection resources.

public PaginatedDesignationRefundClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedDesignationRefundClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedDesignationRefundClient

The current PaginatedDesignationRefundClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedDesignationRefundClient ClearParameters()

Returns

PaginatedDesignationRefundClient

The current PaginatedDesignationRefundClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedDesignationRefundClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedDesignationRefundClient

The current PaginatedDesignationRefundClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of DesignationRefund resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<DesignationRefundCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeDesignation()

Include related Designation resources in the response.

public DesignationRefundClient IncludeDesignation()

Returns

DesignationRefundClient

Offset(int)

Sets the item offset in the paginated response.

public PaginatedDesignationRefundClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedDesignationRefundClient

The current PaginatedDesignationRefundClient instance.

PerPage(int)

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

public PaginatedDesignationRefundClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedDesignationRefundClient

The current PaginatedDesignationRefundClient instance.

WithId(string)

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

public DesignationRefundClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

DesignationRefundClient

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