zyphr 0.1.17 → 0.1.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc874bcc04f01c43da7844d1d562c5e1e8720a1c791abe5988228eecf2a3486a
-  data.tar.gz: 1daf9d45e70baf4dc6bff9467cf4b4de10cf40f891812f2df5c0ac8840882b91
+  metadata.gz: 7fdd3e435ef1d46a572b992085fb931fbcbcdd7bbbb5e7b18acd98a46026b2c3
+  data.tar.gz: 9fa61d3546fd88327740d55a0f043579ab2b14e381d5292c5ed9d380ff60c45b
 SHA512:
-  metadata.gz: 885fe09a25de1fe5e69a444e341c844790fbe5b1dcb8b20dfc399647ed06858f726c911cb8eea37984c50db15ba064e1a6ae562a3794dcc7aeacb257bc655aff
-  data.tar.gz: 823f2d417febb7b5983953185586f0facbf80ff56cd7ee1618995486b56faad69afbaae47dd3079caa75d4dc88913c98412600d6520326fcfb89736784882e6a
+  metadata.gz: 75f321d8cf7847769c4c9f1a7f15936c2b55063046bc7be4c022a5cfd7493f89aedcab7d1e215a13c65d3cbf6f2026d98291b27a63b0cc482692d1811d85b748
+  data.tar.gz: b44f62bc08856f0a35e4978c932b1a12b4a712e53a375126ab2c40c53a81256574181a6bc5fe64114ab3afdade27b3339904e9e613b6b9050327c11eac96d055

data/README.md

@@ -186,6 +186,9 @@ Class | Method | HTTP request | Description
 *Zyphr::EmailsApi* | [**list_emails**](docs/EmailsApi.md#list_emails) | **GET** /emails | List emails
 *Zyphr::EmailsApi* | [**send_batch_email**](docs/EmailsApi.md#send_batch_email) | **POST** /emails/batch | Send batch emails
 *Zyphr::EmailsApi* | [**send_email**](docs/EmailsApi.md#send_email) | **POST** /emails | Send an email
+*Zyphr::ExecutionsApi* | [**cancel_execution**](docs/ExecutionsApi.md#cancel_execution) | **POST** /executions/{id}/cancel | Cancel a running execution
+*Zyphr::ExecutionsApi* | [**get_execution**](docs/ExecutionsApi.md#get_execution) | **GET** /executions/{id} | Get a workflow execution
+*Zyphr::ExecutionsApi* | [**retry_execution**](docs/ExecutionsApi.md#retry_execution) | **POST** /executions/{id}/retry | Retry a failed or cancelled execution
 *Zyphr::InboxApi* | [**archive_inbox_notification**](docs/InboxApi.md#archive_inbox_notification) | **POST** /inbox/{id}/archive | Archive a notification
 *Zyphr::InboxApi* | [**archive_subscriber_notification**](docs/InboxApi.md#archive_subscriber_notification) | **POST** /subscriber-inbox/{id}/archive | Archive a notification
 *Zyphr::InboxApi* | [**delete_inbox_notification**](docs/InboxApi.md#delete_inbox_notification) | **DELETE** /inbox/{id} | Delete a notification
@@ -380,6 +383,11 @@ Class | Method | HTTP request | Description
  - [Zyphr::EmailTrackingResponse](docs/EmailTrackingResponse.md)
  - [Zyphr::EndUserDeleteResponse](docs/EndUserDeleteResponse.md)
  - [Zyphr::EndUserDeleteResponseData](docs/EndUserDeleteResponseData.md)
+ - [Zyphr::ExecutionCancelResponse](docs/ExecutionCancelResponse.md)
+ - [Zyphr::ExecutionCancelResponseData](docs/ExecutionCancelResponseData.md)
+ - [Zyphr::ExecutionResponse](docs/ExecutionResponse.md)
+ - [Zyphr::ExecutionRetryResponse](docs/ExecutionRetryResponse.md)
+ - [Zyphr::ExecutionRetryResponseData](docs/ExecutionRetryResponseData.md)
  - [Zyphr::ForgotPasswordRequest](docs/ForgotPasswordRequest.md)
  - [Zyphr::GenerateSubscriberToken200Response](docs/GenerateSubscriberToken200Response.md)
  - [Zyphr::GenerateSubscriberToken200ResponseData](docs/GenerateSubscriberToken200ResponseData.md)
@@ -650,6 +658,10 @@ Class | Method | HTTP request | Description
  - [Zyphr::WebhookVersionsResponse](docs/WebhookVersionsResponse.md)
  - [Zyphr::WebhookVersionsResponseData](docs/WebhookVersionsResponseData.md)
  - [Zyphr::WithdrawSubscriberConsentRequest](docs/WithdrawSubscriberConsentRequest.md)
+ - [Zyphr::WorkflowExecution](docs/WorkflowExecution.md)
+ - [Zyphr::WorkflowExecutionStatus](docs/WorkflowExecutionStatus.md)
+ - [Zyphr::WorkflowStepExecution](docs/WorkflowStepExecution.md)
+ - [Zyphr::WorkflowStepExecutionStatus](docs/WorkflowStepExecutionStatus.md)
 
 
 ## Documentation for Authorization

data/docs/ExecutionCancelResponse.md

@@ -0,0 +1,20 @@
+# Zyphr::ExecutionCancelResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**ExecutionCancelResponseData**](ExecutionCancelResponseData.md) |  | [optional] |
+| **meta** | [**RequestMeta**](RequestMeta.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::ExecutionCancelResponse.new(
+  data: null,
+  meta: null
+)
+```
+

data/docs/ExecutionCancelResponseData.md

@@ -0,0 +1,20 @@
+# Zyphr::ExecutionCancelResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **status** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::ExecutionCancelResponseData.new(
+  id: null,
+  status: cancelled
+)
+```
+

data/docs/ExecutionResponse.md

@@ -0,0 +1,20 @@
+# Zyphr::ExecutionResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**WorkflowExecution**](WorkflowExecution.md) |  | [optional] |
+| **meta** | [**RequestMeta**](RequestMeta.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::ExecutionResponse.new(
+  data: null,
+  meta: null
+)
+```
+

data/docs/ExecutionRetryResponse.md

@@ -0,0 +1,20 @@
+# Zyphr::ExecutionRetryResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**ExecutionRetryResponseData**](ExecutionRetryResponseData.md) |  | [optional] |
+| **meta** | [**RequestMeta**](RequestMeta.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::ExecutionRetryResponse.new(
+  data: null,
+  meta: null
+)
+```
+

data/docs/ExecutionRetryResponseData.md

@@ -0,0 +1,22 @@
+# Zyphr::ExecutionRetryResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The new execution created by the retry |  |
+| **original_execution_id** | **String** | The execution that was retried |  |
+| **status** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::ExecutionRetryResponseData.new(
+  id: null,
+  original_execution_id: null,
+  status: pending
+)
+```
+

data/docs/ExecutionsApi.md

@@ -0,0 +1,223 @@
+# Zyphr::ExecutionsApi
+
+All URIs are relative to *https://api.zyphr.dev/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**cancel_execution**](ExecutionsApi.md#cancel_execution) | **POST** /executions/{id}/cancel | Cancel a running execution |
+| [**get_execution**](ExecutionsApi.md#get_execution) | **GET** /executions/{id} | Get a workflow execution |
+| [**retry_execution**](ExecutionsApi.md#retry_execution) | **POST** /executions/{id}/retry | Retry a failed or cancelled execution |
+
+
+## cancel_execution
+
+> <ExecutionCancelResponse> cancel_execution(id)
+
+Cancel a running execution
+
+Cancel a workflow execution that is still pending or running. Already-terminal executions cannot be cancelled.
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = '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['X-API-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::ExecutionsApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Execution ID
+
+begin
+  # Cancel a running execution
+  result = api_instance.cancel_execution(id)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling ExecutionsApi->cancel_execution: #{e}"
+end
+```
+
+#### Using the cancel_execution_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ExecutionCancelResponse>, Integer, Hash)> cancel_execution_with_http_info(id)
+
+```ruby
+begin
+  # Cancel a running execution
+  data, status_code, headers = api_instance.cancel_execution_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ExecutionCancelResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling ExecutionsApi->cancel_execution_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Execution ID |  |
+
+### Return type
+
+[**ExecutionCancelResponse**](ExecutionCancelResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_execution
+
+> <ExecutionResponse> get_execution(id)
+
+Get a workflow execution
+
+Retrieve a workflow execution by ID, including its step execution details.
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = '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['X-API-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::ExecutionsApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Execution ID
+
+begin
+  # Get a workflow execution
+  result = api_instance.get_execution(id)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling ExecutionsApi->get_execution: #{e}"
+end
+```
+
+#### Using the get_execution_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ExecutionResponse>, Integer, Hash)> get_execution_with_http_info(id)
+
+```ruby
+begin
+  # Get a workflow execution
+  data, status_code, headers = api_instance.get_execution_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ExecutionResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling ExecutionsApi->get_execution_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Execution ID |  |
+
+### Return type
+
+[**ExecutionResponse**](ExecutionResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## retry_execution
+
+> <ExecutionRetryResponse> retry_execution(id)
+
+Retry a failed or cancelled execution
+
+Create a new workflow execution that re-runs the same workflow with the original subscriber, payload, and sender. Only `failed` or `cancelled` executions can be retried.
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = '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['X-API-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::ExecutionsApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | ID of the execution to retry
+
+begin
+  # Retry a failed or cancelled execution
+  result = api_instance.retry_execution(id)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling ExecutionsApi->retry_execution: #{e}"
+end
+```
+
+#### Using the retry_execution_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ExecutionRetryResponse>, Integer, Hash)> retry_execution_with_http_info(id)
+
+```ruby
+begin
+  # Retry a failed or cancelled execution
+  data, status_code, headers = api_instance.retry_execution_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ExecutionRetryResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling ExecutionsApi->retry_execution_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | ID of the execution to retry |  |
+
+### Return type
+
+[**ExecutionRetryResponse**](ExecutionRetryResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/WorkflowExecution.md

@@ -0,0 +1,46 @@
+# Zyphr::WorkflowExecution
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **workflow_id** | **String** |  |  |
+| **account_id** | **String** |  |  |
+| **project_id** | **String** |  |  |
+| **subscriber_id** | **String** |  |  |
+| **topic_key** | **String** |  | [optional] |
+| **trigger_payload** | **Hash<String, Object>** |  | [optional] |
+| **transaction_id** | **String** |  | [optional] |
+| **sender_from** | **String** |  | [optional] |
+| **status** | [**WorkflowExecutionStatus**](WorkflowExecutionStatus.md) |  |  |
+| **current_step_id** | **String** |  | [optional] |
+| **step_executions** | [**Array<WorkflowStepExecution>**](WorkflowStepExecution.md) |  | [optional] |
+| **started_at** | **Time** |  | [optional] |
+| **completed_at** | **Time** |  | [optional] |
+| **created_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::WorkflowExecution.new(
+  id: null,
+  workflow_id: null,
+  account_id: null,
+  project_id: null,
+  subscriber_id: null,
+  topic_key: null,
+  trigger_payload: null,
+  transaction_id: null,
+  sender_from: null,
+  status: null,
+  current_step_id: null,
+  step_executions: null,
+  started_at: null,
+  completed_at: null,
+  created_at: null
+)
+```
+

data/docs/WorkflowExecutionStatus.md

@@ -0,0 +1,15 @@
+# Zyphr::WorkflowExecutionStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::WorkflowExecutionStatus.new()
+```
+

data/docs/WorkflowStepExecution.md

@@ -0,0 +1,40 @@
+# Zyphr::WorkflowStepExecution
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **execution_id** | **String** |  |  |
+| **step_id** | **String** |  |  |
+| **status** | [**WorkflowStepExecutionStatus**](WorkflowStepExecutionStatus.md) |  |  |
+| **result** | **Hash<String, Object>** |  | [optional] |
+| **started_at** | **Time** |  | [optional] |
+| **completed_at** | **Time** |  | [optional] |
+| **error** | **String** |  | [optional] |
+| **created_at** | **Time** |  |  |
+| **step_key** | **String** | Step key from the workflow definition | [optional] |
+| **step_name** | **String** | Human-readable step name | [optional] |
+| **step_type** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::WorkflowStepExecution.new(
+  id: null,
+  execution_id: null,
+  step_id: null,
+  status: null,
+  result: null,
+  started_at: null,
+  completed_at: null,
+  error: null,
+  created_at: null,
+  step_key: null,
+  step_name: null,
+  step_type: null
+)
+```
+

data/docs/WorkflowStepExecutionStatus.md

@@ -0,0 +1,15 @@
+# Zyphr::WorkflowStepExecutionStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::WorkflowStepExecutionStatus.new()
+```
+