Class PaginatedRefundClient

Namespace

Crews.PlanningCenter.Api.Giving.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Refund collection resources.

public class PaginatedRefundClient : PaginatedResourceClient<Refund, RefundResource, RefundCollectionResponse, RefundResponse>

Inheritance

object

ResourceClient<Refund>

PaginatedResourceClient<Refund, RefundResource, RefundCollectionResponse, RefundResponse>

PaginatedRefundClient

Inherited Members

PaginatedResourceClient<Refund, RefundResource, RefundCollectionResponse, RefundResponse>.PerPage(int)

PaginatedResourceClient<Refund, RefundResource, RefundCollectionResponse, RefundResponse>.Offset(int)

PaginatedResourceClient<Refund, RefundResource, RefundCollectionResponse, RefundResponse>.Filter(string)

PaginatedResourceClient<Refund, RefundResource, RefundCollectionResponse, RefundResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Refund, RefundResource, RefundCollectionResponse, RefundResponse>.PostAsync(Refund, CancellationToken)

PaginatedResourceClient<Refund, RefundResource, RefundCollectionResponse, RefundResponse>.PostAsync(JsonApiDocument<RefundResource>, CancellationToken)

ResourceClient<Refund>.AddQueryParameter(string, string)

ResourceClient<Refund>.ReplaceQueryParameter(string, string)

ResourceClient<Refund>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Refund>.Uri

ResourceClient<Refund>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedRefundClient(HttpClient, Uri)

Client for interacting with Refund collection resources.

public PaginatedRefundClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedRefundClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedRefundClient

The current PaginatedRefundClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedRefundClient ClearParameters()

Returns

PaginatedRefundClient

The current PaginatedRefundClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedRefundClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedRefundClient

The current PaginatedRefundClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of Refund resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<RefundCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeDesignationRefunds()

Include related DesignationRefunds resources in the response.

public RefundClient IncludeDesignationRefunds()

Returns

RefundClient

Offset(int)

Sets the item offset in the paginated response.

public PaginatedRefundClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedRefundClient

The current PaginatedRefundClient instance.

PerPage(int)

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

public PaginatedRefundClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedRefundClient

The current PaginatedRefundClient instance.

WithId(string)

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

public RefundClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

RefundClient

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