Class NameSuffixClient

Namespace

Crews.PlanningCenter.Api.People.V2023_02_15

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the NameSuffix resource.

public class NameSuffixClient : SingletonResourceClient<NameSuffix, NameSuffixResource, NameSuffixResponse>

Inheritance

object

ResourceClient<NameSuffix>

SingletonResourceClient<NameSuffix, NameSuffixResource, NameSuffixResponse>

NameSuffixClient

Inherited Members

SingletonResourceClient<NameSuffix, NameSuffixResource, NameSuffixResponse>.GetAsync(CancellationToken)

SingletonResourceClient<NameSuffix, NameSuffixResource, NameSuffixResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<NameSuffix, NameSuffixResource, NameSuffixResponse>.PatchAsync(NameSuffix, CancellationToken)

SingletonResourceClient<NameSuffix, NameSuffixResource, NameSuffixResponse>.PatchAsync(JsonApiDocument<NameSuffixResource>, CancellationToken)

SingletonResourceClient<NameSuffix, NameSuffixResource, NameSuffixResponse>.DeleteAsync(CancellationToken)

ResourceClient<NameSuffix>.AddQueryParameter(string, string)

ResourceClient<NameSuffix>.ReplaceQueryParameter(string, string)

ResourceClient<NameSuffix>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<NameSuffix>.Uri

ResourceClient<NameSuffix>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

NameSuffixClient(HttpClient, Uri)

Client for interacting with the NameSuffix resource.

public NameSuffixClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public NameSuffixClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

NameSuffixClient

The current NameSuffixClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public NameSuffixClient ClearParameters()

Returns

NameSuffixClient

The current NameSuffixClient instance.

DeleteAsync(CancellationToken)

Deletes the NameSuffix 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 NameSuffix resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<NameSuffixResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(NameSuffix, CancellationToken)

Updates an existing NameSuffix resource asynchronously.

public Task<NameSuffixResponse> PatchAsync(NameSuffix resource, CancellationToken cancellationToken = default)

Parameters

resource NameSuffix

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<NameSuffixResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<NameSuffixResource>, CancellationToken)

Updates an existing NameSuffix resource asynchronously.

public Task<NameSuffixResponse> PatchAsync(JsonApiDocument<NameSuffixResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<NameSuffixResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<NameSuffixResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.