Class MembershipTypeClient

Namespace

Crews.PlanningCenter.Api.People.V2022_01_05

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the MembershipType resource.

public class MembershipTypeClient : SingletonResourceClient<MembershipType, MembershipTypeResource, MembershipTypeResponse>

Inheritance

object

ResourceClient<MembershipType>

SingletonResourceClient<MembershipType, MembershipTypeResource, MembershipTypeResponse>

MembershipTypeClient

Inherited Members

SingletonResourceClient<MembershipType, MembershipTypeResource, MembershipTypeResponse>.GetAsync(CancellationToken)

SingletonResourceClient<MembershipType, MembershipTypeResource, MembershipTypeResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<MembershipType, MembershipTypeResource, MembershipTypeResponse>.PatchAsync(MembershipType, CancellationToken)

SingletonResourceClient<MembershipType, MembershipTypeResource, MembershipTypeResponse>.PatchAsync(JsonApiDocument<MembershipTypeResource>, CancellationToken)

SingletonResourceClient<MembershipType, MembershipTypeResource, MembershipTypeResponse>.DeleteAsync(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

MembershipTypeClient(HttpClient, Uri)

Client for interacting with the MembershipType resource.

public MembershipTypeClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public MembershipTypeClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

MembershipTypeClient

The current MembershipTypeClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public MembershipTypeClient ClearParameters()

Returns

MembershipTypeClient

The current MembershipTypeClient instance.

DeleteAsync(CancellationToken)

Deletes the MembershipType resource asynchronously.

public Task DeleteAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task

A task representing the asynchronous delete operation.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

GetAsync(CancellationToken)

Fetches the MembershipType resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<MembershipTypeResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(MembershipType, CancellationToken)

Updates an existing MembershipType resource asynchronously.

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

Parameters

resource MembershipType

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<MembershipTypeResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<MembershipTypeResource>, CancellationToken)

Updates an existing MembershipType resource asynchronously.

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

Parameters

document JsonApiDocument<MembershipTypeResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<MembershipTypeResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.