@widgetic/api-sdk 1.0.24 → 1.0.26

package/dist/apis/CanvasesApi.d.ts

@@ -27,6 +27,8 @@ export interface GetAllCanvasesRequest {
     createdBefore?: Date;
     updatedAfter?: Date;
     updatedBefore?: Date;
+    managedUserId?: string;
+    managedUserExternalId?: string;
 }
 export interface GetCanvasRequest {
     id: string;
@@ -43,32 +45,32 @@ export interface UpdateCanvasOperationRequest {
  */
 export declare class CanvasesApi extends runtime.BaseAPI {
     /**
-     * Creates a new canvas with the specified properties.
+     * Creates a new canvas with the specified properties.  To make the canvas for one of your managed users, send `managedUserId` or `managedUserExternalId`. The canvas stays in your account and is yours to edit; the tag lets you list one user\'s canvases with `getAllCanvases`. The managed user must be yours and active: one that is not yours, or does not exist, is answered with 404 and `MANAGED_USER_NOT_FOUND`, and one that is switched off with 409 and `MANAGED_USER_INACTIVE`. The tag is set here and does not change afterwards. Called with an editor session, the canvas is always made for the session\'s managed user.
      * Create Canvas
      */
     createCanvasRaw(requestParameters: CreateCanvasOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Canvas>>;
     /**
-     * Creates a new canvas with the specified properties.
+     * Creates a new canvas with the specified properties.  To make the canvas for one of your managed users, send `managedUserId` or `managedUserExternalId`. The canvas stays in your account and is yours to edit; the tag lets you list one user\'s canvases with `getAllCanvases`. The managed user must be yours and active: one that is not yours, or does not exist, is answered with 404 and `MANAGED_USER_NOT_FOUND`, and one that is switched off with 409 and `MANAGED_USER_INACTIVE`. The tag is set here and does not change afterwards. Called with an editor session, the canvas is always made for the session\'s managed user.
      * Create Canvas
      */
     createCanvas(requestParameters: CreateCanvasOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Canvas>;
     /**
-     * Deletes a canvas.
+     * Deletes a canvas together with every widget on it.  Called with an editor session, only a canvas whose widgets were all made for the session\'s managed user can be deleted; one that also holds somebody else\'s widgets is refused with 409 and `CANVAS_HAS_OTHER_WIDGETS`, and nothing is deleted. Delete such a canvas with your API key.
      * Delete Canvas
      */
     deleteCanvasRaw(requestParameters: DeleteCanvasRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Deletes a canvas.
+     * Deletes a canvas together with every widget on it.  Called with an editor session, only a canvas whose widgets were all made for the session\'s managed user can be deleted; one that also holds somebody else\'s widgets is refused with 409 and `CANVAS_HAS_OTHER_WIDGETS`, and nothing is deleted. Delete such a canvas with your API key.
      * Delete Canvas
      */
     deleteCanvas(requestParameters: DeleteCanvasRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     * Retrieves all canvases with pagination support and filtering options.
+     * Retrieves all canvases with pagination support and filtering options.  Pass `managedUserId` (Widgetic\'s id for one of your managed users) or `managedUserExternalId` (your own identifier for the user) to list only the canvases made for that managed user. The canvases of your other managed users, and your own, are left out. A managed user that is not yours, or does not exist, is answered with 404 and `MANAGED_USER_NOT_FOUND`. Called with an editor session, the list is always the session\'s managed user\'s.
      * Get All Canvases
      */
     getAllCanvasesRaw(requestParameters: GetAllCanvasesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetAllCanvases200Response>>;
     /**
-     * Retrieves all canvases with pagination support and filtering options.
+     * Retrieves all canvases with pagination support and filtering options.  Pass `managedUserId` (Widgetic\'s id for one of your managed users) or `managedUserExternalId` (your own identifier for the user) to list only the canvases made for that managed user. The canvases of your other managed users, and your own, are left out. A managed user that is not yours, or does not exist, is answered with 404 and `MANAGED_USER_NOT_FOUND`. Called with an editor session, the list is always the session\'s managed user\'s.
      * Get All Canvases
      */
     getAllCanvases(requestParameters?: GetAllCanvasesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAllCanvases200Response>;
@@ -83,12 +85,12 @@ export declare class CanvasesApi extends runtime.BaseAPI {
      */
     getCanvas(requestParameters: GetCanvasRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Canvas>;
     /**
-     * Lists the widgets that a canvas deletion would remove, grouped by project name. A canvas can hold widgets from more than one project, so the confirmation dialog can state exactly what will be lost.
+     * Lists the widgets that a canvas deletion would remove, grouped by project name. A canvas can hold widgets from more than one project, so the confirmation dialog can state exactly what will be lost. Called with an editor session, it lists only the widgets made for the session\'s managed user.
      * Preview Canvas Deletion
      */
     previewDeleteCanvasRaw(requestParameters: PreviewDeleteCanvasRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PreviewDeleteCanvas200Response>>;
     /**
-     * Lists the widgets that a canvas deletion would remove, grouped by project name. A canvas can hold widgets from more than one project, so the confirmation dialog can state exactly what will be lost.
+     * Lists the widgets that a canvas deletion would remove, grouped by project name. A canvas can hold widgets from more than one project, so the confirmation dialog can state exactly what will be lost. Called with an editor session, it lists only the widgets made for the session\'s managed user.
      * Preview Canvas Deletion
      */
     previewDeleteCanvas(requestParameters: PreviewDeleteCanvasRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PreviewDeleteCanvas200Response>;

package/dist/apis/CanvasesApi.js

@@ -30,7 +30,7 @@ const index_1 = require("../models/index");
  */
 class CanvasesApi extends runtime.BaseAPI {
     /**
-     * Creates a new canvas with the specified properties.
+     * Creates a new canvas with the specified properties.  To make the canvas for one of your managed users, send `managedUserId` or `managedUserExternalId`. The canvas stays in your account and is yours to edit; the tag lets you list one user\'s canvases with `getAllCanvases`. The managed user must be yours and active: one that is not yours, or does not exist, is answered with 404 and `MANAGED_USER_NOT_FOUND`, and one that is switched off with 409 and `MANAGED_USER_INACTIVE`. The tag is set here and does not change afterwards. Called with an editor session, the canvas is always made for the session\'s managed user.
      * Create Canvas
      */
     createCanvasRaw(requestParameters, initOverrides) {
@@ -59,7 +59,7 @@ class CanvasesApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Creates a new canvas with the specified properties.
+     * Creates a new canvas with the specified properties.  To make the canvas for one of your managed users, send `managedUserId` or `managedUserExternalId`. The canvas stays in your account and is yours to edit; the tag lets you list one user\'s canvases with `getAllCanvases`. The managed user must be yours and active: one that is not yours, or does not exist, is answered with 404 and `MANAGED_USER_NOT_FOUND`, and one that is switched off with 409 and `MANAGED_USER_INACTIVE`. The tag is set here and does not change afterwards. Called with an editor session, the canvas is always made for the session\'s managed user.
      * Create Canvas
      */
     createCanvas(requestParameters, initOverrides) {
@@ -69,7 +69,7 @@ class CanvasesApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Deletes a canvas.
+     * Deletes a canvas together with every widget on it.  Called with an editor session, only a canvas whose widgets were all made for the session\'s managed user can be deleted; one that also holds somebody else\'s widgets is refused with 409 and `CANVAS_HAS_OTHER_WIDGETS`, and nothing is deleted. Delete such a canvas with your API key.
      * Delete Canvas
      */
     deleteCanvasRaw(requestParameters, initOverrides) {
@@ -96,7 +96,7 @@ class CanvasesApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Deletes a canvas.
+     * Deletes a canvas together with every widget on it.  Called with an editor session, only a canvas whose widgets were all made for the session\'s managed user can be deleted; one that also holds somebody else\'s widgets is refused with 409 and `CANVAS_HAS_OTHER_WIDGETS`, and nothing is deleted. Delete such a canvas with your API key.
      * Delete Canvas
      */
     deleteCanvas(requestParameters, initOverrides) {
@@ -105,7 +105,7 @@ class CanvasesApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Retrieves all canvases with pagination support and filtering options.
+     * Retrieves all canvases with pagination support and filtering options.  Pass `managedUserId` (Widgetic\'s id for one of your managed users) or `managedUserExternalId` (your own identifier for the user) to list only the canvases made for that managed user. The canvases of your other managed users, and your own, are left out. A managed user that is not yours, or does not exist, is answered with 404 and `MANAGED_USER_NOT_FOUND`. Called with an editor session, the list is always the session\'s managed user\'s.
      * Get All Canvases
      */
     getAllCanvasesRaw(requestParameters, initOverrides) {
@@ -138,6 +138,12 @@ class CanvasesApi extends runtime.BaseAPI {
             if (requestParameters['updatedBefore'] != null) {
                 queryParameters['updated_before'] = requestParameters['updatedBefore'].toISOString();
             }
+            if (requestParameters['managedUserId'] != null) {
+                queryParameters['managedUserId'] = requestParameters['managedUserId'];
+            }
+            if (requestParameters['managedUserExternalId'] != null) {
+                queryParameters['managedUserExternalId'] = requestParameters['managedUserExternalId'];
+            }
             const headerParameters = {};
             if (this.configuration && this.configuration.accessToken) {
                 const token = this.configuration.accessToken;
@@ -156,7 +162,7 @@ class CanvasesApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Retrieves all canvases with pagination support and filtering options.
+     * Retrieves all canvases with pagination support and filtering options.  Pass `managedUserId` (Widgetic\'s id for one of your managed users) or `managedUserExternalId` (your own identifier for the user) to list only the canvases made for that managed user. The canvases of your other managed users, and your own, are left out. A managed user that is not yours, or does not exist, is answered with 404 and `MANAGED_USER_NOT_FOUND`. Called with an editor session, the list is always the session\'s managed user\'s.
      * Get All Canvases
      */
     getAllCanvases() {
@@ -203,7 +209,7 @@ class CanvasesApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Lists the widgets that a canvas deletion would remove, grouped by project name. A canvas can hold widgets from more than one project, so the confirmation dialog can state exactly what will be lost.
+     * Lists the widgets that a canvas deletion would remove, grouped by project name. A canvas can hold widgets from more than one project, so the confirmation dialog can state exactly what will be lost. Called with an editor session, it lists only the widgets made for the session\'s managed user.
      * Preview Canvas Deletion
      */
     previewDeleteCanvasRaw(requestParameters, initOverrides) {
@@ -230,7 +236,7 @@ class CanvasesApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Lists the widgets that a canvas deletion would remove, grouped by project name. A canvas can hold widgets from more than one project, so the confirmation dialog can state exactly what will be lost.
+     * Lists the widgets that a canvas deletion would remove, grouped by project name. A canvas can hold widgets from more than one project, so the confirmation dialog can state exactly what will be lost. Called with an editor session, it lists only the widgets made for the session\'s managed user.
      * Preview Canvas Deletion
      */
     previewDeleteCanvas(requestParameters, initOverrides) {

package/dist/apis/ComponentsApi.d.ts

@@ -10,12 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { CanvasesCanvasIdComponentsComponentIdPublishPost202Response, CanvasesCanvasIdComponentsComponentIdPublishPostRequest, Component, CreateComponentRequest, GetComponentsByWidgetId200Response, RollbackComponentRequest, UpdateComponentRequest, UsersSendFeedbackPost200Response } from '../models/index';
-export interface CanvasesCanvasIdComponentsComponentIdPublishPostOperationRequest {
-    canvasId: string;
-    componentId: string;
-    canvasesCanvasIdComponentsComponentIdPublishPostRequest: CanvasesCanvasIdComponentsComponentIdPublishPostRequest;
-}
+import type { Component, CreateComponentRequest, GetComponentsByWidgetId200Response, UpdateComponentRequest } from '../models/index';
 export interface CreateComponentOperationRequest {
     canvasId: string;
     createComponentRequest: CreateComponentRequest;
@@ -43,10 +38,6 @@ export interface GetComponentsByWidgetIdRequest {
     size?: number;
     sort?: string;
 }
-export interface RollbackComponentOperationRequest {
-    componentId: string;
-    rollbackComponentRequest: RollbackComponentRequest;
-}
 export interface UpdateComponentOperationRequest {
     canvasId: string;
     componentId: string;
@@ -56,14 +47,6 @@ export interface UpdateComponentOperationRequest {
  *
  */
 export declare class ComponentsApi extends runtime.BaseAPI {
-    /**
-     * Publishes a specific component version as a widget build
-     */
-    canvasesCanvasIdComponentsComponentIdPublishPostRaw(requestParameters: CanvasesCanvasIdComponentsComponentIdPublishPostOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CanvasesCanvasIdComponentsComponentIdPublishPost202Response>>;
-    /**
-     * Publishes a specific component version as a widget build
-     */
-    canvasesCanvasIdComponentsComponentIdPublishPost(requestParameters: CanvasesCanvasIdComponentsComponentIdPublishPostOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CanvasesCanvasIdComponentsComponentIdPublishPost202Response>;
     /**
      * Creates a new component for a canvas with the specified properties.
      * Create Component
@@ -124,16 +107,6 @@ export declare class ComponentsApi extends runtime.BaseAPI {
      * Get Components By Widget ID
      */
     getComponentsByWidgetId(requestParameters: GetComponentsByWidgetIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetComponentsByWidgetId200Response>;
-    /**
-     * Rolls back a component to a specific checkpoint version by reverting to a specific Git commit. This operation cancels any in-progress or queued tasks for the component, resets the repository to the specified checkpoint, and updates the component\'s metadata.
-     * Rollback Component to Checkpoint
-     */
-    rollbackComponentRaw(requestParameters: RollbackComponentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UsersSendFeedbackPost200Response>>;
-    /**
-     * Rolls back a component to a specific checkpoint version by reverting to a specific Git commit. This operation cancels any in-progress or queued tasks for the component, resets the repository to the specified checkpoint, and updates the component\'s metadata.
-     * Rollback Component to Checkpoint
-     */
-    rollbackComponent(requestParameters: RollbackComponentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UsersSendFeedbackPost200Response>;
     /**
      * Updates an existing component with the specified properties.
      * Update Component

package/dist/apis/ComponentsApi.js

@@ -29,49 +29,6 @@ const index_1 = require("../models/index");
  *
  */
 class ComponentsApi extends runtime.BaseAPI {
-    /**
-     * Publishes a specific component version as a widget build
-     */
-    canvasesCanvasIdComponentsComponentIdPublishPostRaw(requestParameters, initOverrides) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (requestParameters['canvasId'] == null) {
-                throw new runtime.RequiredError('canvasId', 'Required parameter "canvasId" was null or undefined when calling canvasesCanvasIdComponentsComponentIdPublishPost().');
-            }
-            if (requestParameters['componentId'] == null) {
-                throw new runtime.RequiredError('componentId', 'Required parameter "componentId" was null or undefined when calling canvasesCanvasIdComponentsComponentIdPublishPost().');
-            }
-            if (requestParameters['canvasesCanvasIdComponentsComponentIdPublishPostRequest'] == null) {
-                throw new runtime.RequiredError('canvasesCanvasIdComponentsComponentIdPublishPostRequest', 'Required parameter "canvasesCanvasIdComponentsComponentIdPublishPostRequest" was null or undefined when calling canvasesCanvasIdComponentsComponentIdPublishPost().');
-            }
-            const queryParameters = {};
-            const headerParameters = {};
-            headerParameters['Content-Type'] = 'application/json';
-            if (this.configuration && this.configuration.accessToken) {
-                const token = this.configuration.accessToken;
-                const tokenString = yield token("bearerAuth", []);
-                if (tokenString) {
-                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
-                }
-            }
-            const response = yield this.request({
-                path: `/canvases/{canvasId}/components/{componentId}/publish`.replace(`{${"canvasId"}}`, encodeURIComponent(String(requestParameters['canvasId']))).replace(`{${"componentId"}}`, encodeURIComponent(String(requestParameters['componentId']))),
-                method: 'POST',
-                headers: headerParameters,
-                query: queryParameters,
-                body: (0, index_1.CanvasesCanvasIdComponentsComponentIdPublishPostRequestToJSON)(requestParameters['canvasesCanvasIdComponentsComponentIdPublishPostRequest']),
-            }, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.CanvasesCanvasIdComponentsComponentIdPublishPost202ResponseFromJSON)(jsonValue));
-        });
-    }
-    /**
-     * Publishes a specific component version as a widget build
-     */
-    canvasesCanvasIdComponentsComponentIdPublishPost(requestParameters, initOverrides) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.canvasesCanvasIdComponentsComponentIdPublishPostRaw(requestParameters, initOverrides);
-            return yield response.value();
-        });
-    }
     /**
      * Creates a new component for a canvas with the specified properties.
      * Create Component
@@ -320,48 +277,6 @@ class ComponentsApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
-    /**
-     * Rolls back a component to a specific checkpoint version by reverting to a specific Git commit. This operation cancels any in-progress or queued tasks for the component, resets the repository to the specified checkpoint, and updates the component\'s metadata.
-     * Rollback Component to Checkpoint
-     */
-    rollbackComponentRaw(requestParameters, initOverrides) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (requestParameters['componentId'] == null) {
-                throw new runtime.RequiredError('componentId', 'Required parameter "componentId" was null or undefined when calling rollbackComponent().');
-            }
-            if (requestParameters['rollbackComponentRequest'] == null) {
-                throw new runtime.RequiredError('rollbackComponentRequest', 'Required parameter "rollbackComponentRequest" was null or undefined when calling rollbackComponent().');
-            }
-            const queryParameters = {};
-            const headerParameters = {};
-            headerParameters['Content-Type'] = 'application/json';
-            if (this.configuration && this.configuration.accessToken) {
-                const token = this.configuration.accessToken;
-                const tokenString = yield token("bearerAuth", []);
-                if (tokenString) {
-                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
-                }
-            }
-            const response = yield this.request({
-                path: `/components/{componentId}/rollback`.replace(`{${"componentId"}}`, encodeURIComponent(String(requestParameters['componentId']))),
-                method: 'POST',
-                headers: headerParameters,
-                query: queryParameters,
-                body: (0, index_1.RollbackComponentRequestToJSON)(requestParameters['rollbackComponentRequest']),
-            }, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.UsersSendFeedbackPost200ResponseFromJSON)(jsonValue));
-        });
-    }
-    /**
-     * Rolls back a component to a specific checkpoint version by reverting to a specific Git commit. This operation cancels any in-progress or queued tasks for the component, resets the repository to the specified checkpoint, and updates the component\'s metadata.
-     * Rollback Component to Checkpoint
-     */
-    rollbackComponent(requestParameters, initOverrides) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.rollbackComponentRaw(requestParameters, initOverrides);
-            return yield response.value();
-        });
-    }
     /**
      * Updates an existing component with the specified properties.
      * Update Component

package/dist/apis/CompositionsApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { CheckCompositionAccess200Response, Composition, CompositionVersion, CreateComposition201Response, DuplicateComposition202Response, DuplicateCompositionRequest, GetAllCompositions200Response, GetCompositionContentSchema200Response, GetCompositionDesignSchema200Response, GetCompositionsBatch200Response, GetCompositionsBatchRequest, NewComposition, SetDynamicContent200Response, SetDynamicContentRequest, UpdateComposition, UpdateCompositionStatusRequest, ValidateCompositionContent200Response } from '../models/index';
+import type { CheckCompositionAccess200Response, Composition, CompositionEntriesDescription, CompositionEntriesReading, CreateComposition201Response, DuplicateComposition202Response, DuplicateCompositionRequest, GetAllCompositions200Response, GetCompositionContentSchema200Response, GetCompositionDesignSchema200Response, GetCompositionEmbedSchema200Response, GetCompositionPreview200Response, GetCompositionVersions200Response, GetCompositionsBatch200Response, GetCompositionsBatchRequest, NewComposition, SetDynamicContent200Response, SetDynamicContentRequest, UpdateComposition, UpdateCompositionStatusRequest, ValidateCompositionContent200Response } from '../models/index';
 export interface CheckCompositionAccessRequest {
     id: string;
 }
@@ -30,6 +30,9 @@ export interface DeleteCompositionDatabaseRecordRequest {
     table: string;
     recordId: string;
 }
+export interface DescribeCompositionEntriesRequest {
+    id: string;
+}
 export interface DuplicateCompositionOperationRequest {
     id: string;
     duplicateCompositionRequest?: DuplicateCompositionRequest;
@@ -43,6 +46,8 @@ export interface GetAllCompositionsRequest {
     projectFolder?: string;
     status?: GetAllCompositionsStatusEnum;
     include?: string;
+    managedUserId?: string;
+    managedUserExternalId?: string;
 }
 export interface GetCompositionByIdRequest {
     id: string;
@@ -68,15 +73,27 @@ export interface GetCompositionDesignRequest {
 export interface GetCompositionDesignSchemaRequest {
     id: string;
 }
+export interface GetCompositionEmbedSchemaRequest {
+    id: string;
+}
 export interface GetCompositionEmbedSettingsRequest {
     id: string;
 }
+export interface GetCompositionPreviewRequest {
+    id: string;
+}
 export interface GetCompositionVersionsRequest {
     id: string;
 }
 export interface GetCompositionsBatchOperationRequest {
     getCompositionsBatchRequest: GetCompositionsBatchRequest;
 }
+export interface ReadCompositionEntriesRequest {
+    id: string;
+    table: string;
+    groupBy?: string;
+    rows?: number;
+}
 export interface SetDynamicContentOperationRequest {
     id: string;
     setDynamicContentRequest: SetDynamicContentRequest;
@@ -114,12 +131,12 @@ export declare class CompositionsApi extends runtime.BaseAPI {
      */
     checkCompositionAccess(requestParameters: CheckCompositionAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CheckCompositionAccess200Response>;
     /**
-     * Creates a new composition.
+     * Creates a new composition.  To make the composition for one of your managed users, send `managedUserId` or `managedUserExternalId`. The composition stays in your account and is yours to edit; the tag lets you list one user\'s compositions with `getAllCompositions`. The managed user must be yours and active: one that is not yours, or does not exist, is answered with 404 and `MANAGED_USER_NOT_FOUND`, and one that is switched off with 409 and `MANAGED_USER_INACTIVE`. The tag is set here and does not change afterwards. A copy made with `duplicateComposition` keeps the tag of the original.  An editor session with the `creator` surface may call this to start a composition of a widget it built: it sends only `name`, `widgetId` (a widget made for the session\'s managed user) and `content`, and the composition is always made for that managed user.  The `Idempotency-Key` header is required (`400` without it). Send the same key when you retry, so one composition is created, not two.
      * Create Composition
      */
     createCompositionRaw(requestParameters: CreateCompositionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateComposition201Response>>;
     /**
-     * Creates a new composition.
+     * Creates a new composition.  To make the composition for one of your managed users, send `managedUserId` or `managedUserExternalId`. The composition stays in your account and is yours to edit; the tag lets you list one user\'s compositions with `getAllCompositions`. The managed user must be yours and active: one that is not yours, or does not exist, is answered with 404 and `MANAGED_USER_NOT_FOUND`, and one that is switched off with 409 and `MANAGED_USER_INACTIVE`. The tag is set here and does not change afterwards. A copy made with `duplicateComposition` keeps the tag of the original.  An editor session with the `creator` surface may call this to start a composition of a widget it built: it sends only `name`, `widgetId` (a widget made for the session\'s managed user) and `content`, and the composition is always made for that managed user.  The `Idempotency-Key` header is required (`400` without it). Send the same key when you retry, so one composition is created, not two.
      * Create Composition
      */
     createComposition(requestParameters: CreateCompositionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateComposition201Response>;
@@ -154,22 +171,32 @@ export declare class CompositionsApi extends runtime.BaseAPI {
      */
     deleteCompositionDatabaseRecord(requestParameters: DeleteCompositionDatabaseRecordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     * Creates a duplicate of an existing composition for the authenticated user.
+     * Names the tables a composition\'s widget keeps entries in (the votes, ratings, answers or sign-ups its visitors left), their columns, and how many entries each holds. Call it first to learn the table and column names that `readCompositionEntries` takes.  A widget that only shows content keeps nothing of its own: the answer is `hasData: false` with no tables, and that is not an error. A table that could not be counted has `rows: null`, which is not zero.  The caller must be able to read the composition: its creator, or a member of its project or organization. An editor session cannot call this route.
+     * Describe What a Composition Keeps
+     */
+    describeCompositionEntriesRaw(requestParameters: DescribeCompositionEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CompositionEntriesDescription>>;
+    /**
+     * Names the tables a composition\'s widget keeps entries in (the votes, ratings, answers or sign-ups its visitors left), their columns, and how many entries each holds. Call it first to learn the table and column names that `readCompositionEntries` takes.  A widget that only shows content keeps nothing of its own: the answer is `hasData: false` with no tables, and that is not an error. A table that could not be counted has `rows: null`, which is not zero.  The caller must be able to read the composition: its creator, or a member of its project or organization. An editor session cannot call this route.
+     * Describe What a Composition Keeps
+     */
+    describeCompositionEntries(requestParameters: DescribeCompositionEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CompositionEntriesDescription>;
+    /**
+     * Creates a duplicate of an existing composition for the authenticated user.  The duplicate is made after the answer: the call returns `202` with an `operationId`. Ask `GET /operations/{id}` for that operation until its `status` is `completed`; the new composition is named in `metadata.newCompositionId`. A problem with the duplicate\'s database (for example, one that could not be copied) is listed in `metadata.warnings`, which is absent when there is none.  The `Idempotency-Key` header is required (`400` without it). Send the same key when you retry, so one duplicate is made, not two.
      * Duplicate Composition
      */
     duplicateCompositionRaw(requestParameters: DuplicateCompositionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DuplicateComposition202Response>>;
     /**
-     * Creates a duplicate of an existing composition for the authenticated user.
+     * Creates a duplicate of an existing composition for the authenticated user.  The duplicate is made after the answer: the call returns `202` with an `operationId`. Ask `GET /operations/{id}` for that operation until its `status` is `completed`; the new composition is named in `metadata.newCompositionId`. A problem with the duplicate\'s database (for example, one that could not be copied) is listed in `metadata.warnings`, which is absent when there is none.  The `Idempotency-Key` header is required (`400` without it). Send the same key when you retry, so one duplicate is made, not two.
      * Duplicate Composition
      */
     duplicateComposition(requestParameters: DuplicateCompositionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DuplicateComposition202Response>;
     /**
-     * Retrieves all compositions with pagination support.
+     * Retrieves all compositions with pagination support.  Pass `managedUserId` (Widgetic\'s id for one of your managed users) or `managedUserExternalId` (your own identifier for the user) to list only the compositions made for that managed user. The compositions of your other managed users, and your own, are left out. It combines with the other filters and with paging. A managed user that is not yours, or does not exist, is answered with 404 and `MANAGED_USER_NOT_FOUND`.  An editor session with the `creator` surface may call this to list the compositions of ONE widget it built: it must send `widget_id`, and the answer holds only the compositions made for the session\'s managed user.
      * Get All Compositions
      */
     getAllCompositionsRaw(requestParameters: GetAllCompositionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetAllCompositions200Response>>;
     /**
-     * Retrieves all compositions with pagination support.
+     * Retrieves all compositions with pagination support.  Pass `managedUserId` (Widgetic\'s id for one of your managed users) or `managedUserExternalId` (your own identifier for the user) to list only the compositions made for that managed user. The compositions of your other managed users, and your own, are left out. It combines with the other filters and with paging. A managed user that is not yours, or does not exist, is answered with 404 and `MANAGED_USER_NOT_FOUND`.  An editor session with the `creator` surface may call this to list the compositions of ONE widget it built: it must send `widget_id`, and the answer holds only the compositions made for the session\'s managed user.
      * Get All Compositions
      */
     getAllCompositions(requestParameters?: GetAllCompositionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAllCompositions200Response>;
@@ -243,6 +270,16 @@ export declare class CompositionsApi extends runtime.BaseAPI {
      * Get Design Schema
      */
     getCompositionDesignSchema(requestParameters: GetCompositionDesignSchemaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCompositionDesignSchema200Response>;
+    /**
+     * Retrieves the definition of the composition\'s Embed tab: which settings exist, what each one holds, what it defaults to, and when its control is shown. It is the third tab beside `schema/content` and `schema/design`, in the same format (`componentGroups` → `components` → `propertyGroups` → `properties`, each property with a `type`, a `defaultValue` and an `inputController`), so a client that draws those two tabs draws this one with the same code.  The schema is the same for every composition (it is the one Widgetic\'s own Embed Editor draws). The composition id decides who may ask: the caller must be able to read the composition.  Reading and saving the values: - `GET /compositions/{id}/embed-settings` returns what the composition saved. A composition whose Embed tab   was never saved has nothing to return; seed the form from `defaults`, which holds the `defaultValue` of   every setting that declares one. - `PUT /compositions/{id}` with `embedSettings` saves them. The gateway stores `embedSettings` as given and   does not check it against this schema; the schema is how a client knows what to put there.  A property\'s `visibilityCondition` says when its control is shown: `condition` is a comparison of the current values of the properties named in `dependsOn` (`useIframe === false`, `embedTarget === \'mixed\' && keepDimensions === false`). While it is false the Embed Editor does not show the control.  A colour picker with `showOpacityControls` saves its opacity next to the colour, under the key `<name>_opacity` as a number from 0 to 1 (`overlayBackgroundColor` → `overlayBackgroundColor_opacity`). Its `defaultTransparency` is a percentage and the saved value a fraction (50 → 0.5).
+     * Get Embed Schema
+     */
+    getCompositionEmbedSchemaRaw(requestParameters: GetCompositionEmbedSchemaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCompositionEmbedSchema200Response>>;
+    /**
+     * Retrieves the definition of the composition\'s Embed tab: which settings exist, what each one holds, what it defaults to, and when its control is shown. It is the third tab beside `schema/content` and `schema/design`, in the same format (`componentGroups` → `components` → `propertyGroups` → `properties`, each property with a `type`, a `defaultValue` and an `inputController`), so a client that draws those two tabs draws this one with the same code.  The schema is the same for every composition (it is the one Widgetic\'s own Embed Editor draws). The composition id decides who may ask: the caller must be able to read the composition.  Reading and saving the values: - `GET /compositions/{id}/embed-settings` returns what the composition saved. A composition whose Embed tab   was never saved has nothing to return; seed the form from `defaults`, which holds the `defaultValue` of   every setting that declares one. - `PUT /compositions/{id}` with `embedSettings` saves them. The gateway stores `embedSettings` as given and   does not check it against this schema; the schema is how a client knows what to put there.  A property\'s `visibilityCondition` says when its control is shown: `condition` is a comparison of the current values of the properties named in `dependsOn` (`useIframe === false`, `embedTarget === \'mixed\' && keepDimensions === false`). While it is false the Embed Editor does not show the control.  A colour picker with `showOpacityControls` saves its opacity next to the colour, under the key `<name>_opacity` as a number from 0 to 1 (`overlayBackgroundColor` → `overlayBackgroundColor_opacity`). Its `defaultTransparency` is a percentage and the saved value a fraction (50 → 0.5).
+     * Get Embed Schema
+     */
+    getCompositionEmbedSchema(requestParameters: GetCompositionEmbedSchemaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCompositionEmbedSchema200Response>;
     /**
      * Retrieves only the embedSettings field from a composition.
      * Get Composition Embed Settings
@@ -253,43 +290,63 @@ export declare class CompositionsApi extends runtime.BaseAPI {
      * Get Composition Embed Settings
      */
     getCompositionEmbedSettings(requestParameters: GetCompositionEmbedSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
+    /**
+     * Returns the address of the page an editor shows the composition in: the page of the widget\'s published version on the CDN, with the widget and version it is. Load it in a frame, then send the frame what to show (the content, design and embed settings you read from the composition, and every change the user makes) with `postMessage`: `{ type: \'widgetic:update\', design }`, `{ type: \'widgetic:update\', content }` or `{ type: \'widgetic:update\', contentItems }`.  The version is the one embeds show, so the editor previews what a visitor gets. The address does not carry the composition id: an embed uses the id to fetch the saved composition itself, while an editor sends the current state (unsaved changes included).  A widget that has never been published has no page to show: the answer is 409 `WIDGET_NOT_PUBLISHED`.
+     * Get Composition Preview
+     */
+    getCompositionPreviewRaw(requestParameters: GetCompositionPreviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCompositionPreview200Response>>;
+    /**
+     * Returns the address of the page an editor shows the composition in: the page of the widget\'s published version on the CDN, with the widget and version it is. Load it in a frame, then send the frame what to show (the content, design and embed settings you read from the composition, and every change the user makes) with `postMessage`: `{ type: \'widgetic:update\', design }`, `{ type: \'widgetic:update\', content }` or `{ type: \'widgetic:update\', contentItems }`.  The version is the one embeds show, so the editor previews what a visitor gets. The address does not carry the composition id: an embed uses the id to fetch the saved composition itself, while an editor sends the current state (unsaved changes included).  A widget that has never been published has no page to show: the answer is 409 `WIDGET_NOT_PUBLISHED`.
+     * Get Composition Preview
+     */
+    getCompositionPreview(requestParameters: GetCompositionPreviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCompositionPreview200Response>;
     /**
      * Retrieves version history for a specific composition.
      * Get Composition Versions
      */
-    getCompositionVersionsRaw(requestParameters: GetCompositionVersionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CompositionVersion>>>;
+    getCompositionVersionsRaw(requestParameters: GetCompositionVersionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCompositionVersions200Response>>;
     /**
      * Retrieves version history for a specific composition.
      * Get Composition Versions
      */
-    getCompositionVersions(requestParameters: GetCompositionVersionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CompositionVersion>>;
+    getCompositionVersions(requestParameters: GetCompositionVersionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCompositionVersions200Response>;
     /**
-     * Retrieves multiple compositions by their IDs in a single request. This endpoint includes domain validation for embed contexts and is used by the embed SDK.
+     * Retrieves multiple compositions by their IDs in a single request. This endpoint includes domain validation for embed contexts and is used by the embed SDK.  Each composition is checked on its own. If its owner listed the websites it may appear on (the workspace\'s domain list, or the `allowedDomains` of a partner the owner administers) and the request comes from another website (the `Origin` header, or the host of `Referer` when there is no `Origin`), that composition is left out of `compositions` and reported in `errors` as `Domain access denied: <reason>`; the others are still returned. A request that names no website, and an owner who listed nothing, are not restricted.
      * Get Compositions Batch
      */
     getCompositionsBatchRaw(requestParameters: GetCompositionsBatchOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCompositionsBatch200Response>>;
     /**
-     * Retrieves multiple compositions by their IDs in a single request. This endpoint includes domain validation for embed contexts and is used by the embed SDK.
+     * Retrieves multiple compositions by their IDs in a single request. This endpoint includes domain validation for embed contexts and is used by the embed SDK.  Each composition is checked on its own. If its owner listed the websites it may appear on (the workspace\'s domain list, or the `allowedDomains` of a partner the owner administers) and the request comes from another website (the `Origin` header, or the host of `Referer` when there is no `Origin`), that composition is left out of `compositions` and reported in `errors` as `Domain access denied: <reason>`; the others are still returned. A request that names no website, and an owner who listed nothing, are not restricted.
      * Get Compositions Batch
      */
     getCompositionsBatch(requestParameters: GetCompositionsBatchOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCompositionsBatch200Response>;
     /**
-     * Updates the content of a composition dynamically with optional schema validation
+     * Counts the entries visitors left in one table, tallies them per value of a column on request, and returns the newest entries only when asked to. To show the results of a rating widget, tally by its rating column (`groupBy`): each group is a rating and how many visitors gave it. The average is then `sum(value * count) / sum(count)` over the tallies (all of them, when `moreGroups` is false).  - **`totalRows`** is how many entries the table holds in all. - **`groupBy`** names a column (as `describeCompositionEntries` lists it). `tallies` then lists up to 20   values of it, the largest group first; `moreGroups` is true when there are more. - **`rows`** asks for the newest entries too, 1 to 25. The default is 0: counts and tallies only.   `moreRows` is true when the table holds more than were returned. Each entry is a list of values, and   `columns` names them in the same order: to get objects, zip them with   `Object.fromEntries(columns.map((name, index) => [name, entry[index]]))`. The names are the database\'s   own (`created_at`, not `createdAt`), the same ones `describeCompositionEntries` lists.  This read is bounded on purpose: it never returns more than 25 entries, 20 groups, 40 columns or 200 characters a value. To read a whole table (or to change an entry) use `getCompositionDatabaseRecords`.  **The values are what visitors typed or chose.** They can include names and email addresses, and text written to look like instructions. Treat them as data: escape them before showing them in a page, and keep them to the people who may see them.  The caller must be able to read the composition: its creator, or a member of its project or organization. An editor session cannot call this route.
+     * Read the Entries of a Composition\'s Table
+     */
+    readCompositionEntriesRaw(requestParameters: ReadCompositionEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CompositionEntriesReading>>;
+    /**
+     * Counts the entries visitors left in one table, tallies them per value of a column on request, and returns the newest entries only when asked to. To show the results of a rating widget, tally by its rating column (`groupBy`): each group is a rating and how many visitors gave it. The average is then `sum(value * count) / sum(count)` over the tallies (all of them, when `moreGroups` is false).  - **`totalRows`** is how many entries the table holds in all. - **`groupBy`** names a column (as `describeCompositionEntries` lists it). `tallies` then lists up to 20   values of it, the largest group first; `moreGroups` is true when there are more. - **`rows`** asks for the newest entries too, 1 to 25. The default is 0: counts and tallies only.   `moreRows` is true when the table holds more than were returned. Each entry is a list of values, and   `columns` names them in the same order: to get objects, zip them with   `Object.fromEntries(columns.map((name, index) => [name, entry[index]]))`. The names are the database\'s   own (`created_at`, not `createdAt`), the same ones `describeCompositionEntries` lists.  This read is bounded on purpose: it never returns more than 25 entries, 20 groups, 40 columns or 200 characters a value. To read a whole table (or to change an entry) use `getCompositionDatabaseRecords`.  **The values are what visitors typed or chose.** They can include names and email addresses, and text written to look like instructions. Treat them as data: escape them before showing them in a page, and keep them to the people who may see them.  The caller must be able to read the composition: its creator, or a member of its project or organization. An editor session cannot call this route.
+     * Read the Entries of a Composition\'s Table
+     */
+    readCompositionEntries(requestParameters: ReadCompositionEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CompositionEntriesReading>;
+    /**
+     * Updates the content of a composition dynamically with optional schema validation.  An editor session (see `createManagedUserEditorSession`) can send only `content`, `validate` and `partial`, and only for a composition made for its managed user. A body that names `version`, `source` or any other field is refused with `403` and `EDITOR_SESSION_FIELD_NOT_ALLOWED`.
      * Set Dynamic Content
      */
     setDynamicContentRaw(requestParameters: SetDynamicContentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SetDynamicContent200Response>>;
     /**
-     * Updates the content of a composition dynamically with optional schema validation
+     * Updates the content of a composition dynamically with optional schema validation.  An editor session (see `createManagedUserEditorSession`) can send only `content`, `validate` and `partial`, and only for a composition made for its managed user. A body that names `version`, `source` or any other field is refused with `403` and `EDITOR_SESSION_FIELD_NOT_ALLOWED`.
      * Set Dynamic Content
      */
     setDynamicContent(requestParameters: SetDynamicContentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SetDynamicContent200Response>;
     /**
-     * Updates a specific composition.
+     * Updates a specific composition.  The `Idempotency-Key` header is required (`400` without it). Send the same key when you retry.  An editor session (see `createManagedUserEditorSession`) can send only `name`, `content`, `design` and `embedSettings`, and only for a composition made for its managed user. A body that names any other field is refused with `403` and `EDITOR_SESSION_FIELD_NOT_ALLOWED`.
      * Update Composition
      */
     updateCompositionRaw(requestParameters: UpdateCompositionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateComposition201Response>>;
     /**
-     * Updates a specific composition.
+     * Updates a specific composition.  The `Idempotency-Key` header is required (`400` without it). Send the same key when you retry.  An editor session (see `createManagedUserEditorSession`) can send only `name`, `content`, `design` and `embedSettings`, and only for a composition made for its managed user. A body that names any other field is refused with `403` and `EDITOR_SESSION_FIELD_NOT_ALLOWED`.
      * Update Composition
      */
     updateComposition(requestParameters: UpdateCompositionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateComposition201Response>;
@@ -304,12 +361,12 @@ export declare class CompositionsApi extends runtime.BaseAPI {
      */
     updateCompositionDatabaseRecord(requestParameters: UpdateCompositionDatabaseRecordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     * Updates the status of a specific composition.
+     * Updates the status of a specific composition.  The `Idempotency-Key` header is required (`400` without it). Send the same key when you retry.
      * Update Composition Status
      */
     updateCompositionStatusRaw(requestParameters: UpdateCompositionStatusOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Composition>>;
     /**
-     * Updates the status of a specific composition.
+     * Updates the status of a specific composition.  The `Idempotency-Key` header is required (`400` without it). Send the same key when you retry.
      * Update Composition Status
      */
     updateCompositionStatus(requestParameters: UpdateCompositionStatusOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Composition>;