Class RefundClient

Namespace

Crews.PlanningCenter.Api.Giving.V2019_10_18

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Refund resource.

public class RefundClient : SingletonResourceClient<Refund, RefundResource, RefundResponse>

Inheritance

object

ResourceClient<Refund>

SingletonResourceClient<Refund, RefundResource, RefundResponse>

RefundClient

Inherited Members

SingletonResourceClient<Refund, RefundResource, RefundResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Refund, RefundResource, RefundResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Refund, RefundResource, RefundResponse>.PatchAsync(Refund, CancellationToken)

SingletonResourceClient<Refund, RefundResource, RefundResponse>.PatchAsync(JsonApiDocument<RefundResource>, CancellationToken)

SingletonResourceClient<Refund, RefundResource, RefundResponse>.DeleteAsync(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

RefundClient(HttpClient, Uri)

Client for interacting with the Refund resource.

public RefundClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

DesignationRefunds

Associated DesignationRefunds.

public PaginatedDesignationRefundClient DesignationRefunds { get; }

Property Value

PaginatedDesignationRefundClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public RefundClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

RefundClient

The current RefundClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public RefundClient ClearParameters()

Returns

RefundClient

The current RefundClient instance.

GetAsync(CancellationToken)

Fetches the Refund resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<RefundResponse>

A task representing the asynchronous operation, containing the Refund resource.

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