api-sdk-rb 1.11.66 → 1.11.111

data/docs/ConfirmAdapterConnectionRequest.md

@@ -0,0 +1,18 @@
+# ApiSdkRb::ConfirmAdapterConnectionRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | The digits of the code Widgetic emailed to the address, with nothing else. It works for 30 minutes and for five wrong tries; after that, save the address again and a new code is emailed |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::ConfirmAdapterConnectionRequest.new(
+  code: 123456
+)
+```
+

data/docs/CreateWidget201ResponseData.md

@@ -20,8 +20,7 @@
 | **repo_id** | **String** | Repository identifier for source code. | [optional] |
 | **database_id** | **String** | Legacy. The name of a Neon database that an earlier version made for this widget. A widget has no database now (what the visitors of a composition leave is kept in the tables of that composition), so widgets made now have none. | [optional] |
 | **version** | **Float** | Version number of the widget. | [optional] |
-| **cpg_schema_id** | **String** | ID linking to the widget's code graph schema. | [optional] |
-| **last_cpg_commit_sha** | **String** | Last Git commit SHA analyzed for code graph. | [optional] |
+| **last_commit_sha** | **String** | Latest Git commit SHA of the widget's code repository. | [optional] |
 | **organization_id** | **String** | Organization ID if created in an organization workspace. | [optional] |
 | **project_folder** | **String** | Project folder reference for organization widgets. | [optional] |
 | **workspace_type** | **String** | Workspace type when created. | [optional] |
@@ -50,8 +49,7 @@ instance = ApiSdkRb::CreateWidget201ResponseData.new(
   repo_id: user/chart-widget,
   database_id: widget_3fa85f64_5717_4562_b3fc_2c963f66afa6,
   version: 1,
-  cpg_schema_id: cpg_4b3a2d1f9e8c7b6a,
-  last_cpg_commit_sha: a1b2c3d4e5f6g7h8i9j0,
+  last_commit_sha: a1b2c3d4e5f6g7h8i9j0,
   organization_id: 5e2d3f4a-1b6c-4a1f-8b9c-3c2d4e5f6a7b,
   project_folder: marketing/q4-launch,
   workspace_type: personal,

data/docs/CreateWorkspaceWorkflowFromPreset201Response.md

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

data/docs/CreateWorkspaceWorkflowFromPresetRequest.md

@@ -0,0 +1,20 @@
+# ApiSdkRb::CreateWorkspaceWorkflowFromPresetRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** | The starting point, as `listWorkspaceWorkflowPresets` gives it. |  |
+| **name** | **String** | The new workflow's name. The starting point's title when left out. | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::CreateWorkspaceWorkflowFromPresetRequest.new(
+  key: welcome-then-offer,
+  name: null
+)
+```
+

data/docs/CreateWorkspaceWorkflowRequest.md

@@ -0,0 +1,22 @@
+# ApiSdkRb::CreateWorkspaceWorkflowRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **composition_id** | **String** | A composition of this workspace to start with. | [optional] |
+| **timezone** | **String** | An IANA time zone name; UTC when not given. | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::CreateWorkspaceWorkflowRequest.new(
+  name: Welcome journey,
+  composition_id: null,
+  timezone: Europe/Bucharest
+)
+```
+

data/docs/DeleteWorkspaceWorkflow200Response.md

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

data/docs/GetPublicCompositionEmbed200Response.md

@@ -8,16 +8,19 @@
 | **widget_id** | **String** |  | [optional] |
 | **version** | **Integer** |  | [optional] |
 | **widget_version** | **Integer** | Published widget version on the CDN artifact this composition uses. | [optional] |
-| **player_version** | **Integer** | Version of the player: the gateway frame wrapper that shows the widget, and the host bridge it speaks with the embedding page and the widget (currently 4). Raised when the messages between page, frame, and widget change in a way a widget could notice, such as a new `widgetic:host` field or a new forwarded event (2 added `entries`, 3 added `adapters`, 4 added `entries.writeToken`). It is not `widgetVersion` (the version of the published widget) and not the `version` inside a `widgetic:host` message. | [optional] |
+| **player_version** | **Integer** | Version of the player: the gateway frame wrapper that shows the widget, and the host bridge it speaks with the embedding page and the widget (currently 6). Raised when the messages between page, frame, and widget change in a way a widget could notice, such as a new `widgetic:host` field or a new forwarded event (2 added `entries`, 3 added `adapters`, 4 added `entries.writeToken`, 5 added the A/B goal: `widgetic:ab-goal` to the widget and `widgetic:goal` back, 6 added the watch of a workflow: `widgetic:workflow-watch` to the widget, the watched values in `widgetic:submitted` and the watched action in `widgetic:goal`). It is not `widgetVersion` (the version of the published widget) and not the `version` inside a `widgetic:host` message. | [optional] |
 | **data_source** | [**GetPublicCompositionEmbed200ResponseDataSource**](GetPublicCompositionEmbed200ResponseDataSource.md) |  | [optional] |
 | **embed_url** | **String** |  | [optional] |
 | **entry_write_token** | **String** | Signed per-composition write token for `POST /embed/compositions/{compositionId}/entries/{table}`, also handed to the widget inside `widgetic:host` as `entries.writeToken`. | [optional] |
+| **entries** | [**GetPublicCompositionEmbed200ResponseEntries**](GetPublicCompositionEmbed200ResponseEntries.md) |  | [optional] |
+| **adapters** | [**GetPublicCompositionEmbed200ResponseAdapters**](GetPublicCompositionEmbed200ResponseAdapters.md) |  | [optional] |
 | **width** | **Integer** |  | [optional] |
 | **height** | **Integer** |  | [optional] |
 | **design** | **Object** |  | [optional] |
 | **content** | **Object** |  | [optional] |
 | **content_items** | **Array<Hash<String, Object>>** |  | [optional] |
 | **iframe_allow** | **String** | The browser features the widget needs the iframe that shows it to be allowed to use, as the value of that iframe's `allow` attribute (for example `camera; microphone`; the words are `camera`, `display-capture` and `microphone`). Present only for a widget that uses a module that needs one, and absent for every other widget. A page that embeds the frame itself copies it onto its own iframe (`allow=\"...\"`); a page that does not leaves the widget to say, in its own words, that the feature is blocked there. The frame wrapper already passes it on to the iframe it holds. | [optional] |
+| **media** | [**GetPublicCompositionEmbed200ResponseMedia**](GetPublicCompositionEmbed200ResponseMedia.md) |  | [optional] |
 | **direct** | [**GetPublicCompositionEmbed200ResponseDirect**](GetPublicCompositionEmbed200ResponseDirect.md) |  | [optional] |
 
 ## Example
@@ -34,12 +37,15 @@ instance = ApiSdkRb::GetPublicCompositionEmbed200Response.new(
   data_source: null,
   embed_url: null,
   entry_write_token: null,
+  entries: null,
+  adapters: null,
   width: null,
   height: null,
   design: null,
   content: null,
   content_items: null,
   iframe_allow: camera; microphone,
+  media: null,
   direct: null
 )
 ```

data/docs/GetPublicCompositionEmbed200ResponseAdapters.md

@@ -0,0 +1,20 @@
+# ApiSdkRb::GetPublicCompositionEmbed200ResponseAdapters
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** | The operations' address; an operation is `{url}/{adapterId}/{operation}`. | [optional] |
+| **captcha** | [**GetPublicCompositionEmbed200ResponseAdaptersCaptcha**](GetPublicCompositionEmbed200ResponseAdaptersCaptcha.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::GetPublicCompositionEmbed200ResponseAdapters.new(
+  url: https://api.widgetic.com/embed/compositions/0f6f7f0e-3c2a-4b86-9e51-2d8d5f4a7c11/adapters,
+  captcha: null
+)
+```
+

data/docs/GetPublicCompositionEmbed200ResponseAdaptersCaptcha.md

@@ -0,0 +1,18 @@
+# ApiSdkRb::GetPublicCompositionEmbed200ResponseAdaptersCaptcha
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **site_key** | **String** | The public site key of the CAPTCHA widget. | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::GetPublicCompositionEmbed200ResponseAdaptersCaptcha.new(
+  site_key: null
+)
+```
+

data/docs/GetPublicCompositionEmbed200ResponseEntries.md

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

data/docs/GetPublicCompositionEmbed200ResponseMedia.md

@@ -0,0 +1,18 @@
+# ApiSdkRb::GetPublicCompositionEmbed200ResponseMedia
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **optimize** | **Boolean** | The owner's \"Optimize images for the web\" account setting (ON until they turn it off). When true the Embed SDK may ask Cloudflare for a right-sized, modern-format copy of each content image; when false it uses the originals. | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::GetPublicCompositionEmbed200ResponseMedia.new(
+  optimize: null
+)
+```
+

data/docs/GetPublicWorkflow200Response.md

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

data/docs/GetWorkspaceWorkflowStats200Response.md

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

data/docs/GetWorkspaceWorkflowVersion200Response.md

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

data/docs/ListPartnerWorkflowPresets200Response.md

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

data/docs/ListWorkspaceWorkflowCompositionOptions200Response.md

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

data/docs/ListWorkspaceWorkflowPresets200Response.md

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

data/docs/ListWorkspaceWorkflowVersions200Response.md

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

data/docs/ListWorkspaceWorkflows200Response.md

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

data/docs/ManagedUsersApi.md

@@ -252,7 +252,7 @@ end
 
 Create an editor session for a managed user
 
-Makes a short-lived credential that lets the browser of ONE of your managed users use Widgetic's editor pieces, such as the File Browser and the composition editor, without your API key ever reaching that browser. Call this from your server when the page that hosts the editor opens, and hand the `token` in the answer to that page.  The token is shown once. It starts with `wgt_ses_` and the browser sends it as `Authorization: Bearer <token>`. It can do only what the `surfaces` you name allow, and only for this managed user:  - `files`: upload a file (`uploadsPost`) and list the files uploaded for this user (`uploadsGet`). Every   file is filed for this user and stored in your own storage destination, never in Widgetic's: a file a   customer uploads is yours to keep, and takes none of your storage allowance. Partner storage is not   optional, so no session, whatever its surfaces, can be made until you have set a destination   (`setPartnerStorageDestination`); until then it is refused with 409 and `PARTNER_STORAGE_REQUIRED`, and   when the destination cannot be used with 503 and `STORAGE_DESTINATION_UNAVAILABLE`. A destination you   remove after the session was made stops its uploads too (the same 409; the browser is only told that   the feature is not available right now). To keep a customer from uploading, leave `files` out of the   session and hand the editors your own media library instead (`mediaLibrary`). - `editor`: edit one of this user's compositions: read it (`getCompositionById`, its content, design,   embed settings and schemas), check a content change (`validateCompositionContent`), and change its   name, content, design and embed settings (`updateComposition`, `setDynamicContent`). It can reach   only compositions you created for this managed user (tag them with `managedUserId` when you create   them); any other composition, including another of your users', answers 404. - `creator`: use Widgetic's widget creator for this user, including its AI. Draw on canvases and save   them (`getAllCanvases`, `getCanvas`, `createCanvas`, `updateCanvas`, `previewDeleteCanvas`,   `deleteCanvas`); make, change, copy and delete the widgets on them (`createWidget`, `getWidgets`,   `getWidgetsBatch`, `updateWidget`, `uploadWidgetThumbnail`, `duplicateWidget`, `deleteWidget`);   list and make the compositions of a widget it built (`getAllCompositions`, `createComposition`), which   is how it shows the widget with sample values; keep the   conversation of each widget (`getConversationsByWidgetId`, `createConversationForWidget`,   `updateConversation`, `getMessages`, `createMessage`, `updateMessage`, `restoreCheckpoint`); and read a   widget's schemas and give it its repository (`getWidgetContentSchema`, `getWidgetDesignSchema`,   `updateWidgetRepository`). The AI that builds a widget is part of it: list the models   (`agentModelsGet`), open the widget's repository (`agentRepositoriesPost`,   `agentRepositoriesRepoIdGet`), start a generation and follow or cancel it (`agentCodeGeneratePost`,   `operationsStreamGet`, `operationsIdGet`, `operationsIdCancelPost`), build and preview the result   (`agentWidgetBuilderRepoHeadWidgetIdGet`, `buildWidgetFromRepo`, `previewWidgetVersion`), publish a   version of the widget and move between its versions (`agentWidgetBuilderPublishWidgetIdPost`,   `getWidgetPublishHistory`, `setWidgetPublishHistoryLive`, `renameWidgetPublishHistoryTitle`), and   turn a stroke or a sentence into a decision (`agentShapeRecognizePost`, `agentDesignResolvePost`). It can   also offer the customer your presets as starting points: read them and ask for a copy for this customer   (`listMyPresets`, `copyMyPreset`; you choose the presets with `setPartnerPreset`).   What the session makes is filed for this managed user, and the lists it reads hold only this user's   canvases, widgets and compositions. It can reach only canvases, widgets, compositions, repositories,   uploaded files and operations made for this managed user (tag the canvases and widgets you create   with `managedUserId`); any other canvas, widget, composition, conversation, message, repository, file   or operation, including another of your users', answers 404. The creator also saves the composition   it is editing (`updateComposition`, from the `editor` surface) and attaches pictures to its chat   (`uploadsPost`, from the `files` surface), and the surfaces do not imply one another: to open the   whole creator for a user, ask for `creator`, `editor` and `files` together. A generation or a build   one user starts can be followed and cancelled by that user and by you, never by another of your   users. The AI is paid for by your account, as your own calls are: its credits and allowances are   yours. A session cannot make a widget public (publishing a version does not), file one under a   project or an organization, or set anything the creator does not set: a body with another field is   refused with 403 and `EDITOR_SESSION_FIELD_NOT_ALLOWED`.  Everything else is refused with 403 and `EDITOR_SESSION_ROUTE_NOT_ALLOWED`: a session cannot read your account, make more sessions, change your presets or delete a composition, and a session without the `creator` surface cannot create or list compositions. Create the composition yourself with your API key, then open the editor on it.  A session ends at `expiresAt` (at most four hours), when you end it (`revokeManagedUserEditorSession`), or when the managed user is switched off or deleted. A managed user can have at most 100 live sessions at once (`429 EDITOR_SESSION_LIMIT_REACHED`). A session that is bound to a web page (`allowedOrigin`) is refused from any other origin.  The AI the session runs is paid for with your credits. Set `maxCredits` to hold the session to a number of them: once its generations have taken that many (a generation that fails is refunded and does not count), the next one is refused with 402 and `EDITOR_SESSION_CREDIT_LIMIT_REACHED`, and the browser is told only that the feature is not available right now. Without it, the limit Widgetic has set for your account applies when it has set one (the same limit for every session you make, and `maxCredits: null` asks for none), and otherwise the credits of your account are the only ceiling. What each of your users' sessions has spent is in `getManagedUserUsage`.  Each call makes a new session. It does not take an `Idempotency-Key`: the answer holds the token, and the token is never stored where a retry could read it back. The answer is sent with `Cache-Control: no-store`. 
+Makes a short-lived credential that lets the browser of ONE of your managed users use Widgetic's editor pieces, such as the File Browser and the composition editor, without your API key ever reaching that browser. Call this from your server when the page that hosts the editor opens, and hand the `token` in the answer to that page.  The token is shown once. It starts with `wgt_ses_` and the browser sends it as `Authorization: Bearer <token>`. It can do only what the `surfaces` you name allow, and only for this managed user:  - `files`: upload a file (`uploadsPost`) and list the files uploaded for this user (`uploadsGet`). Every   file is filed for this user and stored in your own storage destination, never in Widgetic's: a file a   customer uploads is yours to keep, and takes none of your storage allowance. Partner storage is not   optional, so no session, whatever its surfaces, can be made until you have set a destination   (`setPartnerStorageDestination`); until then it is refused with 409 and `PARTNER_STORAGE_REQUIRED`, and   when the destination cannot be used with 503 and `STORAGE_DESTINATION_UNAVAILABLE`. A destination you   remove after the session was made stops its uploads too (the same 409; the browser is only told that   the feature is not available right now). To keep a customer from uploading, leave `files` out of the   session and hand the editors your own media library instead (`mediaLibrary`). - `editor`: edit one of this user's compositions: read it (`getCompositionById`, its content, design,   embed settings and schemas), check a content change (`validateCompositionContent`), and change its   name, content, design and embed settings (`updateComposition`, `setDynamicContent`). For a widget that   answers visitors' questions from documents (the `ai-answers` adapter), it also lists those documents,   adds one as text or as a file (a text file or a picture; a PDF once PDFs are read), and removes one   (`getAiAnswersKnowledge`, `addAiAnswersKnowledgeDocument`, `addAiAnswersKnowledgeFile`,   `removeAiAnswersKnowledgeDocument`); adding costs no credits, and is limited for each of your users   separately. It can reach   only compositions you created for this managed user (tag them with `managedUserId` when you create   them); any other composition, including another of your users', answers 404. - `creator`: use Widgetic's widget creator for this user, including its AI. Draw on canvases and save   them (`getAllCanvases`, `getCanvas`, `createCanvas`, `updateCanvas`, `previewDeleteCanvas`,   `deleteCanvas`); make, change, copy and delete the widgets on them (`createWidget`, `getWidgets`,   `getWidgetsBatch`, `updateWidget`, `uploadWidgetThumbnail`, `duplicateWidget`, `deleteWidget`);   list and make the compositions of a widget it built (`getAllCompositions`, `createComposition`), which   is how it shows the widget with sample values; keep the   conversation of each widget (`getConversationsByWidgetId`, `createConversationForWidget`,   `updateConversation`, `getMessages`, `createMessage`, `updateMessage`, `restoreCheckpoint`); and read a   widget's schemas and give it its repository (`getWidgetContentSchema`, `getWidgetDesignSchema`,   `updateWidgetRepository`). The AI that builds a widget is part of it: list the models   (`agentModelsGet`), open the widget's repository (`agentRepositoriesPost`,   `agentRepositoriesRepoIdGet`), start a generation and follow or cancel it (`agentCodeGeneratePost`,   `operationsStreamGet`, `operationsIdGet`, `operationsIdCancelPost`), build and preview the result   (`agentWidgetBuilderRepoHeadWidgetIdGet`, `buildWidgetFromRepo`, `previewWidgetVersion`), publish a   version of the widget and move between its versions (`agentWidgetBuilderPublishWidgetIdPost`,   `getWidgetPublishHistory`, `setWidgetPublishHistoryLive`, `renameWidgetPublishHistoryTitle`), and   turn a stroke or a sentence into a decision (`agentShapeRecognizePost`, `agentDesignResolvePost`). It can   also offer the customer your presets as starting points: read them and ask for a copy for this customer   (`listMyPresets`, `copyMyPreset`; you choose the presets with `setPartnerPreset`).   What the session makes is filed for this managed user, and the lists it reads hold only this user's   canvases, widgets and compositions. It can reach only canvases, widgets, compositions, repositories,   uploaded files and operations made for this managed user (tag the canvases and widgets you create   with `managedUserId`); any other canvas, widget, composition, conversation, message, repository, file   or operation, including another of your users', answers 404. The creator also saves the composition   it is editing (`updateComposition`, from the `editor` surface) and attaches pictures to its chat   (`uploadsPost`, from the `files` surface), and the surfaces do not imply one another: to open the   whole creator for a user, ask for `creator`, `editor` and `files` together. A generation or a build   one user starts can be followed and cancelled by that user and by you, never by another of your   users. The AI is paid for by your account, as your own calls are: its credits and allowances are   yours. A session cannot make a widget public (publishing a version does not), file one under a   project or an organization, or set anything the creator does not set: a body with another field is   refused with 403 and `EDITOR_SESSION_FIELD_NOT_ALLOWED`. - `workflows`: use Widgetic's Workflows editor for this user. List their workflows and the compositions   a workflow of theirs can chain (`listWorkspaceWorkflows`, `listWorkspaceWorkflowCompositionOptions`);   list the starting points you offer them and make a workflow from one, which gives the user their own copy   of every widget it chains, a composition of their own on each copy, and a draft   (`listWorkspaceWorkflowPresets`, `createWorkspaceWorkflowFromPreset`; you offer them with   `setPartnerWorkflowPreset`);   make, open, change and delete one (`createWorkspaceWorkflow`, `getWorkspaceWorkflow`,   `saveWorkspaceWorkflow`, `deleteWorkspaceWorkflow`) and copy it (`duplicateWorkspaceWorkflow`); publish   it or discard the changes of its draft (`publishWorkspaceWorkflow`,   `discardWorkspaceWorkflowChanges`); read and restore its versions (`listWorkspaceWorkflowVersions`,   `getWorkspaceWorkflowVersion`, `restoreWorkspaceWorkflowVersion`); pause, resume, archive and unarchive it   (`pauseWorkspaceWorkflow`, `resumeWorkspaceWorkflow`, `archiveWorkspaceWorkflow`,   `unarchiveWorkspaceWorkflow`); and read its counts (`getWorkspaceWorkflowStats`). The workspace in each   path is `personal`: a session has no other, and a path that names an organization is refused. What the   session makes is filed for this managed user (`managedUserId`), the lists hold only this user's workflows,   and it can reach only workflows made for this managed user; any other workflow, including one of yours   or of another of your users, answers 404. A workflow can chain only the compositions you made for this   managed user (tag them with `managedUserId`): one that belongs to anybody else is not available, and   publishing a workflow that uses it is refused. A customer can have at most 50 workflows, and what a   customer's session reads never says who published a version. A session cannot set who a workflow belongs   to or which workspace it is in: a body with another field is refused with 403 and   `EDITOR_SESSION_FIELD_NOT_ALLOWED`.  Everything else is refused with 403 and `EDITOR_SESSION_ROUTE_NOT_ALLOWED`: a session cannot read your account, make more sessions, change your presets or delete a composition, and a session without the `creator` surface cannot create or list compositions. Create the composition yourself with your API key, then open the editor on it.  A session ends at `expiresAt` (at most four hours), when you end it (`revokeManagedUserEditorSession`), or when the managed user is switched off or deleted. A managed user can have at most 100 live sessions at once (`429 EDITOR_SESSION_LIMIT_REACHED`). A session that is bound to a web page (`allowedOrigin`) is refused from any other origin.  The AI the session runs is paid for with your credits. Set `maxCredits` to hold the session to a number of them: once its generations have taken that many (a generation that fails is refunded and does not count), the next one is refused with 402 and `EDITOR_SESSION_CREDIT_LIMIT_REACHED`, and the browser is told only that the feature is not available right now. Without it, the limit Widgetic has set for your account applies when it has set one (the same limit for every session you make, and `maxCredits: null` asks for none), and otherwise the credits of your account are the only ceiling. What each of your users' sessions has spent is in `getManagedUserUsage`.  Each call makes a new session. It does not take an `Idempotency-Key`: the answer holds the token, and the token is never stored where a retry could read it back. The answer is sent with `Cache-Control: no-store`. 
 
 ### Examples
 

data/docs/NewComposition.md

@@ -11,7 +11,7 @@
 | **status** | **String** | Initial status of the composition | [optional][default to 'draft'] |
 | **embed_settings** | **Object** | Settings for embedding the composition | [optional] |
 | **design** | **Object** | Design settings for the composition | [optional] |
-| **database_schema** | **Object** | The tables this composition keeps what visitors send it in (votes, ratings, answers). They are made when the composition is created, in a schema of their own that no other composition can reach: in Widgetic's database, or in your own Neon database when you have set one with `setPartnerDataDatabase`. They are deleted with the composition.  The shape is `{ \"tables\": [ ... ] }`. A table has a `name`, a list of `columns` and, optionally, a list of `indexes`. A column has a `name` and a `type`, and optionally `primaryKey`, `notNull`, `unique` and `default`. An index has a `name` and the `columns` it covers (1 to 8), and optionally `unique`. Any other key is refused.  - Names (tables, columns, indexes) use lower-case letters, digits and underscores, start with a letter and   are at most 63 characters long. A name that starts with `_` or `pg_` is reserved. - `type` is one of `text`, `smallint`, `integer` (or `int`), `bigint`, `numeric`, `real`,   `double precision`, `boolean` (or `bool`), `date`, `timestamp`, `timestamptz` (or   `timestamp with time zone`), `uuid`, `json`, `jsonb`, `serial`, `bigserial`. - `default` is a number, `true` or `false`, a text of at most 500 characters (no backslash), a JSON value   for a `json` or `jsonb` column, or one of `now()`, `current_timestamp` and `current_date` (date and   timestamp columns) and `gen_random_uuid()` (a `uuid` column). A `serial` column numbers itself and has   no default. - A composition declares at most 20 tables, with at most 64 columns and 10 indexes each.  A declaration that cannot be used is refused with `400` and `INVALID_DATABASE_SCHEMA`; `error.details.problems` lists what to change. Tables that already exist are never changed or dropped: sending more tables later, when you update the composition, adds the ones that are missing. When the composition is saved but its tables cannot be made just now, the answer says so in `meta.warnings`: send the same `databaseSchema` again to retry.  Leave it out and the composition gets the tables its widget declares in its own source (`src/lib/meta/database.json`), if any. Send `{ \"tables\": [] }` to give the composition no tables and keep it from getting its widget's.  | [optional] |
+| **database_schema** | **Object** | The tables this composition keeps what visitors send it in (votes, ratings, answers). They are made when the composition is created, in a schema of their own that no other composition can reach: in Widgetic's database, or in your own Neon database when you have set one with `setPartnerDataDatabase`. They are deleted with the composition.  The shape is `{ \"tables\": [ ... ] }`. A table has a `name`, a list of `columns` and, optionally, a list of `indexes`, and optionally `countable`. A column has a `name` and a `type`, and optionally `primaryKey`, `notNull`, `unique`, `default` and `readable`. An index has a `name` and the `columns` it covers (1 to 8), and optionally `unique`. Any other key is refused, except `source` (see below).  `countable` and `readable` are the read policy of the composition's own page: nothing the visitors sent can be read back by the page until you say so. `countable: true` on a table lets the widget show how many rows it has; `readable: true` on a column lets it show or total that column's values (a tally of votes, an average rating). Mark only what is safe to show to anyone who opens the page. A column whose name holds `email`, `phone`, `address`, `token`, `password`, `secret`, `ip` or the like, and a `json`, `jsonb` or `uuid` column, cannot be `readable`.  - Names (tables, columns, indexes) use lower-case letters, digits and underscores, start with a letter and   are at most 63 characters long. A name that starts with `_` or `pg_` is reserved. - `type` is one of `text`, `smallint`, `integer` (or `int`), `bigint`, `numeric`, `real`,   `double precision`, `boolean` (or `bool`), `date`, `timestamp`, `timestamptz` (or   `timestamp with time zone`), `uuid`, `json`, `jsonb`, `serial`, `bigserial`. - `default` is a number, `true` or `false`, a text of at most 500 characters (no backslash), a JSON value   for a `json` or `jsonb` column, or one of `now()`, `current_timestamp` and `current_date` (date and   timestamp columns) and `gen_random_uuid()` (a `uuid` column). A `serial` column numbers itself and has   no default. - A composition declares at most 20 tables, with at most 64 columns and 10 indexes each.  A declaration that cannot be used is refused with `400` and `INVALID_DATABASE_SCHEMA`; `error.details.problems` lists what to change. Tables that already exist are never changed or dropped: sending more tables later, when you update the composition, adds the ones that are missing. When the composition is saved but its tables cannot be made just now, the answer says so in `meta.warnings`: send the same `databaseSchema` again to retry.  Leave it out and the composition gets the tables its widget declares in its own source (`src/lib/meta/database.json`), if any. Send `{ \"tables\": [] }` to give the composition no tables and keep it from getting its widget's.  A composition whose tables were made from its widget's own file reads back with `\"source\": \"widget\"` next to `tables`. When the widget is published again, a table, a field or an index its file gained is added to them; nothing that exists is changed or dropped, and what a page may read does not change. Send `source` back as it was and it stays. Leave it out and the tables are yours: no widget's file adds anything to them. It is the only value `source` can have.  | [optional] |
 | **project_id** | **String** | ID of the project this composition belongs to | [optional] |
 | **managed_user_id** | **String** | Make the composition for one of your managed users, by Widgetic's id for the user. Send this or `managedUserExternalId`, not both. The managed user must be yours and active. The composition stays in your account; the tag lets you list one user's compositions and keeps it out of the others' lists. It is set here and does not change afterwards. | [optional] |
 | **managed_user_external_id** | **String** | The same, by your own identifier for the user, the `externalId` you gave when you created the managed user (answers show it as `externalId`). Send this or `managedUserId`, not both. | [optional] |

data/docs/NewEditorSession.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **surfaces** | **Array<String>** | The pieces of Widgetic's editor the session may drive. `files` is the media library (the File Browser: upload a file, list the files uploaded for this user); what a user uploads is kept in your own storage destination. Partner storage is not optional: a session of any surface can be made only once you have set a destination up (`setPartnerStorageDestination`), and is refused with `409 PARTNER_STORAGE_REQUIRED` until then. `editor` is editing one of this user's compositions: read it, change its name, content, design and embed settings, read its schemas, and ask where to show it (`getCompositionPreview`: the widget's published page). `creator` is Widgetic's widget creator, with its drawing canvas and its AI: this user's canvases, the widgets on them and the conversation of each widget, the generation, build and publish calls that make a widget, and the compositions of those widgets (list, make). The surfaces do not imply one another: the whole creator also saves a composition (`editor`) and attaches pictures to its chat (`files`), so ask for `[\"creator\", \"editor\", \"files\"]`.  |  |
+| **surfaces** | **Array<String>** | The pieces of Widgetic's editor the session may drive. `files` is the media library (the File Browser: upload a file, list the files uploaded for this user); what a user uploads is kept in your own storage destination. Partner storage is not optional: a session of any surface can be made only once you have set a destination up (`setPartnerStorageDestination`), and is refused with `409 PARTNER_STORAGE_REQUIRED` until then. `editor` is editing one of this user's compositions: read it, change its name, content, design and embed settings, read its schemas, and ask where to show it (`getCompositionPreview`: the widget's published page). `creator` is Widgetic's widget creator, with its drawing canvas and its AI: this user's canvases, the widgets on them and the conversation of each widget, the generation, build and publish calls that make a widget, and the compositions of those widgets (list, make). The surfaces do not imply one another: the whole creator also saves a composition (`editor`) and attaches pictures to its chat (`files`), so ask for `[\"creator\", \"editor\", \"files\"]`. `workflows` is the Workflows editor: this user's own workflows (list, make, make from one of your starting points, draw, publish, pause, resume, archive, delete, the version history and the counts) under `/workspaces/personal/workflows`, and the compositions made for this user, which are the only ones a workflow of theirs can chain. A workflow is filed under the user it was made for (`managedUserId`), and the session reaches nothing of another user's, nor of yours.  |  |
 | **expires_in_seconds** | **Integer** | How long the session lasts, in seconds. It cannot be extended; make a new session when it ends. | [optional][default to 3600] |
 | **allowed_origin** | **String** | Bind the session to one web page origin, such as `https://app.example.com` (no path; `http` is accepted only for `localhost`). The session is then refused from any other origin, and from a request that carries no `Origin` header. Leave it out for a session that can be used from anywhere, which is what a server-side caller needs.  | [optional] |
 | **max_credits** | **Integer** | The most credits this session may spend on Widgetic's AI, one credit being one generation. Once the operations it ran have taken that many, the next one is refused (402, `EDITOR_SESSION_CREDIT_LIMIT_REACHED`) and the browser is only told that the feature is not available right now. A generation that fails is refunded and does not count. Leave it out to get the limit Widgetic has set for your account, if it has set one (it sets none unless you ask), and otherwise no limit of its own, which leaves the credits of your account as the only ceiling. Send `null` to ask for no limit of its own even when a default is set.  | [optional] |

data/docs/OfferWorkflowPresetRequest.md

@@ -0,0 +1,24 @@
+# ApiSdkRb::OfferWorkflowPresetRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workflow_id** | **String** | One of your own published workflows. |  |
+| **title** | **String** | What the picker shows. Leave it out to show the workflow's name. | [optional] |
+| **description** | **String** |  | [optional] |
+| **position** | **Integer** | Where it sits in the list. Smallest first; the same position is ordered by key. | [optional][default to 0] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::OfferWorkflowPresetRequest.new(
+  workflow_id: null,
+  title: null,
+  description: null,
+  position: null
+)
+```
+

data/docs/OfferedWorkflowPreset.md

@@ -0,0 +1,40 @@
+# ApiSdkRb::OfferedWorkflowPreset
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** | The name your code and the picker use for the starting point. |  |
+| **workflow_id** | **String** | The workflow it is made from. What people get is its live version as it is when they start. |  |
+| **title** | **String** | What the picker shows. Null means show the workflow's name. |  |
+| **description** | **String** |  |  |
+| **position** | **Integer** | The list is ordered by this, smallest first, then by key. |  |
+| **available** | **Boolean** | Whether people can start from it now. A starting point that is not available is not shown to anyone, and says why. |  |
+| **unavailable_reason** | **String** | Why it is not available. `workflow_missing`: the workflow was deleted. `workflow_not_own`: it is no longer a workflow of your own. `workflow_archived`: unarchive it. `workflow_not_published`: it has no live version. `workflow_empty`: it shows no composition. `composition_not_own`: a block shows a composition made for a customer or a team. `too_many_widgets`: it chains more than 10 widgets. `widget_not_preset`: a widget it chains is no longer offered as a preset.  |  |
+| **workflow_name** | **String** | The workflow's name. Null when the workflow is gone. |  |
+| **block_count** | **Integer** | How many blocks its live version has. Null when it is not available. |  |
+| **widgets** | [**Array<OfferedWorkflowPresetWidget>**](OfferedWorkflowPresetWidget.md) | The widgets it chains, once each, in the order they first appear. Empty when it is not available. |  |
+| **created_at** | **Time** |  |  |
+| **updated_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::OfferedWorkflowPreset.new(
+  key: welcome-then-offer,
+  workflow_id: null,
+  title: null,
+  description: null,
+  position: null,
+  available: null,
+  unavailable_reason: null,
+  workflow_name: null,
+  block_count: null,
+  widgets: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/OfferedWorkflowPresetList.md

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

data/docs/OfferedWorkflowPresetWidget.md

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