api-sdk-rb 1.11.66 → 1.11.133

data/docs/PublicWorkflow.md

@@ -0,0 +1,36 @@
+# ApiSdkRb::PublicWorkflow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workflow_id** | **String** |  |  |
+| **status** | **String** |  |  |
+| **version_id** | **String** | The published version this answer is for. A visitor who starts on it finishes on it. | [optional] |
+| **version_number** | **Integer** |  | [optional] |
+| **published_at** | **Time** |  | [optional] |
+| **start_composition_id** | **String** | The composition a new visitor starts on, so the page can show it while the graph is still being read. | [optional] |
+| **timezone** | **String** | The zone date and time triggers are read in. | [optional] |
+| **graph** | [**WorkflowGraph**](WorkflowGraph.md) |  | [optional] |
+| **translations** | [**Hash<String, PublicWorkflowTranslation>**](PublicWorkflowTranslation.md) | The languages the compositions of the graph can be shown in, by composition id: only the compositions that have an active translation with a language besides their own, so the field is absent when none has. The browser shows the copy in the visitor's language in place of the composition, at the first step and at every move, with the rules `<widgetic-translations>` follows (the visitor's language, then its language family, then the language the composition was written in). It is read when the answer is made, not when the version was published, so a language added to a translation reaches visitors without a new publish. Ids, counts and the visitor's place keep naming the composition of the graph, never its copy.  | [optional] |
+| **event_token** | **String** | What lets the browser report counts for this version, valid for 24 hours. Absent when this server cannot sign one, and the browser then reports nothing.  | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::PublicWorkflow.new(
+  workflow_id: null,
+  status: null,
+  version_id: null,
+  version_number: null,
+  published_at: null,
+  start_composition_id: null,
+  timezone: null,
+  graph: null,
+  translations: null,
+  event_token: null
+)
+```
+

data/docs/PublicWorkflowEventsAccepted.md

@@ -0,0 +1,22 @@
+# ApiSdkRb::PublicWorkflowEventsAccepted
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **recorded** | **Boolean** | False when nothing was counted or kept (the workflow is not live any more, or the ids are not in that version). |  |
+| **counters** | **Integer** | How many counters were raised (0 for a report of heights alone). | [optional] |
+| **reason** | **String** | Why nothing was counted or kept, when `recorded` is false. | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::PublicWorkflowEventsAccepted.new(
+  recorded: null,
+  counters: null,
+  reason: null
+)
+```
+

data/docs/PublicWorkflowEventsRequest.md

@@ -0,0 +1,24 @@
+# ApiSdkRb::PublicWorkflowEventsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **version_id** | **String** |  |  |
+| **token** | **String** | The `eventToken` of the workflow, read for the same version. |  |
+| **events** | [**Array<PublicWorkflowEventsRequestEventsInner>**](PublicWorkflowEventsRequestEventsInner.md) | The counts of what visitors did. At least one of `events` and `heights` is needed. | [optional] |
+| **heights** | [**Array<PublicWorkflowEventsRequestHeightsInner>**](PublicWorkflowEventsRequestHeightsInner.md) | How tall steps of this version settled in the visitor's browser, so that the embed code of the workflow can start its box at the height visitors saw instead of a guess. The Embed SDK sends one for a visitor who has no remembered height for the step. The gateway keeps the latest few for each composition (the median is what the code gets); a composition that this version does not show is left out. At least one of `events` and `heights` is needed.  | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::PublicWorkflowEventsRequest.new(
+  version_id: null,
+  token: null,
+  events: null,
+  heights: null
+)
+```
+

data/docs/PublicWorkflowEventsRequestEventsInner.md

@@ -0,0 +1,24 @@
+# ApiSdkRb::PublicWorkflowEventsRequestEventsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **k** | **String** | `n` a visitor reached a block, `e` a visitor took a connection, `f` moving a visitor on failed. |  |
+| **id** | **String** | The block or connection counted. |  |
+| **c** | **Integer** | How many times (1 when not given). | [optional] |
+| **r** | **String** | Only on an `f` event: why moving the visitor on failed. `t` the composition did not appear in time, `e` the widget in it reported an error, `b` the composition could not be built, `o` another reason (a step was already on its way, or the page was going away). Left out by an embed that does not say why; a letter this server does not know is read as left out, and the failure is still counted. On an `n` or an `e` event it is ignored. Never a message: one letter, so that nothing a visitor typed can ride on it.  | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::PublicWorkflowEventsRequestEventsInner.new(
+  k: null,
+  id: null,
+  c: null,
+  r: null
+)
+```
+

data/docs/PublicWorkflowEventsRequestHeightsInner.md

@@ -0,0 +1,20 @@
+# ApiSdkRb::PublicWorkflowEventsRequestHeightsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **composition_id** | **String** | The composition the step shows. |  |
+| **height** | **Integer** | The height the step settled at, in pixels. One under 100 is not kept, one over 2000 is kept as 2000. |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::PublicWorkflowEventsRequestHeightsInner.new(
+  composition_id: null,
+  height: null
+)
+```
+

data/docs/{CreateCompositionFromWidget201Response.md → PublicWorkflowResponse.md}

@@ -1,11 +1,11 @@
-# ApiSdkRb::CreateCompositionFromWidget201Response
+# ApiSdkRb::PublicWorkflowResponse
 
 ## Properties
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **success** | **Boolean** |  |  |
-| **data** | [**Composition**](Composition.md) |  |  |
+| **data** | [**PublicWorkflow**](PublicWorkflow.md) |  |  |
 | **meta** | [**ResponseMeta**](ResponseMeta.md) |  | [optional] |
 
 ## Example
@@ -13,7 +13,7 @@
 ```ruby
 require 'api-sdk-rb'
 
-instance = ApiSdkRb::CreateCompositionFromWidget201Response.new(
+instance = ApiSdkRb::PublicWorkflowResponse.new(
   success: null,
   data: null,
   meta: null

data/docs/PublicWorkflowTranslation.md

@@ -0,0 +1,20 @@
+# ApiSdkRb::PublicWorkflowTranslation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **root_language** | **String** | The language the composition was written in. A visitor whose language matches nothing else is shown the composition itself. |  |
+| **compositions** | **Hash<String, String>** | Language code (lower case) to the composition that shows it. The root language is listed too, and is the composition itself. |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::PublicWorkflowTranslation.new(
+  root_language: en,
+  compositions: {"en":"7b1d5c3e-6f0a-4c52-9d3a-0a1b2c3d4e5f","fr":"2f6c8a90-1b3d-4e7f-8a9b-c0d1e2f3a4b5"}
+)
+```
+

data/docs/PublishWorkspaceWorkflow200Response.md

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

data/docs/PublishWorkspaceWorkflowRequest.md

@@ -0,0 +1,18 @@
+# ApiSdkRb::PublishWorkspaceWorkflowRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **revision** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::PublishWorkspaceWorkflowRequest.new(
+  revision: null
+)
+```
+

data/docs/PutBrandKitRequest.md

@@ -0,0 +1,22 @@
+# ApiSdkRb::PutBrandKitRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tokens** | [**BrandKitTokens**](BrandKitTokens.md) |  |  |
+| **figma_source** | [**BrandKitFigmaSource**](BrandKitFigmaSource.md) |  | [optional] |
+| **expected_version** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::PutBrandKitRequest.new(
+  tokens: null,
+  figma_source: null,
+  expected_version: null
+)
+```
+

data/docs/RemovePartnerWorkflowPreset200Response.md

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

data/docs/ReportPublicWorkflowEvents200Response.md

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

data/docs/SaveWorkspaceWorkflowRequest.md

@@ -0,0 +1,24 @@
+# ApiSdkRb::SaveWorkspaceWorkflowRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **revision** | **Integer** | The revision the editor read. |  |
+| **name** | **String** |  | [optional] |
+| **timezone** | **String** |  | [optional] |
+| **graph** | [**WorkflowGraph**](WorkflowGraph.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::SaveWorkspaceWorkflowRequest.new(
+  revision: null,
+  name: null,
+  timezone: Europe/Bucharest,
+  graph: null
+)
+```
+

data/docs/SetAdapterConnectionRequest.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **credential** | **String** | The key exactly as its provider gave it: one line of text, at most 2048 characters. It is stored encrypted and is never returned or logged. |  |
+| **credential** | **String** | The key exactly as its provider gave it: one line of text, at most 2048 characters. It is stored encrypted and is never returned or logged. For a credential that is an email address (`confirmation: email_code`), write that one address, with nothing else |  |
 
 ## Example
 

data/docs/SetPartnerWorkflowPreset200Response.md

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

data/docs/TokensApi.md

@@ -4,15 +4,17 @@ All URIs are relative to *https://api.widgetic.com/v1*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**validate_token_0**](TokensApi.md#validate_token_0) | **GET** /tokens/validate | Validate current authentication token |
+| [**validate_token**](TokensApi.md#validate_token) | **GET** /tokens/validate | Validate current authentication token |
 
 
-## validate_token_0
+## validate_token
 
-> <ValidateToken200Response> validate_token_0
+> <ValidateToken200Response> validate_token
 
 Validate current authentication token
 
+Describes the credential the request was made with: how it signs in (`tokenType`), what it may do (`scopes`) and the account it belongs to (`userId`). A credential that belongs to the platform itself, and not to a customer's account, is held to no scope: it is answered with `tokenType` `service_key`, `scopes` `[\"*:*\"]` and no `userId`. 
+
 ### Examples
 
 ```ruby
@@ -33,28 +35,28 @@ api_instance = ApiSdkRb::TokensApi.new
 
 begin
   # Validate current authentication token
-  result = api_instance.validate_token_0
+  result = api_instance.validate_token
   p result
 rescue ApiSdkRb::ApiError => e
-  puts "Error when calling TokensApi->validate_token_0: #{e}"
+  puts "Error when calling TokensApi->validate_token: #{e}"
 end
 ```
 
-#### Using the validate_token_0_with_http_info variant
+#### Using the validate_token_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<ValidateToken200Response>, Integer, Hash)> validate_token_0_with_http_info
+> <Array(<ValidateToken200Response>, Integer, Hash)> validate_token_with_http_info
 
 ```ruby
 begin
   # Validate current authentication token
-  data, status_code, headers = api_instance.validate_token_0_with_http_info
+  data, status_code, headers = api_instance.validate_token_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <ValidateToken200Response>
 rescue ApiSdkRb::ApiError => e
-  puts "Error when calling TokensApi->validate_token_0_with_http_info: #{e}"
+  puts "Error when calling TokensApi->validate_token_with_http_info: #{e}"
 end
 ```
 

data/docs/UpdateComposition.md

@@ -10,7 +10,7 @@
 | **status** | **String** | Updated status | [optional] |
 | **embed_settings** | **Object** | Updated embed settings | [optional] |
 | **design** | **Object** | Updated design settings | [optional] |
-| **database_schema** | **Object** | Tables to make for the composition, in the shape `createComposition` takes (`{ \"tables\": [ ... ] }`, with the same names, types, defaults and limits). Only the tables that are missing are made. A table that already exists is never changed or dropped: it keeps its columns, so a column added to the declaration is not added to it. A declaration that cannot be used is refused with `400` and `INVALID_DATABASE_SCHEMA`. When the composition is saved but its tables cannot be made just now, `meta.warnings` says so: send the same `databaseSchema` again to retry.  | [optional] |
+| **database_schema** | **Object** | Tables to make for the composition, in the shape `createComposition` takes (`{ \"tables\": [ ... ] }`, with the same names, types, defaults and limits). Only the tables that are missing are made. A table that already exists is never changed or dropped: it keeps its columns, so a column added to the declaration is not added to it. (Tables made from the widget's own file are the one exception, brought up to date when the widget is published; see `source` on `createComposition`.) A declaration that cannot be used is refused with `400` and `INVALID_DATABASE_SCHEMA`. When the composition is saved but its tables cannot be made just now, `meta.warnings` says so: send the same `databaseSchema` again to retry.  | [optional] |
 | **project_id** | **String** | Updated project ID | [optional] |
 
 ## Example

data/docs/Upload.md

@@ -16,7 +16,7 @@
 | **source** | **String** | Which part of the product, or which client, uploaded the file. `widget-visitor-upload` is a file a visitor sent through a widget's upload adapter; it cannot be asked for when uploading. |  |
 | **widget_id** | **String** |  | [optional] |
 | **conversation_id** | **String** |  | [optional] |
-| **managed_user_id** | **String** | The managed user the file was uploaded for, or null when it is the account's own. List one managed user's files with the `managed_user_id` or `managed_user_external_id` query parameter of `uploadsGet`. | [optional] |
+| **managed_user_id** | **String** | The managed user the file was uploaded for, or null when it is the account's own. List one managed user's files with the `managed_user_id` or `managed_user_external_id` query parameter of `listUploads`. | [optional] |
 | **purpose** | **String** | Where in the product the partner uses the file, or null when unknown | [optional] |
 
 ## Example

data/docs/UploadLimits.md

@@ -4,9 +4,9 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **multipart_max_bytes** | **Integer** | The largest file `uploadsPost` takes in one request, in bytes. The same for every account. | [optional] |
-| **multipart_mime_types** | **Array<String>** | The file types `uploadsPost` takes for media (`content-property` uploads) | [optional] |
-| **tus_enabled** | **Boolean** | Whether resumable uploads are switched on. They need a signed-in session; an API key uses `uploadsPost`. | [optional] |
+| **multipart_max_bytes** | **Integer** | The largest file `uploadFile` takes in one request, in bytes. The same for every account. | [optional] |
+| **multipart_mime_types** | **Array<String>** | The file types `uploadFile` takes for media (`content-property` uploads) | [optional] |
+| **tus_enabled** | **Boolean** | Whether resumable uploads are switched on. They need a signed-in session; an API key uses `uploadFile`. | [optional] |
 | **tus_max_bytes** | **Integer** | The largest file a resumable upload takes, in bytes (250 MB by default). The same for every account, whatever its plan. A file over `multipart_max_bytes` goes through a resumable upload. | [optional] |
 | **tus_chunk_size_bytes** | **Integer** | The chunk size resumable uploads are tuned for, in bytes. A client may send smaller or larger chunks. | [optional] |
 | **tus_mime_types** | **Array<String>** |  | [optional] |