Class PaginatedDesignationRefundClient

Namespace

Crews.PlanningCenter.Api.Giving.V2019_10_18

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

ResourceClient<DesignationRefund>.ClearParameters()

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

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

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.