Class PaginatedMailchimpSyncStatusClient

Namespace

Crews.PlanningCenter.Api.People.V2020_07_22

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with MailchimpSyncStatus collection resources.

public class PaginatedMailchimpSyncStatusClient : PaginatedResourceClient<MailchimpSyncStatus, MailchimpSyncStatusResource, MailchimpSyncStatusCollectionResponse, MailchimpSyncStatusResponse>

Inheritance

object

ResourceClient<MailchimpSyncStatus>

PaginatedResourceClient<MailchimpSyncStatus, MailchimpSyncStatusResource, MailchimpSyncStatusCollectionResponse, MailchimpSyncStatusResponse>

PaginatedMailchimpSyncStatusClient

Inherited Members

PaginatedResourceClient<MailchimpSyncStatus, MailchimpSyncStatusResource, MailchimpSyncStatusCollectionResponse, MailchimpSyncStatusResponse>.PerPage(int)

PaginatedResourceClient<MailchimpSyncStatus, MailchimpSyncStatusResource, MailchimpSyncStatusCollectionResponse, MailchimpSyncStatusResponse>.Offset(int)

PaginatedResourceClient<MailchimpSyncStatus, MailchimpSyncStatusResource, MailchimpSyncStatusCollectionResponse, MailchimpSyncStatusResponse>.Filter(string)

PaginatedResourceClient<MailchimpSyncStatus, MailchimpSyncStatusResource, MailchimpSyncStatusCollectionResponse, MailchimpSyncStatusResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<MailchimpSyncStatus, MailchimpSyncStatusResource, MailchimpSyncStatusCollectionResponse, MailchimpSyncStatusResponse>.PostAsync(MailchimpSyncStatus, CancellationToken)

PaginatedResourceClient<MailchimpSyncStatus, MailchimpSyncStatusResource, MailchimpSyncStatusCollectionResponse, MailchimpSyncStatusResponse>.PostAsync(JsonApiDocument<MailchimpSyncStatusResource>, CancellationToken)

ResourceClient<MailchimpSyncStatus>.AddQueryParameter(string, string)

ResourceClient<MailchimpSyncStatus>.ReplaceQueryParameter(string, string)

ResourceClient<MailchimpSyncStatus>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<MailchimpSyncStatus>.Uri

ResourceClient<MailchimpSyncStatus>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedMailchimpSyncStatusClient(HttpClient, Uri)

Client for interacting with MailchimpSyncStatus collection resources.

public PaginatedMailchimpSyncStatusClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedMailchimpSyncStatusClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedMailchimpSyncStatusClient

The current PaginatedMailchimpSyncStatusClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedMailchimpSyncStatusClient ClearParameters()

Returns

PaginatedMailchimpSyncStatusClient

The current PaginatedMailchimpSyncStatusClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedMailchimpSyncStatusClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedMailchimpSyncStatusClient

The current PaginatedMailchimpSyncStatusClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of MailchimpSyncStatus resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<MailchimpSyncStatusCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedMailchimpSyncStatusClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedMailchimpSyncStatusClient

The current PaginatedMailchimpSyncStatusClient instance.

PerPage(int)

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

public PaginatedMailchimpSyncStatusClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedMailchimpSyncStatusClient

The current PaginatedMailchimpSyncStatusClient instance.

WithId(string)

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

public MailchimpSyncStatusClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

MailchimpSyncStatusClient

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