Class: ZendeskSupportAPI::Jobs

Inherits:

Object

• Object
• ZendeskSupportAPI::Jobs

Defined in:

lib/zendesk_support_api/jobs.rb

Overview

Jobs class - developer.zendesk.com/rest_api/docs/support/job_statuses

Class Method Summary

• .show(client, id) ⇒ Hash

  Make a request to show the job status.

Class Method Details

.show(client, id) ⇒ Hash

Make a request to show the job status

Examples:

client = ZendeskSupportAPI::Client.new('user', '123', 'zendesk.com/api')
ZendeskSupportAPI::Jobs.show(client, 'abc123')
#=> {
#=>   "job_status"=> {
#=>     "id"=>"abc123",
#=>     "url"=>"abc123.json",
#=>     "total"=>2,
#=>     "progress"=>2,
#=>     "status"=>"completed",
#=>     "message"=>"Completed at 2020-04-29 13:26:40 +0000",
#=>     "results"=> [
#=>       {
#=>         "id"=>369731992959,
#=>         "status"=>"Updated",
#=>         "email"=>"test@example.com"
#=>       },
#=>       {
#=>         "id"=>369728778639,
#=>         "status"=>"Updated",
#=>         "email"=>"test2@example.com"
#=>       }
#=>     ]
#=>   }
#=> }

Parameters:

• client (ZendeskSupportAPI::Client) —

  The client instance

• id (String) —

  The id of the job to check

Returns:

• (Hash)

# File 'lib/zendesk_support_api/jobs.rb', line 38

def self.show(client, id)
  client.request(:get, "job_statuses/#{id}.json")
end