hatchet-sdk 0.0.1 → 0.1.0.pre.alpha

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

@@ -0,0 +1,72 @@
+# HatchetSdkRest::V1TaskSummary
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | [**APIResourceMeta**](APIResourceMeta.md) |  |  |
+| **created_at** | **Time** | The timestamp the task was created. |  |
+| **display_name** | **String** | The display name of the task run. |  |
+| **input** | **Object** | The input of the task run. |  |
+| **num_spawned_children** | **Integer** | The number of spawned children tasks |  |
+| **output** | **Object** | The output of the task run (for the latest run) |  |
+| **status** | [**V1TaskStatus**](V1TaskStatus.md) |  |  |
+| **task_external_id** | **String** | The external ID of the task. |  |
+| **task_id** | **Integer** | The ID of the task. |  |
+| **task_inserted_at** | **Time** | The timestamp the task was inserted. |  |
+| **tenant_id** | **String** | The ID of the tenant. |  |
+| **type** | [**V1WorkflowType**](V1WorkflowType.md) | The type of the workflow (whether it's a DAG or a task) |  |
+| **workflow_id** | **String** |  |  |
+| **workflow_run_external_id** | **String** | The external ID of the workflow run |  |
+| **action_id** | **String** | The action ID of the task. | [optional] |
+| **retry_count** | **Integer** | The number of retries of the task. | [optional] |
+| **attempt** | **Integer** | The attempt number of the task. | [optional] |
+| **additional_metadata** | **Object** | Additional metadata for the task run. | [optional] |
+| **children** | [**Array<V1TaskSummary>**](V1TaskSummary.md) | The list of children tasks | [optional] |
+| **duration** | **Integer** | The duration of the task run, in milliseconds. | [optional] |
+| **error_message** | **String** | The error message of the task run (for the latest run) | [optional] |
+| **finished_at** | **Time** | The timestamp the task run finished. | [optional] |
+| **started_at** | **Time** | The timestamp the task run started. | [optional] |
+| **step_id** | **String** | The step ID of the task. | [optional] |
+| **workflow_name** | **String** |  | [optional] |
+| **workflow_version_id** | **String** | The version ID of the workflow | [optional] |
+| **workflow_config** | **Object** |  | [optional] |
+| **parent_task_external_id** | **String** | The external ID of the parent task. | [optional] |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::V1TaskSummary.new(
+  metadata: null,
+  created_at: null,
+  display_name: null,
+  input: null,
+  num_spawned_children: null,
+  output: null,
+  status: null,
+  task_external_id: null,
+  task_id: null,
+  task_inserted_at: null,
+  tenant_id: bb214807-246e-43a5-a25d-41761d1cff9e,
+  type: null,
+  workflow_id: null,
+  workflow_run_external_id: null,
+  action_id: null,
+  retry_count: null,
+  attempt: null,
+  additional_metadata: null,
+  children: null,
+  duration: null,
+  error_message: null,
+  finished_at: null,
+  started_at: null,
+  step_id: null,
+  workflow_name: null,
+  workflow_version_id: null,
+  workflow_config: null,
+  parent_task_external_id: null
+)
+```
+

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

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

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

@@ -0,0 +1,46 @@
+# HatchetSdkRest::V1TaskTiming
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | [**APIResourceMeta**](APIResourceMeta.md) |  |  |
+| **depth** | **Integer** | The depth of the task in the waterfall. |  |
+| **status** | [**V1TaskStatus**](V1TaskStatus.md) |  |  |
+| **task_display_name** | **String** | The display name of the task run. |  |
+| **task_external_id** | **String** | The external ID of the task. |  |
+| **task_id** | **Integer** | The ID of the task. |  |
+| **task_inserted_at** | **Time** | The timestamp the task was inserted. |  |
+| **tenant_id** | **String** | The ID of the tenant. |  |
+| **parent_task_external_id** | **String** | The external ID of the parent task. | [optional] |
+| **queued_at** | **Time** | The timestamp the task run was queued. | [optional] |
+| **started_at** | **Time** | The timestamp the task run started. | [optional] |
+| **finished_at** | **Time** | The timestamp the task run finished. | [optional] |
+| **workflow_run_id** | **String** | The external ID of the workflow run. | [optional] |
+| **retry_count** | **Integer** | The number of retries of the task. | [optional] |
+| **attempt** | **Integer** | The attempt number of the task. | [optional] |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::V1TaskTiming.new(
+  metadata: null,
+  depth: null,
+  status: null,
+  task_display_name: null,
+  task_external_id: null,
+  task_id: null,
+  task_inserted_at: null,
+  tenant_id: bb214807-246e-43a5-a25d-41761d1cff9e,
+  parent_task_external_id: null,
+  queued_at: null,
+  started_at: null,
+  finished_at: null,
+  workflow_run_id: null,
+  retry_count: null,
+  attempt: null
+)
+```
+

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

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

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

@@ -0,0 +1,24 @@
+# HatchetSdkRest::V1TriggerWorkflowRunRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workflow_name** | **String** | The name of the workflow. |  |
+| **input** | **Object** |  |  |
+| **additional_metadata** | **Object** |  | [optional] |
+| **priority** | **Integer** | The priority of the workflow run. | [optional] |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::V1TriggerWorkflowRunRequest.new(
+  workflow_name: null,
+  input: null,
+  additional_metadata: null,
+  priority: null
+)
+```
+

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

@@ -0,0 +1,22 @@
+# HatchetSdkRest::V1UpdateFilterRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **expression** | **String** | The expression for the filter | [optional] |
+| **scope** | **String** | The scope associated with this filter. Used for subsetting candidate filters at evaluation time | [optional] |
+| **payload** | **Object** | The payload for the filter | [optional] |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::V1UpdateFilterRequest.new(
+  expression: null,
+  scope: null,
+  payload: null
+)
+```
+

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

@@ -0,0 +1,46 @@
+# HatchetSdkRest::V1WorkflowRun
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | [**APIResourceMeta**](APIResourceMeta.md) |  |  |
+| **status** | [**V1TaskStatus**](V1TaskStatus.md) |  |  |
+| **tenant_id** | **String** | The ID of the tenant. |  |
+| **display_name** | **String** | The display name of the task run. |  |
+| **workflow_id** | **String** |  |  |
+| **output** | **Object** | The output of the task run (for the latest run) |  |
+| **input** | **Object** | The input of the task run. |  |
+| **started_at** | **Time** | The timestamp the task run started. | [optional] |
+| **finished_at** | **Time** | The timestamp the task run finished. | [optional] |
+| **duration** | **Integer** | The duration of the task run, in milliseconds. | [optional] |
+| **additional_metadata** | **Object** | Additional metadata for the task run. | [optional] |
+| **error_message** | **String** | The error message of the task run (for the latest run) | [optional] |
+| **workflow_version_id** | **String** | The ID of the workflow version. | [optional] |
+| **created_at** | **Time** | The timestamp the task run was created. | [optional] |
+| **parent_task_external_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::V1WorkflowRun.new(
+  metadata: null,
+  status: null,
+  tenant_id: bb214807-246e-43a5-a25d-41761d1cff9e,
+  display_name: null,
+  workflow_id: null,
+  output: null,
+  input: null,
+  started_at: null,
+  finished_at: null,
+  duration: null,
+  additional_metadata: null,
+  error_message: null,
+  workflow_version_id: null,
+  created_at: null,
+  parent_task_external_id: null
+)
+```
+

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

@@ -0,0 +1,26 @@
+# HatchetSdkRest::V1WorkflowRunDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **run** | [**V1WorkflowRun**](V1WorkflowRun.md) |  |  |
+| **task_events** | [**Array<V1TaskEvent>**](V1TaskEvent.md) | The list of task events for the workflow run |  |
+| **shape** | [**Array<WorkflowRunShapeItemForWorkflowRunDetails>**](WorkflowRunShapeItemForWorkflowRunDetails.md) |  |  |
+| **tasks** | [**Array<V1TaskSummary>**](V1TaskSummary.md) |  |  |
+| **workflow_config** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::V1WorkflowRunDetails.new(
+  run: null,
+  task_events: null,
+  shape: null,
+  tasks: null,
+  workflow_config: null
+)
+```
+

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

@@ -0,0 +1,20 @@
+# HatchetSdkRest::V1WorkflowRunDisplayName
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | [**APIResourceMeta**](APIResourceMeta.md) |  |  |
+| **display_name** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::V1WorkflowRunDisplayName.new(
+  metadata: null,
+  display_name: null
+)
+```
+

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

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

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

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

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

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

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

@@ -0,0 +1,22 @@
+# HatchetSdkRest::WebhookWorkerCreateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the webhook worker. |  |
+| **url** | **String** | The webhook url. |  |
+| **secret** | **String** | The secret key for validation. If not provided, a random secret will be generated. | [optional] |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::WebhookWorkerCreateRequest.new(
+  name: null,
+  url: null,
+  secret: null
+)
+```
+

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

@@ -0,0 +1,18 @@
+# HatchetSdkRest::WebhookWorkerCreateResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **worker** | [**WebhookWorkerCreated**](WebhookWorkerCreated.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::WebhookWorkerCreateResponse.new(
+  worker: null
+)
+```
+

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

@@ -0,0 +1,24 @@
+# HatchetSdkRest::WebhookWorkerCreated
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | [**APIResourceMeta**](APIResourceMeta.md) |  |  |
+| **name** | **String** | The name of the webhook worker. |  |
+| **url** | **String** | The webhook url. |  |
+| **secret** | **String** | The secret key for validation. |  |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::WebhookWorkerCreated.new(
+  metadata: null,
+  name: null,
+  url: null,
+  secret: null
+)
+```
+

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

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

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

@@ -0,0 +1,22 @@
+# HatchetSdkRest::WebhookWorkerRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_at** | **Time** | The date and time the request was created. |  |
+| **method** | [**WebhookWorkerRequestMethod**](WebhookWorkerRequestMethod.md) | The HTTP method used for the request. |  |
+| **status_code** | **Integer** | The HTTP status code of the response. |  |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::WebhookWorkerRequest.new(
+  created_at: null,
+  method: null,
+  status_code: null
+)
+```
+

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

@@ -0,0 +1,18 @@
+# HatchetSdkRest::WebhookWorkerRequestListResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **requests** | [**Array<WebhookWorkerRequest>**](WebhookWorkerRequest.md) | The list of webhook requests. | [optional] |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::WebhookWorkerRequestListResponse.new(
+  requests: null
+)
+```
+

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

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

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

@@ -0,0 +1,48 @@
+# HatchetSdkRest::Worker
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | [**APIResourceMeta**](APIResourceMeta.md) |  |  |
+| **name** | **String** | The name of the worker. |  |
+| **type** | [**WorkerType**](WorkerType.md) |  |  |
+| **last_heartbeat_at** | **Time** | The time this worker last sent a heartbeat. | [optional] |
+| **last_listener_established** | **Time** | The time this worker last sent a heartbeat. | [optional] |
+| **actions** | **Array<String>** | The actions this worker can perform. | [optional] |
+| **slots** | [**Array<SemaphoreSlots>**](SemaphoreSlots.md) | The semaphore slot state for the worker. | [optional] |
+| **recent_step_runs** | [**Array<RecentStepRuns>**](RecentStepRuns.md) | The recent step runs for the worker. | [optional] |
+| **status** | **String** | The status of the worker. | [optional] |
+| **max_runs** | **Integer** | The maximum number of runs this worker can execute concurrently. | [optional] |
+| **available_runs** | **Integer** | The number of runs this worker can execute concurrently. | [optional] |
+| **dispatcher_id** | **String** | the id of the assigned dispatcher, in UUID format | [optional] |
+| **labels** | [**Array<WorkerLabel>**](WorkerLabel.md) | The current label state of the worker. | [optional] |
+| **webhook_url** | **String** | The webhook URL for the worker. | [optional] |
+| **webhook_id** | **String** | The webhook ID for the worker. | [optional] |
+| **runtime_info** | [**WorkerRuntimeInfo**](WorkerRuntimeInfo.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::Worker.new(
+  metadata: null,
+  name: null,
+  type: null,
+  last_heartbeat_at: 2022-12-13T15:06:48.888358-05:00,
+  last_listener_established: 2022-12-13T15:06:48.888358-05:00,
+  actions: null,
+  slots: null,
+  recent_step_runs: null,
+  status: null,
+  max_runs: null,
+  available_runs: null,
+  dispatcher_id: bb214807-246e-43a5-a25d-41761d1cff9e,
+  labels: null,
+  webhook_url: null,
+  webhook_id: null,
+  runtime_info: null
+)
+```
+