Class: ZendeskSupportAPI::Jobs

Inherits:
Object
  • Object
show all
Defined in:
lib/zendesk_support_api/jobs.rb

Overview

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

Class Method Summary collapse

Class Method Details

.list(client) ⇒ Hash

Make a request to show all job statuses

Examples:

ZendeskSupportAPI::Jobs.show_many(client, ['abc123', 'def456'])
#=> {
#=>   "job_statuses": [
#=>     {
#=>       "id": "abc123",
#=>       "status": "completed",
#=>       ...
#=>     },
#=>     {
#=>      "id": "def456",
#=>      "status": "completed",
#=>      ...
#=>     }
#=>   ]
#=> }

Parameters:

Returns:

  • (Hash) 


64
65
66
 
# File 'lib/zendesk_support_api/jobs.rb', line 64

def self.list(client)
  client.request(:get, 'job_statuses.json')['job_statuses']
end

.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"=>"[email protected]"
#=>       },
#=>       {
#=>         "id"=>369728778639,
#=>         "status"=>"Updated",
#=>         "email"=>"[email protected]"
#=>       }
#=>     ]
#=>   }
#=> }

Parameters:

Returns:

  • (Hash) 


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

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

.show_many(client, ids) ⇒ Hash

Show many job statuses

Examples:

ZendeskSupportAPI::Jobs.show_many(client, ['abc123', 'def456'])
#=> {
#=>   "job_statuses": [
#=>     {
#=>       "id": "abc123",
#=>       "status": "completed",
#=>       ...
#=>     },
#=>     {
#=>      "id": "def456",
#=>      "status": "completed",
#=>      ...
#=>     }
#=>   ]
#=> }

Parameters:

Returns:

  • (Hash) 


91
92
93
 
# File 'lib/zendesk_support_api/jobs.rb', line 91

def self.show_many(client, ids)
  client.request(:get, "job_statuses/show_many.json?ids=#{ids.join(',')}")
end