Class PaginatedPaymentSourceClient

Namespace

Crews.PlanningCenter.Api.Giving.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with PaymentSource collection resources.

public class PaginatedPaymentSourceClient : PaginatedResourceClient<PaymentSource, PaymentSourceResource, PaymentSourceCollectionResponse, PaymentSourceResponse>

Inheritance

object

ResourceClient<PaymentSource>

PaginatedResourceClient<PaymentSource, PaymentSourceResource, PaymentSourceCollectionResponse, PaymentSourceResponse>

PaginatedPaymentSourceClient

Inherited Members

PaginatedResourceClient<PaymentSource, PaymentSourceResource, PaymentSourceCollectionResponse, PaymentSourceResponse>.PerPage(int)

PaginatedResourceClient<PaymentSource, PaymentSourceResource, PaymentSourceCollectionResponse, PaymentSourceResponse>.Offset(int)

PaginatedResourceClient<PaymentSource, PaymentSourceResource, PaymentSourceCollectionResponse, PaymentSourceResponse>.Filter(string)

PaginatedResourceClient<PaymentSource, PaymentSourceResource, PaymentSourceCollectionResponse, PaymentSourceResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<PaymentSource, PaymentSourceResource, PaymentSourceCollectionResponse, PaymentSourceResponse>.PostAsync(PaymentSource, CancellationToken)

PaginatedResourceClient<PaymentSource, PaymentSourceResource, PaymentSourceCollectionResponse, PaymentSourceResponse>.PostAsync(JsonApiDocument<PaymentSourceResource>, CancellationToken)

ResourceClient<PaymentSource>.AddQueryParameter(string, string)

ResourceClient<PaymentSource>.ReplaceQueryParameter(string, string)

ResourceClient<PaymentSource>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<PaymentSource>.Uri

ResourceClient<PaymentSource>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedPaymentSourceClient(HttpClient, Uri)

Client for interacting with PaymentSource collection resources.

public PaginatedPaymentSourceClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedPaymentSourceClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedPaymentSourceClient

The current PaginatedPaymentSourceClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedPaymentSourceClient ClearParameters()

Returns

PaginatedPaymentSourceClient

The current PaginatedPaymentSourceClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedPaymentSourceClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedPaymentSourceClient

The current PaginatedPaymentSourceClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of PaymentSource resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PaymentSourceCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedPaymentSourceClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedPaymentSourceClient

The current PaginatedPaymentSourceClient instance.

PerPage(int)

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

public PaginatedPaymentSourceClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedPaymentSourceClient

The current PaginatedPaymentSourceClient instance.

PostAsync(PaymentSource, CancellationToken)

Creates a new PaymentSource resource asynchronously.

public Task<PaymentSourceResponse> PostAsync(PaymentSource resource, CancellationToken cancellationToken = default)

Parameters

resource PaymentSource

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PaymentSourceResponse>

A task representing the asynchronous operation, containing the created PaymentSource resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<PaymentSourceResource>, CancellationToken)

Creates a new PaymentSource resource asynchronously.

public Task<PaymentSourceResponse> PostAsync(JsonApiDocument<PaymentSourceResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<PaymentSourceResource>

The JSON:API document to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PaymentSourceResponse>

A task representing the asynchronous operation, containing the created PaymentSource resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WithId(string)

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

public PaymentSourceClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

PaymentSourceClient

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