@widgetic/api-sdk 1.0.24 → 1.0.25

package/dist/esm/apis/CompositionsApi.js

@@ -21,7 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import * as runtime from '../runtime.js';
-import { CheckCompositionAccess200ResponseFromJSON, CompositionFromJSON, CompositionVersionFromJSON, CreateComposition201ResponseFromJSON, DuplicateComposition202ResponseFromJSON, DuplicateCompositionRequestToJSON, GetAllCompositions200ResponseFromJSON, GetCompositionContentSchema200ResponseFromJSON, GetCompositionDesignSchema200ResponseFromJSON, GetCompositionsBatch200ResponseFromJSON, GetCompositionsBatchRequestToJSON, NewCompositionToJSON, SetDynamicContent200ResponseFromJSON, SetDynamicContentRequestToJSON, UpdateCompositionToJSON, UpdateCompositionStatusRequestToJSON, ValidateCompositionContent200ResponseFromJSON, } from '../models/index.js';
+import { CheckCompositionAccess200ResponseFromJSON, CompositionFromJSON, CompositionEntriesDescriptionFromJSON, CompositionEntriesReadingFromJSON, CreateComposition201ResponseFromJSON, DuplicateComposition202ResponseFromJSON, DuplicateCompositionRequestToJSON, GetAllCompositions200ResponseFromJSON, GetCompositionContentSchema200ResponseFromJSON, GetCompositionDesignSchema200ResponseFromJSON, GetCompositionEmbedSchema200ResponseFromJSON, GetCompositionPreview200ResponseFromJSON, GetCompositionVersions200ResponseFromJSON, GetCompositionsBatch200ResponseFromJSON, GetCompositionsBatchRequestToJSON, NewCompositionToJSON, SetDynamicContent200ResponseFromJSON, SetDynamicContentRequestToJSON, UpdateCompositionToJSON, UpdateCompositionStatusRequestToJSON, ValidateCompositionContent200ResponseFromJSON, } from '../models/index.js';
 /**
  *
  */
@@ -64,7 +64,7 @@ export class CompositionsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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, initOverrides) {
@@ -93,7 +93,7 @@ export class CompositionsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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, initOverrides) {
@@ -225,7 +225,44 @@ export class CompositionsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling describeCompositionEntries().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("apiKeyAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/compositions/{id}/entries`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => CompositionEntriesDescriptionFromJSON(jsonValue));
+        });
+    }
+    /**
+     * 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, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.describeCompositionEntriesRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * 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, initOverrides) {
@@ -254,7 +291,7 @@ export class CompositionsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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, initOverrides) {
@@ -264,7 +301,7 @@ export class CompositionsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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, initOverrides) {
@@ -294,6 +331,12 @@ export class CompositionsApi extends runtime.BaseAPI {
             if (requestParameters['include'] != null) {
                 queryParameters['include'] = requestParameters['include'];
             }
+            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;
@@ -312,7 +355,7 @@ export class CompositionsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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() {
@@ -587,6 +630,43 @@ export class CompositionsApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * 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, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getCompositionEmbedSchema().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("apiKeyAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/compositions/{id}/schema/embed`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => GetCompositionEmbedSchema200ResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * 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, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getCompositionEmbedSchemaRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Retrieves only the embedSettings field from a composition.
      * Get Composition Embed Settings
@@ -624,6 +704,43 @@ export class CompositionsApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * 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, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getCompositionPreview().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("apiKeyAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/compositions/{id}/preview`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => GetCompositionPreview200ResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * 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, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getCompositionPreviewRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Retrieves version history for a specific composition.
      * Get Composition Versions
@@ -648,7 +765,7 @@ export class CompositionsApi extends runtime.BaseAPI {
                 headers: headerParameters,
                 query: queryParameters,
             }, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(CompositionVersionFromJSON));
+            return new runtime.JSONApiResponse(response, (jsonValue) => GetCompositionVersions200ResponseFromJSON(jsonValue));
         });
     }
     /**
@@ -662,7 +779,7 @@ export class CompositionsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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, initOverrides) {
@@ -691,7 +808,7 @@ export class CompositionsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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, initOverrides) {
@@ -701,7 +818,53 @@ export class CompositionsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling readCompositionEntries().');
+            }
+            if (requestParameters['table'] == null) {
+                throw new runtime.RequiredError('table', 'Required parameter "table" was null or undefined when calling readCompositionEntries().');
+            }
+            const queryParameters = {};
+            if (requestParameters['groupBy'] != null) {
+                queryParameters['groupBy'] = requestParameters['groupBy'];
+            }
+            if (requestParameters['rows'] != null) {
+                queryParameters['rows'] = requestParameters['rows'];
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("apiKeyAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/compositions/{id}/entries/{table}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))).replace(`{${"table"}}`, encodeURIComponent(String(requestParameters['table']))),
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => CompositionEntriesReadingFromJSON(jsonValue));
+        });
+    }
+    /**
+     * 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, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.readCompositionEntriesRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * 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, initOverrides) {
@@ -733,7 +896,7 @@ export class CompositionsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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, initOverrides) {
@@ -743,7 +906,7 @@ export class CompositionsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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, initOverrides) {
@@ -775,7 +938,7 @@ export class CompositionsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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, initOverrides) {
@@ -832,7 +995,7 @@ export class CompositionsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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, initOverrides) {
@@ -864,7 +1027,7 @@ export class CompositionsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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, initOverrides) {

package/dist/esm/apis/CreditsApi.d.ts

@@ -10,6 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
+import type { AccountCreditBalance, GetUserCreditTransactions200Response } from '../models/index';
 export interface AddCreditsRequest {
     body: object;
 }
@@ -34,12 +35,12 @@ export interface SubtractCreditsRequest {
  */
 export declare class CreditsApi extends runtime.BaseAPI {
     /**
-     * Adds credits to a user\'s balance. Admin only. A `referenceId` in the body names the grant event; when it is omitted the request\'s `Idempotency-Key` header is used instead. One of the two is required — a grant with no reference id cannot be recognised as a repeat by the ledger, so a retried request would credit the account twice — and the request is refused with 400 when neither is present.
+     * Adds credits to a user\'s balance. Admin only. A `referenceId` in the body names the grant event; when it is omitted the request\'s `Idempotency-Key` header is used instead. One of the two is required — a grant with no reference id cannot be recognised as a repeat by the ledger, so a retried request would credit the account twice — and the request is refused with 400 when neither is present. Free credits are limited per admin: one request may grant at most `ADMIN_GRANT_MAX_PER_REQUEST` credits (default 5000) and one admin may grant at most `ADMIN_GRANT_DAILY_LIMIT` credits alone per UTC day (default 10000), counted across this route, the credits adjustment route and the grants route. Over the daily limit the request is refused with 429 and `ADMIN_GRANT_LIMIT_REACHED`; a grant approved by a second admin (`POST /admin-billing/grants`) is not counted.
      * Add credits to user balance
      */
     addCreditsRaw(requestParameters: AddCreditsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
     /**
-     * Adds credits to a user\'s balance. Admin only. A `referenceId` in the body names the grant event; when it is omitted the request\'s `Idempotency-Key` header is used instead. One of the two is required — a grant with no reference id cannot be recognised as a repeat by the ledger, so a retried request would credit the account twice — and the request is refused with 400 when neither is present.
+     * Adds credits to a user\'s balance. Admin only. A `referenceId` in the body names the grant event; when it is omitted the request\'s `Idempotency-Key` header is used instead. One of the two is required — a grant with no reference id cannot be recognised as a repeat by the ledger, so a retried request would credit the account twice — and the request is refused with 400 when neither is present. Free credits are limited per admin: one request may grant at most `ADMIN_GRANT_MAX_PER_REQUEST` credits (default 5000) and one admin may grant at most `ADMIN_GRANT_DAILY_LIMIT` credits alone per UTC day (default 10000), counted across this route, the credits adjustment route and the grants route. Over the daily limit the request is refused with 429 and `ADMIN_GRANT_LIMIT_REACHED`; a grant approved by a second admin (`POST /admin-billing/grants`) is not counted.
      * Add credits to user balance
      */
     addCredits(requestParameters: AddCreditsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
@@ -54,25 +55,25 @@ export declare class CreditsApi extends runtime.BaseAPI {
      */
     getAllCreditBalances(requestParameters?: GetAllCreditBalancesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<object>>;
     /**
-     * Retrieves the current credit balance for a user.
-     * Get user credit balance
+     * Returns the credits an account holds: the balance, and how much of it is reserved by operations that are still running.  An account reads its own balance; with a partner\'s API key, that is the account of the person who administers the partner. Widgetic administrators can read any account\'s. An account that has never held credits reads a balance of 0.
+     * Get an account\'s credit balance
      */
-    getUserCreditBalanceRaw(requestParameters: GetUserCreditBalanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
+    getUserCreditBalanceRaw(requestParameters: GetUserCreditBalanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccountCreditBalance>>;
     /**
-     * Retrieves the current credit balance for a user.
-     * Get user credit balance
+     * Returns the credits an account holds: the balance, and how much of it is reserved by operations that are still running.  An account reads its own balance; with a partner\'s API key, that is the account of the person who administers the partner. Widgetic administrators can read any account\'s. An account that has never held credits reads a balance of 0.
+     * Get an account\'s credit balance
      */
-    getUserCreditBalance(requestParameters: GetUserCreditBalanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
+    getUserCreditBalance(requestParameters: GetUserCreditBalanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountCreditBalance>;
     /**
-     * Retrieves credit transaction history for a user.
-     * Get user credit transactions
+     * Lists the entries of an account\'s credit ledger, newest first. This is also how an account\'s usage is read: every operation that spends credits is a `debit` entry, so summing the `debit` entries over a period gives the credits consumed in it, and the other types give what was added.  An account reads its own ledger; with a partner\'s API key, that is the account of the person who administers the partner. Widgetic administrators can read any account\'s. A partner\'s wallet is a separate ledger, read with `getPartnerCreditTransactions`.  The page is always bounded: `limit` defaults to 100 and is capped at 500, `offset` defaults to 0.
+     * List an account\'s credit ledger
      */
-    getUserCreditTransactionsRaw(requestParameters: GetUserCreditTransactionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<object>>>;
+    getUserCreditTransactionsRaw(requestParameters: GetUserCreditTransactionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetUserCreditTransactions200Response>>;
     /**
-     * Retrieves credit transaction history for a user.
-     * Get user credit transactions
+     * Lists the entries of an account\'s credit ledger, newest first. This is also how an account\'s usage is read: every operation that spends credits is a `debit` entry, so summing the `debit` entries over a period gives the credits consumed in it, and the other types give what was added.  An account reads its own ledger; with a partner\'s API key, that is the account of the person who administers the partner. Widgetic administrators can read any account\'s. A partner\'s wallet is a separate ledger, read with `getPartnerCreditTransactions`.  The page is always bounded: `limit` defaults to 100 and is capped at 500, `offset` defaults to 0.
+     * List an account\'s credit ledger
      */
-    getUserCreditTransactions(requestParameters: GetUserCreditTransactionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<object>>;
+    getUserCreditTransactions(requestParameters: GetUserCreditTransactionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetUserCreditTransactions200Response>;
     /**
      * Subtracts credits from a user\'s balance. Admin only. A `referenceId` in the body names the deduction event; when it is omitted the request\'s `Idempotency-Key` header is used instead, and the request is refused with 400 when neither is present, so a retried deduction cannot be applied twice.
      * Subtract credits from user balance

package/dist/esm/apis/CreditsApi.js

@@ -21,12 +21,13 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import * as runtime from '../runtime.js';
+import { AccountCreditBalanceFromJSON, GetUserCreditTransactions200ResponseFromJSON, } from '../models/index.js';
 /**
  *
  */
 export class CreditsApi extends runtime.BaseAPI {
     /**
-     * Adds credits to a user\'s balance. Admin only. A `referenceId` in the body names the grant event; when it is omitted the request\'s `Idempotency-Key` header is used instead. One of the two is required — a grant with no reference id cannot be recognised as a repeat by the ledger, so a retried request would credit the account twice — and the request is refused with 400 when neither is present.
+     * Adds credits to a user\'s balance. Admin only. A `referenceId` in the body names the grant event; when it is omitted the request\'s `Idempotency-Key` header is used instead. One of the two is required — a grant with no reference id cannot be recognised as a repeat by the ledger, so a retried request would credit the account twice — and the request is refused with 400 when neither is present. Free credits are limited per admin: one request may grant at most `ADMIN_GRANT_MAX_PER_REQUEST` credits (default 5000) and one admin may grant at most `ADMIN_GRANT_DAILY_LIMIT` credits alone per UTC day (default 10000), counted across this route, the credits adjustment route and the grants route. Over the daily limit the request is refused with 429 and `ADMIN_GRANT_LIMIT_REACHED`; a grant approved by a second admin (`POST /admin-billing/grants`) is not counted.
      * Add credits to user balance
      */
     addCreditsRaw(requestParameters, initOverrides) {
@@ -55,7 +56,7 @@ export class CreditsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Adds credits to a user\'s balance. Admin only. A `referenceId` in the body names the grant event; when it is omitted the request\'s `Idempotency-Key` header is used instead. One of the two is required — a grant with no reference id cannot be recognised as a repeat by the ledger, so a retried request would credit the account twice — and the request is refused with 400 when neither is present.
+     * Adds credits to a user\'s balance. Admin only. A `referenceId` in the body names the grant event; when it is omitted the request\'s `Idempotency-Key` header is used instead. One of the two is required — a grant with no reference id cannot be recognised as a repeat by the ledger, so a retried request would credit the account twice — and the request is refused with 400 when neither is present. Free credits are limited per admin: one request may grant at most `ADMIN_GRANT_MAX_PER_REQUEST` credits (default 5000) and one admin may grant at most `ADMIN_GRANT_DAILY_LIMIT` credits alone per UTC day (default 10000), counted across this route, the credits adjustment route and the grants route. Over the daily limit the request is refused with 429 and `ADMIN_GRANT_LIMIT_REACHED`; a grant approved by a second admin (`POST /admin-billing/grants`) is not counted.
      * Add credits to user balance
      */
     addCredits(requestParameters, initOverrides) {
@@ -105,8 +106,8 @@ export class CreditsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Retrieves the current credit balance for a user.
-     * Get user credit balance
+     * Returns the credits an account holds: the balance, and how much of it is reserved by operations that are still running.  An account reads its own balance; with a partner\'s API key, that is the account of the person who administers the partner. Widgetic administrators can read any account\'s. An account that has never held credits reads a balance of 0.
+     * Get an account\'s credit balance
      */
     getUserCreditBalanceRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -123,17 +124,17 @@ export class CreditsApi extends runtime.BaseAPI {
                 }
             }
             const response = yield this.request({
-                path: `/users/{userId}/credits/balance`.replace(`{${"userId"}}`, encodeURIComponent(String(requestParameters['userId']))),
+                path: `/credits/user/{userId}/balance`.replace(`{${"userId"}}`, encodeURIComponent(String(requestParameters['userId']))),
                 method: 'GET',
                 headers: headerParameters,
                 query: queryParameters,
             }, initOverrides);
-            return new runtime.JSONApiResponse(response);
+            return new runtime.JSONApiResponse(response, (jsonValue) => AccountCreditBalanceFromJSON(jsonValue));
         });
     }
     /**
-     * Retrieves the current credit balance for a user.
-     * Get user credit balance
+     * Returns the credits an account holds: the balance, and how much of it is reserved by operations that are still running.  An account reads its own balance; with a partner\'s API key, that is the account of the person who administers the partner. Widgetic administrators can read any account\'s. An account that has never held credits reads a balance of 0.
+     * Get an account\'s credit balance
      */
     getUserCreditBalance(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -142,8 +143,8 @@ export class CreditsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Retrieves credit transaction history for a user.
-     * Get user credit transactions
+     * Lists the entries of an account\'s credit ledger, newest first. This is also how an account\'s usage is read: every operation that spends credits is a `debit` entry, so summing the `debit` entries over a period gives the credits consumed in it, and the other types give what was added.  An account reads its own ledger; with a partner\'s API key, that is the account of the person who administers the partner. Widgetic administrators can read any account\'s. A partner\'s wallet is a separate ledger, read with `getPartnerCreditTransactions`.  The page is always bounded: `limit` defaults to 100 and is capped at 500, `offset` defaults to 0.
+     * List an account\'s credit ledger
      */
     getUserCreditTransactionsRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -169,17 +170,17 @@ export class CreditsApi extends runtime.BaseAPI {
                 }
             }
             const response = yield this.request({
-                path: `/users/{userId}/credits/transactions`.replace(`{${"userId"}}`, encodeURIComponent(String(requestParameters['userId']))),
+                path: `/credits/user/{userId}/transactions`.replace(`{${"userId"}}`, encodeURIComponent(String(requestParameters['userId']))),
                 method: 'GET',
                 headers: headerParameters,
                 query: queryParameters,
             }, initOverrides);
-            return new runtime.JSONApiResponse(response);
+            return new runtime.JSONApiResponse(response, (jsonValue) => GetUserCreditTransactions200ResponseFromJSON(jsonValue));
         });
     }
     /**
-     * Retrieves credit transaction history for a user.
-     * Get user credit transactions
+     * Lists the entries of an account\'s credit ledger, newest first. This is also how an account\'s usage is read: every operation that spends credits is a `debit` entry, so summing the `debit` entries over a period gives the credits consumed in it, and the other types give what was added.  An account reads its own ledger; with a partner\'s API key, that is the account of the person who administers the partner. Widgetic administrators can read any account\'s. A partner\'s wallet is a separate ledger, read with `getPartnerCreditTransactions`.  The page is always bounded: `limit` defaults to 100 and is capped at 500, `offset` defaults to 0.
+     * List an account\'s credit ledger
      */
     getUserCreditTransactions(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {

package/dist/esm/apis/EntitlementsApi.js

@@ -91,7 +91,7 @@ export class EntitlementsApi extends runtime.BaseAPI {
                 }
             }
             const response = yield this.request({
-                path: `/managed-users/{managedUserId}/entitlements`.replace(`{${"managedUserId"}}`, encodeURIComponent(String(requestParameters['managedUserId']))),
+                path: `/entitlements/managed-users/{managedUserId}`.replace(`{${"managedUserId"}}`, encodeURIComponent(String(requestParameters['managedUserId']))),
                 method: 'GET',
                 headers: headerParameters,
                 query: queryParameters,
@@ -137,7 +137,7 @@ export class EntitlementsApi extends runtime.BaseAPI {
                 }
             }
             const response = yield this.request({
-                path: `/partners/{partnerId}/entitlements`.replace(`{${"partnerId"}}`, encodeURIComponent(String(requestParameters['partnerId']))),
+                path: `/entitlements/partners/{partnerId}`.replace(`{${"partnerId"}}`, encodeURIComponent(String(requestParameters['partnerId']))),
                 method: 'GET',
                 headers: headerParameters,
                 query: queryParameters,
@@ -221,7 +221,7 @@ export class EntitlementsApi extends runtime.BaseAPI {
                 }
             }
             const response = yield this.request({
-                path: `/partners/{partnerId}/entitlements`.replace(`{${"partnerId"}}`, encodeURIComponent(String(requestParameters['partnerId']))),
+                path: `/entitlements/partners/{partnerId}`.replace(`{${"partnerId"}}`, encodeURIComponent(String(requestParameters['partnerId']))),
                 method: 'PUT',
                 headers: headerParameters,
                 query: queryParameters,