api-sdk-rb 1.11.66 → 1.11.111

data/docs/WorkflowList.md

@@ -0,0 +1,24 @@
+# ApiSdkRb::WorkflowList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **items** | [**Array<Workflow>**](Workflow.md) |  |  |
+| **total** | **Integer** |  |  |
+| **limit** | **Integer** |  |  |
+| **offset** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::WorkflowList.new(
+  items: null,
+  total: null,
+  limit: null,
+  offset: null
+)
+```
+

data/docs/WorkflowNode.md

@@ -0,0 +1,30 @@
+# ApiSdkRb::WorkflowNode
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **type** | **String** |  |  |
+| **position** | [**WorkflowNodePosition**](WorkflowNodePosition.md) |  | [optional] |
+| **composition_id** | **String** | The composition a `composition` block shows. | [optional] |
+| **starts_here** | **Boolean** | Set on the one composition block a visitor starts at. | [optional] |
+| **trigger** | [**WorkflowTrigger**](WorkflowTrigger.md) |  | [optional] |
+| **cases** | [**Array<WorkflowConditionCase>**](WorkflowConditionCase.md) | The rules of a `condition` block, in the order they are read. | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::WorkflowNode.new(
+  id: null,
+  type: null,
+  position: null,
+  composition_id: null,
+  starts_here: null,
+  trigger: null,
+  cases: null
+)
+```
+

data/docs/WorkflowNodePosition.md

@@ -0,0 +1,20 @@
+# ApiSdkRb::WorkflowNodePosition
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x** | **Float** |  |  |
+| **y** | **Float** |  |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::WorkflowNodePosition.new(
+  x: null,
+  y: null
+)
+```
+

data/docs/WorkflowPresetChoice.md

@@ -0,0 +1,26 @@
+# ApiSdkRb::WorkflowPresetChoice
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** | What `createWorkspaceWorkflowFromPreset` takes to say which starting point. |  |
+| **title** | **String** | The title the offerer gave it, or the name of the workflow it is made from. |  |
+| **description** | **String** |  |  |
+| **block_count** | **Integer** | How many blocks it has (compositions, triggers and conditions). |  |
+| **widgets** | [**Array<WorkflowPresetWidget>**](WorkflowPresetWidget.md) | The widgets it shows, once each, in the order they first appear. |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::WorkflowPresetChoice.new(
+  key: welcome-then-offer,
+  title: null,
+  description: null,
+  block_count: null,
+  widgets: null
+)
+```
+

data/docs/WorkflowPresetChoices.md

@@ -0,0 +1,18 @@
+# ApiSdkRb::WorkflowPresetChoices
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **items** | [**Array<WorkflowPresetChoice>**](WorkflowPresetChoice.md) | The starting points, in the order the offerer set (smallest position first, then by key). |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::WorkflowPresetChoices.new(
+  items: null
+)
+```
+

data/docs/WorkflowPresetRemoval.md

@@ -0,0 +1,18 @@
+# ApiSdkRb::WorkflowPresetRemoval
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **removed** | **Boolean** | False when nothing was offered under that key. |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::WorkflowPresetRemoval.new(
+  removed: null
+)
+```
+

data/docs/WorkflowPresetWidget.md

@@ -0,0 +1,20 @@
+# ApiSdkRb::WorkflowPresetWidget
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **thumbnail_url** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::WorkflowPresetWidget.new(
+  name: null,
+  thumbnail_url: null
+)
+```
+

data/docs/WorkflowPublishResult.md

@@ -0,0 +1,22 @@
+# ApiSdkRb::WorkflowPublishResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workflow** | [**WorkflowDetail**](WorkflowDetail.md) |  |  |
+| **version** | [**WorkflowVersion**](WorkflowVersion.md) |  |  |
+| **warnings** | [**Array<WorkflowIssue>**](WorkflowIssue.md) | Advice that does not stop publishing, such as a block nothing leads to. |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::WorkflowPublishResult.new(
+  workflow: null,
+  version: null,
+  warnings: null
+)
+```
+

data/docs/WorkflowRemoved.md

@@ -0,0 +1,18 @@
+# ApiSdkRb::WorkflowRemoved
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **removed** | **Boolean** |  |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::WorkflowRemoved.new(
+  removed: true
+)
+```
+

data/docs/WorkflowSchedule.md

@@ -0,0 +1,24 @@
+# ApiSdkRb::WorkflowSchedule
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mode** | **String** |  |  |
+| **amount** | **Float** | How long to wait (mode `after`). | [optional] |
+| **unit** | **String** | The unit of `amount` (mode `after`). | [optional] |
+| **at** | **Time** | The moment to fire at, as an ISO time in UTC (mode `at`). | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::WorkflowSchedule.new(
+  mode: null,
+  amount: null,
+  unit: null,
+  at: null
+)
+```
+

data/docs/WorkflowStats.md

@@ -0,0 +1,32 @@
+# ApiSdkRb::WorkflowStats
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workflow_id** | **String** |  |  |
+| **version_id** | **String** | The version counted, or null when all versions are. | [optional] |
+| **from** | **String** | First UTC day counted (YYYY-MM-DD). |  |
+| **to** | **String** | Last UTC day counted (YYYY-MM-DD). |  |
+| **started** | **Integer** | Visitors who started the workflow in the range; null when all versions are counted. | [optional] |
+| **nodes** | [**Array<WorkflowCounter>**](WorkflowCounter.md) | Visitors who reached each block. |  |
+| **edges** | [**Array<WorkflowCounter>**](WorkflowCounter.md) | Visitors who took each connection. |  |
+| **failed** | [**Array<WorkflowCounter>**](WorkflowCounter.md) | Times moving on to a block failed (it did not load in time) and the visitor stayed. |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::WorkflowStats.new(
+  workflow_id: null,
+  version_id: null,
+  from: null,
+  to: null,
+  started: null,
+  nodes: null,
+  edges: null,
+  failed: null
+)
+```
+

data/docs/WorkflowStatus.md

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

data/docs/WorkflowTrigger.md

@@ -0,0 +1,28 @@
+# ApiSdkRb::WorkflowTrigger
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **kind** | **String** |  |  |
+| **table** | **String** |  | [optional] |
+| **action_id** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **values** | [**Array<WorkflowTriggerValuesInner>**](WorkflowTriggerValuesInner.md) |  | [optional] |
+| **schedule** | [**WorkflowSchedule**](WorkflowSchedule.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::WorkflowTrigger.new(
+  kind: null,
+  table: null,
+  action_id: null,
+  name: null,
+  values: null,
+  schedule: null
+)
+```
+

data/docs/WorkflowTriggerValuesInner.md

@@ -0,0 +1,20 @@
+# ApiSdkRb::WorkflowTriggerValuesInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **type** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::WorkflowTriggerValuesInner.new(
+  name: null,
+  type: null
+)
+```
+

data/docs/WorkflowVersion.md

@@ -0,0 +1,28 @@
+# ApiSdkRb::WorkflowVersion
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **version_number** | **Integer** |  |  |
+| **published_at** | **Time** |  |  |
+| **published_by** | [**WorkflowVersionPublishedBy**](WorkflowVersionPublishedBy.md) |  | [optional] |
+| **timezone** | **String** |  |  |
+| **is_live** | **Boolean** | Whether this is the version visitors who are new to the workflow get. |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::WorkflowVersion.new(
+  id: null,
+  version_number: null,
+  published_at: null,
+  published_by: null,
+  timezone: Europe/Bucharest,
+  is_live: null
+)
+```
+

data/docs/WorkflowVersionDetail.md

@@ -0,0 +1,32 @@
+# ApiSdkRb::WorkflowVersionDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **version_number** | **Integer** |  |  |
+| **published_at** | **Time** |  |  |
+| **published_by** | [**WorkflowVersionPublishedBy**](WorkflowVersionPublishedBy.md) |  | [optional] |
+| **timezone** | **String** |  |  |
+| **is_live** | **Boolean** | Whether this is the version visitors who are new to the workflow get. |  |
+| **start_node_id** | **String** |  |  |
+| **graph** | [**WorkflowGraph**](WorkflowGraph.md) |  |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::WorkflowVersionDetail.new(
+  id: null,
+  version_number: null,
+  published_at: null,
+  published_by: null,
+  timezone: Europe/Bucharest,
+  is_live: null,
+  start_node_id: null,
+  graph: null
+)
+```
+

data/docs/WorkflowVersionList.md

@@ -0,0 +1,18 @@
+# ApiSdkRb::WorkflowVersionList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **items** | [**Array<WorkflowVersion>**](WorkflowVersion.md) | Newest first. |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::WorkflowVersionList.new(
+  items: null
+)
+```
+

data/docs/WorkflowVersionPublishedBy.md

@@ -0,0 +1,20 @@
+# ApiSdkRb::WorkflowVersionPublishedBy
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::WorkflowVersionPublishedBy.new(
+  id: null,
+  name: null
+)
+```
+