hatchet-sdk 0.0.1 → 0.1.0.pre.alpha

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

@@ -0,0 +1,235 @@
+# HatchetSdkRest::SNSApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**sns_create**](SNSApi.md#sns_create) | **POST** /api/v1/tenants/{tenant}/sns | Create SNS integration |
+| [**sns_delete**](SNSApi.md#sns_delete) | **DELETE** /api/v1/sns/{sns} | Delete SNS integration |
+| [**sns_list**](SNSApi.md#sns_list) | **GET** /api/v1/tenants/{tenant}/sns | List SNS integrations |
+
+
+## sns_create
+
+> <SNSIntegration> sns_create(tenant, opts)
+
+Create SNS integration
+
+Create SNS integration
+
+### 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::SNSApi.new
+tenant = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The tenant id
+opts = {
+  create_sns_integration_request: HatchetSdkRest::CreateSNSIntegrationRequest.new({topic_arn: 'topic_arn_example'}) # CreateSNSIntegrationRequest | 
+}
+
+begin
+  # Create SNS integration
+  result = api_instance.sns_create(tenant, opts)
+  p result
+rescue HatchetSdkRest::ApiError => e
+  puts "Error when calling SNSApi->sns_create: #{e}"
+end
+```
+
+#### Using the sns_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SNSIntegration>, Integer, Hash)> sns_create_with_http_info(tenant, opts)
+
+```ruby
+begin
+  # Create SNS integration
+  data, status_code, headers = api_instance.sns_create_with_http_info(tenant, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SNSIntegration>
+rescue HatchetSdkRest::ApiError => e
+  puts "Error when calling SNSApi->sns_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tenant** | **String** | The tenant id |  |
+| **create_sns_integration_request** | [**CreateSNSIntegrationRequest**](CreateSNSIntegrationRequest.md) |  | [optional] |
+
+### Return type
+
+[**SNSIntegration**](SNSIntegration.md)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## sns_delete
+
+> sns_delete(sns)
+
+Delete SNS integration
+
+Delete SNS integration
+
+### 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::SNSApi.new
+sns = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The SNS integration id
+
+begin
+  # Delete SNS integration
+  api_instance.sns_delete(sns)
+rescue HatchetSdkRest::ApiError => e
+  puts "Error when calling SNSApi->sns_delete: #{e}"
+end
+```
+
+#### Using the sns_delete_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> sns_delete_with_http_info(sns)
+
+```ruby
+begin
+  # Delete SNS integration
+  data, status_code, headers = api_instance.sns_delete_with_http_info(sns)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue HatchetSdkRest::ApiError => e
+  puts "Error when calling SNSApi->sns_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sns** | **String** | The SNS integration id |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## sns_list
+
+> <ListSNSIntegrations> sns_list(tenant)
+
+List SNS integrations
+
+List SNS integrations
+
+### 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::SNSApi.new
+tenant = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The tenant id
+
+begin
+  # List SNS integrations
+  result = api_instance.sns_list(tenant)
+  p result
+rescue HatchetSdkRest::ApiError => e
+  puts "Error when calling SNSApi->sns_list: #{e}"
+end
+```
+
+#### Using the sns_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListSNSIntegrations>, Integer, Hash)> sns_list_with_http_info(tenant)
+
+```ruby
+begin
+  # List SNS integrations
+  data, status_code, headers = api_instance.sns_list_with_http_info(tenant)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListSNSIntegrations>
+rescue HatchetSdkRest::ApiError => e
+  puts "Error when calling SNSApi->sns_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tenant** | **String** | The tenant id |  |
+
+### Return type
+
+[**ListSNSIntegrations**](ListSNSIntegrations.md)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

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

@@ -0,0 +1,24 @@
+# HatchetSdkRest::SNSIntegration
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | [**APIResourceMeta**](APIResourceMeta.md) |  |  |
+| **tenant_id** | **String** | The unique identifier for the tenant that the SNS integration belongs to. |  |
+| **topic_arn** | **String** | The Amazon Resource Name (ARN) of the SNS topic. |  |
+| **ingest_url** | **String** | The URL to send SNS messages to. | [optional] |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::SNSIntegration.new(
+  metadata: null,
+  tenant_id: null,
+  topic_arn: null,
+  ingest_url: null
+)
+```
+

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

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

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

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

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

@@ -0,0 +1,44 @@
+# HatchetSdkRest::ScheduledWorkflows
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | [**APIResourceMeta**](APIResourceMeta.md) |  |  |
+| **tenant_id** | **String** |  |  |
+| **workflow_version_id** | **String** |  |  |
+| **workflow_id** | **String** |  |  |
+| **workflow_name** | **String** |  |  |
+| **trigger_at** | **Time** |  |  |
+| **method** | [**ScheduledWorkflowsMethod**](ScheduledWorkflowsMethod.md) |  |  |
+| **input** | **Hash<String, Object>** |  | [optional] |
+| **additional_metadata** | **Hash<String, Object>** |  | [optional] |
+| **workflow_run_created_at** | **Time** |  | [optional] |
+| **workflow_run_name** | **String** |  | [optional] |
+| **workflow_run_status** | [**WorkflowRunStatus**](WorkflowRunStatus.md) |  | [optional] |
+| **workflow_run_id** | **String** |  | [optional] |
+| **priority** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::ScheduledWorkflows.new(
+  metadata: null,
+  tenant_id: null,
+  workflow_version_id: null,
+  workflow_id: null,
+  workflow_name: null,
+  trigger_at: null,
+  method: null,
+  input: null,
+  additional_metadata: null,
+  workflow_run_created_at: null,
+  workflow_run_name: null,
+  workflow_run_status: null,
+  workflow_run_id: bb214807-246e-43a5-a25d-41761d1cff9e,
+  priority: null
+)
+```
+

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

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

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

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

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

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

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

@@ -0,0 +1,28 @@
+# HatchetSdkRest::SemaphoreSlots
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **step_run_id** | **String** | The step run id. |  |
+| **action_id** | **String** | The action id. |  |
+| **workflow_run_id** | **String** | The workflow run id. |  |
+| **started_at** | **Time** | The time this slot was started. | [optional] |
+| **timeout_at** | **Time** | The time this slot will timeout. | [optional] |
+| **status** | [**StepRunStatus**](StepRunStatus.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::SemaphoreSlots.new(
+  step_run_id: null,
+  action_id: null,
+  workflow_run_id: null,
+  started_at: null,
+  timeout_at: null,
+  status: null
+)
+```
+

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

@@ -0,0 +1,156 @@
+# HatchetSdkRest::SlackApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**slack_webhook_delete**](SlackApi.md#slack_webhook_delete) | **DELETE** /api/v1/slack/{slack} | Delete Slack webhook |
+| [**slack_webhook_list**](SlackApi.md#slack_webhook_list) | **GET** /api/v1/tenants/{tenant}/slack | List Slack integrations |
+
+
+## slack_webhook_delete
+
+> slack_webhook_delete(slack)
+
+Delete Slack webhook
+
+Delete Slack webhook
+
+### 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::SlackApi.new
+slack = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The Slack webhook id
+
+begin
+  # Delete Slack webhook
+  api_instance.slack_webhook_delete(slack)
+rescue HatchetSdkRest::ApiError => e
+  puts "Error when calling SlackApi->slack_webhook_delete: #{e}"
+end
+```
+
+#### Using the slack_webhook_delete_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> slack_webhook_delete_with_http_info(slack)
+
+```ruby
+begin
+  # Delete Slack webhook
+  data, status_code, headers = api_instance.slack_webhook_delete_with_http_info(slack)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue HatchetSdkRest::ApiError => e
+  puts "Error when calling SlackApi->slack_webhook_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **slack** | **String** | The Slack webhook id |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## slack_webhook_list
+
+> <ListSlackWebhooks> slack_webhook_list(tenant)
+
+List Slack integrations
+
+List Slack webhooks
+
+### 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::SlackApi.new
+tenant = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The tenant id
+
+begin
+  # List Slack integrations
+  result = api_instance.slack_webhook_list(tenant)
+  p result
+rescue HatchetSdkRest::ApiError => e
+  puts "Error when calling SlackApi->slack_webhook_list: #{e}"
+end
+```
+
+#### Using the slack_webhook_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListSlackWebhooks>, Integer, Hash)> slack_webhook_list_with_http_info(tenant)
+
+```ruby
+begin
+  # List Slack integrations
+  data, status_code, headers = api_instance.slack_webhook_list_with_http_info(tenant)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListSlackWebhooks>
+rescue HatchetSdkRest::ApiError => e
+  puts "Error when calling SlackApi->slack_webhook_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tenant** | **String** | The tenant id |  |
+
+### Return type
+
+[**ListSlackWebhooks**](ListSlackWebhooks.md)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

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

@@ -0,0 +1,28 @@
+# HatchetSdkRest::SlackWebhook
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | [**APIResourceMeta**](APIResourceMeta.md) |  |  |
+| **tenant_id** | **String** | The unique identifier for the tenant that the SNS integration belongs to. |  |
+| **team_name** | **String** | The team name associated with this slack webhook. |  |
+| **team_id** | **String** | The team id associated with this slack webhook. |  |
+| **channel_name** | **String** | The channel name associated with this slack webhook. |  |
+| **channel_id** | **String** | The channel id associated with this slack webhook. |  |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::SlackWebhook.new(
+  metadata: null,
+  tenant_id: null,
+  team_name: null,
+  team_id: null,
+  channel_name: null,
+  channel_id: null
+)
+```
+

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

@@ -0,0 +1,32 @@
+# HatchetSdkRest::Step
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | [**APIResourceMeta**](APIResourceMeta.md) |  |  |
+| **readable_id** | **String** | The readable id of the step. |  |
+| **tenant_id** | **String** |  |  |
+| **job_id** | **String** |  |  |
+| **action** | **String** |  |  |
+| **timeout** | **String** | The timeout of the step. | [optional] |
+| **children** | **Array<String>** |  | [optional] |
+| **parents** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::Step.new(
+  metadata: null,
+  readable_id: null,
+  tenant_id: null,
+  job_id: null,
+  action: null,
+  timeout: null,
+  children: null,
+  parents: null
+)
+```
+