Class PaginatedAddressClient

Namespace

Crews.PlanningCenter.Api.People.V2025_11_10

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Address collection resources.

public class PaginatedAddressClient : PaginatedResourceClient<Address, AddressResource, AddressCollectionResponse, AddressResponse>

Inheritance

object

ResourceClient<Address>

PaginatedResourceClient<Address, AddressResource, AddressCollectionResponse, AddressResponse>

PaginatedAddressClient

Inherited Members

PaginatedResourceClient<Address, AddressResource, AddressCollectionResponse, AddressResponse>.PerPage(int)

PaginatedResourceClient<Address, AddressResource, AddressCollectionResponse, AddressResponse>.Offset(int)

PaginatedResourceClient<Address, AddressResource, AddressCollectionResponse, AddressResponse>.Filter(string)

PaginatedResourceClient<Address, AddressResource, AddressCollectionResponse, AddressResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Address, AddressResource, AddressCollectionResponse, AddressResponse>.PostAsync(Address, CancellationToken)

PaginatedResourceClient<Address, AddressResource, AddressCollectionResponse, AddressResponse>.PostAsync(JsonApiDocument<AddressResource>, CancellationToken)

ResourceClient<Address>.AddQueryParameter(string, string)

ResourceClient<Address>.ReplaceQueryParameter(string, string)

ResourceClient<Address>.AddCustomParameter(string, string)

ResourceClient<Address>.ClearParameters()

ResourceClient<Address>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Address>.Uri

ResourceClient<Address>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedAddressClient(HttpClient, Uri)

Client for interacting with Address collection resources.

public PaginatedAddressClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of Address resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<AddressCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

OrderByCity()

Sort response items by the City attribute.

public AddressClient OrderByCity()

Returns

AddressClient

OrderByCityDescending()

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

public AddressClient OrderByCityDescending()

Returns

AddressClient

OrderByCountryCode()

Sort response items by the CountryCode attribute.

public AddressClient OrderByCountryCode()

Returns

AddressClient

OrderByCountryCodeDescending()

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

public AddressClient OrderByCountryCodeDescending()

Returns

AddressClient

OrderByCreatedAt()

Sort response items by the CreatedAt attribute.

public AddressClient OrderByCreatedAt()

Returns

AddressClient

OrderByCreatedAtDescending()

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

public AddressClient OrderByCreatedAtDescending()

Returns

AddressClient

OrderByLocation()

Sort response items by the Location attribute.

public AddressClient OrderByLocation()

Returns

AddressClient

OrderByLocationDescending()

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

public AddressClient OrderByLocationDescending()

Returns

AddressClient

OrderByPrimary()

Sort response items by the Primary attribute.

public AddressClient OrderByPrimary()

Returns

AddressClient

OrderByPrimaryDescending()

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

public AddressClient OrderByPrimaryDescending()

Returns

AddressClient

OrderByState()

Sort response items by the State attribute.

public AddressClient OrderByState()

Returns

AddressClient

OrderByStateDescending()

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

public AddressClient OrderByStateDescending()

Returns

AddressClient

OrderByStreetLine1()

Sort response items by the StreetLine1 attribute.

public AddressClient OrderByStreetLine1()

Returns

AddressClient

OrderByStreetLine1Descending()

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

public AddressClient OrderByStreetLine1Descending()

Returns

AddressClient

OrderByStreetLine2()

Sort response items by the StreetLine2 attribute.

public AddressClient OrderByStreetLine2()

Returns

AddressClient

OrderByStreetLine2Descending()

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

public AddressClient OrderByStreetLine2Descending()

Returns

AddressClient

OrderByUpdatedAt()

Sort response items by the UpdatedAt attribute.

public AddressClient OrderByUpdatedAt()

Returns

AddressClient

OrderByUpdatedAtDescending()

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

public AddressClient OrderByUpdatedAtDescending()

Returns

AddressClient

OrderByZip()

Sort response items by the Zip attribute.

public AddressClient OrderByZip()

Returns

AddressClient

OrderByZipDescending()

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

public AddressClient OrderByZipDescending()

Returns

AddressClient

PostAsync(Address, CancellationToken)

Creates a new Address resource asynchronously.

public Task<AddressResponse> PostAsync(Address resource, CancellationToken cancellationToken = default)

Parameters

resource Address

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<AddressResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<AddressResource>, CancellationToken)

Creates a new Address resource asynchronously.

public Task<AddressResponse> PostAsync(JsonApiDocument<AddressResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<AddressResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<AddressResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WhereCity(string)

Query response items by the City attribute.

public AddressClient WhereCity(string value)

Parameters

value string

Returns

AddressClient

WhereCountryCode(string)

Query response items by the CountryCode attribute.

public AddressClient WhereCountryCode(string value)

Parameters

value string

Returns

AddressClient

WhereLocation(string)

Query response items by the Location attribute.

public AddressClient WhereLocation(string value)

Parameters

value string

Returns

AddressClient

WherePrimary(bool)

Query response items by the Primary attribute.

public AddressClient WherePrimary(bool value)

Parameters

value bool

Returns

AddressClient

WhereState(string)

Query response items by the State attribute.

public AddressClient WhereState(string value)

Parameters

value string

Returns

AddressClient

WhereStreetLine1(string)

Query response items by the StreetLine1 attribute.

public AddressClient WhereStreetLine1(string value)

Parameters

value string

Returns

AddressClient

WhereStreetLine2(string)

Query response items by the StreetLine2 attribute.

public AddressClient WhereStreetLine2(string value)

Parameters

value string

Returns

AddressClient

WhereZip(string)

Query response items by the Zip attribute.

public AddressClient WhereZip(string value)

Parameters

value string

Returns

AddressClient

WithId(string)

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

public AddressClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

AddressClient

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