module Selligent::Client::Tasks

Implements the task endpoints

/organizations/:organization/tasks/*

Public Instance Methods

disable_task(name) click to toggle source

Disable a task

@param name [String] The task name

# File lib/selligent/client/tasks.rb, line 37
def disable_task(name)
  post "#{base_url}/tasks/#{name}/actions/disable"
end
enable_task(name) click to toggle source

Enable a task

@param name [String] The task name

# File lib/selligent/client/tasks.rb, line 44
def enable_task(name)
  post "#{base_url}/tasks/#{name}/actions/enable"
end
run_task(name) click to toggle source

Run a task

@param name [String] The task name

# File lib/selligent/client/tasks.rb, line 51
def run_task(name)
  post "#{base_url}/tasks/#{name}/actions/run"
end
task(name) click to toggle source

Get task details by name

@param name [String] The task name

# File lib/selligent/client/tasks.rb, line 23
def task(name)
  get "#{base_url}/tasks/#{name}"
end
task_actions(task_name) click to toggle source

Get task-actions by task name

@param task_name [String] The task name

# File lib/selligent/client/tasks.rb, line 30
def task_actions(task_name)
  get "#{base_url}/tasks/#{task_name}/actions"
end
tasks(options = {}) click to toggle source

Get a collection of tasks

@param options [Hash] Additional options @option options [String] :filter Filter by type @option options [String] :search Search by name, description or tags @option options [Integer] :skip Specify index to start form @option options [Integer] :take Specify number of tasks to take

# File lib/selligent/client/tasks.rb, line 16
def tasks(options = {})
  get "#{base_url}/tasks", options
end