@widgetic/api-sdk 1.0.24 → 1.0.26

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

@@ -0,0 +1,62 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface NewEditorSession
+ */
+export interface NewEditorSession {
+    /**
+     * The pieces of Widgetic's editor the session may drive. `files` is the media library (the File Browser: upload a file, list the files uploaded for this user); what a user uploads is kept in your own storage destination. Partner storage is not optional: a session of any surface can be made only once you have set a destination up (`setPartnerStorageDestination`), and is refused with `409 PARTNER_STORAGE_REQUIRED` until then. `editor` is editing one of this user's compositions: read it, change its name, content, design and embed settings, read its schemas, and ask where to show it (`getCompositionPreview`: the widget's published page). `creator` is Widgetic's widget creator, with its drawing canvas and its AI: this user's canvases, the widgets on them, their components and the conversation of each widget, the generation, build and publish calls that make a widget, and the compositions of those widgets (list, make). The surfaces do not imply one another: the whole creator also saves a composition (`editor`) and attaches pictures to its chat (`files`), so ask for `["creator", "editor", "files"]`.
+     *
+     * @type {Array<string>}
+     * @memberof NewEditorSession
+     */
+    surfaces: Array<NewEditorSessionSurfacesEnum>;
+    /**
+     * How long the session lasts, in seconds. It cannot be extended; make a new session when it ends.
+     * @type {number}
+     * @memberof NewEditorSession
+     */
+    expires_in_seconds?: number;
+    /**
+     * Bind the session to one web page origin, such as `https://app.example.com` (no path; `http` is accepted only for `localhost`). The session is then refused from any other origin, and from a request that carries no `Origin` header. Leave it out for a session that can be used from anywhere, which is what a server-side caller needs.
+     *
+     * @type {string}
+     * @memberof NewEditorSession
+     */
+    allowed_origin?: string | null;
+    /**
+     * The most credits this session may spend on Widgetic's AI, one credit being one generation. Once the operations it ran have taken that many, the next one is refused (402, `EDITOR_SESSION_CREDIT_LIMIT_REACHED`) and the browser is only told that the feature is not available right now. A generation that fails is refunded and does not count. Leave it out for no limit of its own, which leaves the credits of your account as the only ceiling.
+     *
+     * @type {number}
+     * @memberof NewEditorSession
+     */
+    max_credits?: number;
+}
+/**
+ * @export
+ */
+export declare const NewEditorSessionSurfacesEnum: {
+    readonly Files: "files";
+    readonly Editor: "editor";
+    readonly Creator: "creator";
+};
+export type NewEditorSessionSurfacesEnum = typeof NewEditorSessionSurfacesEnum[keyof typeof NewEditorSessionSurfacesEnum];
+/**
+ * Check if a given object implements the NewEditorSession interface.
+ */
+export declare function instanceOfNewEditorSession(value: object): value is NewEditorSession;
+export declare function NewEditorSessionFromJSON(json: any): NewEditorSession;
+export declare function NewEditorSessionFromJSONTyped(json: any, ignoreDiscriminator: boolean): NewEditorSession;
+export declare function NewEditorSessionToJSON(json: any): NewEditorSession;
+export declare function NewEditorSessionToJSONTyped(value?: NewEditorSession | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/NewEditorSession.js

@@ -0,0 +1,57 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const NewEditorSessionSurfacesEnum = {
+    Files: 'files',
+    Editor: 'editor',
+    Creator: 'creator'
+};
+/**
+ * Check if a given object implements the NewEditorSession interface.
+ */
+export function instanceOfNewEditorSession(value) {
+    if (!('surfaces' in value) || value['surfaces'] === undefined)
+        return false;
+    return true;
+}
+export function NewEditorSessionFromJSON(json) {
+    return NewEditorSessionFromJSONTyped(json, false);
+}
+export function NewEditorSessionFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'surfaces': json['surfaces'],
+        'expires_in_seconds': json['expires_in_seconds'] == null ? undefined : json['expires_in_seconds'],
+        'allowed_origin': json['allowed_origin'] == null ? undefined : json['allowed_origin'],
+        'max_credits': json['max_credits'] == null ? undefined : json['max_credits'],
+    };
+}
+export function NewEditorSessionToJSON(json) {
+    return NewEditorSessionToJSONTyped(json, false);
+}
+export function NewEditorSessionToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'surfaces': value['surfaces'],
+        'expires_in_seconds': value['expires_in_seconds'],
+        'allowed_origin': value['allowed_origin'],
+        'max_credits': value['max_credits'],
+    };
+}

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

@@ -16,17 +16,17 @@
  */
 export interface NewManagedUser {
     /**
-     * External identifier for the managed user
+     * Your own identifier for the managed user. Must be unique among the managed users you manage (409 otherwise); another partner using the same value does not matter.
      * @type {string}
      * @memberof NewManagedUser
      */
     external_id: string;
     /**
-     * ID of the user who will manage this managed user
+     * ID of the user who will manage this managed user. Defaults to your own user ID; a partner can only use their own ID (403 otherwise), only an admin can name another manager.
      * @type {string}
      * @memberof NewManagedUser
      */
-    manager_id: string;
+    manager_id?: string;
     /**
      * Additional metadata for the managed user
      * @type {object}

package/dist/esm/models/NewManagedUser.js

@@ -17,8 +17,6 @@
 export function instanceOfNewManagedUser(value) {
     if (!('external_id' in value) || value['external_id'] === undefined)
         return false;
-    if (!('manager_id' in value) || value['manager_id'] === undefined)
-        return false;
     return true;
 }
 export function NewManagedUserFromJSON(json) {
@@ -30,7 +28,7 @@ export function NewManagedUserFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'external_id': json['external_id'],
-        'manager_id': json['manager_id'],
+        'manager_id': json['manager_id'] == null ? undefined : json['manager_id'],
         'metadata': json['metadata'] == null ? undefined : json['metadata'],
     };
 }

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

@@ -9,9 +9,11 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import type { NewWidgetComponentsMetadataInner } from './NewWidgetComponentsMetadataInner';
 /**
- * Payload used to create a new widget.
+ * What a new widget starts from. Only the fields listed here are used. The widget is created without
+ * code: it is a record with a name, a type and some starting content, plus a canvas and a database of
+ * its own.
+ *
  * @export
  * @interface NewWidget
  */
@@ -23,19 +25,13 @@ export interface NewWidget {
      */
     name: string;
     /**
-     * Description of the widget.
-     * @type {string}
-     * @memberof NewWidget
-     */
-    description?: string | null;
-    /**
-     * Type of widget being created.
+     * What kind of widget this is, as a label of your choosing (for example chart, form, gallery).
      * @type {string}
      * @memberof NewWidget
      */
     type: string;
     /**
-     * Initial content configuration for the widget.
+     * Starting content for the widget. An empty object is fine.
      * @type {{ [key: string]: any; }}
      * @memberof NewWidget
      */
@@ -43,95 +39,53 @@ export interface NewWidget {
         [key: string]: any;
     };
     /**
-     * Whether the widget is publicly available.
+     * Whether the widget is public.
      * @type {boolean}
      * @memberof NewWidget
      */
     isPublic?: boolean;
     /**
-     * Whether the widget should start as a draft.
+     * Whether the widget starts as a draft. A widget created without this is a draft.
      * @type {boolean}
      * @memberof NewWidget
      */
     isDraft?: boolean;
     /**
-     * Optional ID of an existing canvas to associate with the widget.
-     * @type {string}
-     * @memberof NewWidget
-     */
-    canvasId?: string | null;
-    /**
-     * Path to the JavaScript file for this widget.
-     * @type {string}
-     * @memberof NewWidget
-     */
-    jsPath?: string | null;
-    /**
-     * Repository identifier for managing the widget's source code.
-     * @type {string}
-     * @memberof NewWidget
-     */
-    repoId?: string | null;
-    /**
-     * Optional version number for the widget.
-     * @type {number}
-     * @memberof NewWidget
-     */
-    version?: number | null;
-    /**
-     * Optional metadata for components created with the widget.
-     * @type {Array<NewWidgetComponentsMetadataInner>}
-     * @memberof NewWidget
-     */
-    componentsMetadata?: Array<NewWidgetComponentsMetadataInner> | null;
-    /**
-     * Optional code graph schema identifier.
-     * @type {string}
-     * @memberof NewWidget
-     */
-    cpgSchemaId?: string | null;
-    /**
-     * Optional Git commit SHA of the last code graph analysis.
-     * @type {string}
-     * @memberof NewWidget
-     */
-    lastCpgCommitSha?: string | null;
-    /**
-     * ID of the VM template to use when provisioning a development environment.
+     * Put the widget on this existing canvas instead of a new one. You must own the canvas.
      * @type {string}
      * @memberof NewWidget
      */
-    vmTemplateId?: string | null;
+    canvasId?: string;
     /**
-     * Version of the VM template.
+     * Project to file the widget in. You must be able to edit the project.
      * @type {string}
      * @memberof NewWidget
      */
-    vmTemplateVersion?: string | null;
+    projectId?: string;
     /**
-     * Type of VM template (e.g., base, development).
+     * Organization the widget belongs to. You must be a member who may create widgets there.
      * @type {string}
      * @memberof NewWidget
      */
-    vmTemplateType?: string | null;
+    organizationId?: string;
     /**
-     * Organization workspace ID, if applicable.
+     * Whether the widget lives in your personal workspace or in an organization's.
      * @type {string}
      * @memberof NewWidget
      */
-    organizationId?: string | null;
+    workspaceType?: NewWidgetWorkspaceTypeEnum;
     /**
-     * Project folder reference within the organization workspace.
+     * Make the widget for one of your managed users, by Widgetic's id for the user. Send this or `managedUserExternalId`, not both. The managed user must be yours and active. The widget stays in your account; the tag lets you list one user's widgets and keeps it out of the others' lists. It is set here and does not change afterwards.
      * @type {string}
      * @memberof NewWidget
      */
-    projectFolder?: string | null;
+    managedUserId?: string;
     /**
-     * Workspace type where the widget will live.
+     * The same, by your own identifier for the user, the `external_id` you gave when you created the managed user (answers show it as `externalId`). Send this or `managedUserId`, not both.
      * @type {string}
      * @memberof NewWidget
      */
-    workspaceType?: NewWidgetWorkspaceTypeEnum | null;
+    managedUserExternalId?: string;
 }
 /**
  * @export

package/dist/esm/models/NewWidget.js

@@ -11,7 +11,6 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import { NewWidgetComponentsMetadataInnerFromJSON, NewWidgetComponentsMetadataInnerToJSON, } from './NewWidgetComponentsMetadataInner.js';
 /**
  * @export
  */
@@ -40,24 +39,16 @@ export function NewWidgetFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'name': json['name'],
-        'description': json['description'] == null ? undefined : json['description'],
         'type': json['type'],
         'content': json['content'],
         'isPublic': json['isPublic'] == null ? undefined : json['isPublic'],
         'isDraft': json['isDraft'] == null ? undefined : json['isDraft'],
         'canvasId': json['canvasId'] == null ? undefined : json['canvasId'],
-        'jsPath': json['jsPath'] == null ? undefined : json['jsPath'],
-        'repoId': json['repoId'] == null ? undefined : json['repoId'],
-        'version': json['version'] == null ? undefined : json['version'],
-        'componentsMetadata': json['componentsMetadata'] == null ? undefined : (json['componentsMetadata'].map(NewWidgetComponentsMetadataInnerFromJSON)),
-        'cpgSchemaId': json['cpgSchemaId'] == null ? undefined : json['cpgSchemaId'],
-        'lastCpgCommitSha': json['lastCpgCommitSha'] == null ? undefined : json['lastCpgCommitSha'],
-        'vmTemplateId': json['vmTemplateId'] == null ? undefined : json['vmTemplateId'],
-        'vmTemplateVersion': json['vmTemplateVersion'] == null ? undefined : json['vmTemplateVersion'],
-        'vmTemplateType': json['vmTemplateType'] == null ? undefined : json['vmTemplateType'],
+        'projectId': json['projectId'] == null ? undefined : json['projectId'],
         'organizationId': json['organizationId'] == null ? undefined : json['organizationId'],
-        'projectFolder': json['projectFolder'] == null ? undefined : json['projectFolder'],
         'workspaceType': json['workspaceType'] == null ? undefined : json['workspaceType'],
+        'managedUserId': json['managedUserId'] == null ? undefined : json['managedUserId'],
+        'managedUserExternalId': json['managedUserExternalId'] == null ? undefined : json['managedUserExternalId'],
     };
 }
 export function NewWidgetToJSON(json) {
@@ -69,23 +60,15 @@ export function NewWidgetToJSONTyped(value, ignoreDiscriminator = false) {
     }
     return {
         'name': value['name'],
-        'description': value['description'],
         'type': value['type'],
         'content': value['content'],
         'isPublic': value['isPublic'],
         'isDraft': value['isDraft'],
         'canvasId': value['canvasId'],
-        'jsPath': value['jsPath'],
-        'repoId': value['repoId'],
-        'version': value['version'],
-        'componentsMetadata': value['componentsMetadata'] == null ? undefined : (value['componentsMetadata'].map(NewWidgetComponentsMetadataInnerToJSON)),
-        'cpgSchemaId': value['cpgSchemaId'],
-        'lastCpgCommitSha': value['lastCpgCommitSha'],
-        'vmTemplateId': value['vmTemplateId'],
-        'vmTemplateVersion': value['vmTemplateVersion'],
-        'vmTemplateType': value['vmTemplateType'],
+        'projectId': value['projectId'],
         'organizationId': value['organizationId'],
-        'projectFolder': value['projectFolder'],
         'workspaceType': value['workspaceType'],
+        'managedUserId': value['managedUserId'],
+        'managedUserExternalId': value['managedUserExternalId'],
     };
 }

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

@@ -0,0 +1,88 @@
+/**
+ * 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.
+ */
+/**
+ * Operation payload including status, metadata, and timestamps.
+ * @export
+ * @interface OperationsIdGet200Response
+ */
+export interface OperationsIdGet200Response {
+    /**
+     * The operation's identifier, the `operationId` the call that started it returned
+     * @type {string}
+     * @memberof OperationsIdGet200Response
+     */
+    id?: string;
+    /**
+     * What the operation does
+     * @type {string}
+     * @memberof OperationsIdGet200Response
+     */
+    type?: string;
+    /**
+     * Where the operation stands. `completed`, `failed` and `cancelled` are final
+     * @type {string}
+     * @memberof OperationsIdGet200Response
+     */
+    status?: OperationsIdGet200ResponseStatusEnum;
+    /**
+     * How far the operation has got, in percent
+     * @type {number}
+     * @memberof OperationsIdGet200Response
+     */
+    progress?: number;
+    /**
+     * What the operation tells about its work. A finished composition duplication names the new composition in `newCompositionId`, and lists any problem with its database in `warnings` (absent when there is none).
+     *
+     * @type {{ [key: string]: any; }}
+     * @memberof OperationsIdGet200Response
+     */
+    metadata?: {
+        [key: string]: any;
+    };
+    /**
+     * Why a `failed` operation failed (absent otherwise)
+     * @type {string}
+     * @memberof OperationsIdGet200Response
+     */
+    error?: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof OperationsIdGet200Response
+     */
+    createdAt?: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof OperationsIdGet200Response
+     */
+    updatedAt?: Date;
+}
+/**
+ * @export
+ */
+export declare const OperationsIdGet200ResponseStatusEnum: {
+    readonly Pending: "pending";
+    readonly Running: "running";
+    readonly Completed: "completed";
+    readonly Failed: "failed";
+    readonly Cancelled: "cancelled";
+};
+export type OperationsIdGet200ResponseStatusEnum = typeof OperationsIdGet200ResponseStatusEnum[keyof typeof OperationsIdGet200ResponseStatusEnum];
+/**
+ * Check if a given object implements the OperationsIdGet200Response interface.
+ */
+export declare function instanceOfOperationsIdGet200Response(value: object): value is OperationsIdGet200Response;
+export declare function OperationsIdGet200ResponseFromJSON(json: any): OperationsIdGet200Response;
+export declare function OperationsIdGet200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): OperationsIdGet200Response;
+export declare function OperationsIdGet200ResponseToJSON(json: any): OperationsIdGet200Response;
+export declare function OperationsIdGet200ResponseToJSONTyped(value?: OperationsIdGet200Response | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/OperationsIdGet200Response.js

@@ -0,0 +1,65 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const OperationsIdGet200ResponseStatusEnum = {
+    Pending: 'pending',
+    Running: 'running',
+    Completed: 'completed',
+    Failed: 'failed',
+    Cancelled: 'cancelled'
+};
+/**
+ * Check if a given object implements the OperationsIdGet200Response interface.
+ */
+export function instanceOfOperationsIdGet200Response(value) {
+    return true;
+}
+export function OperationsIdGet200ResponseFromJSON(json) {
+    return OperationsIdGet200ResponseFromJSONTyped(json, false);
+}
+export function OperationsIdGet200ResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'] == null ? undefined : json['id'],
+        'type': json['type'] == null ? undefined : json['type'],
+        'status': json['status'] == null ? undefined : json['status'],
+        'progress': json['progress'] == null ? undefined : json['progress'],
+        'metadata': json['metadata'] == null ? undefined : json['metadata'],
+        'error': json['error'] == null ? undefined : json['error'],
+        'createdAt': json['createdAt'] == null ? undefined : (new Date(json['createdAt'])),
+        'updatedAt': json['updatedAt'] == null ? undefined : (new Date(json['updatedAt'])),
+    };
+}
+export function OperationsIdGet200ResponseToJSON(json) {
+    return OperationsIdGet200ResponseToJSONTyped(json, false);
+}
+export function OperationsIdGet200ResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'type': value['type'],
+        'status': value['status'],
+        'progress': value['progress'],
+        'metadata': value['metadata'],
+        'error': value['error'],
+        'createdAt': value['createdAt'] == null ? undefined : ((value['createdAt']).toISOString()),
+        'updatedAt': value['updatedAt'] == null ? undefined : ((value['updatedAt']).toISOString()),
+    };
+}

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

@@ -47,13 +47,21 @@ export interface OrganizationsOrgIdBillingGet200ResponseData {
      */
     monthlySubtotal?: number;
     /**
+     * The extra storage the organization has, in GB. It is a recurring item on
+     * the subscription: it renews with the seats until it is removed.
      *
      * @type {number}
      * @memberof OrganizationsOrgIdBillingGet200ResponseData
      */
     storagePacksGb?: number;
     /**
-     *
+     * What the extra storage costs per month (`storagePacksGb` at the per-GB rate)
+     * @type {number}
+     * @memberof OrganizationsOrgIdBillingGet200ResponseData
+     */
+    monthlyStorageSubtotal?: number;
+    /**
+     * The recurring amount per month - the seats plus the extra storage.
      * @type {number}
      * @memberof OrganizationsOrgIdBillingGet200ResponseData
      */

package/dist/esm/models/OrganizationsOrgIdBillingGet200ResponseData.js

@@ -32,6 +32,7 @@ export function OrganizationsOrgIdBillingGet200ResponseDataFromJSONTyped(json, i
         'pricePerMember': json['pricePerMember'] == null ? undefined : json['pricePerMember'],
         'monthlySubtotal': json['monthlySubtotal'] == null ? undefined : json['monthlySubtotal'],
         'storagePacksGb': json['storagePacksGb'] == null ? undefined : json['storagePacksGb'],
+        'monthlyStorageSubtotal': json['monthlyStorageSubtotal'] == null ? undefined : json['monthlyStorageSubtotal'],
         'totalMonthlyPrice': json['totalMonthlyPrice'] == null ? undefined : json['totalMonthlyPrice'],
         'nextBillingDate': json['nextBillingDate'] == null ? undefined : json['nextBillingDate'],
         'billingHistory': json['billingHistory'] == null ? undefined : (json['billingHistory'].map(OrganizationsOrgIdBillingGet200ResponseDataBillingHistoryInnerFromJSON)),
@@ -51,6 +52,7 @@ export function OrganizationsOrgIdBillingGet200ResponseDataToJSONTyped(value, ig
         'pricePerMember': value['pricePerMember'],
         'monthlySubtotal': value['monthlySubtotal'],
         'storagePacksGb': value['storagePacksGb'],
+        'monthlyStorageSubtotal': value['monthlyStorageSubtotal'],
         'totalMonthlyPrice': value['totalMonthlyPrice'],
         'nextBillingDate': value['nextBillingDate'],
         'billingHistory': value['billingHistory'] == null ? undefined : (value['billingHistory'].map(OrganizationsOrgIdBillingGet200ResponseDataBillingHistoryInnerToJSON)),

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

@@ -16,7 +16,7 @@
  */
 export interface OrganizationsOrgIdBillingPortalPostRequest {
     /**
-     * Where Stripe sends the user back after the portal session
+     * Where Stripe sends the user back after the portal session. Used only when it is on a Widgetic site origin; any other URL is ignored and the user returns to the organization's billing settings page.
      * @type {string}
      * @memberof OrganizationsOrgIdBillingPortalPostRequest
      */

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

@@ -22,7 +22,11 @@ export interface OrganizationsOrgIdBillingUpgradePostRequest {
      */
     memberCount: number;
     /**
-     * Additional storage packs in GB
+     * Extra storage in GB to start the subscription with, in whole packs of 50 GB
+     * (0, 50, 100, ...). A GB count that is not a whole number of packs is refused with
+     * a 400. It is a recurring add-on: billed every period next to the seats, until it
+     * is removed with `POST /organizations/{orgId}/storage/cancel-pack`.
+     *
      * @type {number}
      * @memberof OrganizationsOrgIdBillingUpgradePostRequest
      */