hatchet-sdk 0.0.1 → 0.1.0.pre.alpha

data/lib/hatchet/clients/rest/docs/WorkerApi.md

@@ -0,0 +1,234 @@
+# HatchetSdkRest::WorkerApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**worker_get**](WorkerApi.md#worker_get) | **GET** /api/v1/workers/{worker} | Get worker |
+| [**worker_list**](WorkerApi.md#worker_list) | **GET** /api/v1/tenants/{tenant}/worker | Get workers |
+| [**worker_update**](WorkerApi.md#worker_update) | **PATCH** /api/v1/workers/{worker} | Update worker |
+
+
+## worker_get
+
+> <Worker> worker_get(worker)
+
+Get worker
+
+Get a worker
+
+### Examples
+
+```ruby
+require 'time'
+require 'hatchet-sdk-rest'
+# setup authorization
+HatchetSdkRest.configure do |config|
+  # Configure API key authorization: cookieAuth
+  config.api_key['hatchet'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['hatchet'] = 'Bearer'
+
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = HatchetSdkRest::WorkerApi.new
+worker = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The worker id
+
+begin
+  # Get worker
+  result = api_instance.worker_get(worker)
+  p result
+rescue HatchetSdkRest::ApiError => e
+  puts "Error when calling WorkerApi->worker_get: #{e}"
+end
+```
+
+#### Using the worker_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Worker>, Integer, Hash)> worker_get_with_http_info(worker)
+
+```ruby
+begin
+  # Get worker
+  data, status_code, headers = api_instance.worker_get_with_http_info(worker)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Worker>
+rescue HatchetSdkRest::ApiError => e
+  puts "Error when calling WorkerApi->worker_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **worker** | **String** | The worker id |  |
+
+### Return type
+
+[**Worker**](Worker.md)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## worker_list
+
+> <WorkerList> worker_list(tenant)
+
+Get workers
+
+Get all workers for a tenant
+
+### Examples
+
+```ruby
+require 'time'
+require 'hatchet-sdk-rest'
+# setup authorization
+HatchetSdkRest.configure do |config|
+  # Configure API key authorization: cookieAuth
+  config.api_key['hatchet'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['hatchet'] = 'Bearer'
+
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = HatchetSdkRest::WorkerApi.new
+tenant = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The tenant id
+
+begin
+  # Get workers
+  result = api_instance.worker_list(tenant)
+  p result
+rescue HatchetSdkRest::ApiError => e
+  puts "Error when calling WorkerApi->worker_list: #{e}"
+end
+```
+
+#### Using the worker_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<WorkerList>, Integer, Hash)> worker_list_with_http_info(tenant)
+
+```ruby
+begin
+  # Get workers
+  data, status_code, headers = api_instance.worker_list_with_http_info(tenant)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <WorkerList>
+rescue HatchetSdkRest::ApiError => e
+  puts "Error when calling WorkerApi->worker_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tenant** | **String** | The tenant id |  |
+
+### Return type
+
+[**WorkerList**](WorkerList.md)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## worker_update
+
+> <Worker> worker_update(worker, update_worker_request)
+
+Update worker
+
+Update a worker
+
+### Examples
+
+```ruby
+require 'time'
+require 'hatchet-sdk-rest'
+# setup authorization
+HatchetSdkRest.configure do |config|
+  # Configure API key authorization: cookieAuth
+  config.api_key['hatchet'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['hatchet'] = 'Bearer'
+
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = HatchetSdkRest::WorkerApi.new
+worker = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The worker id
+update_worker_request = HatchetSdkRest::UpdateWorkerRequest.new # UpdateWorkerRequest | The worker update
+
+begin
+  # Update worker
+  result = api_instance.worker_update(worker, update_worker_request)
+  p result
+rescue HatchetSdkRest::ApiError => e
+  puts "Error when calling WorkerApi->worker_update: #{e}"
+end
+```
+
+#### Using the worker_update_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Worker>, Integer, Hash)> worker_update_with_http_info(worker, update_worker_request)
+
+```ruby
+begin
+  # Update worker
+  data, status_code, headers = api_instance.worker_update_with_http_info(worker, update_worker_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Worker>
+rescue HatchetSdkRest::ApiError => e
+  puts "Error when calling WorkerApi->worker_update_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **worker** | **String** | The worker id |  |
+| **update_worker_request** | [**UpdateWorkerRequest**](UpdateWorkerRequest.md) | The worker update |  |
+
+### Return type
+
+[**Worker**](Worker.md)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/lib/hatchet/clients/rest/docs/WorkerLabel.md

@@ -0,0 +1,22 @@
+# HatchetSdkRest::WorkerLabel
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | [**APIResourceMeta**](APIResourceMeta.md) |  |  |
+| **key** | **String** | The key of the label. |  |
+| **value** | **String** | The value of the label. | [optional] |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::WorkerLabel.new(
+  metadata: null,
+  key: null,
+  value: null
+)
+```
+

data/lib/hatchet/clients/rest/docs/WorkerList.md

@@ -0,0 +1,20 @@
+# HatchetSdkRest::WorkerList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pagination** | [**PaginationResponse**](PaginationResponse.md) |  | [optional] |
+| **rows** | [**Array<Worker>**](Worker.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::WorkerList.new(
+  pagination: null,
+  rows: null
+)
+```
+

data/lib/hatchet/clients/rest/docs/WorkerRuntimeInfo.md

@@ -0,0 +1,26 @@
+# HatchetSdkRest::WorkerRuntimeInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sdk_version** | **String** |  | [optional] |
+| **language** | [**WorkerRuntimeSDKs**](WorkerRuntimeSDKs.md) |  | [optional] |
+| **language_version** | **String** |  | [optional] |
+| **os** | **String** |  | [optional] |
+| **runtime_extra** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::WorkerRuntimeInfo.new(
+  sdk_version: null,
+  language: null,
+  language_version: null,
+  os: null,
+  runtime_extra: null
+)
+```
+

data/lib/hatchet/clients/rest/docs/WorkerRuntimeSDKs.md

@@ -0,0 +1,15 @@
+# HatchetSdkRest::WorkerRuntimeSDKs
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::WorkerRuntimeSDKs.new()
+```
+

data/lib/hatchet/clients/rest/docs/WorkerType.md

@@ -0,0 +1,15 @@
+# HatchetSdkRest::WorkerType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::WorkerType.new()
+```
+

data/lib/hatchet/clients/rest/docs/Workflow.md

@@ -0,0 +1,32 @@
+# HatchetSdkRest::Workflow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | [**APIResourceMeta**](APIResourceMeta.md) |  |  |
+| **name** | **String** | The name of the workflow. |  |
+| **tenant_id** | **String** | The tenant id of the workflow. |  |
+| **description** | **String** | The description of the workflow. | [optional] |
+| **is_paused** | **Boolean** | Whether the workflow is paused. | [optional] |
+| **versions** | [**Array<WorkflowVersionMeta>**](WorkflowVersionMeta.md) |  | [optional] |
+| **tags** | [**Array<WorkflowTag>**](WorkflowTag.md) | The tags of the workflow. | [optional] |
+| **jobs** | [**Array<Job>**](Job.md) | The jobs of the workflow. | [optional] |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::Workflow.new(
+  metadata: null,
+  name: null,
+  tenant_id: null,
+  description: null,
+  is_paused: null,
+  versions: null,
+  tags: null,
+  jobs: null
+)
+```
+