@widgetic/api-sdk 1.0.30 → 1.0.32

package/dist/esm/apis/WidgetsApi.js

@@ -21,7 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import * as runtime from '../runtime.js';
-import { CheckWidgetAccess200ResponseFromJSON, CreateWidget201ResponseFromJSON, DeleteWidgetRequestToJSON, DuplicateWidget201ResponseFromJSON, DuplicateWidgetRequestToJSON, GetWidgetPublishHistory200ResponseFromJSON, GetWidgets200ResponseFromJSON, GetWidgetsBatch200ResponseFromJSON, GetWidgetsBatchRequestToJSON, NewWidgetToJSON, RenameWidgetPublishHistoryTitle200ResponseFromJSON, RenameWidgetPublishHistoryTitleRequestToJSON, SetWidgetPublishHistoryLive200ResponseFromJSON, UpdateWidgetRepository200ResponseFromJSON, UpdateWidgetRepositoryRequestToJSON, UpdateWidgetRequestToJSON, UploadWidgetThumbnail200ResponseFromJSON, UploadWidgetThumbnailRequestToJSON, } from '../models/index.js';
+import { CheckWidgetAccess200ResponseFromJSON, CreateCompositionFromWidget201ResponseFromJSON, CreateCompositionFromWidgetRequestToJSON, CreateWidget201ResponseFromJSON, DeleteWidgetRequestToJSON, DuplicateWidget201ResponseFromJSON, DuplicateWidgetRequestToJSON, GetWidgetPublishHistory200ResponseFromJSON, GetWidgets200ResponseFromJSON, GetWidgetsBatch200ResponseFromJSON, GetWidgetsBatchRequestToJSON, NewWidgetToJSON, RenameWidgetPublishHistoryTitle200ResponseFromJSON, RenameWidgetPublishHistoryTitleRequestToJSON, SetWidgetPublishHistoryLive200ResponseFromJSON, UpdateWidgetRepository200ResponseFromJSON, UpdateWidgetRepositoryRequestToJSON, UpdateWidgetRequestToJSON, UploadWidgetThumbnail200ResponseFromJSON, UploadWidgetThumbnailRequestToJSON, } from '../models/index.js';
 /**
  *
  */
@@ -63,6 +63,51 @@ export class WidgetsApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * After a managed user publishes a widget from the creator, call this with the widget id, the customer\'s managed user (when the widget is not already filed under one), and optional content, design, embed settings and locale. Every input is validated before a single insert; a failure never leaves a half-made composition.  When the widget is already tagged with a managed user, you may omit `managed_user_id`. When you send it, it must match that tag.  The widget must be published. The `Idempotency-Key` header is required.
+     * Create a composition for a widget in one call
+     */
+    createCompositionFromWidgetRaw(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 createCompositionFromWidget().');
+            }
+            if (requestParameters['createCompositionFromWidgetRequest'] == null) {
+                throw new runtime.RequiredError('createCompositionFromWidgetRequest', 'Required parameter "createCompositionFromWidgetRequest" was null or undefined when calling createCompositionFromWidget().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (requestParameters['idempotencyKey'] != null) {
+                headerParameters['Idempotency-Key'] = String(requestParameters['idempotencyKey']);
+            }
+            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: `/widgets/{id}/composition`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: CreateCompositionFromWidgetRequestToJSON(requestParameters['createCompositionFromWidgetRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => CreateCompositionFromWidget201ResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * After a managed user publishes a widget from the creator, call this with the widget id, the customer\'s managed user (when the widget is not already filed under one), and optional content, design, embed settings and locale. Every input is validated before a single insert; a failure never leaves a half-made composition.  When the widget is already tagged with a managed user, you may omit `managed_user_id`. When you send it, it must match that tag.  The widget must be published. The `Idempotency-Key` header is required.
+     * Create a composition for a widget in one call
+     */
+    createCompositionFromWidget(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createCompositionFromWidgetRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Creates a widget for your account: a named record with a type and some starting content, on a canvas of its own (or one of yours that you name), with a database provisioned for it. It costs no credits and has no code yet; the code is generated for it afterwards. The new widget is yours, and you can list it with `getWidgets`. A widget is a draft until you say otherwise (`isDraft: false`).  If the database cannot be provisioned the widget is still created, and `data.warnings` says what did not go through. Read it before relying on the widget.  A widget can be placed on one of your canvases (`canvasId`), in a project you can edit (`projectId`) or in an organization where you may create widgets (`organizationId`). Naming anything you cannot use is refused with 403, and the answer is the same whether it exists or not.  To make the widget for one of your managed users, send `managedUserId` or `managedUserExternalId`. The widget stays in your account and is yours to edit; the tag lets you list one user\'s widgets with `getWidgets`. 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.  Creating a widget provisions its database, so this call has a limit of its own: 120 per minute for each account (ask Widgetic if you need more). Past that the call is answered with 429 and a `Retry-After`. The `Idempotency-Key` header is required; send the same key when you retry, so one widget is created, not two.
      * Create Widget
@@ -339,6 +384,45 @@ export class WidgetsApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Retrieves multiple widgets by their IDs in a single request. An id that is not found, or that is not yours, is reported in `errors` exactly like one that does not exist. Called with an editor session, only the widgets made for the session\'s managed user are returned.
+     * Get Widgets Batch
+     */
+    getWidgetsBatchRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['getWidgetsBatchRequest'] == null) {
+                throw new runtime.RequiredError('getWidgetsBatchRequest', 'Required parameter "getWidgetsBatchRequest" was null or undefined when calling getWidgetsBatch().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            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: `/widgets/batch`,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: GetWidgetsBatchRequestToJSON(requestParameters['getWidgetsBatchRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => GetWidgetsBatch200ResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Retrieves multiple widgets by their IDs in a single request. An id that is not found, or that is not yours, is reported in `errors` exactly like one that does not exist. Called with an editor session, only the widgets made for the session\'s managed user are returned.
+     * Get Widgets Batch
+     */
+    getWidgetsBatch(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getWidgetsBatchRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Lists the widgets your account owns, newest first. A widget is the reusable piece a composition is made from; this is your own library, not a catalogue of Widgetic\'s widgets.  Pass `page` (counting from 1) and `size` (1 to 100, 20 when left out) to read the list one page at a time. `meta` then carries `total`, `hasNextPage` and `hasPreviousPage`, so a client can walk the list to its end. A page past the end is an empty list. Without `page` and `size` the call returns the whole list in one response, which only suits an account with a few widgets.  Pass `canvasId` to list only the widgets on one of your canvases. That list is always returned whole, whatever `page` and `size` say.  Pass `managedUserId` (Widgetic\'s id for one of your managed users) or `managedUserExternalId` (your own identifier for the user) to list only the widgets made for that managed user. The widgets of your other managed users, and your own, are left out. It combines with `page`, `size` and `canvasId`. A managed user that is not yours, or does not exist, is answered with 404 and `MANAGED_USER_NOT_FOUND`.
      * List Widgets
@@ -388,45 +472,6 @@ export class WidgetsApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
-    /**
-     * Retrieves multiple widgets by their IDs in a single request. An id that is not found, or that is not yours, is reported in `errors` exactly like one that does not exist. Called with an editor session, only the widgets made for the session\'s managed user are returned.
-     * Get Widgets Batch
-     */
-    getWidgetsBatchRaw(requestParameters, initOverrides) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (requestParameters['getWidgetsBatchRequest'] == null) {
-                throw new runtime.RequiredError('getWidgetsBatchRequest', 'Required parameter "getWidgetsBatchRequest" was null or undefined when calling getWidgetsBatch().');
-            }
-            const queryParameters = {};
-            const headerParameters = {};
-            headerParameters['Content-Type'] = 'application/json';
-            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: `/widgets/batch`,
-                method: 'POST',
-                headers: headerParameters,
-                query: queryParameters,
-                body: GetWidgetsBatchRequestToJSON(requestParameters['getWidgetsBatchRequest']),
-            }, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => GetWidgetsBatch200ResponseFromJSON(jsonValue));
-        });
-    }
-    /**
-     * Retrieves multiple widgets by their IDs in a single request. An id that is not found, or that is not yours, is reported in `errors` exactly like one that does not exist. Called with an editor session, only the widgets made for the session\'s managed user are returned.
-     * Get Widgets Batch
-     */
-    getWidgetsBatch(requestParameters, initOverrides) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.getWidgetsBatchRaw(requestParameters, initOverrides);
-            return yield response.value();
-        });
-    }
     /**
      * Updates `commit_title` on one version — the owner\'s correction of the wording the codegen pipeline authored for the commit. Works on Draft and Live versions alike; the Live badge says what is being served, the title says what the change was. A whitespace-only title clears it.
      * Rename a version\'s title

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

@@ -32,10 +32,12 @@ export * from './OAuthConnectionsApi';
 export * from './OperationsApi';
 export * from './OrganizationActivitiesApi';
 export * from './OrganizationsApi';
+export * from './PartnerApi';
 export * from './PartnerCustomizationsApi';
 export * from './PartnersApi';
 export * from './ProjectsApi';
 export * from './PromptsApi';
+export * from './PublicEmbedApi';
 export * from './ShopifyApi';
 export * from './SubscriptionPlansApi';
 export * from './SubscriptionsApi';

package/dist/esm/apis/index.js

@@ -34,10 +34,12 @@ export * from './OAuthConnectionsApi.js';
 export * from './OperationsApi.js';
 export * from './OrganizationActivitiesApi.js';
 export * from './OrganizationsApi.js';
+export * from './PartnerApi.js';
 export * from './PartnerCustomizationsApi.js';
 export * from './PartnersApi.js';
 export * from './ProjectsApi.js';
 export * from './PromptsApi.js';
+export * from './PublicEmbedApi.js';
 export * from './ShopifyApi.js';
 export * from './SubscriptionPlansApi.js';
 export * from './SubscriptionsApi.js';

package/dist/esm/models/Composition.d.ts

@@ -45,6 +45,12 @@ export interface Composition {
      * @memberof Composition
      */
     content: object;
+    /**
+     * Monotonic content version when the content_version migration is applied
+     * @type {number}
+     * @memberof Composition
+     */
+    contentVersion?: number;
     /**
      * Current status of the composition
      * @type {string}
@@ -93,6 +99,18 @@ export interface Composition {
      * @memberof Composition
      */
     managedUserId?: string | null;
+    /**
+     * Whether the widget the composition is made from is drawn straight into the page, without a frame
+     * (`true`), or inside a frame (`false`). `null` when the widget has no published version yet. It is a
+     * fact about the widget's published version, so every composition of one widget answers the same, and it
+     * changes when you publish another version. It cannot be set. Only `getCompositionById` returns it:
+     * the other calls that return a composition leave it out, and so does that one on the rare occasion the
+     * answer could not be worked out just then (ask again).
+     *
+     * @type {boolean}
+     * @memberof Composition
+     */
+    direct?: boolean | null;
 }
 /**
  * @export

package/dist/esm/models/Composition.js

@@ -54,6 +54,7 @@ export function CompositionFromJSONTyped(json, ignoreDiscriminator) {
         'widgetId': json['widgetId'],
         'name': json['name'],
         'content': json['content'],
+        'contentVersion': json['contentVersion'] == null ? undefined : json['contentVersion'],
         'status': json['status'],
         'createdAt': (new Date(json['createdAt'])),
         'updatedAt': (new Date(json['updatedAt'])),
@@ -62,6 +63,7 @@ export function CompositionFromJSONTyped(json, ignoreDiscriminator) {
         'databaseId': json['databaseId'] == null ? undefined : json['databaseId'],
         'projectId': json['projectId'] == null ? undefined : json['projectId'],
         'managedUserId': json['managedUserId'] == null ? undefined : json['managedUserId'],
+        'direct': json['direct'] == null ? undefined : json['direct'],
     };
 }
 export function CompositionToJSON(json) {
@@ -77,6 +79,7 @@ export function CompositionToJSONTyped(value, ignoreDiscriminator = false) {
         'widgetId': value['widgetId'],
         'name': value['name'],
         'content': value['content'],
+        'contentVersion': value['contentVersion'],
         'status': value['status'],
         'createdAt': ((value['createdAt']).toISOString()),
         'updatedAt': ((value['updatedAt']).toISOString()),
@@ -85,5 +88,6 @@ export function CompositionToJSONTyped(value, ignoreDiscriminator = false) {
         'databaseId': value['databaseId'],
         'projectId': value['projectId'],
         'managedUserId': value['managedUserId'],
+        'direct': value['direct'],
     };
 }

package/dist/esm/models/CompositionDataSource.d.ts

@@ -0,0 +1,41 @@
+/**
+ * Widgetic API Gateway
+ * API documentation for the Widgetic API Gateway
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * The public JSON address a composition's widget reads when it loads and again every `refreshSeconds`. One
+ * per composition: binding another replaces it. It is sent as `refresh_seconds` (the request body keeps the
+ * snake case it always had) and answered as `refreshSeconds`, like every answer of the API.
+ *
+ * @export
+ * @interface CompositionDataSource
+ */
+export interface CompositionDataSource {
+    /**
+     * The https address as it was saved, after the checks (a public host, never loopback, link-local or a metadata address)
+     * @type {string}
+     * @memberof CompositionDataSource
+     */
+    url: string;
+    /**
+     * How often the widget reads the address again, in seconds
+     * @type {number}
+     * @memberof CompositionDataSource
+     */
+    refreshSeconds: number;
+}
+/**
+ * Check if a given object implements the CompositionDataSource interface.
+ */
+export declare function instanceOfCompositionDataSource(value: object): value is CompositionDataSource;
+export declare function CompositionDataSourceFromJSON(json: any): CompositionDataSource;
+export declare function CompositionDataSourceFromJSONTyped(json: any, ignoreDiscriminator: boolean): CompositionDataSource;
+export declare function CompositionDataSourceToJSON(json: any): CompositionDataSource;
+export declare function CompositionDataSourceToJSONTyped(value?: CompositionDataSource | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CompositionDataSource.js

@@ -0,0 +1,47 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Widgetic API Gateway
+ * API documentation for the Widgetic API Gateway
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the CompositionDataSource interface.
+ */
+export function instanceOfCompositionDataSource(value) {
+    if (!('url' in value) || value['url'] === undefined)
+        return false;
+    if (!('refreshSeconds' in value) || value['refreshSeconds'] === undefined)
+        return false;
+    return true;
+}
+export function CompositionDataSourceFromJSON(json) {
+    return CompositionDataSourceFromJSONTyped(json, false);
+}
+export function CompositionDataSourceFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'url': json['url'],
+        'refreshSeconds': json['refreshSeconds'],
+    };
+}
+export function CompositionDataSourceToJSON(json) {
+    return CompositionDataSourceToJSONTyped(json, false);
+}
+export function CompositionDataSourceToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'url': value['url'],
+        'refreshSeconds': value['refreshSeconds'],
+    };
+}

package/dist/esm/models/CompositionEntriesReading.d.ts

@@ -10,6 +10,7 @@
  * Do not edit the class manually.
  */
 import type { CompositionEntryTally } from './CompositionEntryTally';
+import type { CompositionEntryAggregatesBlock } from './CompositionEntryAggregatesBlock';
 /**
  *
  * @export
@@ -29,21 +30,27 @@ export interface CompositionEntriesReading {
      */
     table: string;
     /**
-     * How many entries the table holds in all
+     * How many entries the table holds in all. Not narrowed by `since`, `until` or a filter: only
+     * `aggregates` is.
+     *
      * @type {number}
      * @memberof CompositionEntriesReading
      */
     totalRows: number;
     /**
-     * How many entries have each value of the `groupBy` column, largest group first (up to 20 groups).
-     * `null` when no `groupBy` was asked for.
+     * How many entries have each value of the `groupBy` column, largest group first (up to 20 groups), over
+     * the whole table. `null` when no `groupBy` was asked for. For the groups of a selection (a time window,
+     * a `context` filter) or for more than 20 groups, ask for `aggregate`: `aggregates.tallies` holds up to
+     * 200 groups.
      *
      * @type {Array<CompositionEntryTally>}
      * @memberof CompositionEntriesReading
      */
     tallies: Array<CompositionEntryTally> | null;
     /**
-     * True when there are more groups than `tallies` lists
+     * True when the `groupBy` column has more than the 20 groups `tallies` lists. It speaks of `tallies`
+     * only: `aggregates.truncated` is the same signal for `aggregates` (200 groups).
+     *
      * @type {boolean}
      * @memberof CompositionEntriesReading
      */
@@ -72,6 +79,15 @@ export interface CompositionEntriesReading {
      * @memberof CompositionEntriesReading
      */
     moreRows: boolean;
+    /**
+     * Only present when the read asked for `aggregate`. Unlike `totalRows`, `tallies` and `rows`, it is
+     * narrowed by `since`, `until` and the `context` and column filters of the same call: it answers
+     * "the average rating this week" where `tallies` answer "how many of each rating, ever".
+     *
+     * @type {CompositionEntryAggregatesBlock}
+     * @memberof CompositionEntriesReading
+     */
+    aggregates?: CompositionEntryAggregatesBlock;
 }
 /**
  * Check if a given object implements the CompositionEntriesReading interface.

package/dist/esm/models/CompositionEntriesReading.js

@@ -12,6 +12,7 @@
  * Do not edit the class manually.
  */
 import { CompositionEntryTallyFromJSON, CompositionEntryTallyToJSON, } from './CompositionEntryTally.js';
+import { CompositionEntryAggregatesBlockFromJSON, CompositionEntryAggregatesBlockToJSON, } from './CompositionEntryAggregatesBlock.js';
 /**
  * Check if a given object implements the CompositionEntriesReading interface.
  */
@@ -50,6 +51,7 @@ export function CompositionEntriesReadingFromJSONTyped(json, ignoreDiscriminator
         'columns': json['columns'],
         'rows': json['rows'] == null ? null : json['rows'],
         'moreRows': json['moreRows'],
+        'aggregates': json['aggregates'] == null ? undefined : CompositionEntryAggregatesBlockFromJSON(json['aggregates']),
     };
 }
 export function CompositionEntriesReadingToJSON(json) {
@@ -68,5 +70,6 @@ export function CompositionEntriesReadingToJSONTyped(value, ignoreDiscriminator
         'columns': value['columns'],
         'rows': value['rows'],
         'moreRows': value['moreRows'],
+        'aggregates': CompositionEntryAggregatesBlockToJSON(value['aggregates']),
     };
 }

package/dist/esm/models/CompositionEntryAggregateTally.d.ts

@@ -0,0 +1,69 @@
+/**
+ * Widgetic API Gateway
+ * API documentation for the Widgetic API Gateway
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * The aggregates of one group (the entries that share a value of the `groupBy` column), or of the whole
+ * selection when no `groupBy` was asked for. Only the functions that were asked for with `aggregate` are
+ * present.
+ *
+ * @export
+ * @interface CompositionEntryAggregateTally
+ */
+export interface CompositionEntryAggregateTally {
+    /**
+     * The value of the `groupBy` column, as text (a number is `"5"`); `null` groups the entries that left it
+     * empty. Absent when no `groupBy` was asked for.
+     *
+     * @type {string}
+     * @memberof CompositionEntryAggregateTally
+     */
+    group?: string | null;
+    /**
+     * How many entries are in the group (or in the selection)
+     * @type {number}
+     * @memberof CompositionEntryAggregateTally
+     */
+    count?: number;
+    /**
+     * The average of the numeric `column`, rounded to 4 decimals. `null` when no entry matched: there is no
+     * average of nothing, and it is not 0.
+     *
+     * @type {number}
+     * @memberof CompositionEntryAggregateTally
+     */
+    avg?: number | null;
+    /**
+     * The smallest value of the numeric `column`. `null` when no entry matched.
+     * @type {number}
+     * @memberof CompositionEntryAggregateTally
+     */
+    min?: number | null;
+    /**
+     * The largest value of the numeric `column`. `null` when no entry matched.
+     * @type {number}
+     * @memberof CompositionEntryAggregateTally
+     */
+    max?: number | null;
+    /**
+     * The sum of the numeric `column`. `null` when no entry matched.
+     * @type {number}
+     * @memberof CompositionEntryAggregateTally
+     */
+    sum?: number | null;
+}
+/**
+ * Check if a given object implements the CompositionEntryAggregateTally interface.
+ */
+export declare function instanceOfCompositionEntryAggregateTally(value: object): value is CompositionEntryAggregateTally;
+export declare function CompositionEntryAggregateTallyFromJSON(json: any): CompositionEntryAggregateTally;
+export declare function CompositionEntryAggregateTallyFromJSONTyped(json: any, ignoreDiscriminator: boolean): CompositionEntryAggregateTally;
+export declare function CompositionEntryAggregateTallyToJSON(json: any): CompositionEntryAggregateTally;
+export declare function CompositionEntryAggregateTallyToJSONTyped(value?: CompositionEntryAggregateTally | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CompositionEntryAggregateTally.js

@@ -0,0 +1,51 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Widgetic API Gateway
+ * API documentation for the Widgetic API Gateway
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the CompositionEntryAggregateTally interface.
+ */
+export function instanceOfCompositionEntryAggregateTally(value) {
+    return true;
+}
+export function CompositionEntryAggregateTallyFromJSON(json) {
+    return CompositionEntryAggregateTallyFromJSONTyped(json, false);
+}
+export function CompositionEntryAggregateTallyFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'group': json['group'] == null ? undefined : json['group'],
+        'count': json['count'] == null ? undefined : json['count'],
+        'avg': json['avg'] == null ? undefined : json['avg'],
+        'min': json['min'] == null ? undefined : json['min'],
+        'max': json['max'] == null ? undefined : json['max'],
+        'sum': json['sum'] == null ? undefined : json['sum'],
+    };
+}
+export function CompositionEntryAggregateTallyToJSON(json) {
+    return CompositionEntryAggregateTallyToJSONTyped(json, false);
+}
+export function CompositionEntryAggregateTallyToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'group': value['group'],
+        'count': value['count'],
+        'avg': value['avg'],
+        'min': value['min'],
+        'max': value['max'],
+        'sum': value['sum'],
+    };
+}

package/dist/esm/models/CompositionEntryAggregatesBlock.d.ts

@@ -0,0 +1,55 @@
+/**
+ * Widgetic API Gateway
+ * API documentation for the Widgetic API Gateway
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { CompositionEntryAggregateTally } from './CompositionEntryAggregateTally';
+/**
+ * What `aggregate` asked for, computed over the entries that match `since`, `until` and the `context` and
+ * column filters of the same call.
+ *
+ * @export
+ * @interface CompositionEntryAggregatesBlock
+ */
+export interface CompositionEntryAggregatesBlock {
+    /**
+     * The numeric column `avg`, `min`, `max` and `sum` were computed over. An empty text when only `count`
+     * was asked for.
+     *
+     * @type {string}
+     * @memberof CompositionEntryAggregatesBlock
+     */
+    column: string;
+    /**
+     * One tally per value of `groupBy`, in the order of that column (a number as a number, `null` last), up
+     * to 200 groups; or ONE tally for the whole selection when no `groupBy` was asked for. Empty when
+     * `groupBy` was asked for and no entry matched.
+     *
+     * @type {Array<CompositionEntryAggregateTally>}
+     * @memberof CompositionEntryAggregatesBlock
+     */
+    tallies: Array<CompositionEntryAggregateTally>;
+    /**
+     * True when more than 200 groups matched, so `tallies` lists the first 200 in that order. Absent
+     * otherwise. (Not to be mixed up with `moreGroups` on the reading, which is about the plain `tallies`
+     * of the whole table: those are 20 groups, largest first.)
+     *
+     * @type {boolean}
+     * @memberof CompositionEntryAggregatesBlock
+     */
+    truncated?: boolean;
+}
+/**
+ * Check if a given object implements the CompositionEntryAggregatesBlock interface.
+ */
+export declare function instanceOfCompositionEntryAggregatesBlock(value: object): value is CompositionEntryAggregatesBlock;
+export declare function CompositionEntryAggregatesBlockFromJSON(json: any): CompositionEntryAggregatesBlock;
+export declare function CompositionEntryAggregatesBlockFromJSONTyped(json: any, ignoreDiscriminator: boolean): CompositionEntryAggregatesBlock;
+export declare function CompositionEntryAggregatesBlockToJSON(json: any): CompositionEntryAggregatesBlock;
+export declare function CompositionEntryAggregatesBlockToJSONTyped(value?: CompositionEntryAggregatesBlock | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CompositionEntryAggregatesBlock.js

@@ -0,0 +1,50 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Widgetic API Gateway
+ * API documentation for the Widgetic API Gateway
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { CompositionEntryAggregateTallyFromJSON, CompositionEntryAggregateTallyToJSON, } from './CompositionEntryAggregateTally.js';
+/**
+ * Check if a given object implements the CompositionEntryAggregatesBlock interface.
+ */
+export function instanceOfCompositionEntryAggregatesBlock(value) {
+    if (!('column' in value) || value['column'] === undefined)
+        return false;
+    if (!('tallies' in value) || value['tallies'] === undefined)
+        return false;
+    return true;
+}
+export function CompositionEntryAggregatesBlockFromJSON(json) {
+    return CompositionEntryAggregatesBlockFromJSONTyped(json, false);
+}
+export function CompositionEntryAggregatesBlockFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'column': json['column'],
+        'tallies': (json['tallies'].map(CompositionEntryAggregateTallyFromJSON)),
+        'truncated': json['truncated'] == null ? undefined : json['truncated'],
+    };
+}
+export function CompositionEntryAggregatesBlockToJSON(json) {
+    return CompositionEntryAggregatesBlockToJSONTyped(json, false);
+}
+export function CompositionEntryAggregatesBlockToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'column': value['column'],
+        'tallies': (value['tallies'].map(CompositionEntryAggregateTallyToJSON)),
+        'truncated': value['truncated'],
+    };
+}