hatchet-sdk 0.0.1 → 0.1.0.pre.alpha

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

@@ -0,0 +1,129 @@
+# HatchetSdkRest::HealthcheckApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**liveness_get**](HealthcheckApi.md#liveness_get) | **GET** /api/live | Get liveness |
+| [**readiness_get**](HealthcheckApi.md#readiness_get) | **GET** /api/ready | Get readiness |
+
+
+## liveness_get
+
+> liveness_get
+
+Get liveness
+
+Gets the liveness status
+
+### Examples
+
+```ruby
+require 'time'
+require 'hatchet-sdk-rest'
+
+api_instance = HatchetSdkRest::HealthcheckApi.new
+
+begin
+  # Get liveness
+  api_instance.liveness_get
+rescue HatchetSdkRest::ApiError => e
+  puts "Error when calling HealthcheckApi->liveness_get: #{e}"
+end
+```
+
+#### Using the liveness_get_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)> liveness_get_with_http_info
+
+```ruby
+begin
+  # Get liveness
+  data, status_code, headers = api_instance.liveness_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue HatchetSdkRest::ApiError => e
+  puts "Error when calling HealthcheckApi->liveness_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## readiness_get
+
+> readiness_get
+
+Get readiness
+
+Gets the readiness status
+
+### Examples
+
+```ruby
+require 'time'
+require 'hatchet-sdk-rest'
+
+api_instance = HatchetSdkRest::HealthcheckApi.new
+
+begin
+  # Get readiness
+  api_instance.readiness_get
+rescue HatchetSdkRest::ApiError => e
+  puts "Error when calling HealthcheckApi->readiness_get: #{e}"
+end
+```
+
+#### Using the readiness_get_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)> readiness_get_with_http_info
+
+```ruby
+begin
+  # Get readiness
+  data, status_code, headers = api_instance.readiness_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue HatchetSdkRest::ApiError => e
+  puts "Error when calling HealthcheckApi->readiness_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+

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

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

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

@@ -0,0 +1,30 @@
+# HatchetSdkRest::Job
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | [**APIResourceMeta**](APIResourceMeta.md) |  |  |
+| **tenant_id** | **String** |  |  |
+| **version_id** | **String** |  |  |
+| **name** | **String** |  |  |
+| **steps** | [**Array<Step>**](Step.md) |  |  |
+| **description** | **String** | The description of the job. | [optional] |
+| **timeout** | **String** | The timeout of the job. | [optional] |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::Job.new(
+  metadata: null,
+  tenant_id: null,
+  version_id: null,
+  name: null,
+  steps: null,
+  description: null,
+  timeout: null
+)
+```
+

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

@@ -0,0 +1,48 @@
+# HatchetSdkRest::JobRun
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | [**APIResourceMeta**](APIResourceMeta.md) |  |  |
+| **tenant_id** | **String** |  |  |
+| **workflow_run_id** | **String** |  |  |
+| **job_id** | **String** |  |  |
+| **status** | [**JobRunStatus**](JobRunStatus.md) |  |  |
+| **workflow_run** | [**WorkflowRun**](WorkflowRun.md) |  | [optional] |
+| **job** | [**Job**](Job.md) |  | [optional] |
+| **ticker_id** | **String** |  | [optional] |
+| **step_runs** | [**Array<StepRun>**](StepRun.md) |  | [optional] |
+| **result** | **Object** |  | [optional] |
+| **started_at** | **Time** |  | [optional] |
+| **finished_at** | **Time** |  | [optional] |
+| **timeout_at** | **Time** |  | [optional] |
+| **cancelled_at** | **Time** |  | [optional] |
+| **cancelled_reason** | **String** |  | [optional] |
+| **cancelled_error** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::JobRun.new(
+  metadata: null,
+  tenant_id: null,
+  workflow_run_id: null,
+  job_id: null,
+  status: null,
+  workflow_run: null,
+  job: null,
+  ticker_id: null,
+  step_runs: null,
+  result: null,
+  started_at: null,
+  finished_at: null,
+  timeout_at: null,
+  cancelled_at: null,
+  cancelled_reason: null,
+  cancelled_error: null
+)
+```
+

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,171 @@
+# HatchetSdkRest::LogApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**log_line_list**](LogApi.md#log_line_list) | **GET** /api/v1/step-runs/{step-run}/logs | List log lines |
+| [**v1_log_line_list**](LogApi.md#v1_log_line_list) | **GET** /api/v1/stable/tasks/{task}/logs | List log lines |
+
+
+## log_line_list
+
+> <LogLineList> log_line_list(step_run, opts)
+
+List log lines
+
+Lists log lines for a step run.
+
+### 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::LogApi.new
+step_run = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The step run id
+opts = {
+  offset: 789, # Integer | The number to skip
+  limit: 789, # Integer | The number to limit by
+  levels: [HatchetSdkRest::LogLineLevel::DEBUG], # Array<LogLineLevel> | A list of levels to filter by
+  search: 'search_example', # String | The search query to filter for
+  order_by_field: HatchetSdkRest::LogLineOrderByField::CREATED_AT, # LogLineOrderByField | What to order by
+  order_by_direction: HatchetSdkRest::LogLineOrderByDirection::ASC # LogLineOrderByDirection | The order direction
+}
+
+begin
+  # List log lines
+  result = api_instance.log_line_list(step_run, opts)
+  p result
+rescue HatchetSdkRest::ApiError => e
+  puts "Error when calling LogApi->log_line_list: #{e}"
+end
+```
+
+#### Using the log_line_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<LogLineList>, Integer, Hash)> log_line_list_with_http_info(step_run, opts)
+
+```ruby
+begin
+  # List log lines
+  data, status_code, headers = api_instance.log_line_list_with_http_info(step_run, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <LogLineList>
+rescue HatchetSdkRest::ApiError => e
+  puts "Error when calling LogApi->log_line_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **step_run** | **String** | The step run id |  |
+| **offset** | **Integer** | The number to skip | [optional] |
+| **limit** | **Integer** | The number to limit by | [optional] |
+| **levels** | [**Array&lt;LogLineLevel&gt;**](LogLineLevel.md) | A list of levels to filter by | [optional] |
+| **search** | **String** | The search query to filter for | [optional] |
+| **order_by_field** | [**LogLineOrderByField**](.md) | What to order by | [optional] |
+| **order_by_direction** | [**LogLineOrderByDirection**](.md) | The order direction | [optional] |
+
+### Return type
+
+[**LogLineList**](LogLineList.md)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## v1_log_line_list
+
+> <V1LogLineList> v1_log_line_list(task)
+
+List log lines
+
+Lists log lines for a task
+
+### 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::LogApi.new
+task = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The task id
+
+begin
+  # List log lines
+  result = api_instance.v1_log_line_list(task)
+  p result
+rescue HatchetSdkRest::ApiError => e
+  puts "Error when calling LogApi->v1_log_line_list: #{e}"
+end
+```
+
+#### Using the v1_log_line_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<V1LogLineList>, Integer, Hash)> v1_log_line_list_with_http_info(task)
+
+```ruby
+begin
+  # List log lines
+  data, status_code, headers = api_instance.v1_log_line_list_with_http_info(task)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <V1LogLineList>
+rescue HatchetSdkRest::ApiError => e
+  puts "Error when calling LogApi->v1_log_line_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **task** | **String** | The task id |  |
+
+### Return type
+
+[**V1LogLineList**](V1LogLineList.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/LogLine.md

@@ -0,0 +1,22 @@
+# HatchetSdkRest::LogLine
+
+## 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. |  |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::LogLine.new(
+  created_at: null,
+  message: null,
+  metadata: null
+)
+```
+

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

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

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

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

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

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

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

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