Class PaginatedPaymentMethodClient

Namespace

Crews.PlanningCenter.Api.Giving.V2018_08_01

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

ResourceClient<PaymentMethod>.ClearParameters()

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

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.

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.