hatchet-sdk 0.0.1 → 0.1.0.pre.alpha

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

@@ -0,0 +1,20 @@
+# HatchetSdkRest::UserChangePasswordRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **password** | **String** | The password of the user. |  |
+| **new_password** | **String** | The new password for the user. |  |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::UserChangePasswordRequest.new(
+  password: null,
+  new_password: null
+)
+```
+

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

@@ -0,0 +1,20 @@
+# HatchetSdkRest::UserLoginRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | The email address of the user. |  |
+| **password** | **String** | The password of the user. |  |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::UserLoginRequest.new(
+  email: null,
+  password: null
+)
+```
+

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

@@ -0,0 +1,22 @@
+# HatchetSdkRest::UserRegisterRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the user. |  |
+| **email** | **String** | The email address of the user. |  |
+| **password** | **String** | The password of the user. |  |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::UserRegisterRequest.new(
+  name: null,
+  email: null,
+  password: null
+)
+```
+

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

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

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

@@ -0,0 +1,20 @@
+# HatchetSdkRest::UserTenantPublic
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | The email address of the user. |  |
+| **name** | **String** | The display name of the user. | [optional] |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::UserTenantPublic.new(
+  email: null,
+  name: null
+)
+```
+

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

@@ -0,0 +1,20 @@
+# HatchetSdkRest::V1CancelTaskRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **external_ids** | **Array<String>** | A list of external IDs, which can refer to either task or workflow run external IDs | [optional] |
+| **filter** | [**V1TaskFilter**](V1TaskFilter.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::V1CancelTaskRequest.new(
+  external_ids: null,
+  filter: null
+)
+```
+

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

@@ -0,0 +1,18 @@
+# HatchetSdkRest::V1CancelledTasks
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ids** | **Array<String>** | The list of task external ids that were cancelled | [optional] |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::V1CancelledTasks.new(
+  ids: null
+)
+```
+

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

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

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

@@ -0,0 +1,20 @@
+# HatchetSdkRest::V1DagChildren
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **dag_id** | **String** |  | [optional] |
+| **children** | [**Array<V1TaskSummary>**](V1TaskSummary.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::V1DagChildren.new(
+  dag_id: null,
+  children: null
+)
+```
+

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

@@ -0,0 +1,36 @@
+# HatchetSdkRest::V1Event
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | [**APIResourceMeta**](APIResourceMeta.md) |  |  |
+| **key** | **String** | The key for the event. |  |
+| **tenant_id** | **String** | The ID of the tenant associated with this event. |  |
+| **workflow_run_summary** | [**V1EventWorkflowRunSummary**](V1EventWorkflowRunSummary.md) | The workflow run summary for this event. |  |
+| **tenant** | [**Tenant**](Tenant.md) | The tenant associated with this event. | [optional] |
+| **additional_metadata** | **Object** | Additional metadata for the event. | [optional] |
+| **payload** | **Object** | The payload of the event, which can be any JSON-serializable object. | [optional] |
+| **scope** | **String** | The scope of the event, which can be used to filter or categorize events. | [optional] |
+| **seen_at** | **Time** | The timestamp when the event was seen. | [optional] |
+| **triggered_runs** | [**Array<V1EventTriggeredRun>**](V1EventTriggeredRun.md) | The external IDs of the runs that were triggered by this event. | [optional] |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::V1Event.new(
+  metadata: null,
+  key: null,
+  tenant_id: null,
+  workflow_run_summary: null,
+  tenant: null,
+  additional_metadata: null,
+  payload: null,
+  scope: null,
+  seen_at: null,
+  triggered_runs: null
+)
+```
+

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

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

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

@@ -0,0 +1,20 @@
+# HatchetSdkRest::V1EventTriggeredRun
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workflow_run_id** | **String** | The external ID of the triggered run. |  |
+| **filter_id** | **String** | The ID of the filter that triggered the run, if applicable. | [optional] |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::V1EventTriggeredRun.new(
+  workflow_run_id: null,
+  filter_id: null
+)
+```
+

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

@@ -0,0 +1,26 @@
+# HatchetSdkRest::V1EventWorkflowRunSummary
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **running** | **Integer** | The number of running runs. |  |
+| **queued** | **Integer** | The number of queued runs. |  |
+| **succeeded** | **Integer** | The number of succeeded runs. |  |
+| **failed** | **Integer** | The number of failed runs. |  |
+| **cancelled** | **Integer** | The number of cancelled runs. |  |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::V1EventWorkflowRunSummary.new(
+  running: null,
+  queued: null,
+  succeeded: null,
+  failed: null,
+  cancelled: null
+)
+```
+

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

@@ -0,0 +1,28 @@
+# HatchetSdkRest::V1Filter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | [**APIResourceMeta**](APIResourceMeta.md) |  |  |
+| **tenant_id** | **String** | The ID of the tenant associated with this filter. |  |
+| **workflow_id** | **String** | The workflow id associated with this filter. |  |
+| **scope** | **String** | The scope associated with this filter. Used for subsetting candidate filters at evaluation time |  |
+| **expression** | **String** | The expression associated with this filter. |  |
+| **payload** | **Object** | Additional payload data associated with the filter |  |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::V1Filter.new(
+  metadata: null,
+  tenant_id: null,
+  workflow_id: null,
+  scope: null,
+  expression: null,
+  payload: null
+)
+```
+

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

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

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

@@ -0,0 +1,28 @@
+# HatchetSdkRest::V1LogLine
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_at** | **Time** | The creation date of the log line. |  |
+| **message** | **String** | The log message. |  |
+| **metadata** | **Object** | The log metadata. |  |
+| **retry_count** | **Integer** | The retry count of the log line. | [optional] |
+| **attempt** | **Integer** | The attempt number of the log line. | [optional] |
+| **level** | [**V1LogLineLevel**](V1LogLineLevel.md) | The log level. | [optional] |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::V1LogLine.new(
+  created_at: null,
+  message: null,
+  metadata: null,
+  retry_count: null,
+  attempt: null,
+  level: null
+)
+```
+

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

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

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

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

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

@@ -0,0 +1,20 @@
+# HatchetSdkRest::V1ReplayTaskRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **external_ids** | **Array<String>** | A list of external IDs, which can refer to either task or workflow run external IDs | [optional] |
+| **filter** | [**V1TaskFilter**](V1TaskFilter.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::V1ReplayTaskRequest.new(
+  external_ids: null,
+  filter: null
+)
+```
+

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

@@ -0,0 +1,18 @@
+# HatchetSdkRest::V1ReplayedTasks
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ids** | **Array<String>** | The list of task external ids that were replayed | [optional] |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::V1ReplayedTasks.new(
+  ids: null
+)
+```
+

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

@@ -0,0 +1,38 @@
+# HatchetSdkRest::V1TaskEvent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  |  |
+| **task_id** | **String** |  |  |
+| **timestamp** | **Time** |  |  |
+| **event_type** | [**V1TaskEventType**](V1TaskEventType.md) |  |  |
+| **message** | **String** |  |  |
+| **error_message** | **String** |  | [optional] |
+| **output** | **String** |  | [optional] |
+| **worker_id** | **String** |  | [optional] |
+| **task_display_name** | **String** |  | [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::V1TaskEvent.new(
+  id: null,
+  task_id: null,
+  timestamp: null,
+  event_type: null,
+  message: null,
+  error_message: null,
+  output: null,
+  worker_id: null,
+  task_display_name: null,
+  retry_count: null,
+  attempt: null
+)
+```
+

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

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

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

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

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

@@ -0,0 +1,26 @@
+# HatchetSdkRest::V1TaskFilter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **since** | **Time** |  |  |
+| **_until** | **Time** |  | [optional] |
+| **statuses** | [**Array<V1TaskStatus>**](V1TaskStatus.md) |  | [optional] |
+| **workflow_ids** | **Array<String>** |  | [optional] |
+| **additional_metadata** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::V1TaskFilter.new(
+  since: null,
+  _until: null,
+  statuses: null,
+  workflow_ids: null,
+  additional_metadata: null
+)
+```
+

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

@@ -0,0 +1,22 @@
+# HatchetSdkRest::V1TaskPointMetric
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **time** | **Time** |  |  |
+| **succeeded** | **Integer** |  |  |
+| **failed** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::V1TaskPointMetric.new(
+  time: null,
+  succeeded: null,
+  failed: null
+)
+```
+

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

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

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

@@ -0,0 +1,20 @@
+# HatchetSdkRest::V1TaskRunMetric
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | [**V1TaskStatus**](V1TaskStatus.md) |  |  |
+| **count** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::V1TaskRunMetric.new(
+  status: null,
+  count: null
+)
+```
+

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

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

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

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