hatchet-sdk 0.0.1 → 0.1.0.pre.alpha

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

@@ -0,0 +1,203 @@
+# HatchetSdkRest::MetadataApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**cloud_metadata_get**](MetadataApi.md#cloud_metadata_get) | **GET** /api/v1/cloud/metadata | Get cloud metadata |
+| [**metadata_get**](MetadataApi.md#metadata_get) | **GET** /api/v1/meta | Get metadata |
+| [**metadata_list_integrations**](MetadataApi.md#metadata_list_integrations) | **GET** /api/v1/meta/integrations | List integrations |
+
+
+## cloud_metadata_get
+
+> <APIErrors> cloud_metadata_get
+
+Get cloud metadata
+
+Gets metadata for the Hatchet cloud instance
+
+### Examples
+
+```ruby
+require 'time'
+require 'hatchet-sdk-rest'
+
+api_instance = HatchetSdkRest::MetadataApi.new
+
+begin
+  # Get cloud metadata
+  result = api_instance.cloud_metadata_get
+  p result
+rescue HatchetSdkRest::ApiError => e
+  puts "Error when calling MetadataApi->cloud_metadata_get: #{e}"
+end
+```
+
+#### Using the cloud_metadata_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<APIErrors>, Integer, Hash)> cloud_metadata_get_with_http_info
+
+```ruby
+begin
+  # Get cloud metadata
+  data, status_code, headers = api_instance.cloud_metadata_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <APIErrors>
+rescue HatchetSdkRest::ApiError => e
+  puts "Error when calling MetadataApi->cloud_metadata_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**APIErrors**](APIErrors.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## metadata_get
+
+> <APIMeta> metadata_get
+
+Get metadata
+
+Gets metadata for the Hatchet instance
+
+### Examples
+
+```ruby
+require 'time'
+require 'hatchet-sdk-rest'
+
+api_instance = HatchetSdkRest::MetadataApi.new
+
+begin
+  # Get metadata
+  result = api_instance.metadata_get
+  p result
+rescue HatchetSdkRest::ApiError => e
+  puts "Error when calling MetadataApi->metadata_get: #{e}"
+end
+```
+
+#### Using the metadata_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<APIMeta>, Integer, Hash)> metadata_get_with_http_info
+
+```ruby
+begin
+  # Get metadata
+  data, status_code, headers = api_instance.metadata_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <APIMeta>
+rescue HatchetSdkRest::ApiError => e
+  puts "Error when calling MetadataApi->metadata_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**APIMeta**](APIMeta.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## metadata_list_integrations
+
+> <Array<APIMetaIntegration>> metadata_list_integrations
+
+List integrations
+
+List all 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::MetadataApi.new
+
+begin
+  # List integrations
+  result = api_instance.metadata_list_integrations
+  p result
+rescue HatchetSdkRest::ApiError => e
+  puts "Error when calling MetadataApi->metadata_list_integrations: #{e}"
+end
+```
+
+#### Using the metadata_list_integrations_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<APIMetaIntegration>>, Integer, Hash)> metadata_list_integrations_with_http_info
+
+```ruby
+begin
+  # List integrations
+  data, status_code, headers = api_instance.metadata_list_integrations_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<APIMetaIntegration>>
+rescue HatchetSdkRest::ApiError => e
+  puts "Error when calling MetadataApi->metadata_list_integrations_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array&lt;APIMetaIntegration&gt;**](APIMetaIntegration.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/PaginationResponse.md

@@ -0,0 +1,22 @@
+# HatchetSdkRest::PaginationResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **current_page** | **Integer** | the current page | [optional] |
+| **next_page** | **Integer** | the next page | [optional] |
+| **num_pages** | **Integer** | the total number of pages for listing | [optional] |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::PaginationResponse.new(
+  current_page: 2,
+  next_page: 3,
+  num_pages: 10
+)
+```
+

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

@@ -0,0 +1,32 @@
+# HatchetSdkRest::PullRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **repository_owner** | **String** |  |  |
+| **repository_name** | **String** |  |  |
+| **pull_request_id** | **Integer** |  |  |
+| **pull_request_title** | **String** |  |  |
+| **pull_request_number** | **Integer** |  |  |
+| **pull_request_head_branch** | **String** |  |  |
+| **pull_request_base_branch** | **String** |  |  |
+| **pull_request_state** | [**PullRequestState**](PullRequestState.md) |  |  |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::PullRequest.new(
+  repository_owner: null,
+  repository_name: null,
+  pull_request_id: null,
+  pull_request_title: null,
+  pull_request_number: null,
+  pull_request_head_branch: null,
+  pull_request_base_branch: null,
+  pull_request_state: null
+)
+```
+

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

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

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

@@ -0,0 +1,22 @@
+# HatchetSdkRest::QueueMetrics
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **num_queued** | **Integer** | The number of items in the queue. |  |
+| **num_running** | **Integer** | The number of items running. |  |
+| **num_pending** | **Integer** | The number of items pending. |  |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::QueueMetrics.new(
+  num_queued: null,
+  num_running: null,
+  num_pending: null
+)
+```
+

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

@@ -0,0 +1,28 @@
+# HatchetSdkRest::RateLimit
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** | The key for the rate limit. |  |
+| **tenant_id** | **String** | The ID of the tenant associated with this rate limit. |  |
+| **limit_value** | **Integer** | The maximum number of requests allowed within the window. |  |
+| **value** | **Integer** | The current number of requests made within the window. |  |
+| **window** | **String** | The window of time in which the limitValue is enforced. |  |
+| **last_refill** | **Time** | The last time the rate limit was refilled. |  |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::RateLimit.new(
+  key: null,
+  tenant_id: null,
+  limit_value: null,
+  value: null,
+  window: null,
+  last_refill: 2022-12-13T15:06:48.888358-05:00
+)
+```
+

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

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

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

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

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

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

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

@@ -0,0 +1,94 @@
+# HatchetSdkRest::RateLimitsApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**rate_limit_list**](RateLimitsApi.md#rate_limit_list) | **GET** /api/v1/tenants/{tenant}/rate-limits | List rate limits |
+
+
+## rate_limit_list
+
+> <RateLimitList> rate_limit_list(tenant, opts)
+
+List rate limits
+
+Lists all rate limits 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::RateLimitsApi.new
+tenant = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The tenant id
+opts = {
+  offset: 789, # Integer | The number to skip
+  limit: 789, # Integer | The number to limit by
+  search: 'search_example', # String | The search query to filter for
+  order_by_field: HatchetSdkRest::RateLimitOrderByField::KEY, # RateLimitOrderByField | What to order by
+  order_by_direction: HatchetSdkRest::RateLimitOrderByDirection::ASC # RateLimitOrderByDirection | The order direction
+}
+
+begin
+  # List rate limits
+  result = api_instance.rate_limit_list(tenant, opts)
+  p result
+rescue HatchetSdkRest::ApiError => e
+  puts "Error when calling RateLimitsApi->rate_limit_list: #{e}"
+end
+```
+
+#### Using the rate_limit_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RateLimitList>, Integer, Hash)> rate_limit_list_with_http_info(tenant, opts)
+
+```ruby
+begin
+  # List rate limits
+  data, status_code, headers = api_instance.rate_limit_list_with_http_info(tenant, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RateLimitList>
+rescue HatchetSdkRest::ApiError => e
+  puts "Error when calling RateLimitsApi->rate_limit_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tenant** | **String** | The tenant id |  |
+| **offset** | **Integer** | The number to skip | [optional] |
+| **limit** | **Integer** | The number to limit by | [optional] |
+| **search** | **String** | The search query to filter for | [optional] |
+| **order_by_field** | [**RateLimitOrderByField**](.md) | What to order by | [optional] |
+| **order_by_direction** | [**RateLimitOrderByDirection**](.md) | The order direction | [optional] |
+
+### Return type
+
+[**RateLimitList**](RateLimitList.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/RecentStepRuns.md

@@ -0,0 +1,30 @@
+# HatchetSdkRest::RecentStepRuns
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | [**APIResourceMeta**](APIResourceMeta.md) |  |  |
+| **action_id** | **String** | The action id. |  |
+| **status** | [**StepRunStatus**](StepRunStatus.md) |  |  |
+| **workflow_run_id** | **String** |  |  |
+| **started_at** | **Time** |  | [optional] |
+| **finished_at** | **Time** |  | [optional] |
+| **cancelled_at** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'hatchet-sdk-rest'
+
+instance = HatchetSdkRest::RecentStepRuns.new(
+  metadata: null,
+  action_id: null,
+  status: null,
+  workflow_run_id: null,
+  started_at: null,
+  finished_at: null,
+  cancelled_at: null
+)
+```
+

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

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

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

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

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

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

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

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

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

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