Class DesignationRefundClient

Namespace

Crews.PlanningCenter.Api.Giving.V2019_10_18

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the DesignationRefund resource.

public class DesignationRefundClient : SingletonResourceClient<DesignationRefund, DesignationRefundResource, DesignationRefundResponse>

Inheritance

object

ResourceClient<DesignationRefund>

SingletonResourceClient<DesignationRefund, DesignationRefundResource, DesignationRefundResponse>

DesignationRefundClient

Inherited Members

SingletonResourceClient<DesignationRefund, DesignationRefundResource, DesignationRefundResponse>.GetAsync(CancellationToken)

SingletonResourceClient<DesignationRefund, DesignationRefundResource, DesignationRefundResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<DesignationRefund, DesignationRefundResource, DesignationRefundResponse>.PatchAsync(DesignationRefund, CancellationToken)

SingletonResourceClient<DesignationRefund, DesignationRefundResource, DesignationRefundResponse>.PatchAsync(JsonApiDocument<DesignationRefundResource>, CancellationToken)

SingletonResourceClient<DesignationRefund, DesignationRefundResource, DesignationRefundResponse>.DeleteAsync(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

DesignationRefundClient(HttpClient, Uri)

Client for interacting with the DesignationRefund resource.

public DesignationRefundClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Designation

Associated Designation.

public DesignationClient Designation { get; }

Property Value

DesignationClient

Methods

GetAsync(CancellationToken)

Fetches the DesignationRefund resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<DesignationRefundResponse>

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

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