zyphr 0.1.39 → 0.1.41

data/docs/WorkflowsApi.md

@@ -0,0 +1,901 @@
+# Zyphr::WorkflowsApi
+
+All URIs are relative to *https://api.zyphr.dev/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**add_workflow_step**](WorkflowsApi.md#add_workflow_step) | **POST** /workflows/{key}/steps | Add a workflow step |
+| [**create_workflow**](WorkflowsApi.md#create_workflow) | **POST** /workflows | Create a workflow |
+| [**delete_workflow**](WorkflowsApi.md#delete_workflow) | **DELETE** /workflows/{key} | Delete a workflow |
+| [**delete_workflow_step**](WorkflowsApi.md#delete_workflow_step) | **DELETE** /workflows/{key}/steps/{stepKey} | Delete a workflow step |
+| [**get_workflow**](WorkflowsApi.md#get_workflow) | **GET** /workflows/{key} | Get a workflow |
+| [**list_workflow_executions**](WorkflowsApi.md#list_workflow_executions) | **GET** /workflows/{key}/executions | List workflow executions |
+| [**list_workflows**](WorkflowsApi.md#list_workflows) | **GET** /workflows | List workflows |
+| [**reorder_workflow_steps**](WorkflowsApi.md#reorder_workflow_steps) | **PUT** /workflows/{key}/steps/reorder | Reorder workflow steps |
+| [**trigger_workflow**](WorkflowsApi.md#trigger_workflow) | **POST** /workflows/{key}/trigger | Trigger a workflow |
+| [**update_workflow**](WorkflowsApi.md#update_workflow) | **PATCH** /workflows/{key} | Update a workflow |
+| [**update_workflow_status**](WorkflowsApi.md#update_workflow_status) | **PATCH** /workflows/{key}/status | Update workflow status |
+| [**update_workflow_step**](WorkflowsApi.md#update_workflow_step) | **PATCH** /workflows/{key}/steps/{stepKey} | Update a workflow step |
+
+
+## add_workflow_step
+
+> <AddWorkflowStep201Response> add_workflow_step(key, add_workflow_step_request)
+
+Add a workflow step
+
+Append a step to a workflow. Channel steps (`email`, `push`, `sms`, `in_app`, `slack`, `discord`, `teams`) carry message content in `config`; `delay` steps carry `{ amount, unit }`; `branch` steps carry `{ conditions }`. 
+
+### 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::WorkflowsApi.new
+key = 'key_example' # String | The workflow key.
+add_workflow_step_request = Zyphr::AddWorkflowStepRequest.new({step_key: 'send-welcome-email', name: 'name_example', type: Zyphr::WorkflowStepType::EMAIL, config: { key: 3.56}}) # AddWorkflowStepRequest | 
+
+begin
+  # Add a workflow step
+  result = api_instance.add_workflow_step(key, add_workflow_step_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling WorkflowsApi->add_workflow_step: #{e}"
+end
+```
+
+#### Using the add_workflow_step_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AddWorkflowStep201Response>, Integer, Hash)> add_workflow_step_with_http_info(key, add_workflow_step_request)
+
+```ruby
+begin
+  # Add a workflow step
+  data, status_code, headers = api_instance.add_workflow_step_with_http_info(key, add_workflow_step_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AddWorkflowStep201Response>
+rescue Zyphr::ApiError => e
+  puts "Error when calling WorkflowsApi->add_workflow_step_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** | The workflow key. |  |
+| **add_workflow_step_request** | [**AddWorkflowStepRequest**](AddWorkflowStepRequest.md) |  |  |
+
+### Return type
+
+[**AddWorkflowStep201Response**](AddWorkflowStep201Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## create_workflow
+
+> <CreateWorkflow201Response> create_workflow(create_workflow_request)
+
+Create a workflow
+
+Create a new notification workflow. A workflow is a named, multi-step notification sequence identified by a unique `key` within the project. If `key` is omitted, one is derived from the `name`. 
+
+### 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::WorkflowsApi.new
+create_workflow_request = Zyphr::CreateWorkflowRequest.new({name: 'Welcome Series'}) # CreateWorkflowRequest | 
+
+begin
+  # Create a workflow
+  result = api_instance.create_workflow(create_workflow_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling WorkflowsApi->create_workflow: #{e}"
+end
+```
+
+#### Using the create_workflow_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateWorkflow201Response>, Integer, Hash)> create_workflow_with_http_info(create_workflow_request)
+
+```ruby
+begin
+  # Create a workflow
+  data, status_code, headers = api_instance.create_workflow_with_http_info(create_workflow_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateWorkflow201Response>
+rescue Zyphr::ApiError => e
+  puts "Error when calling WorkflowsApi->create_workflow_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_workflow_request** | [**CreateWorkflowRequest**](CreateWorkflowRequest.md) |  |  |
+
+### Return type
+
+[**CreateWorkflow201Response**](CreateWorkflow201Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_workflow
+
+> <DeleteWorkflow200Response> delete_workflow(key)
+
+Delete a workflow
+
+Permanently delete a workflow and all of its steps.
+
+### 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::WorkflowsApi.new
+key = 'key_example' # String | The workflow key.
+
+begin
+  # Delete a workflow
+  result = api_instance.delete_workflow(key)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling WorkflowsApi->delete_workflow: #{e}"
+end
+```
+
+#### Using the delete_workflow_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DeleteWorkflow200Response>, Integer, Hash)> delete_workflow_with_http_info(key)
+
+```ruby
+begin
+  # Delete a workflow
+  data, status_code, headers = api_instance.delete_workflow_with_http_info(key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DeleteWorkflow200Response>
+rescue Zyphr::ApiError => e
+  puts "Error when calling WorkflowsApi->delete_workflow_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** | The workflow key. |  |
+
+### Return type
+
+[**DeleteWorkflow200Response**](DeleteWorkflow200Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## delete_workflow_step
+
+> <DeleteWorkflowStep200Response> delete_workflow_step(key, step_key)
+
+Delete a workflow step
+
+Remove a step from a workflow.
+
+### 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::WorkflowsApi.new
+key = 'key_example' # String | The workflow key.
+step_key = 'step_key_example' # String | The step key.
+
+begin
+  # Delete a workflow step
+  result = api_instance.delete_workflow_step(key, step_key)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling WorkflowsApi->delete_workflow_step: #{e}"
+end
+```
+
+#### Using the delete_workflow_step_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DeleteWorkflowStep200Response>, Integer, Hash)> delete_workflow_step_with_http_info(key, step_key)
+
+```ruby
+begin
+  # Delete a workflow step
+  data, status_code, headers = api_instance.delete_workflow_step_with_http_info(key, step_key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DeleteWorkflowStep200Response>
+rescue Zyphr::ApiError => e
+  puts "Error when calling WorkflowsApi->delete_workflow_step_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** | The workflow key. |  |
+| **step_key** | **String** | The step key. |  |
+
+### Return type
+
+[**DeleteWorkflowStep200Response**](DeleteWorkflowStep200Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_workflow
+
+> <CreateWorkflow201Response> get_workflow(key)
+
+Get a workflow
+
+Retrieve a single workflow by its key, including its ordered steps.
+
+### 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::WorkflowsApi.new
+key = 'key_example' # String | The workflow key.
+
+begin
+  # Get a workflow
+  result = api_instance.get_workflow(key)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling WorkflowsApi->get_workflow: #{e}"
+end
+```
+
+#### Using the get_workflow_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateWorkflow201Response>, Integer, Hash)> get_workflow_with_http_info(key)
+
+```ruby
+begin
+  # Get a workflow
+  data, status_code, headers = api_instance.get_workflow_with_http_info(key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateWorkflow201Response>
+rescue Zyphr::ApiError => e
+  puts "Error when calling WorkflowsApi->get_workflow_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** | The workflow key. |  |
+
+### Return type
+
+[**CreateWorkflow201Response**](CreateWorkflow201Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_workflow_executions
+
+> <ListWorkflowExecutions200Response> list_workflow_executions(key, opts)
+
+List workflow executions
+
+List the executions of a workflow, most recent first. Supports pagination.
+
+### 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::WorkflowsApi.new
+key = 'key_example' # String | The workflow key.
+opts = {
+  page: 56, # Integer | Page number (1-based).
+  per_page: 56 # Integer | Number of executions per page (max 100).
+}
+
+begin
+  # List workflow executions
+  result = api_instance.list_workflow_executions(key, opts)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling WorkflowsApi->list_workflow_executions: #{e}"
+end
+```
+
+#### Using the list_workflow_executions_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListWorkflowExecutions200Response>, Integer, Hash)> list_workflow_executions_with_http_info(key, opts)
+
+```ruby
+begin
+  # List workflow executions
+  data, status_code, headers = api_instance.list_workflow_executions_with_http_info(key, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListWorkflowExecutions200Response>
+rescue Zyphr::ApiError => e
+  puts "Error when calling WorkflowsApi->list_workflow_executions_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** | The workflow key. |  |
+| **page** | **Integer** | Page number (1-based). | [optional][default to 1] |
+| **per_page** | **Integer** | Number of executions per page (max 100). | [optional][default to 25] |
+
+### Return type
+
+[**ListWorkflowExecutions200Response**](ListWorkflowExecutions200Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_workflows
+
+> <ListWorkflows200Response> list_workflows(opts)
+
+List workflows
+
+List workflows in the project. Supports pagination, free-text search, and status filtering.
+
+### 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::WorkflowsApi.new
+opts = {
+  page: 56, # Integer | Page number (1-based).
+  per_page: 56, # Integer | Number of workflows per page (max 100).
+  search: 'search_example', # String | Free-text search over workflow name and key.
+  status: Zyphr::WorkflowStatus::DRAFT # WorkflowStatus | Filter by workflow status.
+}
+
+begin
+  # List workflows
+  result = api_instance.list_workflows(opts)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling WorkflowsApi->list_workflows: #{e}"
+end
+```
+
+#### Using the list_workflows_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListWorkflows200Response>, Integer, Hash)> list_workflows_with_http_info(opts)
+
+```ruby
+begin
+  # List workflows
+  data, status_code, headers = api_instance.list_workflows_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListWorkflows200Response>
+rescue Zyphr::ApiError => e
+  puts "Error when calling WorkflowsApi->list_workflows_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Integer** | Page number (1-based). | [optional][default to 1] |
+| **per_page** | **Integer** | Number of workflows per page (max 100). | [optional][default to 25] |
+| **search** | **String** | Free-text search over workflow name and key. | [optional] |
+| **status** | [**WorkflowStatus**](.md) | Filter by workflow status. | [optional] |
+
+### Return type
+
+[**ListWorkflows200Response**](ListWorkflows200Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## reorder_workflow_steps
+
+> <CreateWorkflow201Response> reorder_workflow_steps(key, reorder_workflow_steps_request)
+
+Reorder workflow steps
+
+Reorder a workflow's steps. Provide the full set of step keys in the desired order — the array must contain exactly the workflow's existing step keys. 
+
+### 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::WorkflowsApi.new
+key = 'key_example' # String | The workflow key.
+reorder_workflow_steps_request = Zyphr::ReorderWorkflowStepsRequest.new({step_keys: ['step_keys_example']}) # ReorderWorkflowStepsRequest | 
+
+begin
+  # Reorder workflow steps
+  result = api_instance.reorder_workflow_steps(key, reorder_workflow_steps_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling WorkflowsApi->reorder_workflow_steps: #{e}"
+end
+```
+
+#### Using the reorder_workflow_steps_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateWorkflow201Response>, Integer, Hash)> reorder_workflow_steps_with_http_info(key, reorder_workflow_steps_request)
+
+```ruby
+begin
+  # Reorder workflow steps
+  data, status_code, headers = api_instance.reorder_workflow_steps_with_http_info(key, reorder_workflow_steps_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateWorkflow201Response>
+rescue Zyphr::ApiError => e
+  puts "Error when calling WorkflowsApi->reorder_workflow_steps_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** | The workflow key. |  |
+| **reorder_workflow_steps_request** | [**ReorderWorkflowStepsRequest**](ReorderWorkflowStepsRequest.md) |  |  |
+
+### Return type
+
+[**CreateWorkflow201Response**](CreateWorkflow201Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## trigger_workflow
+
+> <TriggerWorkflow202Response> trigger_workflow(key, trigger_workflow_request)
+
+Trigger a workflow
+
+Trigger an execution of an active workflow for one or more recipients. The `to` field accepts a single recipient, an array of recipients, or a topic object (`{ \"topic\": \"topic-key\" }`) to trigger for all subscribers of a topic. One execution is created per resolved subscriber. 
+
+### 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::WorkflowsApi.new
+key = 'key_example' # String | The workflow key.
+trigger_workflow_request = Zyphr::TriggerWorkflowRequest.new({to: ["user_123", "user_456"]}) # TriggerWorkflowRequest | 
+
+begin
+  # Trigger a workflow
+  result = api_instance.trigger_workflow(key, trigger_workflow_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling WorkflowsApi->trigger_workflow: #{e}"
+end
+```
+
+#### Using the trigger_workflow_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TriggerWorkflow202Response>, Integer, Hash)> trigger_workflow_with_http_info(key, trigger_workflow_request)
+
+```ruby
+begin
+  # Trigger a workflow
+  data, status_code, headers = api_instance.trigger_workflow_with_http_info(key, trigger_workflow_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TriggerWorkflow202Response>
+rescue Zyphr::ApiError => e
+  puts "Error when calling WorkflowsApi->trigger_workflow_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** | The workflow key. |  |
+| **trigger_workflow_request** | [**TriggerWorkflowRequest**](TriggerWorkflowRequest.md) |  |  |
+
+### Return type
+
+[**TriggerWorkflow202Response**](TriggerWorkflow202Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## update_workflow
+
+> <CreateWorkflow201Response> update_workflow(key, update_workflow_request)
+
+Update a workflow
+
+Update a workflow's metadata. Only the provided fields are changed. To change the status, use the dedicated status endpoint.
+
+### 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::WorkflowsApi.new
+key = 'key_example' # String | The workflow key.
+update_workflow_request = Zyphr::UpdateWorkflowRequest.new # UpdateWorkflowRequest | 
+
+begin
+  # Update a workflow
+  result = api_instance.update_workflow(key, update_workflow_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling WorkflowsApi->update_workflow: #{e}"
+end
+```
+
+#### Using the update_workflow_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateWorkflow201Response>, Integer, Hash)> update_workflow_with_http_info(key, update_workflow_request)
+
+```ruby
+begin
+  # Update a workflow
+  data, status_code, headers = api_instance.update_workflow_with_http_info(key, update_workflow_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateWorkflow201Response>
+rescue Zyphr::ApiError => e
+  puts "Error when calling WorkflowsApi->update_workflow_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** | The workflow key. |  |
+| **update_workflow_request** | [**UpdateWorkflowRequest**](UpdateWorkflowRequest.md) |  |  |
+
+### Return type
+
+[**CreateWorkflow201Response**](CreateWorkflow201Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## update_workflow_status
+
+> <CreateWorkflow201Response> update_workflow_status(key, update_workflow_status_request)
+
+Update workflow status
+
+Change a workflow's lifecycle status. This is the single endpoint for activating, pausing, archiving, or returning a workflow to draft — there are no separate `/activate` or `/pause` endpoints. Set `status` to `active` to activate and `paused` to pause. 
+
+### 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::WorkflowsApi.new
+key = 'key_example' # String | The workflow key.
+update_workflow_status_request = Zyphr::UpdateWorkflowStatusRequest.new({status: Zyphr::WorkflowStatus::DRAFT}) # UpdateWorkflowStatusRequest | 
+
+begin
+  # Update workflow status
+  result = api_instance.update_workflow_status(key, update_workflow_status_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling WorkflowsApi->update_workflow_status: #{e}"
+end
+```
+
+#### Using the update_workflow_status_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateWorkflow201Response>, Integer, Hash)> update_workflow_status_with_http_info(key, update_workflow_status_request)
+
+```ruby
+begin
+  # Update workflow status
+  data, status_code, headers = api_instance.update_workflow_status_with_http_info(key, update_workflow_status_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateWorkflow201Response>
+rescue Zyphr::ApiError => e
+  puts "Error when calling WorkflowsApi->update_workflow_status_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** | The workflow key. |  |
+| **update_workflow_status_request** | [**UpdateWorkflowStatusRequest**](UpdateWorkflowStatusRequest.md) |  |  |
+
+### Return type
+
+[**CreateWorkflow201Response**](CreateWorkflow201Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## update_workflow_step
+
+> <AddWorkflowStep201Response> update_workflow_step(key, step_key, update_workflow_step_request)
+
+Update a workflow step
+
+Update a step's name and/or config. Only the provided fields are changed.
+
+### 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::WorkflowsApi.new
+key = 'key_example' # String | The workflow key.
+step_key = 'step_key_example' # String | The step key.
+update_workflow_step_request = Zyphr::UpdateWorkflowStepRequest.new # UpdateWorkflowStepRequest | 
+
+begin
+  # Update a workflow step
+  result = api_instance.update_workflow_step(key, step_key, update_workflow_step_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling WorkflowsApi->update_workflow_step: #{e}"
+end
+```
+
+#### Using the update_workflow_step_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AddWorkflowStep201Response>, Integer, Hash)> update_workflow_step_with_http_info(key, step_key, update_workflow_step_request)
+
+```ruby
+begin
+  # Update a workflow step
+  data, status_code, headers = api_instance.update_workflow_step_with_http_info(key, step_key, update_workflow_step_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AddWorkflowStep201Response>
+rescue Zyphr::ApiError => e
+  puts "Error when calling WorkflowsApi->update_workflow_step_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** | The workflow key. |  |
+| **step_key** | **String** | The step key. |  |
+| **update_workflow_step_request** | [**UpdateWorkflowStepRequest**](UpdateWorkflowStepRequest.md) |  |  |
+
+### Return type
+
+[**AddWorkflowStep201Response**](AddWorkflowStep201Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+