Class PaginatedEmailClient

Namespace

Crews.PlanningCenter.Api.People.V2025_07_02

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Email collection resources.

public class PaginatedEmailClient : PaginatedResourceClient<Email, EmailResource, EmailCollectionResponse, EmailResponse>

Inheritance

object

ResourceClient<Email>

PaginatedResourceClient<Email, EmailResource, EmailCollectionResponse, EmailResponse>

PaginatedEmailClient

Inherited Members

PaginatedResourceClient<Email, EmailResource, EmailCollectionResponse, EmailResponse>.PerPage(int)

PaginatedResourceClient<Email, EmailResource, EmailCollectionResponse, EmailResponse>.Offset(int)

PaginatedResourceClient<Email, EmailResource, EmailCollectionResponse, EmailResponse>.Filter(string)

PaginatedResourceClient<Email, EmailResource, EmailCollectionResponse, EmailResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Email, EmailResource, EmailCollectionResponse, EmailResponse>.PostAsync(Email, CancellationToken)

PaginatedResourceClient<Email, EmailResource, EmailCollectionResponse, EmailResponse>.PostAsync(JsonApiDocument<EmailResource>, CancellationToken)

ResourceClient<Email>.AddQueryParameter(string, string)

ResourceClient<Email>.ReplaceQueryParameter(string, string)

ResourceClient<Email>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Email>.Uri

ResourceClient<Email>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedEmailClient(HttpClient, Uri)

Client for interacting with Email collection resources.

public PaginatedEmailClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedEmailClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedEmailClient

The current PaginatedEmailClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedEmailClient ClearParameters()

Returns

PaginatedEmailClient

The current PaginatedEmailClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedEmailClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedEmailClient

The current PaginatedEmailClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of Email resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EmailCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedEmailClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedEmailClient

The current PaginatedEmailClient instance.

OrderByAddress()

Sort response items by the Address attribute.

public EmailClient OrderByAddress()

Returns

EmailClient

OrderByAddressDescending()

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

public EmailClient OrderByAddressDescending()

Returns

EmailClient

OrderByCreatedAt()

Sort response items by the CreatedAt attribute.

public EmailClient OrderByCreatedAt()

Returns

EmailClient

OrderByCreatedAtDescending()

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

public EmailClient OrderByCreatedAtDescending()

Returns

EmailClient

OrderByLocation()

Sort response items by the Location attribute.

public EmailClient OrderByLocation()

Returns

EmailClient

OrderByLocationDescending()

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

public EmailClient OrderByLocationDescending()

Returns

EmailClient

OrderByPrimary()

Sort response items by the Primary attribute.

public EmailClient OrderByPrimary()

Returns

EmailClient

OrderByPrimaryDescending()

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

public EmailClient OrderByPrimaryDescending()

Returns

EmailClient

OrderByUpdatedAt()

Sort response items by the UpdatedAt attribute.

public EmailClient OrderByUpdatedAt()

Returns

EmailClient

OrderByUpdatedAtDescending()

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

public EmailClient OrderByUpdatedAtDescending()

Returns

EmailClient

PerPage(int)

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

public PaginatedEmailClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedEmailClient

The current PaginatedEmailClient instance.

PostAsync(Email, CancellationToken)

Creates a new Email resource asynchronously.

public Task<EmailResponse> PostAsync(Email resource, CancellationToken cancellationToken = default)

Parameters

resource Email

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EmailResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<EmailResource>, CancellationToken)

Creates a new Email resource asynchronously.

public Task<EmailResponse> PostAsync(JsonApiDocument<EmailResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<EmailResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EmailResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WhereAddress(string)

Query response items by the Address attribute.

public EmailClient WhereAddress(string value)

Parameters

value string

Returns

EmailClient

WhereBlocked(bool)

Query response items by the Blocked attribute.

public EmailClient WhereBlocked(bool value)

Parameters

value bool

Returns

EmailClient

WhereCreatedAt(DateTime)

Query response items by the CreatedAt attribute.

public EmailClient WhereCreatedAt(DateTime value)

Parameters

value DateTime

Returns

EmailClient

WhereLocation(string)

Query response items by the Location attribute.

public EmailClient WhereLocation(string value)

Parameters

value string

Returns

EmailClient

WherePrimary(bool)

Query response items by the Primary attribute.

public EmailClient WherePrimary(bool value)

Parameters

value bool

Returns

EmailClient

WhereUpdatedAt(DateTime)

Query response items by the UpdatedAt attribute.

public EmailClient WhereUpdatedAt(DateTime value)

Parameters

value DateTime

Returns

EmailClient

WithId(string)

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

public EmailClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

EmailClient

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