Class PaginatedMembershipTypeClient

Namespace

Crews.PlanningCenter.Api.People.V2024_09_12

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with MembershipType collection resources.

public class PaginatedMembershipTypeClient : PaginatedResourceClient<MembershipType, MembershipTypeResource, MembershipTypeCollectionResponse, MembershipTypeResponse>

Inheritance

object

ResourceClient<MembershipType>

PaginatedResourceClient<MembershipType, MembershipTypeResource, MembershipTypeCollectionResponse, MembershipTypeResponse>

PaginatedMembershipTypeClient

Inherited Members

PaginatedResourceClient<MembershipType, MembershipTypeResource, MembershipTypeCollectionResponse, MembershipTypeResponse>.PerPage(int)

PaginatedResourceClient<MembershipType, MembershipTypeResource, MembershipTypeCollectionResponse, MembershipTypeResponse>.Offset(int)

PaginatedResourceClient<MembershipType, MembershipTypeResource, MembershipTypeCollectionResponse, MembershipTypeResponse>.Filter(string)

PaginatedResourceClient<MembershipType, MembershipTypeResource, MembershipTypeCollectionResponse, MembershipTypeResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<MembershipType, MembershipTypeResource, MembershipTypeCollectionResponse, MembershipTypeResponse>.PostAsync(MembershipType, CancellationToken)

PaginatedResourceClient<MembershipType, MembershipTypeResource, MembershipTypeCollectionResponse, MembershipTypeResponse>.PostAsync(JsonApiDocument<MembershipTypeResource>, CancellationToken)

ResourceClient<MembershipType>.AddQueryParameter(string, string)

ResourceClient<MembershipType>.ReplaceQueryParameter(string, string)

ResourceClient<MembershipType>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<MembershipType>.Uri

ResourceClient<MembershipType>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedMembershipTypeClient(HttpClient, Uri)

Client for interacting with MembershipType collection resources.

public PaginatedMembershipTypeClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedMembershipTypeClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedMembershipTypeClient

The current PaginatedMembershipTypeClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedMembershipTypeClient ClearParameters()

Returns

PaginatedMembershipTypeClient

The current PaginatedMembershipTypeClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedMembershipTypeClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedMembershipTypeClient

The current PaginatedMembershipTypeClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of MembershipType resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<MembershipTypeCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedMembershipTypeClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedMembershipTypeClient

The current PaginatedMembershipTypeClient instance.

OrderBySequence()

Sort response items by the Sequence attribute.

public MembershipTypeClient OrderBySequence()

Returns

MembershipTypeClient

OrderBySequenceDescending()

Sort response items by the Sequence attribute. Use reverse order.

public MembershipTypeClient OrderBySequenceDescending()

Returns

MembershipTypeClient

OrderByValue()

Sort response items by the Value attribute.

public MembershipTypeClient OrderByValue()

Returns

MembershipTypeClient

OrderByValueDescending()

Sort response items by the Value attribute. Use reverse order.

public MembershipTypeClient OrderByValueDescending()

Returns

MembershipTypeClient

PerPage(int)

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

public PaginatedMembershipTypeClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedMembershipTypeClient

The current PaginatedMembershipTypeClient instance.

PostAsync(MembershipType, CancellationToken)

Creates a new MembershipType resource asynchronously.

public Task<MembershipTypeResponse> PostAsync(MembershipType resource, CancellationToken cancellationToken = default)

Parameters

resource MembershipType

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<MembershipTypeResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<MembershipTypeResource>, CancellationToken)

Creates a new MembershipType resource asynchronously.

public Task<MembershipTypeResponse> PostAsync(JsonApiDocument<MembershipTypeResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<MembershipTypeResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<MembershipTypeResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WhereValue(string)

Query response items by the Value attribute.

public MembershipTypeClient WhereValue(string value)

Parameters

value string

Returns

MembershipTypeClient

WithId(string)

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

public MembershipTypeClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

MembershipTypeClient

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