zyphr 0.1.38 → 0.1.40

data/docs/TriggerWorkflowRequest.md

@@ -0,0 +1,24 @@
+# Zyphr::TriggerWorkflowRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **to** | **Array<String>** | Recipient(s). An array of subscriber ids. For convenience the API also accepts a single subscriber id string, or a topic fan-out object `{ \"topic\": \"<topic_key>\" }` to deliver to every subscriber of a topic. |  |
+| **payload** | **Hash<String, Object>** | Data made available to step templates and branch conditions. | [optional] |
+| **transaction_id** | **String** | Optional idempotency/correlation identifier. | [optional] |
+| **from** | **String** | Optional sender override for email steps (e.g. `noreply@yourdomain.com`). | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::TriggerWorkflowRequest.new(
+  to: ["user_123","user_456"],
+  payload: null,
+  transaction_id: null,
+  from: null
+)
+```
+

data/docs/UpdateWorkflowRequest.md

@@ -0,0 +1,24 @@
+# Zyphr::UpdateWorkflowRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **is_critical** | **Boolean** |  | [optional] |
+| **tags** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::UpdateWorkflowRequest.new(
+  name: null,
+  description: null,
+  is_critical: null,
+  tags: null
+)
+```
+

data/docs/UpdateWorkflowStatusRequest.md

@@ -0,0 +1,18 @@
+# Zyphr::UpdateWorkflowStatusRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | [**WorkflowStatus**](WorkflowStatus.md) |  |  |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::UpdateWorkflowStatusRequest.new(
+  status: null
+)
+```
+

data/docs/UpdateWorkflowStepRequest.md

@@ -0,0 +1,20 @@
+# Zyphr::UpdateWorkflowStepRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **config** | **Hash<String, Object>** | Step configuration whose shape depends on the step's type. | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::UpdateWorkflowStepRequest.new(
+  name: null,
+  config: null
+)
+```
+

data/docs/Workflow.md

@@ -0,0 +1,42 @@
+# Zyphr::Workflow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **account_id** | **String** |  |  |
+| **key** | **String** | Unique workflow key within the project. |  |
+| **name** | **String** |  |  |
+| **description** | **String** |  | [optional] |
+| **status** | [**WorkflowStatus**](WorkflowStatus.md) |  |  |
+| **is_critical** | **Boolean** |  |  |
+| **trigger_schema** | **Hash<String, Object>** |  | [optional] |
+| **tags** | **Array<String>** |  |  |
+| **step_count** | **Integer** | Number of steps in the workflow (present in list responses). | [optional] |
+| **steps** | [**Array<WorkflowStep>**](WorkflowStep.md) | Ordered workflow steps (present when fetching a single workflow). | [optional] |
+| **created_at** | **Time** |  |  |
+| **updated_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::Workflow.new(
+  id: null,
+  account_id: null,
+  key: welcome-series,
+  name: Welcome Series,
+  description: null,
+  status: null,
+  is_critical: null,
+  trigger_schema: null,
+  tags: null,
+  step_count: null,
+  steps: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/WorkflowStatus.md

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

data/docs/WorkflowStep.md

@@ -0,0 +1,38 @@
+# Zyphr::WorkflowStep
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **workflow_id** | **String** |  |  |
+| **step_key** | **String** | Unique step identifier within the workflow. |  |
+| **name** | **String** | Human-readable step name. |  |
+| **type** | [**WorkflowStepType**](WorkflowStepType.md) |  |  |
+| **position** | **Integer** | Ordering position of the step within the workflow. |  |
+| **config** | **Hash<String, Object>** | Step configuration. The shape depends on `type` — channel steps carry message content (subject, body, template_id, etc.), `delay` steps carry `{ amount, unit }`, and `branch` steps carry `{ conditions }`.  |  |
+| **parent_step_id** | **String** |  | [optional] |
+| **branch_path** | **String** |  | [optional] |
+| **created_at** | **Time** |  |  |
+| **updated_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::WorkflowStep.new(
+  id: null,
+  workflow_id: null,
+  step_key: send-welcome-email,
+  name: null,
+  type: null,
+  position: null,
+  config: null,
+  parent_step_id: null,
+  branch_path: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/WorkflowStepType.md

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