Zendesk Api Client

A .netstandard NuGet package for use with the Zendesk v2 API.

Breaking Changes

4.x.x

This will allow for cursor pagination on some endpoints. We have kept the original offset pagination available so that this release is backward compatible, however due to Zendesk adding a variation of cursor pagination to this single endpoint, we have modified the original cursorPager class to now be cursorPagerVariant. If you use the TicketAudits endpoint please update your code.

Unfortunatly Zendesk has not adopted cursor pagination on all endpoints. A list of compatible endpoints used in this API are as follows:

Users:

GET /api/v2/deleted_users
GET /api/v2/users
GET /api/v2/users/{user_id}/identities
GET /api/v2/user_fields
GET /api/v2/users/{user_id}/groups

Groups:

GET /api/v2/groups
GET /api/v2/groups/{group_id}/users

Help Center:

GET api/v2/help_center/articles
GET api/v2/help_center/categories

Organization:

GET /api/v2/organization_fields
GET /api/v2/organization_memberships
GET /api/v2/organizations
GET /api/v2/organizations/{organization_id}/users
GET /api/v2/organizations/{organization_id}/tickets

Tickets:

GET /api/v2/deleted_tickets
GET /api/v2/tickets
GET /api/v2/tickets/{ticketId}/comments
GET /api/v2/ticket_fields
GET /api/v2/ticket_audits - Cursor Variant

Satisfaction ratings:

GET /api/v2/satisfaction_ratings

Further reading on Zendesk Pagination changes

3.x.x

This is a complete rewrite so expect breaking changes.

Some noteworthy changes include:

PostAsync replaced with CreateAsync
PutAsync replaced with UpdateAsync
Search resource now uses SearchAsync instead of Find, and introduces a new fluent api to replace the old ZendeskQuery<T> class.

Creating a client

To register this in your DI, you just need to call...

services.AddZendeskClient("https://[your_url].zendesk.com", "username", "token");

then you can inject in IZendeskClient anywhere you want to use it. Here you can access all the resources available.

If however you want to use the client in a DI less environment you can do this

var zendeskOptions = new ZendeskOptions
{
   EndpointUri = "https://[your_url].zendesk.com",
   Username = "username"
   Token = "token"
};

var loggerFactory = new LoggerFactory();
var zendeskOptionsWrapper = new OptionsWrapper<ZendeskOptions>(zendeskOptions);
var client = new ZendeskClient(new ZendeskApiClient(zendeskOptionsWrapper), loggerFactory.CreateLogger<ZendeskClient>());

Example methods

var ticket = await client.Tickets.GetAsync(1234L); // Get ticket by Id
var tickets = await client.Tickets.GetAllAsync(new [] { 1234L, 4321L }); // 
var ticket = await client.Tickets.UpdateAsync(ticket);
var ticket = await client.Tickets.CreateAsync(ticket);
await client.Tickets.DeleteAsync(1234L);

Searching and filtering

await client.Search.SearchAsync<User>(q => 
    q.WithFilter("email", "jazzy.b@just-eat.com")
);

await client.Search.SearchAsync<Organization>(q => 
    q.WithFilter("name", "Cupcake Cafe")
);

// All non closed tickets
await client.Search.SearchAsync<Ticket>(q => 
    q.WithFilter("status", "closed", FilterOperator.LessThan)
);

The Zendesk API

The zendesk api documentation is available at http://developer.zendesk.com/documentation/rest_api/introduction.html Querying and searching is limited by the searchable fields on the zendesk api

Integration Tests

In order to run integration tests against your own zendesk instance use the Cake script provided by:

.\build.ps1 --target=Run-Integration-Tests --zendeskUrl="<your zendesk url>" --zendeskUsername="<your zendesk username>" --zendeskToken="<your zendesk token>"

Contributing

We are happy for anyone to contribute into this client, and help us evolve it over time.

Versioning

We aim to follow Semantic Versioning guidelines within this library. When increasing the version there are multiple places that will need to be changed:

automatorJames/ZendeskApiClient