api-sdk-rb 1.11.111 → 1.11.133

data/docs/WidgetClarification.md

@@ -0,0 +1,22 @@
+# ApiSdkRb::WidgetClarification
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | The sentence that introduces the card. |  |
+| **questions** | [**Array<WidgetClarificationQuestion>**](WidgetClarificationQuestion.md) |  |  |
+| **files_read** | **Array<String>** | The paths of the widget's files the questions were judged against, for a \"Read N files\" row. |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::WidgetClarification.new(
+  message: null,
+  questions: null,
+  files_read: null
+)
+```
+

data/docs/WidgetClarificationOption.md

@@ -0,0 +1,22 @@
+# ApiSdkRb::WidgetClarificationOption
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | `q1o1`, `q1o2`, ... Stable within the card. |  |
+| **label** | **String** | The option text, at most 60 characters, including the parenthesised recommendation word on the recommended option (for example `Three plans (Recommended)`). |  |
+| **recommended** | **Boolean** | True for the one option the assistant recommends. It is always the first option when set. The server composes the recommendation word into `label`; clients may still draw a badge. |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::WidgetClarificationOption.new(
+  id: null,
+  label: null,
+  recommended: null
+)
+```
+

data/docs/WidgetClarificationQuestion.md

@@ -0,0 +1,26 @@
+# ApiSdkRb::WidgetClarificationQuestion
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | `q1`, `q2`, ... |  |
+| **question** | **String** |  |  |
+| **recommended_word** | **String** | The localized word placed in parentheses on the recommended option's label (default `Recommended`). |  |
+| **options** | [**Array<WidgetClarificationOption>**](WidgetClarificationOption.md) | Two to five options with the recommended one first; empty for a question answered in words only. |  |
+| **allow_other** | **Boolean** | Whether the person may answer in their own words (the \"Other...\" row). Always true when there are no options. |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::WidgetClarificationQuestion.new(
+  id: null,
+  question: null,
+  recommended_word: null,
+  options: null,
+  allow_other: null
+)
+```
+

data/docs/WidgetNextStep.md

@@ -0,0 +1,24 @@
+# ApiSdkRb::WidgetNextStep
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | `n1`, `n2`, ... |  |
+| **label** | **String** | The request, at most 80 characters. |  |
+| **kind** | **String** |  |  |
+| **recommended** | **Boolean** | True for the first suggestion and false for the others. |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::WidgetNextStep.new(
+  id: null,
+  label: null,
+  kind: null,
+  recommended: null
+)
+```
+

data/docs/WidgetPlan.md

@@ -0,0 +1,26 @@
+# ApiSdkRb::WidgetPlan
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **title** | **String** | One line for the whole plan (\"Building a countdown with confetti\"). |  |
+| **tasks** | [**Array<WidgetPlanTask>**](WidgetPlanTask.md) |  |  |
+| **decisions** | [**WidgetPlanDecisions**](WidgetPlanDecisions.md) |  |  |
+| **completed** | **Integer** | How many steps are `done`. |  |
+| **active_index** | **Integer** | The index in `tasks` of the step in progress, or null when none is. |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::WidgetPlan.new(
+  title: null,
+  tasks: null,
+  decisions: null,
+  completed: null,
+  active_index: null
+)
+```
+

data/docs/WidgetPlanDecisions.md

@@ -0,0 +1,32 @@
+# ApiSdkRb::WidgetPlanDecisions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **libraries** | [**Array<WidgetPlanDecisionsLibrariesInner>**](WidgetPlanDecisionsLibrariesInner.md) |  |  |
+| **adapters** | [**Array<WidgetPlanDecisionsAdaptersInner>**](WidgetPlanDecisionsAdaptersInner.md) | The adapters the adapter stage attached on this turn. Empty while that stage is not applied. |  |
+| **look** | **String** | What the widget should look like, from what the person provided (words, pictures, a copied page, a Figma frame). May be empty. |  |
+| **motion** | **Array<String>** | The animations to apply. At most 3. |  |
+| **improvements** | **Array<String>** | Improvements that do not change what was asked. At most 3. |  |
+| **notes** | **Array<String>** | Anything else particular to this widget. At most 3. |  |
+| **responsive** | [**WidgetPlanDecisionsResponsive**](WidgetPlanDecisionsResponsive.md) |  | [optional] |
+| **elements** | **Array<String>** | What a Convert-to-Widget sketch shows: one short phrase per drawn element, in layout order. Empty when the request has no sketch. At most 12. |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::WidgetPlanDecisions.new(
+  libraries: null,
+  adapters: null,
+  look: null,
+  motion: null,
+  improvements: null,
+  notes: null,
+  responsive: null,
+  elements: null
+)
+```
+

data/docs/WidgetPlanDecisionsAdaptersInner.md

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

data/docs/WidgetPlanDecisionsLibrariesInner.md

@@ -0,0 +1,22 @@
+# ApiSdkRb::WidgetPlanDecisionsLibrariesInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | A stable id of the library (`gsap`, `three`, `chart`, ...). |  |
+| **label** | **String** |  |  |
+| **reason** | **String** | Why the widget needs it, or an empty string. |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::WidgetPlanDecisionsLibrariesInner.new(
+  id: null,
+  label: null,
+  reason: null
+)
+```
+

data/docs/WidgetPlanDecisionsResponsive.md

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

data/docs/WidgetPlanTask.md

@@ -0,0 +1,24 @@
+# ApiSdkRb::WidgetPlanTask
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | `t1`, `t2`, ... Stable for the life of the plan. |  |
+| **label** | **String** | The step, in the language the person wrote in. At most 90 characters. |  |
+| **kind** | **String** | What the step is about, so a client can pick an icon. |  |
+| **status** | **String** | Where the step stands. At most one step is `in_progress`. |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::WidgetPlanTask.new(
+  id: null,
+  label: null,
+  kind: null,
+  status: null
+)
+```
+

data/docs/WidgetsApi.md

@@ -4,15 +4,15 @@ All URIs are relative to *https://api.widgetic.com/v1*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**create_composition_from_widget_0**](WidgetsApi.md#create_composition_from_widget_0) | **POST** /widgets/{id}/composition | Create a composition for a widget in one call |
-| [**create_widget_0**](WidgetsApi.md#create_widget_0) | **POST** /widgets | Create Widget |
-| [**get_widgets_0**](WidgetsApi.md#get_widgets_0) | **GET** /widgets | List Widgets |
-| [**get_widgets_batch_0**](WidgetsApi.md#get_widgets_batch_0) | **POST** /widgets/batch | Get Widgets Batch |
+| [**create_composition_from_widget**](WidgetsApi.md#create_composition_from_widget) | **POST** /widgets/{id}/composition | Create a composition for a widget in one call |
+| [**create_widget**](WidgetsApi.md#create_widget) | **POST** /widgets | Create Widget |
+| [**get_widgets**](WidgetsApi.md#get_widgets) | **GET** /widgets | List Widgets |
+| [**get_widgets_batch**](WidgetsApi.md#get_widgets_batch) | **POST** /widgets/batch | Get Widgets Batch |
 
 
-## create_composition_from_widget_0
+## create_composition_from_widget
 
-> <CreateCompositionFromWidget201Response> create_composition_from_widget_0(id, idempotency_key, create_composition_from_widget_request)
+> <CompositionResponse> create_composition_from_widget(id, idempotency_key, create_composition_from_widget_request)
 
 Create a composition for a widget in one call
 
@@ -36,28 +36,28 @@ create_composition_from_widget_request = ApiSdkRb::CreateCompositionFromWidgetRe
 
 begin
   # Create a composition for a widget in one call
-  result = api_instance.create_composition_from_widget_0(id, idempotency_key, create_composition_from_widget_request)
+  result = api_instance.create_composition_from_widget(id, idempotency_key, create_composition_from_widget_request)
   p result
 rescue ApiSdkRb::ApiError => e
-  puts "Error when calling WidgetsApi->create_composition_from_widget_0: #{e}"
+  puts "Error when calling WidgetsApi->create_composition_from_widget: #{e}"
 end
 ```
 
-#### Using the create_composition_from_widget_0_with_http_info variant
+#### Using the create_composition_from_widget_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<CreateCompositionFromWidget201Response>, Integer, Hash)> create_composition_from_widget_0_with_http_info(id, idempotency_key, create_composition_from_widget_request)
+> <Array(<CompositionResponse>, Integer, Hash)> create_composition_from_widget_with_http_info(id, idempotency_key, create_composition_from_widget_request)
 
 ```ruby
 begin
   # Create a composition for a widget in one call
-  data, status_code, headers = api_instance.create_composition_from_widget_0_with_http_info(id, idempotency_key, create_composition_from_widget_request)
+  data, status_code, headers = api_instance.create_composition_from_widget_with_http_info(id, idempotency_key, create_composition_from_widget_request)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <CreateCompositionFromWidget201Response>
+  p data # => <CompositionResponse>
 rescue ApiSdkRb::ApiError => e
-  puts "Error when calling WidgetsApi->create_composition_from_widget_0_with_http_info: #{e}"
+  puts "Error when calling WidgetsApi->create_composition_from_widget_with_http_info: #{e}"
 end
 ```
 
@@ -71,7 +71,7 @@ end
 
 ### Return type
 
-[**CreateCompositionFromWidget201Response**](CreateCompositionFromWidget201Response.md)
+[**CompositionResponse**](CompositionResponse.md)
 
 ### Authorization
 
@@ -83,9 +83,9 @@ end
 - **Accept**: application/json
 
 
-## create_widget_0
+## create_widget
 
-> <CreateWidget201Response> create_widget_0(idempotency_key, new_widget)
+> <CreateWidget201Response> create_widget(idempotency_key, new_widget)
 
 Create Widget
 
@@ -108,28 +108,28 @@ new_widget = ApiSdkRb::NewWidget.new({name: 'New Chart Widget', type: 'chart', c
 
 begin
   # Create Widget
-  result = api_instance.create_widget_0(idempotency_key, new_widget)
+  result = api_instance.create_widget(idempotency_key, new_widget)
   p result
 rescue ApiSdkRb::ApiError => e
-  puts "Error when calling WidgetsApi->create_widget_0: #{e}"
+  puts "Error when calling WidgetsApi->create_widget: #{e}"
 end
 ```
 
-#### Using the create_widget_0_with_http_info variant
+#### Using the create_widget_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<CreateWidget201Response>, Integer, Hash)> create_widget_0_with_http_info(idempotency_key, new_widget)
+> <Array(<CreateWidget201Response>, Integer, Hash)> create_widget_with_http_info(idempotency_key, new_widget)
 
 ```ruby
 begin
   # Create Widget
-  data, status_code, headers = api_instance.create_widget_0_with_http_info(idempotency_key, new_widget)
+  data, status_code, headers = api_instance.create_widget_with_http_info(idempotency_key, new_widget)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <CreateWidget201Response>
 rescue ApiSdkRb::ApiError => e
-  puts "Error when calling WidgetsApi->create_widget_0_with_http_info: #{e}"
+  puts "Error when calling WidgetsApi->create_widget_with_http_info: #{e}"
 end
 ```
 
@@ -154,9 +154,9 @@ end
 - **Accept**: application/json
 
 
-## get_widgets_0
+## get_widgets
 
-> <GetWidgets200Response> get_widgets_0(opts)
+> <GetWidgets200Response> get_widgets(opts)
 
 List Widgets
 
@@ -184,28 +184,28 @@ opts = {
 
 begin
   # List Widgets
-  result = api_instance.get_widgets_0(opts)
+  result = api_instance.get_widgets(opts)
   p result
 rescue ApiSdkRb::ApiError => e
-  puts "Error when calling WidgetsApi->get_widgets_0: #{e}"
+  puts "Error when calling WidgetsApi->get_widgets: #{e}"
 end
 ```
 
-#### Using the get_widgets_0_with_http_info variant
+#### Using the get_widgets_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<GetWidgets200Response>, Integer, Hash)> get_widgets_0_with_http_info(opts)
+> <Array(<GetWidgets200Response>, Integer, Hash)> get_widgets_with_http_info(opts)
 
 ```ruby
 begin
   # List Widgets
-  data, status_code, headers = api_instance.get_widgets_0_with_http_info(opts)
+  data, status_code, headers = api_instance.get_widgets_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <GetWidgets200Response>
 rescue ApiSdkRb::ApiError => e
-  puts "Error when calling WidgetsApi->get_widgets_0_with_http_info: #{e}"
+  puts "Error when calling WidgetsApi->get_widgets_with_http_info: #{e}"
 end
 ```
 
@@ -233,9 +233,9 @@ end
 - **Accept**: application/json
 
 
-## get_widgets_batch_0
+## get_widgets_batch
 
-> <GetWidgetsBatchResponse> get_widgets_batch_0(get_widgets_batch_request)
+> <GetWidgetsBatchResponse> get_widgets_batch(get_widgets_batch_request)
 
 Get Widgets Batch
 
@@ -257,28 +257,28 @@ get_widgets_batch_request = ApiSdkRb::GetWidgetsBatchRequest.new({widget_ids: ['
 
 begin
   # Get Widgets Batch
-  result = api_instance.get_widgets_batch_0(get_widgets_batch_request)
+  result = api_instance.get_widgets_batch(get_widgets_batch_request)
   p result
 rescue ApiSdkRb::ApiError => e
-  puts "Error when calling WidgetsApi->get_widgets_batch_0: #{e}"
+  puts "Error when calling WidgetsApi->get_widgets_batch: #{e}"
 end
 ```
 
-#### Using the get_widgets_batch_0_with_http_info variant
+#### Using the get_widgets_batch_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<GetWidgetsBatchResponse>, Integer, Hash)> get_widgets_batch_0_with_http_info(get_widgets_batch_request)
+> <Array(<GetWidgetsBatchResponse>, Integer, Hash)> get_widgets_batch_with_http_info(get_widgets_batch_request)
 
 ```ruby
 begin
   # Get Widgets Batch
-  data, status_code, headers = api_instance.get_widgets_batch_0_with_http_info(get_widgets_batch_request)
+  data, status_code, headers = api_instance.get_widgets_batch_with_http_info(get_widgets_batch_request)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <GetWidgetsBatchResponse>
 rescue ApiSdkRb::ApiError => e
-  puts "Error when calling WidgetsApi->get_widgets_batch_0_with_http_info: #{e}"
+  puts "Error when calling WidgetsApi->get_widgets_batch_with_http_info: #{e}"
 end
 ```
 

data/docs/{CreateWorkspaceWorkflowFromPreset201Response.md → WorkflowDetailResponse.md}

@@ -1,4 +1,4 @@
-# ApiSdkRb::CreateWorkspaceWorkflowFromPreset201Response
+# ApiSdkRb::WorkflowDetailResponse
 
 ## Properties
 
@@ -13,7 +13,7 @@
 ```ruby
 require 'api-sdk-rb'
 
-instance = ApiSdkRb::CreateWorkspaceWorkflowFromPreset201Response.new(
+instance = ApiSdkRb::WorkflowDetailResponse.new(
   success: true,
   data: null,
   meta: 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/{SaveWorkspaceWorkflow200Response.md → WorkflowResponse.md}

@@ -1,4 +1,4 @@
-# ApiSdkRb::SaveWorkspaceWorkflow200Response
+# ApiSdkRb::WorkflowResponse
 
 ## Properties
 
@@ -13,7 +13,7 @@
 ```ruby
 require 'api-sdk-rb'
 
-instance = ApiSdkRb::SaveWorkspaceWorkflow200Response.new(
+instance = ApiSdkRb::WorkflowResponse.new(
   success: true,
   data: null,
   meta: null

data/docs/WorkflowStats.md

@@ -11,7 +11,8 @@
 | **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. |  |
+| **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
 
@@ -26,7 +27,8 @@ instance = ApiSdkRb::WorkflowStats.new(
   started: null,
   nodes: null,
   edges: null,
-  failed: null
+  failed: null,
+  failed_reasons: null
 )
 ```