worker_ruby 0.5.7

data/docs/Error.md

@@ -0,0 +1,8 @@
+# IronWorker::Error
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | [**ErrorBody**](ErrorBody.md) |  | [optional] 
+
+

data/docs/ErrorBody.md

@@ -0,0 +1,9 @@
+# IronWorker::ErrorBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **String** |  | [optional] 
+**fields** | **String** |  | [optional] 
+
+

data/docs/Group.md

@@ -0,0 +1,12 @@
+# IronWorker::Group
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of this group. Must be different than the image name. Can ony contain alphanumeric, -, and _. | [optional] 
+**created_at** | **DateTime** | Time when image first used/created. | [optional] 
+**image** | **String** | Name of Docker image to use in this group. You should include the image tag, which should be a version number, to be more accurate. Can be overridden on a per task basis with task.image. | [optional] 
+**env_vars** | **Hash<String, String>** | User defined environment variables that will be passed in to each task in this group. | [optional] 
+**max_concurrency** | **Integer** | The maximum number of tasks that will run at the exact same time in this group. | [optional] 
+
+

data/docs/GroupWrapper.md

@@ -0,0 +1,8 @@
+# IronWorker::GroupWrapper
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**group** | [**Group**](Group.md) |  | 
+
+

data/docs/GroupsApi.md

@@ -0,0 +1,197 @@
+# IronWorker::GroupsApi
+
+All URIs are relative to *https://localhost:8080/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**groups_get**](GroupsApi.md#groups_get) | **GET** /groups | Get all group names.
+[**groups_name_get**](GroupsApi.md#groups_name_get) | **GET** /groups/{name} | Get information for a group.
+[**groups_name_put**](GroupsApi.md#groups_name_put) | **PUT** /groups/{name} | Create/update a task group.
+[**groups_post**](GroupsApi.md#groups_post) | **POST** /groups | Post new group
+
+
+# **groups_get**
+> GroupsWrapper groups_get
+
+Get all group names.
+
+Get a list of all the groups in the system.
+
+### Example
+```ruby
+# load the gem
+require 'worker_ruby'
+
+api_instance = IronWorker::GroupsApi.new
+
+begin
+  #Get all group names.
+  result = api_instance.groups_get
+  p result
+rescue IronWorker::ApiError => e
+  puts "Exception when calling GroupsApi->groups_get: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GroupsWrapper**](GroupsWrapper.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **groups_name_get**
+> GroupWrapper groups_name_get(name)
+
+Get information for a group.
+
+This gives more details about a task group, such as statistics.
+
+### Example
+```ruby
+# load the gem
+require 'worker_ruby'
+
+api_instance = IronWorker::GroupsApi.new
+
+name = "name_example" # String | name of the group.
+
+
+begin
+  #Get information for a group.
+  result = api_instance.groups_name_get(name)
+  p result
+rescue IronWorker::ApiError => e
+  puts "Exception when calling GroupsApi->groups_name_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**| name of the group. | 
+
+### Return type
+
+[**GroupWrapper**](GroupWrapper.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **groups_name_put**
+> GroupWrapper groups_name_put(name, body)
+
+Create/update a task group.
+
+You can set group level settings here. 
+
+### Example
+```ruby
+# load the gem
+require 'worker_ruby'
+
+api_instance = IronWorker::GroupsApi.new
+
+name = "name_example" # String | name of the group.
+
+body = IronWorker::GroupWrapper.new # GroupWrapper | Group to post.
+
+
+begin
+  #Create/update a task group.
+  result = api_instance.groups_name_put(name, body)
+  p result
+rescue IronWorker::ApiError => e
+  puts "Exception when calling GroupsApi->groups_name_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**| name of the group. | 
+ **body** | [**GroupWrapper**](GroupWrapper.md)| Group to post. | 
+
+### Return type
+
+[**GroupWrapper**](GroupWrapper.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **groups_post**
+> GroupWrapper groups_post(body)
+
+Post new group
+
+Insert a new task group
+
+### Example
+```ruby
+# load the gem
+require 'worker_ruby'
+
+api_instance = IronWorker::GroupsApi.new
+
+body = IronWorker::GroupWrapper.new # GroupWrapper | Group to post.
+
+
+begin
+  #Post new group
+  result = api_instance.groups_post(body)
+  p result
+rescue IronWorker::ApiError => e
+  puts "Exception when calling GroupsApi->groups_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**GroupWrapper**](GroupWrapper.md)| Group to post. | 
+
+### Return type
+
+[**GroupWrapper**](GroupWrapper.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/GroupsWrapper.md

@@ -0,0 +1,8 @@
+# IronWorker::GroupsWrapper
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**groups** | [**Array<Group>**](Group.md) |  | 
+
+

data/docs/IdStatus.md

@@ -0,0 +1,9 @@
+# IronWorker::IdStatus
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier representing a specific task. | [optional] 
+**status** | **String** | States and valid transitions.                   +---------+        +---------> delayed <----------------+                  +----+----+                |                       |                     |                       |                     |                  +----v----+                |        +---------> queued  <----------------+                  +----+----+                *                       |                     *                       |               retry * creates new task                  +----v----+                *                  | running |                *                  +--+-+-+--+                |           +---------|-|-|-----+-------------+       +---|---------+ | +-----|---------+   |       |   |           |       |         |   | +-----v---^-+      +--v-------^+     +--v---^-+ | success   |      | cancelled |     |  error | +-----------+      +-----------+     +--------+  * delayed - has a delay. * queued - Ready to be consumed when it's turn comes. * running - Currently consumed by a runner which will attempt to process it. * success - (or complete? success/error is common javascript terminology) * error - Something went wrong. In this case more information can be obtained   by inspecting the \"reason\" field.   - timeout   - killed - forcibly killed by worker due to resource restrictions or access     violations.   - bad_exit - exited with non-zero status due to program termination/crash. * cancelled - cancelled via API. More information in the reason field.   - client_request - Request was cancelled by a client.  | [optional] 
+
+

data/docs/Image.md

@@ -0,0 +1,10 @@
+# IronTitan::Image
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of this image/package/code. Can and should be different than the image name (shoudn't include tag). TODO: Should we strip tag automatically if only image is passed in? | [optional] 
+**image** | **String** | Docker image to use for job, including the tag. | 
+**created_at** | **DateTime** | Time when image first used/created. | [optional] 
+
+

data/docs/ImageWrapper.md

@@ -0,0 +1,8 @@
+# IronTitan::ImageWrapper
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**image** | [**Image**](Image.md) |  | 
+
+

data/docs/ImagesApi.md

@@ -0,0 +1,98 @@
+# IronTitan::ImagesApi
+
+All URIs are relative to *https://localhost:8080/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**image_id_get**](ImagesApi.md#image_id_get) | **GET** /image/{id} | Get information for image id.
+[**images_get**](ImagesApi.md#images_get) | **GET** /images | Get all image names.
+
+
+# **image_id_get**
+> ImageWrapper image_id_get(id)
+
+Get information for image id.
+
+This gives more details about on image, such as the image name and other statistics.
+
+### Example
+```ruby
+# load the gem
+require 'iron_titan'
+
+api_instance = IronTitan::ImagesApi.new
+
+id = "id_example" # String | ID of the image.
+
+
+begin
+  #Get information for image id.
+  result = api_instance.image_id_get(id)
+  p result
+rescue IronTitan::ApiError => e
+  puts "Exception when calling ImagesApi->image_id_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| ID of the image. | 
+
+### Return type
+
+[**ImageWrapper**](ImageWrapper.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP reuqest headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **images_get**
+> ImagesWrapper images_get
+
+Get all image names.
+
+TODO: Using images for lack of a better term. See https://github.com/iron-io/titan/issues/43 for discussion.
+
+### Example
+```ruby
+# load the gem
+require 'iron_titan'
+
+api_instance = IronTitan::ImagesApi.new
+
+begin
+  #Get all image names.
+  result = api_instance.images_get
+  p result
+rescue IronTitan::ApiError => e
+  puts "Exception when calling ImagesApi->images_get: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ImagesWrapper**](ImagesWrapper.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP reuqest headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/ImagesWrapper.md

@@ -0,0 +1,8 @@
+# IronTitan::ImagesWrapper
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**images** | [**Array<Image>**](Image.md) |  | 
+
+

data/docs/Job.md

@@ -0,0 +1,25 @@
+# IronTitan::Job
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**image** | **String** | Name of Docker image to use. This is optional and can be used to override the image defined at the group level. | 
+**payload** | **String** | Payload for the job. This is what you pass into each job to make it do something. | [optional] 
+**delay** | **Integer** | Number of seconds to wait before queueing the job for consumption for the first time. Must be a positive integer. Jobs with a delay start in state \"delayed\" and transition to \"running\" after delay seconds. | [optional] [default to 0]
+**timeout** | **Integer** | Maximum runtime in seconds. If a consumer retrieves the job, but does not change it's status within timeout seconds, the job is considered failed, with reason timeout (Titan may allow a small grace period). The consumer should also kill the job after timeout seconds. If a consumer tries to change status after Titan has already timed out the job, the consumer will be ignored.  | [optional] [default to 60]
+**priority** | **Integer** | Priority of the job. Higher has more priority. 3 levels from 0-2. Jobs at same priority are processed in FIFO order. | 
+**max_retries** | **Integer** | \"Number of automatic retries this job is allowed. A retry will be attempted if a task fails. Max 25. Automatic retries are performed by titan when a task reaches a failed state and has `max_retries` > 0. A retry is performed by queueing a new job with the same image id and payload. The new job's max_retries is one less than the original. The new job's `retry_of` field is set to the original Job ID.  Titan will delay the new job for retries_delay seconds before queueing it. Cancelled or successful tasks are never automatically retried.\"  | [optional] [default to 0]
+**retries_delay** | **Integer** | Time in seconds to wait before retrying the job. Must be a non-negative integer. | [optional] [default to 60]
+**id** | **String** | Unique identifier representing a specific job. | [optional] 
+**status** | **String** | States and valid transitions.                   +---------+        +---------> delayed <----------------+                  +----+----+                |                       |                     |                       |                     |                  +----v----+                |        +---------> queued  <----------------+                  +----+----+                *                       |                     *                       |               retry * creates new job                  +----v----+                *                  | running |                *                  +--+-+-+--+                |           +---------|-|-|-----+-------------+       +---|---------+ | +-----|---------+   |       |   |           |       |         |   | +-----v---^-+      +--v-------^+     +--v---^-+ | success   |      | cancelled |     |  error | +-----------+      +-----------+     +--------+  * delayed - has a delay. * queued - Ready to be consumed when it's turn comes. * running - Currently consumed by a runner which will attempt to process it. * success - (or complete? success/error is common javascript terminology) * error - Something went wrong. In this case more information can be obtained   by inspecting the \"reason\" field.   - timeout   - killed - forcibly killed by worker due to resource restrictions or access     violations.   - bad_exit - exited with non-zero status due to program termination/crash. * cancelled - cancelled via API. More information in the reason field.   - client_request - Request was cancelled by a client.  | [optional] 
+**group_name** | **String** | Group this job belongs to. | [optional] 
+**error** | **String** | The error message, if status is 'error'. This is errors due to things outside the job itself. Errors from user code will be found in the log. | [optional] 
+**reason** | **String** | Machine usable reason for job being in this state. Valid values for error status are `timeout | killed | bad_exit`. Valid values for cancelled status are `client_request`. For everything else, this is undefined.  | [optional] 
+**created_at** | **DateTime** | Time when job was submitted. Always in UTC. | [optional] 
+**started_at** | **DateTime** | Time when job started execution. Always in UTC. | [optional] 
+**completed_at** | **DateTime** | Time when job completed, whether it was successul or failed. Always in UTC. | [optional] 
+**retry_of** | **String** | If this field is set, then this job is a retry of the ID in this field. | [optional] 
+**retry_at** | **String** | If this field is set, then this job was retried by the job referenced in this field. | [optional] 
+**env_vars** | **Hash<String, String>** | Env vars for the task. Comes from the ones set on the Group. | [optional] 
+
+

data/docs/JobWrapper.md

@@ -0,0 +1,8 @@
+# IronTitan::JobWrapper
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**job** | [**Job**](Job.md) |  | 
+
+

data/docs/JobsApi.md

@@ -0,0 +1,684 @@
+# IronTitan::JobsApi
+
+All URIs are relative to *https://localhost:8080/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**groups_name_jobs_get**](JobsApi.md#groups_name_jobs_get) | **GET** /groups/{name}/jobs | Get job list by group name.
+[**groups_name_jobs_id_cancel_post**](JobsApi.md#groups_name_jobs_id_cancel_post) | **POST** /groups/{name}/jobs/{id}/cancel | Cancel a job.
+[**groups_name_jobs_id_delete**](JobsApi.md#groups_name_jobs_id_delete) | **DELETE** /groups/{name}/jobs/{id} | Delete the job.
+[**groups_name_jobs_id_error_post**](JobsApi.md#groups_name_jobs_id_error_post) | **POST** /groups/{name}/jobs/{id}/error | Mark job as failed.
+[**groups_name_jobs_id_get**](JobsApi.md#groups_name_jobs_id_get) | **GET** /groups/{name}/jobs/{id} | Gets job by id
+[**groups_name_jobs_id_log_get**](JobsApi.md#groups_name_jobs_id_log_get) | **GET** /groups/{name}/jobs/{id}/log | Get the log of a completed job.
+[**groups_name_jobs_id_log_post**](JobsApi.md#groups_name_jobs_id_log_post) | **POST** /groups/{name}/jobs/{id}/log | Send in a log for storage.
+[**groups_name_jobs_id_retry_post**](JobsApi.md#groups_name_jobs_id_retry_post) | **POST** /groups/{name}/jobs/{id}/retry | Retry a job.
+[**groups_name_jobs_id_start_post**](JobsApi.md#groups_name_jobs_id_start_post) | **POST** /groups/{name}/jobs/{id}/start | Mark job as started, ie: status = 'running'
+[**groups_name_jobs_id_success_post**](JobsApi.md#groups_name_jobs_id_success_post) | **POST** /groups/{name}/jobs/{id}/success | Mark job as succeeded.
+[**groups_name_jobs_id_touch_post**](JobsApi.md#groups_name_jobs_id_touch_post) | **POST** /groups/{name}/jobs/{id}/touch | Extend job timeout.
+[**groups_name_jobs_post**](JobsApi.md#groups_name_jobs_post) | **POST** /groups/{name}/jobs | Enqueue Job
+[**jobs_get**](JobsApi.md#jobs_get) | **GET** /jobs | Get next job.
+
+
+# **groups_name_jobs_get**
+> JobsWrapper groups_name_jobs_get(name, opts)
+
+Get job list by group name.
+
+This will list jobs for a particular group.
+
+### Example
+```ruby
+# load the gem
+require 'iron_titan'
+
+api_instance = IronTitan::JobsApi.new
+
+name = "name_example" # String | Name of group for this set of jobs.
+
+opts = { 
+  created_after: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | Will return jobs created after this time. In RFC3339 format.
+  n: 56, # Integer | Number of jobs to return per page. Default is 50. Max is 1000.
+  cursor: "cursor_example" # String | Pass this in from a previous query to paginate results.
+}
+
+begin
+  #Get job list by group name.
+  result = api_instance.groups_name_jobs_get(name, opts)
+  p result
+rescue IronTitan::ApiError => e
+  puts "Exception when calling JobsApi->groups_name_jobs_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**| Name of group for this set of jobs. | 
+ **created_after** | **DateTime**| Will return jobs created after this time. In RFC3339 format. | [optional] 
+ **n** | **Integer**| Number of jobs to return per page. Default is 50. Max is 1000. | [optional] 
+ **cursor** | **String**| Pass this in from a previous query to paginate results. | [optional] 
+
+### Return type
+
+[**JobsWrapper**](JobsWrapper.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **groups_name_jobs_id_cancel_post**
+> JobWrapper groups_name_jobs_id_cancel_post(name, id)
+
+Cancel a job.
+
+Cancels a job in delayed, queued or running status. The worker may continue to run a running job. reason is set to `client_request`. The job's completed_at field is set to the current time on the jobserver.
+
+### Example
+```ruby
+# load the gem
+require 'iron_titan'
+
+api_instance = IronTitan::JobsApi.new
+
+name = "name_example" # String | Name of group for this set of jobs.
+
+id = "id_example" # String | Job id
+
+
+begin
+  #Cancel a job.
+  result = api_instance.groups_name_jobs_id_cancel_post(name, id)
+  p result
+rescue IronTitan::ApiError => e
+  puts "Exception when calling JobsApi->groups_name_jobs_id_cancel_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**| Name of group for this set of jobs. | 
+ **id** | **String**| Job id | 
+
+### Return type
+
+[**JobWrapper**](JobWrapper.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **groups_name_jobs_id_delete**
+> groups_name_jobs_id_delete(name, id)
+
+Delete the job.
+
+Delete only succeeds if job status is one of `succeeded | failed | cancelled`. Cancel a job if it is another state and needs to be deleted.  All information about the job, including the log, is irretrievably lost when this is invoked. 
+
+### Example
+```ruby
+# load the gem
+require 'iron_titan'
+
+api_instance = IronTitan::JobsApi.new
+
+name = "name_example" # String | Name of group for this set of jobs.
+
+id = "id_example" # String | Job id
+
+
+begin
+  #Delete the job.
+  api_instance.groups_name_jobs_id_delete(name, id)
+rescue IronTitan::ApiError => e
+  puts "Exception when calling JobsApi->groups_name_jobs_id_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**| Name of group for this set of jobs. | 
+ **id** | **String**| Job id | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **groups_name_jobs_id_error_post**
+> JobWrapper groups_name_jobs_id_error_post(name, id, body)
+
+Mark job as failed.
+
+Job is marked as failed if it was in a valid state. Job's `finished_at` time is initialized.
+
+### Example
+```ruby
+# load the gem
+require 'iron_titan'
+
+api_instance = IronTitan::JobsApi.new
+
+name = "name_example" # String | Name of group for this set of jobs.
+
+id = "id_example" # String | Job id
+
+body = IronTitan::Complete.new # Complete | 
+
+
+begin
+  #Mark job as failed.
+  result = api_instance.groups_name_jobs_id_error_post(name, id, body)
+  p result
+rescue IronTitan::ApiError => e
+  puts "Exception when calling JobsApi->groups_name_jobs_id_error_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**| Name of group for this set of jobs. | 
+ **id** | **String**| Job id | 
+ **body** | [**Complete**](Complete.md)|  | 
+
+### Return type
+
+[**JobWrapper**](JobWrapper.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **groups_name_jobs_id_get**
+> JobWrapper groups_name_jobs_id_get(name, id)
+
+Gets job by id
+
+Gets a job by id.
+
+### Example
+```ruby
+# load the gem
+require 'iron_titan'
+
+api_instance = IronTitan::JobsApi.new
+
+name = "name_example" # String | Name of group for this set of jobs.
+
+id = "id_example" # String | Job id
+
+
+begin
+  #Gets job by id
+  result = api_instance.groups_name_jobs_id_get(name, id)
+  p result
+rescue IronTitan::ApiError => e
+  puts "Exception when calling JobsApi->groups_name_jobs_id_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**| Name of group for this set of jobs. | 
+ **id** | **String**| Job id | 
+
+### Return type
+
+[**JobWrapper**](JobWrapper.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **groups_name_jobs_id_log_get**
+> String groups_name_jobs_id_log_get(name, id)
+
+Get the log of a completed job.
+
+Retrieves the log from log storage.
+
+### Example
+```ruby
+# load the gem
+require 'iron_titan'
+
+api_instance = IronTitan::JobsApi.new
+
+name = "name_example" # String | Name of group for this set of jobs.
+
+id = "id_example" # String | Job id
+
+
+begin
+  #Get the log of a completed job.
+  result = api_instance.groups_name_jobs_id_log_get(name, id)
+  p result
+rescue IronTitan::ApiError => e
+  puts "Exception when calling JobsApi->groups_name_jobs_id_log_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**| Name of group for this set of jobs. | 
+ **id** | **String**| Job id | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: text/plain
+
+
+
+# **groups_name_jobs_id_log_post**
+> JobWrapper groups_name_jobs_id_log_post(name, id, log)
+
+Send in a log for storage.
+
+Logs are sent after a job completes since they may be very large and the runner can process the next job.
+
+### Example
+```ruby
+# load the gem
+require 'iron_titan'
+
+api_instance = IronTitan::JobsApi.new
+
+name = "name_example" # String | Name of group for this set of jobs.
+
+id = "id_example" # String | Job id
+
+log = File.new("/path/to/file.txt") # File | Output log for the job. Content-Type must be \"text/plain; charset=utf-8\".
+
+
+begin
+  #Send in a log for storage.
+  result = api_instance.groups_name_jobs_id_log_post(name, id, log)
+  p result
+rescue IronTitan::ApiError => e
+  puts "Exception when calling JobsApi->groups_name_jobs_id_log_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**| Name of group for this set of jobs. | 
+ **id** | **String**| Job id | 
+ **log** | **File**| Output log for the job. Content-Type must be \"text/plain; charset=utf-8\". | 
+
+### Return type
+
+[**JobWrapper**](JobWrapper.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json
+
+
+
+# **groups_name_jobs_id_retry_post**
+> JobWrapper groups_name_jobs_id_retry_post(name, id)
+
+Retry a job.
+
+\"The /retry endpoint can be used to force a retry of jobs with status succeeded or cancelled. It can also be used to retry jobs that in the failed state, but whose max_retries field is 0. The retried job will continue to have max_retries = 0.\" 
+
+### Example
+```ruby
+# load the gem
+require 'iron_titan'
+
+api_instance = IronTitan::JobsApi.new
+
+name = "name_example" # String | Name of group for this set of jobs.
+
+id = "id_example" # String | Job id
+
+
+begin
+  #Retry a job.
+  result = api_instance.groups_name_jobs_id_retry_post(name, id)
+  p result
+rescue IronTitan::ApiError => e
+  puts "Exception when calling JobsApi->groups_name_jobs_id_retry_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**| Name of group for this set of jobs. | 
+ **id** | **String**| Job id | 
+
+### Return type
+
+[**JobWrapper**](JobWrapper.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **groups_name_jobs_id_start_post**
+> JobWrapper groups_name_jobs_id_start_post(name, id, body)
+
+Mark job as started, ie: status = 'running'
+
+Job status is changed to 'running' if it was in a valid state before. Job's `started_at` time is initialized.
+
+### Example
+```ruby
+# load the gem
+require 'iron_titan'
+
+api_instance = IronTitan::JobsApi.new
+
+name = "name_example" # String | Name of group for this set of jobs.
+
+id = "id_example" # String | Job id
+
+body = IronTitan::Start.new # Start | 
+
+
+begin
+  #Mark job as started, ie: status = 'running'
+  result = api_instance.groups_name_jobs_id_start_post(name, id, body)
+  p result
+rescue IronTitan::ApiError => e
+  puts "Exception when calling JobsApi->groups_name_jobs_id_start_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**| Name of group for this set of jobs. | 
+ **id** | **String**| Job id | 
+ **body** | [**Start**](Start.md)|  | 
+
+### Return type
+
+[**JobWrapper**](JobWrapper.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **groups_name_jobs_id_success_post**
+> JobWrapper groups_name_jobs_id_success_post(name, id, body)
+
+Mark job as succeeded.
+
+Job status is changed to succeeded if it was in a valid state before. Job's `completed_at` time is initialized.
+
+### Example
+```ruby
+# load the gem
+require 'iron_titan'
+
+api_instance = IronTitan::JobsApi.new
+
+name = "name_example" # String | Name of group for this set of jobs.
+
+id = "id_example" # String | Job id
+
+body = IronTitan::Complete.new # Complete | 
+
+
+begin
+  #Mark job as succeeded.
+  result = api_instance.groups_name_jobs_id_success_post(name, id, body)
+  p result
+rescue IronTitan::ApiError => e
+  puts "Exception when calling JobsApi->groups_name_jobs_id_success_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**| Name of group for this set of jobs. | 
+ **id** | **String**| Job id | 
+ **body** | [**Complete**](Complete.md)|  | 
+
+### Return type
+
+[**JobWrapper**](JobWrapper.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **groups_name_jobs_id_touch_post**
+> groups_name_jobs_id_touch_post(name, id)
+
+Extend job timeout.
+
+Consumers can sometimes take a while to run the task after accepting it.  An example is when the runner does not have the docker image locally, it can spend a significant time downloading the image. If the timeout is small, the job may never get to run, or run but not be accepted by Titan. Consumers can touch the job before it times out. Titan will reset the timeout, giving the consumer another timeout seconds to run the job. Touch is only valid while the job is in a running state. If touch fails, the runner may stop running the job. 
+
+### Example
+```ruby
+# load the gem
+require 'iron_titan'
+
+api_instance = IronTitan::JobsApi.new
+
+name = "name_example" # String | Name of group for this set of jobs.
+
+id = "id_example" # String | Job id
+
+
+begin
+  #Extend job timeout.
+  api_instance.groups_name_jobs_id_touch_post(name, id)
+rescue IronTitan::ApiError => e
+  puts "Exception when calling JobsApi->groups_name_jobs_id_touch_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**| Name of group for this set of jobs. | 
+ **id** | **String**| Job id | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **groups_name_jobs_post**
+> JobsWrapper groups_name_jobs_post(name, body)
+
+Enqueue Job
+
+Enqueues job(s). If any of the jobs is invalid, none of the jobs are enqueued. 
+
+### Example
+```ruby
+# load the gem
+require 'iron_titan'
+
+api_instance = IronTitan::JobsApi.new
+
+name = "name_example" # String | name of the group.
+
+body = IronTitan::NewJobsWrapper.new # NewJobsWrapper | Array of jobs to post.
+
+
+begin
+  #Enqueue Job
+  result = api_instance.groups_name_jobs_post(name, body)
+  p result
+rescue IronTitan::ApiError => e
+  puts "Exception when calling JobsApi->groups_name_jobs_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**| name of the group. | 
+ **body** | [**NewJobsWrapper**](NewJobsWrapper.md)| Array of jobs to post. | 
+
+### Return type
+
+[**JobsWrapper**](JobsWrapper.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **jobs_get**
+> JobsWrapper jobs_get(opts)
+
+Get next job.
+
+Gets the next job in the queue, ready for processing. Titan may return <=n jobs. Consumers should start processing jobs in order. Each returned job is set to `status` \"running\" and `started_at` is set to the current time. No other consumer can retrieve this job.
+
+### Example
+```ruby
+# load the gem
+require 'iron_titan'
+
+api_instance = IronTitan::JobsApi.new
+
+opts = { 
+  n: 1 # Integer | Number of jobs to return.
+}
+
+begin
+  #Get next job.
+  result = api_instance.jobs_get(opts)
+  p result
+rescue IronTitan::ApiError => e
+  puts "Exception when calling JobsApi->jobs_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **n** | **Integer**| Number of jobs to return. | [optional] [default to 1]
+
+### Return type
+
+[**JobsWrapper**](JobsWrapper.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+