api-sdk-rb 1.11.66 → 1.11.133

data/docs/WorkflowCompositionOptions.md

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

data/docs/WorkflowConditionCase.md

@@ -0,0 +1,24 @@
+# ApiSdkRb::WorkflowConditionCase
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The output port of the rule. `default` is reserved for the Default output. |  |
+| **label** | **String** |  | [optional] |
+| **match** | **String** | `all` - every comparison must hold; `any` - one is enough. |  |
+| **tests** | [**Array<WorkflowConditionTest>**](WorkflowConditionTest.md) |  |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::WorkflowConditionCase.new(
+  id: null,
+  label: null,
+  match: null,
+  tests: null
+)
+```
+

data/docs/WorkflowConditionTest.md

@@ -0,0 +1,22 @@
+# ApiSdkRb::WorkflowConditionTest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **field** | [**WorkflowFieldReference**](WorkflowFieldReference.md) |  |  |
+| **operator** | **String** | Text fields take is, isNot, contains, doesNotContain, startsWith, endsWith, isEmpty and isNotEmpty. Number fields take is, isNot, greaterThan, atLeast, lessThan, atMost, isEmpty and isNotEmpty. Yes/no fields take is and isNot.  |  |
+| **value** | **Object** | What the field is compared with; not used by isEmpty and isNotEmpty. A text for a text field, a number for a number field, true or false for a yes/no field.  | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::WorkflowConditionTest.new(
+  field: null,
+  operator: null,
+  value: null
+)
+```
+

data/docs/WorkflowCounter.md

@@ -0,0 +1,20 @@
+# ApiSdkRb::WorkflowCounter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The block or connection counted. |  |
+| **total** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::WorkflowCounter.new(
+  id: null,
+  total: null
+)
+```
+

data/docs/WorkflowDetail.md

@@ -0,0 +1,60 @@
+# ApiSdkRb::WorkflowDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **name** | **String** |  |  |
+| **managed_user_id** | **String** | The customer of a partner (a managed user) this workflow was made for, or null when it is its workspace's own. A customer's editor session lists and opens only the workflows filed under that customer; the partner's own account sees every customer's and tells them apart by this. It is set when the workflow is made and never changes.  | [optional] |
+| **status** | [**WorkflowStatus**](WorkflowStatus.md) |  |  |
+| **revision** | **Integer** | Rises by one with every save. A save, a publish, a discard and a restore each name the revision they started from. |  |
+| **unpublished_changes** | **Boolean** | Whether the draft differs from the live version. |  |
+| **composition_ids** | **Array<String>** |  |  |
+| **block_count** | **Integer** |  |  |
+| **timezone** | **String** | The zone date and time triggers are read in (stored as UTC). |  |
+| **runs_count** | **Integer** | Visitors who started the workflow, over its whole life. |  |
+| **live_version_id** | **String** |  | [optional] |
+| **created_at** | **Time** |  |  |
+| **updated_at** | **Time** |  |  |
+| **first_published_at** | **Time** |  | [optional] |
+| **last_published_at** | **Time** |  | [optional] |
+| **paused_at** | **Time** |  | [optional] |
+| **archived_at** | **Time** |  | [optional] |
+| **graph** | [**WorkflowGraph**](WorkflowGraph.md) |  |  |
+| **live_version** | [**WorkflowVersion**](WorkflowVersion.md) | The version visitors get, without its graph; null before the first publish. | [optional] |
+| **ever_published** | **Boolean** | Whether it was ever published (it then has versions and counts, and visitors may have run it). |  |
+| **last_edited_by** | [**WorkflowDetailAllOfLastEditedBy**](WorkflowDetailAllOfLastEditedBy.md) |  | [optional] |
+| **last_edited_at** | **Time** | When that latest change was made. Present whenever `lastEditedBy` is. | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::WorkflowDetail.new(
+  id: null,
+  name: null,
+  managed_user_id: null,
+  status: null,
+  revision: null,
+  unpublished_changes: null,
+  composition_ids: null,
+  block_count: null,
+  timezone: null,
+  runs_count: null,
+  live_version_id: null,
+  created_at: null,
+  updated_at: null,
+  first_published_at: null,
+  last_published_at: null,
+  paused_at: null,
+  archived_at: null,
+  graph: null,
+  live_version: null,
+  ever_published: null,
+  last_edited_by: null,
+  last_edited_at: null
+)
+```
+

data/docs/WorkflowDetailAllOfLastEditedBy.md

@@ -0,0 +1,20 @@
+# ApiSdkRb::WorkflowDetailAllOfLastEditedBy
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The account that made the latest change | [optional] |
+| **name** | **String** | The name on that account, or `null` when it has none or it could not be read just then. Never an email address. | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::WorkflowDetailAllOfLastEditedBy.new(
+  id: null,
+  name: null
+)
+```
+

data/docs/WorkflowDetailResponse.md

@@ -0,0 +1,22 @@
+# ApiSdkRb::WorkflowDetailResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** |  |  |
+| **data** | [**WorkflowDetail**](WorkflowDetail.md) |  |  |
+| **meta** | [**ResponseMeta**](ResponseMeta.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::WorkflowDetailResponse.new(
+  success: true,
+  data: null,
+  meta: null
+)
+```
+

data/docs/WorkflowEdge.md

@@ -0,0 +1,24 @@
+# ApiSdkRb::WorkflowEdge
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **source** | **String** |  |  |
+| **source_port** | **String** | `out` for compositions and triggers; a rule's id, or `default`, for conditions. |  |
+| **target** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::WorkflowEdge.new(
+  id: null,
+  source: null,
+  source_port: null,
+  target: null
+)
+```
+

data/docs/WorkflowFailureReason.md

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

data/docs/WorkflowFailureReasonCounter.md

@@ -0,0 +1,22 @@
+# ApiSdkRb::WorkflowFailureReasonCounter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The block (a composition) that could not be shown. |  |
+| **reason** | [**WorkflowFailureReason**](WorkflowFailureReason.md) |  |  |
+| **total** | **Integer** | How many tries failed for this reason. |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::WorkflowFailureReasonCounter.new(
+  id: null,
+  reason: null,
+  total: null
+)
+```
+

data/docs/WorkflowFieldReference.md

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

data/docs/WorkflowGraph.md

@@ -0,0 +1,22 @@
+# ApiSdkRb::WorkflowGraph
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **schema_version** | **Integer** |  |  |
+| **nodes** | [**Array<WorkflowNode>**](WorkflowNode.md) |  |  |
+| **edges** | [**Array<WorkflowEdge>**](WorkflowEdge.md) |  |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::WorkflowGraph.new(
+  schema_version: null,
+  nodes: null,
+  edges: null
+)
+```
+

data/docs/WorkflowIssue.md

@@ -0,0 +1,28 @@
+# ApiSdkRb::WorkflowIssue
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** |  |  |
+| **severity** | **String** |  |  |
+| **node_id** | **String** |  | [optional] |
+| **edge_id** | **String** |  | [optional] |
+| **case_id** | **String** |  | [optional] |
+| **detail** | **String** | A short machine-readable detail such as a column or a table name. Never a sentence. | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::WorkflowIssue.new(
+  code: trigger_no_target,
+  severity: null,
+  node_id: null,
+  edge_id: null,
+  case_id: null,
+  detail: null
+)
+```
+

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/WorkflowResponse.md

@@ -0,0 +1,22 @@
+# ApiSdkRb::WorkflowResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** |  |  |
+| **data** | [**Workflow**](Workflow.md) |  |  |
+| **meta** | [**ResponseMeta**](ResponseMeta.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::WorkflowResponse.new(
+  success: true,
+  data: null,
+  meta: null
+)
+```
+

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,34 @@
+# 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 and the visitor stayed, whatever the reason: every failure is counted here, including the ones whose browser did not say why. A try is counted, not a visitor: a step is tried once more after 30 seconds, so one visitor can count twice.  |  |
+| **failed_reasons** | [**Array<WorkflowFailureReasonCounter>**](WorkflowFailureReasonCounter.md) | Why those failed, where the visitor's browser said why: one entry for each block and reason that has a count. The reasons of a block add up to at most its `failed` total, never more: a failure reported by an embed that does not say why (an older one) is in `failed` and in none of these, so a block whose reasons add up to less has some of unknown reason. Empty when no failure in the range had a reason. Sent by gateways that keep reasons; a client that reads a gateway without them treats a missing list as empty.  | [optional] |
+
+## 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,
+  failed_reasons: 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
+)
+```
+