Class PaginatedPaymentMethodClient

Namespace

Crews.PlanningCenter.Api.Giving.V2019_10_18

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with PaymentMethod collection resources.

public class PaginatedPaymentMethodClient : PaginatedResourceClient<PaymentMethod, PaymentMethodResource, PaymentMethodCollectionResponse, PaymentMethodResponse>

Inheritance

object

ResourceClient<PaymentMethod>

PaginatedResourceClient<PaymentMethod, PaymentMethodResource, PaymentMethodCollectionResponse, PaymentMethodResponse>

PaginatedPaymentMethodClient

Inherited Members

PaginatedResourceClient<PaymentMethod, PaymentMethodResource, PaymentMethodCollectionResponse, PaymentMethodResponse>.PerPage(int)

PaginatedResourceClient<PaymentMethod, PaymentMethodResource, PaymentMethodCollectionResponse, PaymentMethodResponse>.Offset(int)

PaginatedResourceClient<PaymentMethod, PaymentMethodResource, PaymentMethodCollectionResponse, PaymentMethodResponse>.Filter(string)

PaginatedResourceClient<PaymentMethod, PaymentMethodResource, PaymentMethodCollectionResponse, PaymentMethodResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<PaymentMethod, PaymentMethodResource, PaymentMethodCollectionResponse, PaymentMethodResponse>.PostAsync(PaymentMethod, CancellationToken)

PaginatedResourceClient<PaymentMethod, PaymentMethodResource, PaymentMethodCollectionResponse, PaymentMethodResponse>.PostAsync(JsonApiDocument<PaymentMethodResource>, CancellationToken)

ResourceClient<PaymentMethod>.AddQueryParameter(string, string)

ResourceClient<PaymentMethod>.ReplaceQueryParameter(string, string)

ResourceClient<PaymentMethod>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<PaymentMethod>.Uri

ResourceClient<PaymentMethod>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedPaymentMethodClient(HttpClient, Uri)

Client for interacting with PaymentMethod collection resources.

public PaginatedPaymentMethodClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedPaymentMethodClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedPaymentMethodClient

The current PaginatedPaymentMethodClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedPaymentMethodClient ClearParameters()

Returns

PaginatedPaymentMethodClient

The current PaginatedPaymentMethodClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedPaymentMethodClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedPaymentMethodClient

The current PaginatedPaymentMethodClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of PaymentMethod resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PaymentMethodCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedPaymentMethodClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedPaymentMethodClient

The current PaginatedPaymentMethodClient instance.

PerPage(int)

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

public PaginatedPaymentMethodClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedPaymentMethodClient

The current PaginatedPaymentMethodClient instance.

WithId(string)

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

public PaymentMethodClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

PaymentMethodClient

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