hatchet-sdk 0.0.1 → 0.1.0.pre.alpha

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

@@ -0,0 +1,235 @@
+# HatchetSdkRest::APITokenApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**api_token_create**](APITokenApi.md#api_token_create) | **POST** /api/v1/tenants/{tenant}/api-tokens | Create API Token |
+| [**api_token_list**](APITokenApi.md#api_token_list) | **GET** /api/v1/tenants/{tenant}/api-tokens | List API Tokens |
+| [**api_token_update_revoke**](APITokenApi.md#api_token_update_revoke) | **POST** /api/v1/api-tokens/{api-token} | Revoke API Token |
+
+
+## api_token_create
+
+> <CreateAPITokenResponse> api_token_create(tenant, opts)
+
+Create API Token
+
+Create an API token 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::APITokenApi.new
+tenant = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The tenant id
+opts = {
+  create_api_token_request: HatchetSdkRest::CreateAPITokenRequest.new({name: 'name_example'}) # CreateAPITokenRequest | 
+}
+
+begin
+  # Create API Token
+  result = api_instance.api_token_create(tenant, opts)
+  p result
+rescue HatchetSdkRest::ApiError => e
+  puts "Error when calling APITokenApi->api_token_create: #{e}"
+end
+```
+
+#### Using the api_token_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateAPITokenResponse>, Integer, Hash)> api_token_create_with_http_info(tenant, opts)
+
+```ruby
+begin
+  # Create API Token
+  data, status_code, headers = api_instance.api_token_create_with_http_info(tenant, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateAPITokenResponse>
+rescue HatchetSdkRest::ApiError => e
+  puts "Error when calling APITokenApi->api_token_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tenant** | **String** | The tenant id |  |
+| **create_api_token_request** | [**CreateAPITokenRequest**](CreateAPITokenRequest.md) |  | [optional] |
+
+### Return type
+
+[**CreateAPITokenResponse**](CreateAPITokenResponse.md)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## api_token_list
+
+> <ListAPITokensResponse> api_token_list(tenant)
+
+List API Tokens
+
+List API tokens 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::APITokenApi.new
+tenant = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The tenant id
+
+begin
+  # List API Tokens
+  result = api_instance.api_token_list(tenant)
+  p result
+rescue HatchetSdkRest::ApiError => e
+  puts "Error when calling APITokenApi->api_token_list: #{e}"
+end
+```
+
+#### Using the api_token_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListAPITokensResponse>, Integer, Hash)> api_token_list_with_http_info(tenant)
+
+```ruby
+begin
+  # List API Tokens
+  data, status_code, headers = api_instance.api_token_list_with_http_info(tenant)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListAPITokensResponse>
+rescue HatchetSdkRest::ApiError => e
+  puts "Error when calling APITokenApi->api_token_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tenant** | **String** | The tenant id |  |
+
+### Return type
+
+[**ListAPITokensResponse**](ListAPITokensResponse.md)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## api_token_update_revoke
+
+> api_token_update_revoke(api_token)
+
+Revoke API Token
+
+Revoke an API token 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::APITokenApi.new
+api_token = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The API token
+
+begin
+  # Revoke API Token
+  api_instance.api_token_update_revoke(api_token)
+rescue HatchetSdkRest::ApiError => e
+  puts "Error when calling APITokenApi->api_token_update_revoke: #{e}"
+end
+```
+
+#### Using the api_token_update_revoke_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)> api_token_update_revoke_with_http_info(api_token)
+
+```ruby
+begin
+  # Revoke API Token
+  data, status_code, headers = api_instance.api_token_update_revoke_with_http_info(api_token)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue HatchetSdkRest::ApiError => e
+  puts "Error when calling APITokenApi->api_token_update_revoke_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **api_token** | **String** | The API token |  |
+
+### 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
+

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

@@ -0,0 +1,18 @@
+# HatchetSdkRest::AcceptInviteRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **invite** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::AcceptInviteRequest.new(
+  invite: bb214807-246e-43a5-a25d-41761d1cff9e
+)
+```
+

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

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

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

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

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

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

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

@@ -0,0 +1,20 @@
+# HatchetSdkRest::CreateAPITokenRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | A name for the API token. |  |
+| **expires_in** | **String** | The duration for which the token is valid. | [optional] |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::CreateAPITokenRequest.new(
+  name: null,
+  expires_in: null
+)
+```
+

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

@@ -0,0 +1,18 @@
+# HatchetSdkRest::CreateAPITokenResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token** | **String** | The API token. |  |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::CreateAPITokenResponse.new(
+  token: null
+)
+```
+

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

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

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

@@ -0,0 +1,26 @@
+# HatchetSdkRest::CreateEventRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** | The key for the event. |  |
+| **data** | **Object** | The data for the event. |  |
+| **additional_metadata** | **Object** | Additional metadata for the event. | [optional] |
+| **priority** | **Integer** | The priority of the event. | [optional] |
+| **scope** | **String** | The scope for event filtering. | [optional] |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::CreateEventRequest.new(
+  key: null,
+  data: null,
+  additional_metadata: null,
+  priority: null,
+  scope: null
+)
+```
+

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

@@ -0,0 +1,18 @@
+# HatchetSdkRest::CreatePullRequestFromStepRun
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **branch_name** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::CreatePullRequestFromStepRun.new(
+  branch_name: null
+)
+```
+

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

@@ -0,0 +1,18 @@
+# HatchetSdkRest::CreateSNSIntegrationRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **topic_arn** | **String** | The Amazon Resource Name (ARN) of the SNS topic. |  |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::CreateSNSIntegrationRequest.new(
+  topic_arn: null
+)
+```
+

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

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

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

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

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

@@ -0,0 +1,24 @@
+# HatchetSdkRest::CreateTenantRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the tenant. |  |
+| **slug** | **String** | The slug of the tenant. |  |
+| **ui_version** | [**TenantUIVersion**](TenantUIVersion.md) | The UI version of the tenant. Defaults to V0. | [optional] |
+| **engine_version** | [**TenantVersion**](TenantVersion.md) | The engine version of the tenant. Defaults to V0. | [optional] |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::CreateTenantRequest.new(
+  name: null,
+  slug: null,
+  ui_version: null,
+  engine_version: null
+)
+```
+

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

@@ -0,0 +1,40 @@
+# HatchetSdkRest::CronWorkflows
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | [**APIResourceMeta**](APIResourceMeta.md) |  |  |
+| **tenant_id** | **String** |  |  |
+| **workflow_version_id** | **String** |  |  |
+| **workflow_id** | **String** |  |  |
+| **workflow_name** | **String** |  |  |
+| **cron** | **String** |  |  |
+| **enabled** | **Boolean** |  |  |
+| **method** | [**CronWorkflowsMethod**](CronWorkflowsMethod.md) |  |  |
+| **name** | **String** |  | [optional] |
+| **input** | **Hash<String, Object>** |  | [optional] |
+| **additional_metadata** | **Hash<String, Object>** |  | [optional] |
+| **priority** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::CronWorkflows.new(
+  metadata: null,
+  tenant_id: null,
+  workflow_version_id: null,
+  workflow_id: null,
+  workflow_name: null,
+  cron: null,
+  enabled: null,
+  method: null,
+  name: null,
+  input: null,
+  additional_metadata: null,
+  priority: null
+)
+```
+

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

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

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

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

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

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