api-sdk-rb 1.11.66 → 1.11.133

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
+)
+```
+

data/docs/OperationsApi.md

@@ -4,12 +4,12 @@ All URIs are relative to *https://api.widgetic.com/v1*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**operations_id_get_0**](OperationsApi.md#operations_id_get_0) | **GET** /operations/{id} | Get operation status |
+| [**get_operation**](OperationsApi.md#get_operation) | **GET** /operations/{id} | Get operation status |
 
 
-## operations_id_get_0
+## get_operation
 
-> <OperationsIdGetResponse> operations_id_get_0(id)
+> <GetOperationResponse> get_operation(id)
 
 Get operation status
 
@@ -31,28 +31,28 @@ id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Operation identifier retu
 
 begin
   # Get operation status
-  result = api_instance.operations_id_get_0(id)
+  result = api_instance.get_operation(id)
   p result
 rescue ApiSdkRb::ApiError => e
-  puts "Error when calling OperationsApi->operations_id_get_0: #{e}"
+  puts "Error when calling OperationsApi->get_operation: #{e}"
 end
 ```
 
-#### Using the operations_id_get_0_with_http_info variant
+#### Using the get_operation_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<OperationsIdGetResponse>, Integer, Hash)> operations_id_get_0_with_http_info(id)
+> <Array(<GetOperationResponse>, Integer, Hash)> get_operation_with_http_info(id)
 
 ```ruby
 begin
   # Get operation status
-  data, status_code, headers = api_instance.operations_id_get_0_with_http_info(id)
+  data, status_code, headers = api_instance.get_operation_with_http_info(id)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <OperationsIdGetResponse>
+  p data # => <GetOperationResponse>
 rescue ApiSdkRb::ApiError => e
-  puts "Error when calling OperationsApi->operations_id_get_0_with_http_info: #{e}"
+  puts "Error when calling OperationsApi->get_operation_with_http_info: #{e}"
 end
 ```
 
@@ -64,7 +64,7 @@ end
 
 ### Return type
 
-[**OperationsIdGetResponse**](OperationsIdGetResponse.md)
+[**GetOperationResponse**](GetOperationResponse.md)
 
 ### Authorization
 

data/docs/PartnerCustomization.md

@@ -39,8 +39,8 @@ instance = ApiSdkRb::PartnerCustomization.new(
   billing_cycle: annual,
   minimum_commitment_months: 12,
   support_sla: 99.9%,
-  contract_start_date: Mon Jan 01 02:00:00 EET 2024,
-  contract_end_date: Tue Dec 31 02:00:00 EET 2024,
+  contract_start_date: Mon Jan 01 01:00:00 CET 2024,
+  contract_end_date: Tue Dec 31 01:00:00 CET 2024,
   notes: Special pricing for strategic partner,
   is_active_contract: true,
   created_at: null,

data/docs/PartnerNotification.md

@@ -9,7 +9,7 @@
 | **title** | **String** | One line that says what happened |  |
 | **body** | **String** | A few sentences that say what happened and what to do about it |  |
 | **tone** | **String** | How serious it is |  |
-| **data** | **Hash<String, Object>** | The facts of the event, named in camelCase. An invoice event carries `invoiceNumber`, `subtotal`, `taxAmount`, `total`, `currency`, `dueDate`, `hostedInvoiceUrl` (the page where it is paid) and `purpose` (`contract`, or `extra_credits` for credits you bought on top of the contract: an unpaid invoice for extra credits never stops the account, the credits are just not added until it is paid); a payment adds `paidAt`, a failed payment `reason`, a reminder `daysUntilDue` or `daysOverdue`. A credits event carries `band` (`low` or `empty`), `balance` and `threshold`. `credits.managed_user_cap_reached` (one of your managed users used its monthly credits and a request was refused) goes to your webhook only when subscribed, once per managed user each month, and carries `managedUserId`, `externalId`, `monthlyCredits`, `creditsUsed`, `resetsAt` and `reachedAt`. A standing event carries `status`, `previousStatus` and `reason`; `partner.paused` with `status: payment_arrears` means that an overdue invoice stopped the account (nobody paused it, and `reason` names the invoice), and `partner.resumed` with `previousStatus: payment_arrears` means that its payment ended that. A storage event carries `reason` and `checkedAt`. Content events (`composition.created`, `composition.updated`, `widget.published`, `upload.created`, `entry.created`) go to your webhook only when subscribed; they do not appear in the dashboard list. `composition.created` carries `compositionId`, `widgetId`, `name`, `managedUserId`, `externalId` and `createdAt`; `composition.updated` carries `compositionId`, `widgetId`, `name`, `managedUserId`, `externalId`, `contentVersion` and `savedAt`, and is sent for the first save of a composition in each five minutes (read the composition for its current state); `widget.published` carries `widgetId`, `name`, `managedUserId`, `externalId`, `version` and `publishedAt`; `upload.created` carries `uploadId`, `name`, `mimeType`, `sizeBytes`, `address`, `managedUserId`, `externalId`, `purpose` and `createdAt`; `entry.created` carries `compositionId`, `table`, `entryId`, `createdAt` and `context` (the host attribution of the embedding page, or null), and none of the values the visitor entered: read those with the entries routes. Ignore an event type you do not know: more may be added. `sendPartnerNotificationTestEvent` sends a sample of every one of them. |  |
+| **data** | **Hash<String, Object>** | The facts of the event, named in camelCase. An invoice event carries `invoiceNumber`, `subtotal`, `taxAmount`, `total`, `currency`, `dueDate`, `hostedInvoiceUrl` (the page where it is paid) and `purpose` (`contract`, or `extra_credits` for credits you bought on top of the contract: an unpaid invoice for extra credits never stops the account, the credits are just not added until it is paid); a payment adds `paidAt`, a failed payment `reason`, a reminder `daysUntilDue` or `daysOverdue`. A credits event carries `band` (`low` or `empty`), `balance` and `threshold`. `credits.managed_user_cap_reached` (one of your managed users used its monthly credits and a request was refused) goes to your webhook only when subscribed, once per managed user each month, and carries `managedUserId`, `externalId`, `monthlyCredits`, `creditsUsed`, `resetsAt` and `reachedAt`. A standing event carries `status`, `previousStatus` and `reason`; `partner.paused` with `status: payment_arrears` means that an overdue invoice stopped the account (nobody paused it, and `reason` names the invoice), and `partner.resumed` with `previousStatus: payment_arrears` means that its payment ended that. A storage event carries `reason` and `checkedAt`. Content events (`composition.created`, `composition.updated`, `widget.published`, `upload.created`, `entry.created`, `workflow.created`, `workflow.published`, `workflow.state_changed`, `workflow.deleted`) go to your webhook only when subscribed; they do not appear in the dashboard list. `composition.created` carries `compositionId`, `widgetId`, `name`, `managedUserId`, `externalId` and `createdAt`; `composition.updated` carries `compositionId`, `widgetId`, `name`, `managedUserId`, `externalId`, `contentVersion` and `savedAt`, and is sent for the first save of a composition in each five minutes (read the composition for its current state); `widget.published` carries `widgetId`, `name`, `managedUserId`, `externalId`, `version` and `publishedAt`; `upload.created` carries `uploadId`, `name`, `mimeType`, `sizeBytes`, `address`, `managedUserId`, `externalId`, `purpose` and `createdAt`; `entry.created` carries `compositionId`, `table`, `entryId`, `createdAt` and `context` (the host attribution of the embedding page, or null), and none of the values the visitor entered: read those with the entries routes. The four workflow events are about the workflows your managed users make (only a workflow made for a managed user is told; one your own people made is not). `workflow.created` carries `workflowId`, `name`, `managedUserId`, `externalId`, `createdAt` and `presetKey` (the key you gave the starting point the workflow was started from with `setPartnerWorkflowPreset`, or null when it was drawn new or copied), and is sent for a copy of a workflow and for a start from a starting point too; `workflow.published` carries `workflowId`, `name`, `managedUserId`, `externalId`, `versionId`, `versionNumber` (1 for the first publication) and `publishedAt`; `workflow.state_changed` carries `workflowId`, `name`, `managedUserId`, `externalId`, `action` (`pause`, `resume`, `archive` or `unarchive`), `previousStatus` and `status` (each `draft`, `live`, `paused` or `archived`) and `changedAt`; `workflow.deleted` carries `workflowId`, `name`, `managedUserId`, `externalId`, `previousStatus` (the state it was in when it was deleted: `draft`, `live`, `paused` or `archived`) and `deletedAt`, and means that the workflow with its versions and counts is gone (the compositions it chained are not touched). Read the workflow for what it holds now (a deleted one is not found). Ignore an event type you do not know: more may be added. `sendPartnerNotificationTestEvent` sends a sample of every one of them. |  |
 | **created_at** | **Time** |  |  |
 
 ## Example