hatchet-sdk 0.0.0 → 0.1.0.pre.alpha

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

@@ -0,0 +1,28 @@
+# HatchetSdkRest::TenantInvite
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | [**APIResourceMeta**](APIResourceMeta.md) |  |  |
+| **email** | **String** | The email of the user to invite. |  |
+| **role** | [**TenantMemberRole**](TenantMemberRole.md) | The role of the user in the tenant. |  |
+| **tenant_id** | **String** | The tenant id associated with this tenant invite. |  |
+| **expires** | **Time** | The time that this invite expires. |  |
+| **tenant_name** | **String** | The tenant name for the tenant. | [optional] |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::TenantInvite.new(
+  metadata: null,
+  email: null,
+  role: null,
+  tenant_id: null,
+  expires: null,
+  tenant_name: null
+)
+```
+

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

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

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

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

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

@@ -0,0 +1,24 @@
+# HatchetSdkRest::TenantMember
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | [**APIResourceMeta**](APIResourceMeta.md) |  |  |
+| **user** | [**UserTenantPublic**](UserTenantPublic.md) | The user associated with this tenant member. |  |
+| **role** | [**TenantMemberRole**](TenantMemberRole.md) | The role of the user in the tenant. |  |
+| **tenant** | [**Tenant**](Tenant.md) | The tenant associated with this tenant member. | [optional] |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::TenantMember.new(
+  metadata: null,
+  user: null,
+  role: null,
+  tenant: null
+)
+```
+

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

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

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

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

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

@@ -0,0 +1,22 @@
+# HatchetSdkRest::TenantQueueMetrics
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **total** | [**QueueMetrics**](QueueMetrics.md) | The total queue metrics. | [optional] |
+| **workflow** | [**Hash<String, QueueMetrics>**](QueueMetrics.md) |  | [optional] |
+| **queues** | **Hash<String, Integer>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::TenantQueueMetrics.new(
+  total: null,
+  workflow: null,
+  queues: null
+)
+```
+

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

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

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

@@ -0,0 +1,30 @@
+# HatchetSdkRest::TenantResourceLimit
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | [**APIResourceMeta**](APIResourceMeta.md) |  |  |
+| **resource** | [**TenantResource**](TenantResource.md) | The resource associated with this limit. |  |
+| **limit_value** | **Integer** | The limit associated with this limit. |  |
+| **value** | **Integer** | The current value associated with this limit. |  |
+| **alarm_value** | **Integer** | The alarm value associated with this limit to warn of approaching limit value. | [optional] |
+| **window** | **String** | The meter window for the limit. (i.e. 1 day, 1 week, 1 month) | [optional] |
+| **last_refill** | **Time** | The last time the limit was refilled. | [optional] |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::TenantResourceLimit.new(
+  metadata: null,
+  resource: null,
+  limit_value: null,
+  value: null,
+  alarm_value: null,
+  window: null,
+  last_refill: null
+)
+```
+

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

@@ -0,0 +1,18 @@
+# HatchetSdkRest::TenantResourcePolicy
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limits** | [**Array<TenantResourceLimit>**](TenantResourceLimit.md) | A list of resource limits for the tenant. |  |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::TenantResourcePolicy.new(
+  limits: null
+)
+```
+

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

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

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

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

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

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

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

@@ -0,0 +1,20 @@
+# HatchetSdkRest::TriggerWorkflowRunRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **input** | **Object** |  |  |
+| **additional_metadata** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::TriggerWorkflowRunRequest.new(
+  input: null,
+  additional_metadata: null
+)
+```
+

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

@@ -0,0 +1,18 @@
+# HatchetSdkRest::UpdateTenantAlertEmailGroupRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **emails** | **Array<String>** | A list of emails for users |  |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::UpdateTenantAlertEmailGroupRequest.new(
+  emails: null
+)
+```
+

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

@@ -0,0 +1,18 @@
+# HatchetSdkRest::UpdateTenantInviteRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **role** | [**TenantMemberRole**](TenantMemberRole.md) | The role of the user in the tenant. |  |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::UpdateTenantInviteRequest.new(
+  role: null
+)
+```
+

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

@@ -0,0 +1,34 @@
+# HatchetSdkRest::UpdateTenantRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the tenant. | [optional] |
+| **analytics_opt_out** | **Boolean** | Whether the tenant has opted out of analytics. | [optional] |
+| **alert_member_emails** | **Boolean** | Whether to alert tenant members. | [optional] |
+| **enable_workflow_run_failure_alerts** | **Boolean** | Whether to send alerts when workflow runs fail. | [optional] |
+| **enable_expiring_token_alerts** | **Boolean** | Whether to enable alerts when tokens are approaching expiration. | [optional] |
+| **enable_tenant_resource_limit_alerts** | **Boolean** | Whether to enable alerts when tenant resources are approaching limits. | [optional] |
+| **max_alerting_frequency** | **String** | The max frequency at which to alert. | [optional] |
+| **version** | [**TenantVersion**](TenantVersion.md) | The version of the tenant. | [optional] |
+| **ui_version** | [**TenantUIVersion**](TenantUIVersion.md) | The UI of the tenant. | [optional] |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::UpdateTenantRequest.new(
+  name: null,
+  analytics_opt_out: null,
+  alert_member_emails: null,
+  enable_workflow_run_failure_alerts: null,
+  enable_expiring_token_alerts: null,
+  enable_tenant_resource_limit_alerts: null,
+  max_alerting_frequency: null,
+  version: null,
+  ui_version: null
+)
+```
+

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

@@ -0,0 +1,18 @@
+# HatchetSdkRest::UpdateWorkerRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **is_paused** | **Boolean** | Whether the worker is paused and cannot accept new runs. | [optional] |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::UpdateWorkerRequest.new(
+  is_paused: null
+)
+```
+

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

@@ -0,0 +1,28 @@
+# HatchetSdkRest::User
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | [**APIResourceMeta**](APIResourceMeta.md) |  |  |
+| **email** | **String** | The email address of the user. |  |
+| **email_verified** | **Boolean** | Whether the user has verified their email address. |  |
+| **name** | **String** | The display name of the user. | [optional] |
+| **has_password** | **Boolean** | Whether the user has a password set. | [optional] |
+| **email_hash** | **String** | A hash of the user's email address for use with Pylon Support Chat | [optional] |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::User.new(
+  metadata: null,
+  email: null,
+  email_verified: null,
+  name: null,
+  has_password: null,
+  email_hash: null
+)
+```
+