This client only supports Zendesk's v2 API. Please see our API documentation for more information.

Additional documentation can be found on rubydoc.info

Version 0.0.5 brings with it a change to the top-level namespace. All references to Zendesk should now use ZendeskAPI.

The Zendesk API client can be installed using Rubygems or Bundler.

gem install zendesk_api

Add it to your Gemfile

gem "zendesk_api" 

and follow normal Bundler installation and execution procedures.

Configuration is done through a block returning an instance of ZendeskAPI::Client. The block is mandatory and if not passed, an ArgumentError will be thrown.

require 'zendesk_api' client = ZendeskAPI::Client.new do |config| # Mandatory: config.url = "<- your-zendesk-url ->" # e.g. https://mydesk.zendesk.com/api/v2 config.username = "login.email@zendesk.com" # Choose one of the following depending on your authentication choice config.token = "your zendesk token" config.password = "your zendesk password" # Optional: # Retry uses middleware to notify the user # when hitting the rate limit, sleep automatically, # then retry the request. config.retry = true # Logger prints to STDERR by default, to e.g. print to stdout: require 'logger' config.logger = Logger.new(STDOUT) # Changes Faraday adapter # config.adapter = :patron # Merged with the default client options hash # config.client_options = { :ssl => false } # When getting the error 'hostname does not match the server certificate' # use the API at https://yoursubdomain.zendesk.com/api/v2 end

Note: This ZendeskAPI API client only supports basic authentication at the moment.

The result of configuration is an instance of ZendeskAPI::Client which can then be used in two different methods.

One way to use the client is to pass it in as an argument to individual classes.

ZendeskAPI::Ticket.new(client, :id => 1, :priority => "urgent") # doesn't actually send a request, must explicitly call #save ZendeskAPI::Ticket.create(client, :subject => "Test Ticket", :comment => { :value => "This is a test" }, :submitter_id => client.current_user.id, :priority => "urgent") ZendeskAPI::Ticket.find(client, :id => 1) ZendeskAPI::Ticket.delete(client, :id => 1)

Another way is to use the instance methods under client.

client.tickets.first client.tickets.find(:id => 1) client.tickets.create(:subject => "Test Ticket", :comment => { :value => "This is a test" }, :submitter_id => client.current_user.id, :priority => "urgent") client.tickets.delete(:id => 1)

The methods under ZendeskAPI::Client (such as .tickets) return an instance of ZendeskAPI::Collection a lazy-loaded list of that resource. Actual requests may not be sent until an explicit ZendeskAPI::Collection#fetch, ZendeskAPI::Collection#to_a, or an applicable methods such as #each.

ZendeskAPI::Collections can be paginated:

tickets = client.tickets.page(2).per_page(3) next_page = tickets.next previous_page = tickets.prev

Iteration over all resources and pages is handled by Collection#page_page

client.tickets.each_page do |resource| # all resources will be yielded end

If given a block with two arguments, the page is also passed in.

client.tickets.each_page do |resource, page| # all resources will be yielded along with the page end

Callbacks can be added to the ZendeskAPI::Client instance and will be called (with the response env) after all response middleware on a successful request.

client.insert_callback do |env| puts env[:response_headers] end

Individual resources can be created, modified, saved, and destroyed.

ticket = client.tickets[0] # ZendeskAPI::Ticket.find(client, :id => 1) ticket.priority = "urgent" ticket.attributes # => { "priority" => "urgent" } ticket.save # Will PUT => true ticket.destroy # => true ZendeskAPI::Ticket.new(client, { :priority => "urgent" }) ticket.new_record? # => true ticket.save # Will POST

Warning: this is an experimental feature. Abuse it and lose it.

To facilitate a smaller number of requests and easier manipulation of associated data we allow "side-loading", or inclusion, of selected resources.

For example: A ZendeskAPI::Ticket is associated with ZendeskAPI::User through the requester_id field. API requests for that ticket return a structure similar to this:

"ticket": { "id": 1, "url": "http.....", "requester_id": 7, ... }

Calling ZendeskAPI::Ticket#requester automatically fetches and loads the user referenced above (/api/v2/users/7). Using side-loading, however, the user can be partially loaded in the same request as the ticket.

tickets = client.tickets.include(:users) # Or client.tickets(include: :users) # Does *NOT* make a request to the server since it is already loaded tickets.first.requester # => #<ZendeskAPI::User id=...>

OR

ticket = client.tickets.find(:id => 1, :include => :users) ticket.requester # => #<ZendeskAPI::User id=...>

Currently, this feature is limited to only a few resources and their associations. They are documented on developer.zendesk.com.

API endpoints such as tickets/recent or topics/show_many can be accessed through chaining. They will too return an instance of ZendeskAPI::Collection.

client.tickets.recent client.topics.show_many(:verb => :post, :ids => [1, 2, 3])

Use either of the following to obtain the current user instance:

client.users.find(:id => 'me') client.current_user

Bulk importing tickets allows you to move large amounts of data into Zendesk.

ticket = ZendeskAPI::Ticket.import(client, :subject => "Help", :comments => [{ :author_id => 19, :value => "This is a comment" }])

http://developer.zendesk.com/documentation/rest_api/ticket_import.html

Files can be attached to ticket comments using either a path or the File class and will be automatically uploaded and attached.

ticket = ZendeskAPI::Ticket.new(client, :comment => { :value => "attachments" }) ticket.comment.uploads << "img.jpg" ticket.comment.uploads << File.new("img.jpg") ticket.save

1. Fork the project.
2. Make your feature addition or bug fix.
3. Add tests for it. This is important so I don't break it in a future version unintentionally.
4. Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
5. Send me a pull request. Bonus points for topic branches.

Tested with Ruby 1.8.7 and 1.9.3

See LICENSE