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>.AddCustomParameter(string, string)

ResourceClient<Refund>.ClearParameters()

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

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

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.