@spaciv/sdk 0.1.5 → 0.1.7

package/dist/models/ScriptLimitsResBody.js

@@ -0,0 +1,60 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * spaciv API
+ * The spaciv API powers workplace planning: modelling how many people an organisation has, how they work, and how much space that requires.  ## Getting started  1. Exchange credentials for an access token using one of the operations under    **Authentication**. 2. Send that token on every subsequent request as `Authorization: Bearer <token>`. 3. Access tokens are short lived. Call `POST /v1/auth/refresh-token` to obtain a new one    before the old one expires.  ## Conventions  Every operation is versioned under `/v1`. Collections are plural (`GET /v1/dashboards` lists, `POST /v1/dashboards` creates) and individual records live beneath them (`/v1/dashboards/{id}`). Singular paths such as `/v1/account`, `/v1/project` and `/v1/user` refer to the record the access token was issued for.  Request and response bodies are JSON. Timestamps are RFC 3339. Identifiers are opaque strings unless documented otherwise, and collection operations return the records visible to the account the token was issued for.  Failures return an [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) problem document with a `detail` field describing what went wrong.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@spaciv.com
+ *
+ * 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.instanceOfScriptLimitsResBody = instanceOfScriptLimitsResBody;
+exports.ScriptLimitsResBodyFromJSON = ScriptLimitsResBodyFromJSON;
+exports.ScriptLimitsResBodyFromJSONTyped = ScriptLimitsResBodyFromJSONTyped;
+exports.ScriptLimitsResBodyToJSON = ScriptLimitsResBodyToJSON;
+exports.ScriptLimitsResBodyToJSONTyped = ScriptLimitsResBodyToJSONTyped;
+const ScriptLimitValues_1 = require("./ScriptLimitValues");
+const ScriptLimitOverrides_1 = require("./ScriptLimitOverrides");
+/**
+ * Check if a given object implements the ScriptLimitsResBody interface.
+ */
+function instanceOfScriptLimitsResBody(value) {
+    if (!('defaults' in value) || value['defaults'] === undefined)
+        return false;
+    if (!('effective' in value) || value['effective'] === undefined)
+        return false;
+    if (!('overrides' in value) || value['overrides'] === undefined)
+        return false;
+    return true;
+}
+function ScriptLimitsResBodyFromJSON(json) {
+    return ScriptLimitsResBodyFromJSONTyped(json, false);
+}
+function ScriptLimitsResBodyFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'defaults': (0, ScriptLimitValues_1.ScriptLimitValuesFromJSON)(json['defaults']),
+        'effective': (0, ScriptLimitValues_1.ScriptLimitValuesFromJSON)(json['effective']),
+        'overrides': (0, ScriptLimitOverrides_1.ScriptLimitOverridesFromJSON)(json['overrides']),
+    };
+}
+function ScriptLimitsResBodyToJSON(json) {
+    return ScriptLimitsResBodyToJSONTyped(json, false);
+}
+function ScriptLimitsResBodyToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'defaults': (0, ScriptLimitValues_1.ScriptLimitValuesToJSON)(value['defaults']),
+        'effective': (0, ScriptLimitValues_1.ScriptLimitValuesToJSON)(value['effective']),
+        'overrides': (0, ScriptLimitOverrides_1.ScriptLimitOverridesToJSON)(value['overrides']),
+    };
+}

package/dist/models/ScriptUsage.d.ts

@@ -0,0 +1,50 @@
+/**
+ * spaciv API
+ * The spaciv API powers workplace planning: modelling how many people an organisation has, how they work, and how much space that requires.  ## Getting started  1. Exchange credentials for an access token using one of the operations under    **Authentication**. 2. Send that token on every subsequent request as `Authorization: Bearer <token>`. 3. Access tokens are short lived. Call `POST /v1/auth/refresh-token` to obtain a new one    before the old one expires.  ## Conventions  Every operation is versioned under `/v1`. Collections are plural (`GET /v1/dashboards` lists, `POST /v1/dashboards` creates) and individual records live beneath them (`/v1/dashboards/{id}`). Singular paths such as `/v1/account`, `/v1/project` and `/v1/user` refer to the record the access token was issued for.  Request and response bodies are JSON. Timestamps are RFC 3339. Identifiers are opaque strings unless documented otherwise, and collection operations return the records visible to the account the token was issued for.  Failures return an [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) problem document with a `detail` field describing what went wrong.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@spaciv.com
+ *
+ * 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 ScriptUsage
+ */
+export interface ScriptUsage {
+    /**
+     * Runs that ended in error, timeout or killed.
+     * @type {number}
+     * @memberof ScriptUsage
+     */
+    failedRuns: number;
+    /**
+     * Runs that did not start because a limit was reached.
+     * @type {number}
+     * @memberof ScriptUsage
+     */
+    quotaExceededRuns: number;
+    /**
+     * Runs that were not refused by a limit, whatever their outcome, including runs that failed before their sandbox started.
+     * @type {number}
+     * @memberof ScriptUsage
+     */
+    runs: number;
+    /**
+     *
+     * @type {string}
+     * @memberof ScriptUsage
+     */
+    scriptId: string;
+}
+/**
+ * Check if a given object implements the ScriptUsage interface.
+ */
+export declare function instanceOfScriptUsage(value: object): value is ScriptUsage;
+export declare function ScriptUsageFromJSON(json: any): ScriptUsage;
+export declare function ScriptUsageFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptUsage;
+export declare function ScriptUsageToJSON(json: any): ScriptUsage;
+export declare function ScriptUsageToJSONTyped(value?: ScriptUsage | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ScriptUsage.js

@@ -0,0 +1,62 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * spaciv API
+ * The spaciv API powers workplace planning: modelling how many people an organisation has, how they work, and how much space that requires.  ## Getting started  1. Exchange credentials for an access token using one of the operations under    **Authentication**. 2. Send that token on every subsequent request as `Authorization: Bearer <token>`. 3. Access tokens are short lived. Call `POST /v1/auth/refresh-token` to obtain a new one    before the old one expires.  ## Conventions  Every operation is versioned under `/v1`. Collections are plural (`GET /v1/dashboards` lists, `POST /v1/dashboards` creates) and individual records live beneath them (`/v1/dashboards/{id}`). Singular paths such as `/v1/account`, `/v1/project` and `/v1/user` refer to the record the access token was issued for.  Request and response bodies are JSON. Timestamps are RFC 3339. Identifiers are opaque strings unless documented otherwise, and collection operations return the records visible to the account the token was issued for.  Failures return an [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) problem document with a `detail` field describing what went wrong.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@spaciv.com
+ *
+ * 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.instanceOfScriptUsage = instanceOfScriptUsage;
+exports.ScriptUsageFromJSON = ScriptUsageFromJSON;
+exports.ScriptUsageFromJSONTyped = ScriptUsageFromJSONTyped;
+exports.ScriptUsageToJSON = ScriptUsageToJSON;
+exports.ScriptUsageToJSONTyped = ScriptUsageToJSONTyped;
+/**
+ * Check if a given object implements the ScriptUsage interface.
+ */
+function instanceOfScriptUsage(value) {
+    if (!('failedRuns' in value) || value['failedRuns'] === undefined)
+        return false;
+    if (!('quotaExceededRuns' in value) || value['quotaExceededRuns'] === undefined)
+        return false;
+    if (!('runs' in value) || value['runs'] === undefined)
+        return false;
+    if (!('scriptId' in value) || value['scriptId'] === undefined)
+        return false;
+    return true;
+}
+function ScriptUsageFromJSON(json) {
+    return ScriptUsageFromJSONTyped(json, false);
+}
+function ScriptUsageFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'failedRuns': json['failedRuns'],
+        'quotaExceededRuns': json['quotaExceededRuns'],
+        'runs': json['runs'],
+        'scriptId': json['scriptId'],
+    };
+}
+function ScriptUsageToJSON(json) {
+    return ScriptUsageToJSONTyped(json, false);
+}
+function ScriptUsageToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'failedRuns': value['failedRuns'],
+        'quotaExceededRuns': value['quotaExceededRuns'],
+        'runs': value['runs'],
+        'scriptId': value['scriptId'],
+    };
+}

package/dist/models/ScriptUsageResBody.d.ts

@@ -0,0 +1,103 @@
+/**
+ * spaciv API
+ * The spaciv API powers workplace planning: modelling how many people an organisation has, how they work, and how much space that requires.  ## Getting started  1. Exchange credentials for an access token using one of the operations under    **Authentication**. 2. Send that token on every subsequent request as `Authorization: Bearer <token>`. 3. Access tokens are short lived. Call `POST /v1/auth/refresh-token` to obtain a new one    before the old one expires.  ## Conventions  Every operation is versioned under `/v1`. Collections are plural (`GET /v1/dashboards` lists, `POST /v1/dashboards` creates) and individual records live beneath them (`/v1/dashboards/{id}`). Singular paths such as `/v1/account`, `/v1/project` and `/v1/user` refer to the record the access token was issued for.  Request and response bodies are JSON. Timestamps are RFC 3339. Identifiers are opaque strings unless documented otherwise, and collection operations return the records visible to the account the token was issued for.  Failures return an [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) problem document with a `detail` field describing what went wrong.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@spaciv.com
+ *
+ * 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 { ScriptLimits } from './ScriptLimits';
+import type { ScriptUsage } from './ScriptUsage';
+/**
+ *
+ * @export
+ * @interface ScriptUsageResBody
+ */
+export interface ScriptUsageResBody {
+    /**
+     * near from 80% of maxCreditsPerMonth; reached once they are used, after which runs are recorded as quota_exceeded until the month ends.
+     * @type {string}
+     * @memberof ScriptUsageResBody
+     */
+    creditState: ScriptUsageResBodyCreditStateEnum;
+    /**
+     * Credits the account's script runs were charged this month: the scripts figure the account Usage tab shows.
+     * @type {number}
+     * @memberof ScriptUsageResBody
+     */
+    creditsUsed: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ScriptUsageResBody
+     */
+    enabledScripts: number;
+    /**
+     * Runs that ended in error, timeout or killed.
+     * @type {number}
+     * @memberof ScriptUsageResBody
+     */
+    failedRuns: number;
+    /**
+     *
+     * @type {ScriptLimits}
+     * @memberof ScriptUsageResBody
+     */
+    limits: ScriptLimits;
+    /**
+     * The calendar month (UTC) the usage covers.
+     * @type {string}
+     * @memberof ScriptUsageResBody
+     */
+    period: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof ScriptUsageResBody
+     */
+    periodEnd: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof ScriptUsageResBody
+     */
+    periodStart: Date;
+    /**
+     * Runs that did not start because a limit was reached.
+     * @type {number}
+     * @memberof ScriptUsageResBody
+     */
+    quotaExceededRuns: number;
+    /**
+     * Runs that were not refused by a limit, whatever their outcome, including runs that failed before their sandbox started.
+     * @type {number}
+     * @memberof ScriptUsageResBody
+     */
+    runs: number;
+    /**
+     * Usage of each script that has run this month, deleted scripts included, sorted by scriptId.
+     * @type {Array<ScriptUsage>}
+     * @memberof ScriptUsageResBody
+     */
+    scripts: Array<ScriptUsage>;
+}
+/**
+ * @export
+ */
+export declare const ScriptUsageResBodyCreditStateEnum: {
+    readonly Ok: "ok";
+    readonly Near: "near";
+    readonly Reached: "reached";
+};
+export type ScriptUsageResBodyCreditStateEnum = typeof ScriptUsageResBodyCreditStateEnum[keyof typeof ScriptUsageResBodyCreditStateEnum];
+/**
+ * Check if a given object implements the ScriptUsageResBody interface.
+ */
+export declare function instanceOfScriptUsageResBody(value: object): value is ScriptUsageResBody;
+export declare function ScriptUsageResBodyFromJSON(json: any): ScriptUsageResBody;
+export declare function ScriptUsageResBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptUsageResBody;
+export declare function ScriptUsageResBodyToJSON(json: any): ScriptUsageResBody;
+export declare function ScriptUsageResBodyToJSONTyped(value?: ScriptUsageResBody | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ScriptUsageResBody.js

@@ -0,0 +1,101 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * spaciv API
+ * The spaciv API powers workplace planning: modelling how many people an organisation has, how they work, and how much space that requires.  ## Getting started  1. Exchange credentials for an access token using one of the operations under    **Authentication**. 2. Send that token on every subsequent request as `Authorization: Bearer <token>`. 3. Access tokens are short lived. Call `POST /v1/auth/refresh-token` to obtain a new one    before the old one expires.  ## Conventions  Every operation is versioned under `/v1`. Collections are plural (`GET /v1/dashboards` lists, `POST /v1/dashboards` creates) and individual records live beneath them (`/v1/dashboards/{id}`). Singular paths such as `/v1/account`, `/v1/project` and `/v1/user` refer to the record the access token was issued for.  Request and response bodies are JSON. Timestamps are RFC 3339. Identifiers are opaque strings unless documented otherwise, and collection operations return the records visible to the account the token was issued for.  Failures return an [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) problem document with a `detail` field describing what went wrong.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@spaciv.com
+ *
+ * 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.ScriptUsageResBodyCreditStateEnum = void 0;
+exports.instanceOfScriptUsageResBody = instanceOfScriptUsageResBody;
+exports.ScriptUsageResBodyFromJSON = ScriptUsageResBodyFromJSON;
+exports.ScriptUsageResBodyFromJSONTyped = ScriptUsageResBodyFromJSONTyped;
+exports.ScriptUsageResBodyToJSON = ScriptUsageResBodyToJSON;
+exports.ScriptUsageResBodyToJSONTyped = ScriptUsageResBodyToJSONTyped;
+const ScriptLimits_1 = require("./ScriptLimits");
+const ScriptUsage_1 = require("./ScriptUsage");
+/**
+ * @export
+ */
+exports.ScriptUsageResBodyCreditStateEnum = {
+    Ok: 'ok',
+    Near: 'near',
+    Reached: 'reached'
+};
+/**
+ * Check if a given object implements the ScriptUsageResBody interface.
+ */
+function instanceOfScriptUsageResBody(value) {
+    if (!('creditState' in value) || value['creditState'] === undefined)
+        return false;
+    if (!('creditsUsed' in value) || value['creditsUsed'] === undefined)
+        return false;
+    if (!('enabledScripts' in value) || value['enabledScripts'] === undefined)
+        return false;
+    if (!('failedRuns' in value) || value['failedRuns'] === undefined)
+        return false;
+    if (!('limits' in value) || value['limits'] === undefined)
+        return false;
+    if (!('period' in value) || value['period'] === undefined)
+        return false;
+    if (!('periodEnd' in value) || value['periodEnd'] === undefined)
+        return false;
+    if (!('periodStart' in value) || value['periodStart'] === undefined)
+        return false;
+    if (!('quotaExceededRuns' in value) || value['quotaExceededRuns'] === undefined)
+        return false;
+    if (!('runs' in value) || value['runs'] === undefined)
+        return false;
+    if (!('scripts' in value) || value['scripts'] === undefined)
+        return false;
+    return true;
+}
+function ScriptUsageResBodyFromJSON(json) {
+    return ScriptUsageResBodyFromJSONTyped(json, false);
+}
+function ScriptUsageResBodyFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'creditState': json['creditState'],
+        'creditsUsed': json['creditsUsed'],
+        'enabledScripts': json['enabledScripts'],
+        'failedRuns': json['failedRuns'],
+        'limits': (0, ScriptLimits_1.ScriptLimitsFromJSON)(json['limits']),
+        'period': json['period'],
+        'periodEnd': (new Date(json['periodEnd'])),
+        'periodStart': (new Date(json['periodStart'])),
+        'quotaExceededRuns': json['quotaExceededRuns'],
+        'runs': json['runs'],
+        'scripts': (json['scripts'].map(ScriptUsage_1.ScriptUsageFromJSON)),
+    };
+}
+function ScriptUsageResBodyToJSON(json) {
+    return ScriptUsageResBodyToJSONTyped(json, false);
+}
+function ScriptUsageResBodyToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'creditState': value['creditState'],
+        'creditsUsed': value['creditsUsed'],
+        'enabledScripts': value['enabledScripts'],
+        'failedRuns': value['failedRuns'],
+        'limits': (0, ScriptLimits_1.ScriptLimitsToJSON)(value['limits']),
+        'period': value['period'],
+        'periodEnd': ((value['periodEnd']).toISOString()),
+        'periodStart': ((value['periodStart']).toISOString()),
+        'quotaExceededRuns': value['quotaExceededRuns'],
+        'runs': value['runs'],
+        'scripts': (value['scripts'].map(ScriptUsage_1.ScriptUsageToJSON)),
+    };
+}

package/dist/models/index.d.ts

@@ -299,6 +299,10 @@ export * from './ScriptExport';
 export * from './ScriptExportResBody';
 export * from './ScriptExportRun';
 export * from './ScriptKey';
+export * from './ScriptLimitOverrides';
+export * from './ScriptLimitValues';
+export * from './ScriptLimits';
+export * from './ScriptLimitsResBody';
 export * from './ScriptListResBody';
 export * from './ScriptLogLine';
 export * from './ScriptPatchReqBody';
@@ -313,6 +317,8 @@ export * from './ScriptSchedulePreviewResBody';
 export * from './ScriptSecretsReqBody';
 export * from './ScriptSecretsResBody';
 export * from './ScriptSummary';
+export * from './ScriptUsage';
+export * from './ScriptUsageResBody';
 export * from './ScriptWebhookResBody';
 export * from './SendPasswordPutReqBody';
 export * from './SerializedEvent';

package/dist/models/index.js

@@ -317,6 +317,10 @@ __exportStar(require("./ScriptExport"), exports);
 __exportStar(require("./ScriptExportResBody"), exports);
 __exportStar(require("./ScriptExportRun"), exports);
 __exportStar(require("./ScriptKey"), exports);
+__exportStar(require("./ScriptLimitOverrides"), exports);
+__exportStar(require("./ScriptLimitValues"), exports);
+__exportStar(require("./ScriptLimits"), exports);
+__exportStar(require("./ScriptLimitsResBody"), exports);
 __exportStar(require("./ScriptListResBody"), exports);
 __exportStar(require("./ScriptLogLine"), exports);
 __exportStar(require("./ScriptPatchReqBody"), exports);
@@ -331,6 +335,8 @@ __exportStar(require("./ScriptSchedulePreviewResBody"), exports);
 __exportStar(require("./ScriptSecretsReqBody"), exports);
 __exportStar(require("./ScriptSecretsResBody"), exports);
 __exportStar(require("./ScriptSummary"), exports);
+__exportStar(require("./ScriptUsage"), exports);
+__exportStar(require("./ScriptUsageResBody"), exports);
 __exportStar(require("./ScriptWebhookResBody"), exports);
 __exportStar(require("./SendPasswordPutReqBody"), exports);
 __exportStar(require("./SerializedEvent"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spaciv/sdk",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "description": "OpenAPI client for @spaciv/sdk",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/AccountsApi.ts

@@ -312,7 +312,7 @@ export interface AccountsApiInterface {
     listAuthOptions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountGetAuthOptionsResBody>;
 
     /**
-     * Returns the credits the account used on each of the last `days` days, split into building layer data, aggregating it and the AI assistant. A piece of calculation work is charged once however many times it is computed, and a result already cached costs nothing. Credits are the same unit the rest of the account\'s usage is counted in. Requires the *Manage my account* permission. Returns `500` if the usage cannot be read.
+     * Returns the credits the account used on each of the last `days` days, split into building layer data, aggregating it, the AI assistant and running scripts. A piece of calculation work is charged once however many times it is computed, and a result already cached costs nothing. A script run is charged once, when it ends. Credits are the same unit the rest of the account\'s usage is counted in. Requires the *Manage my account* permission. Returns `500` if the usage cannot be read.
      * @summary Get the account\'s credit usage
      * @param {30 | 90 | 365} [days] How many days of usage to return, ending today (UTC).
      * @param {*} [options] Override http request option.
@@ -322,7 +322,7 @@ export interface AccountsApiInterface {
     listUsageCalculationCreditsRaw(requestParameters: AccountsApiListUsageCalculationCreditsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccountCalculationUsageBody>>;
 
     /**
-     * Returns the credits the account used on each of the last `days` days, split into building layer data, aggregating it and the AI assistant. A piece of calculation work is charged once however many times it is computed, and a result already cached costs nothing. Credits are the same unit the rest of the account\'s usage is counted in. Requires the *Manage my account* permission. Returns `500` if the usage cannot be read.
+     * Returns the credits the account used on each of the last `days` days, split into building layer data, aggregating it, the AI assistant and running scripts. A piece of calculation work is charged once however many times it is computed, and a result already cached costs nothing. A script run is charged once, when it ends. Credits are the same unit the rest of the account\'s usage is counted in. Requires the *Manage my account* permission. Returns `500` if the usage cannot be read.
      * Get the account\'s credit usage
      */
     listUsageCalculationCredits(requestParameters: AccountsApiListUsageCalculationCreditsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountCalculationUsageBody>;
@@ -939,7 +939,7 @@ export class AccountsApi extends runtime.BaseAPI implements AccountsApiInterface
     }
 
     /**
-     * Returns the credits the account used on each of the last `days` days, split into building layer data, aggregating it and the AI assistant. A piece of calculation work is charged once however many times it is computed, and a result already cached costs nothing. Credits are the same unit the rest of the account\'s usage is counted in. Requires the *Manage my account* permission. Returns `500` if the usage cannot be read.
+     * Returns the credits the account used on each of the last `days` days, split into building layer data, aggregating it, the AI assistant and running scripts. A piece of calculation work is charged once however many times it is computed, and a result already cached costs nothing. A script run is charged once, when it ends. Credits are the same unit the rest of the account\'s usage is counted in. Requires the *Manage my account* permission. Returns `500` if the usage cannot be read.
      * Get the account\'s credit usage
      */
     async listUsageCalculationCreditsRaw(requestParameters: AccountsApiListUsageCalculationCreditsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccountCalculationUsageBody>> {
@@ -973,7 +973,7 @@ export class AccountsApi extends runtime.BaseAPI implements AccountsApiInterface
     }
 
     /**
-     * Returns the credits the account used on each of the last `days` days, split into building layer data, aggregating it and the AI assistant. A piece of calculation work is charged once however many times it is computed, and a result already cached costs nothing. Credits are the same unit the rest of the account\'s usage is counted in. Requires the *Manage my account* permission. Returns `500` if the usage cannot be read.
+     * Returns the credits the account used on each of the last `days` days, split into building layer data, aggregating it, the AI assistant and running scripts. A piece of calculation work is charged once however many times it is computed, and a result already cached costs nothing. A script run is charged once, when it ends. Credits are the same unit the rest of the account\'s usage is counted in. Requires the *Manage my account* permission. Returns `500` if the usage cannot be read.
      * Get the account\'s credit usage
      */
     async listUsageCalculationCredits(requestParameters: AccountsApiListUsageCalculationCreditsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountCalculationUsageBody> {

package/src/apis/FloorPlansApi.ts

@@ -120,11 +120,11 @@ export interface FloorPlansApiInterface {
     get(requestParameters: FloorPlansApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FloorplanGetBody>;
 
     /**
-     * Returns the raw image bytes for the specified layer (`image` for the base drawing, `foreground` for the overlay). When no image has been uploaded a generated placeholder is returned unless `noFallback=true` is set. Requires the *View floorplans* permission. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the stored image matches a virus signature; the bytes are kept for investigation.
+     * Returns the raw image bytes for the specified layer (`image` for the base drawing, `foreground` for the overlay): the account file set as the layer\'s `backgroundFile` or `foregroundFile`, or, when there is none or it has been deleted from file storage, an image uploaded to the layer through `PUT`. When the layer has neither, a generated placeholder is returned unless `noFallback=true` is set. Requires the *View floorplans* permission; the *View file storage* permission is not needed to read the layer\'s account file. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the image matches a virus signature; the bytes are kept for investigation.
      * @summary Get a floor plan image
      * @param {string} id 
      * @param {'image' | 'foreground'} imageType Which image layer to retrieve: the base drawing (image) or the foreground overlay (foreground).
-     * @param {boolean} [noFallback] When true, returns 404 instead of a generated placeholder if no image has been uploaded.
+     * @param {boolean} [noFallback] When true, returns 404 instead of a generated placeholder if the layer has no image.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof FloorPlansApiInterface
@@ -132,7 +132,7 @@ export interface FloorPlansApiInterface {
     getImagesRaw(requestParameters: FloorPlansApiGetImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
 
     /**
-     * Returns the raw image bytes for the specified layer (`image` for the base drawing, `foreground` for the overlay). When no image has been uploaded a generated placeholder is returned unless `noFallback=true` is set. Requires the *View floorplans* permission. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the stored image matches a virus signature; the bytes are kept for investigation.
+     * Returns the raw image bytes for the specified layer (`image` for the base drawing, `foreground` for the overlay): the account file set as the layer\'s `backgroundFile` or `foregroundFile`, or, when there is none or it has been deleted from file storage, an image uploaded to the layer through `PUT`. When the layer has neither, a generated placeholder is returned unless `noFallback=true` is set. Requires the *View floorplans* permission; the *View file storage* permission is not needed to read the layer\'s account file. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the image matches a virus signature; the bytes are kept for investigation.
      * Get a floor plan image
      */
     getImages(requestParameters: FloorPlansApiGetImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
@@ -153,7 +153,7 @@ export interface FloorPlansApiInterface {
     list(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<FloorplanBrief>>;
 
     /**
-     * Partially updates the floor plan\'s name, linked property and node, creation timestamp, image overlay offset, and space geometry. Only fields present in the request body are changed. When `spaces` is provided the entire space overlay is replaced. Requires the *Edit floorplans* permission.
+     * Partially updates the floor plan\'s name, linked property and node, creation timestamp, image overlay offset, background and foreground images, and space geometry. Only fields present in the request body are changed, and the request fails with `409` if the floor plan keeps changing while they are. When `spaces` is provided the entire space overlay is replaced. Requires the *Edit floorplans* permission.  `backgroundFile` and `foregroundFile` take the ID of an image in the account\'s file storage (see `/v1/account/files`), or an empty string to remove the layer\'s image; choosing a file also requires the *View file storage* permission. The file must be a PNG, JPEG, GIF, WebP or SVG image of at most 4 MB that is not quarantined, otherwise the request fails with `422` (`403` when quarantined) and nothing is changed. Setting or removing a layer\'s file also deletes any image previously uploaded to that layer through `PUT /v1/floorplans/{id}/images/{imageType}`.
      * @summary Update a floor plan
      * @param {string} id 
      * @param {FloorplanPatchParamsBody} [floorplanPatchParamsBody] 
@@ -164,13 +164,13 @@ export interface FloorPlansApiInterface {
     updateRaw(requestParameters: FloorPlansApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
 
     /**
-     * Partially updates the floor plan\'s name, linked property and node, creation timestamp, image overlay offset, and space geometry. Only fields present in the request body are changed. When `spaces` is provided the entire space overlay is replaced. Requires the *Edit floorplans* permission.
+     * Partially updates the floor plan\'s name, linked property and node, creation timestamp, image overlay offset, background and foreground images, and space geometry. Only fields present in the request body are changed, and the request fails with `409` if the floor plan keeps changing while they are. When `spaces` is provided the entire space overlay is replaced. Requires the *Edit floorplans* permission.  `backgroundFile` and `foregroundFile` take the ID of an image in the account\'s file storage (see `/v1/account/files`), or an empty string to remove the layer\'s image; choosing a file also requires the *View file storage* permission. The file must be a PNG, JPEG, GIF, WebP or SVG image of at most 4 MB that is not quarantined, otherwise the request fails with `422` (`403` when quarantined) and nothing is changed. Setting or removing a layer\'s file also deletes any image previously uploaded to that layer through `PUT /v1/floorplans/{id}/images/{imageType}`.
      * Update a floor plan
      */
     update(requestParameters: FloorPlansApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
 
     /**
-     * Uploads an image file for the specified layer of a floor plan. Submit a `multipart/form-data` request with the file under the `file` key; the maximum file size is 4 MB. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Omitting the file part deletes any existing image for that layer. Requires the *Edit floorplans* permission.
+     * Uploads an image file for the specified layer of a floor plan. Submit a `multipart/form-data` request with the file under the `file` key; the maximum file size is 4 MB. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Omitting the file part deletes any existing image for that layer. Either way, the layer stops showing any account file set for it through `PATCH /v1/floorplans/{id}`; prefer setting `backgroundFile` or `foregroundFile` there instead. Requires the *Edit floorplans* permission.
      * @summary Upload a floor plan image
      * @param {string} id 
      * @param {'image' | 'foreground'} imageType Which image layer to upload: the base drawing (image) or the foreground overlay (foreground).
@@ -183,7 +183,7 @@ export interface FloorPlansApiInterface {
     updateImagesRaw(requestParameters: FloorPlansApiUpdateImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
 
     /**
-     * Uploads an image file for the specified layer of a floor plan. Submit a `multipart/form-data` request with the file under the `file` key; the maximum file size is 4 MB. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Omitting the file part deletes any existing image for that layer. Requires the *Edit floorplans* permission.
+     * Uploads an image file for the specified layer of a floor plan. Submit a `multipart/form-data` request with the file under the `file` key; the maximum file size is 4 MB. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Omitting the file part deletes any existing image for that layer. Either way, the layer stops showing any account file set for it through `PATCH /v1/floorplans/{id}`; prefer setting `backgroundFile` or `foregroundFile` there instead. Requires the *Edit floorplans* permission.
      * Upload a floor plan image
      */
     updateImages(requestParameters: FloorPlansApiUpdateImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
@@ -343,7 +343,7 @@ export class FloorPlansApi extends runtime.BaseAPI implements FloorPlansApiInter
     }
 
     /**
-     * Returns the raw image bytes for the specified layer (`image` for the base drawing, `foreground` for the overlay). When no image has been uploaded a generated placeholder is returned unless `noFallback=true` is set. Requires the *View floorplans* permission. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the stored image matches a virus signature; the bytes are kept for investigation.
+     * Returns the raw image bytes for the specified layer (`image` for the base drawing, `foreground` for the overlay): the account file set as the layer\'s `backgroundFile` or `foregroundFile`, or, when there is none or it has been deleted from file storage, an image uploaded to the layer through `PUT`. When the layer has neither, a generated placeholder is returned unless `noFallback=true` is set. Requires the *View floorplans* permission; the *View file storage* permission is not needed to read the layer\'s account file. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the image matches a virus signature; the bytes are kept for investigation.
      * Get a floor plan image
      */
     async getImagesRaw(requestParameters: FloorPlansApiGetImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>> {
@@ -397,7 +397,7 @@ export class FloorPlansApi extends runtime.BaseAPI implements FloorPlansApiInter
     }
 
     /**
-     * Returns the raw image bytes for the specified layer (`image` for the base drawing, `foreground` for the overlay). When no image has been uploaded a generated placeholder is returned unless `noFallback=true` is set. Requires the *View floorplans* permission. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the stored image matches a virus signature; the bytes are kept for investigation.
+     * Returns the raw image bytes for the specified layer (`image` for the base drawing, `foreground` for the overlay): the account file set as the layer\'s `backgroundFile` or `foregroundFile`, or, when there is none or it has been deleted from file storage, an image uploaded to the layer through `PUT`. When the layer has neither, a generated placeholder is returned unless `noFallback=true` is set. Requires the *View floorplans* permission; the *View file storage* permission is not needed to read the layer\'s account file. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the image matches a virus signature; the bytes are kept for investigation.
      * Get a floor plan image
      */
     async getImages(requestParameters: FloorPlansApiGetImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string> {
@@ -445,7 +445,7 @@ export class FloorPlansApi extends runtime.BaseAPI implements FloorPlansApiInter
     }
 
     /**
-     * Partially updates the floor plan\'s name, linked property and node, creation timestamp, image overlay offset, and space geometry. Only fields present in the request body are changed. When `spaces` is provided the entire space overlay is replaced. Requires the *Edit floorplans* permission.
+     * Partially updates the floor plan\'s name, linked property and node, creation timestamp, image overlay offset, background and foreground images, and space geometry. Only fields present in the request body are changed, and the request fails with `409` if the floor plan keeps changing while they are. When `spaces` is provided the entire space overlay is replaced. Requires the *Edit floorplans* permission.  `backgroundFile` and `foregroundFile` take the ID of an image in the account\'s file storage (see `/v1/account/files`), or an empty string to remove the layer\'s image; choosing a file also requires the *View file storage* permission. The file must be a PNG, JPEG, GIF, WebP or SVG image of at most 4 MB that is not quarantined, otherwise the request fails with `422` (`403` when quarantined) and nothing is changed. Setting or removing a layer\'s file also deletes any image previously uploaded to that layer through `PUT /v1/floorplans/{id}/images/{imageType}`.
      * Update a floor plan
      */
     async updateRaw(requestParameters: FloorPlansApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>> {
@@ -486,7 +486,7 @@ export class FloorPlansApi extends runtime.BaseAPI implements FloorPlansApiInter
     }
 
     /**
-     * Partially updates the floor plan\'s name, linked property and node, creation timestamp, image overlay offset, and space geometry. Only fields present in the request body are changed. When `spaces` is provided the entire space overlay is replaced. Requires the *Edit floorplans* permission.
+     * Partially updates the floor plan\'s name, linked property and node, creation timestamp, image overlay offset, background and foreground images, and space geometry. Only fields present in the request body are changed, and the request fails with `409` if the floor plan keeps changing while they are. When `spaces` is provided the entire space overlay is replaced. Requires the *Edit floorplans* permission.  `backgroundFile` and `foregroundFile` take the ID of an image in the account\'s file storage (see `/v1/account/files`), or an empty string to remove the layer\'s image; choosing a file also requires the *View file storage* permission. The file must be a PNG, JPEG, GIF, WebP or SVG image of at most 4 MB that is not quarantined, otherwise the request fails with `422` (`403` when quarantined) and nothing is changed. Setting or removing a layer\'s file also deletes any image previously uploaded to that layer through `PUT /v1/floorplans/{id}/images/{imageType}`.
      * Update a floor plan
      */
     async update(requestParameters: FloorPlansApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object> {
@@ -495,7 +495,7 @@ export class FloorPlansApi extends runtime.BaseAPI implements FloorPlansApiInter
     }
 
     /**
-     * Uploads an image file for the specified layer of a floor plan. Submit a `multipart/form-data` request with the file under the `file` key; the maximum file size is 4 MB. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Omitting the file part deletes any existing image for that layer. Requires the *Edit floorplans* permission.
+     * Uploads an image file for the specified layer of a floor plan. Submit a `multipart/form-data` request with the file under the `file` key; the maximum file size is 4 MB. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Omitting the file part deletes any existing image for that layer. Either way, the layer stops showing any account file set for it through `PATCH /v1/floorplans/{id}`; prefer setting `backgroundFile` or `foregroundFile` there instead. Requires the *Edit floorplans* permission.
      * Upload a floor plan image
      */
     async updateImagesRaw(requestParameters: FloorPlansApiUpdateImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>> {
@@ -566,7 +566,7 @@ export class FloorPlansApi extends runtime.BaseAPI implements FloorPlansApiInter
     }
 
     /**
-     * Uploads an image file for the specified layer of a floor plan. Submit a `multipart/form-data` request with the file under the `file` key; the maximum file size is 4 MB. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Omitting the file part deletes any existing image for that layer. Requires the *Edit floorplans* permission.
+     * Uploads an image file for the specified layer of a floor plan. Submit a `multipart/form-data` request with the file under the `file` key; the maximum file size is 4 MB. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Omitting the file part deletes any existing image for that layer. Either way, the layer stops showing any account file set for it through `PATCH /v1/floorplans/{id}`; prefer setting `backgroundFile` or `foregroundFile` there instead. Requires the *Edit floorplans* permission.
      * Upload a floor plan image
      */
     async updateImages(requestParameters: FloorPlansApiUpdateImagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object> {