@widgetic/api-sdk 1.0.24 → 1.0.26

package/dist/models/NewManagedUser.js

@@ -24,8 +24,6 @@ exports.NewManagedUserToJSONTyped = NewManagedUserToJSONTyped;
 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;
 }
 function NewManagedUserFromJSON(json) {
@@ -37,7 +35,7 @@ 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/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/models/NewWidget.js

@@ -19,7 +19,6 @@ exports.NewWidgetFromJSON = NewWidgetFromJSON;
 exports.NewWidgetFromJSONTyped = NewWidgetFromJSONTyped;
 exports.NewWidgetToJSON = NewWidgetToJSON;
 exports.NewWidgetToJSONTyped = NewWidgetToJSONTyped;
-const NewWidgetComponentsMetadataInner_1 = require("./NewWidgetComponentsMetadataInner");
 /**
  * @export
  */
@@ -48,24 +47,16 @@ 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(NewWidgetComponentsMetadataInner_1.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'],
     };
 }
 function NewWidgetToJSON(json) {
@@ -77,23 +68,15 @@ 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(NewWidgetComponentsMetadataInner_1.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/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/models/OperationsIdGet200Response.js

@@ -0,0 +1,73 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OperationsIdGet200ResponseStatusEnum = void 0;
+exports.instanceOfOperationsIdGet200Response = instanceOfOperationsIdGet200Response;
+exports.OperationsIdGet200ResponseFromJSON = OperationsIdGet200ResponseFromJSON;
+exports.OperationsIdGet200ResponseFromJSONTyped = OperationsIdGet200ResponseFromJSONTyped;
+exports.OperationsIdGet200ResponseToJSON = OperationsIdGet200ResponseToJSON;
+exports.OperationsIdGet200ResponseToJSONTyped = OperationsIdGet200ResponseToJSONTyped;
+/**
+ * @export
+ */
+exports.OperationsIdGet200ResponseStatusEnum = {
+    Pending: 'pending',
+    Running: 'running',
+    Completed: 'completed',
+    Failed: 'failed',
+    Cancelled: 'cancelled'
+};
+/**
+ * Check if a given object implements the OperationsIdGet200Response interface.
+ */
+function instanceOfOperationsIdGet200Response(value) {
+    return true;
+}
+function OperationsIdGet200ResponseFromJSON(json) {
+    return OperationsIdGet200ResponseFromJSONTyped(json, false);
+}
+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'])),
+    };
+}
+function OperationsIdGet200ResponseToJSON(json) {
+    return OperationsIdGet200ResponseToJSONTyped(json, false);
+}
+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/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/models/OrganizationsOrgIdBillingGet200ResponseData.js

@@ -39,6 +39,7 @@ function OrganizationsOrgIdBillingGet200ResponseDataFromJSONTyped(json, ignoreDi
         '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(OrganizationsOrgIdBillingGet200ResponseDataBillingHistoryInner_1.OrganizationsOrgIdBillingGet200ResponseDataBillingHistoryInnerFromJSON)),
@@ -58,6 +59,7 @@ function OrganizationsOrgIdBillingGet200ResponseDataToJSONTyped(value, ignoreDis
         '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(OrganizationsOrgIdBillingGet200ResponseDataBillingHistoryInner_1.OrganizationsOrgIdBillingGet200ResponseDataBillingHistoryInnerToJSON)),

package/dist/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/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
      */

package/dist/models/Partner.d.ts

@@ -0,0 +1,144 @@
+/**
+ * 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.
+ */
+/**
+ * A partner account as an administrator reads it. A partner has no API key of its own: the administering user's `wgt_prt_` key is what calls the API for it.
+ *
+ * @export
+ * @interface Partner
+ */
+export interface Partner {
+    /**
+     *
+     * @type {string}
+     * @memberof Partner
+     */
+    id: string;
+    /**
+     * The partner's name; unique
+     * @type {string}
+     * @memberof Partner
+     */
+    name: string;
+    /**
+     * The billing contact
+     * @type {string}
+     * @memberof Partner
+     */
+    contactEmail: string;
+    /**
+     * The user who administers the partner account; their own `wgt_prt_` API key calls the API for it
+     * @type {string}
+     * @memberof Partner
+     */
+    adminUserId?: string | null;
+    /**
+     * The partner's standing. `active` partners are served; `inactive` ones are switched off (a new partner starts here, and is unusable until activated); `suspended` ones are paused: switched off with a recorded reason (`suspensionReason`, `suspendedAt`). A paused partner's customers see nothing of it and cannot create anything, and it can still sign in to read and pay its invoices. Change it with `PUT /admin/partners/{partnerId}/status`.
+     *
+     * @type {string}
+     * @memberof Partner
+     */
+    status: PartnerStatusEnum;
+    /**
+     * The switch behind `status`; false for both `inactive` and `suspended`
+     * @type {boolean}
+     * @memberof Partner
+     */
+    isActive?: boolean;
+    /**
+     * Why the partner was suspended; null unless `status` is `suspended`
+     * @type {string}
+     * @memberof Partner
+     */
+    suspensionReason?: string | null;
+    /**
+     * When the suspension began; null unless `status` is `suspended`
+     * @type {Date}
+     * @memberof Partner
+     */
+    suspendedAt?: Date | null;
+    /**
+     *
+     * @type {string}
+     * @memberof Partner
+     */
+    planType?: string | null;
+    /**
+     *
+     * @type {number}
+     * @memberof Partner
+     */
+    monthlyMinimumSpend?: number | null;
+    /**
+     * Where the partner's events are delivered
+     * @type {string}
+     * @memberof Partner
+     */
+    webhookUrl?: string | null;
+    /**
+     * The websites the partner's embeds may appear on; empty or unset means no restriction. Each entry is a domain such as `example.com` (which also covers `www.example.com`) or `*.example.com` (the domain and every subdomain); a scheme, port or path is ignored. It is added to the administering person's own domain list and applies to the embeds made in that person's personal workspace, which is where the partner's API keys create them.
+     *
+     * @type {Array<string>}
+     * @memberof Partner
+     */
+    allowedDomains?: Array<string> | null;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof Partner
+     */
+    featuresEnabled?: Array<string> | null;
+    /**
+     *
+     * @type {{ [key: string]: any; }}
+     * @memberof Partner
+     */
+    billingSettings?: {
+        [key: string]: any;
+    } | null;
+    /**
+     *
+     * @type {{ [key: string]: any; }}
+     * @memberof Partner
+     */
+    whiteLabelConfig?: {
+        [key: string]: any;
+    } | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof Partner
+     */
+    createdAt?: Date | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof Partner
+     */
+    updatedAt?: Date | null;
+}
+/**
+ * @export
+ */
+export declare const PartnerStatusEnum: {
+    readonly Active: "active";
+    readonly Inactive: "inactive";
+    readonly Suspended: "suspended";
+};
+export type PartnerStatusEnum = typeof PartnerStatusEnum[keyof typeof PartnerStatusEnum];
+/**
+ * Check if a given object implements the Partner interface.
+ */
+export declare function instanceOfPartner(value: object): value is Partner;
+export declare function PartnerFromJSON(json: any): Partner;
+export declare function PartnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): Partner;
+export declare function PartnerToJSON(json: any): Partner;
+export declare function PartnerToJSONTyped(value?: Partner | null, ignoreDiscriminator?: boolean): any;