@spaciv/sdk 0.1.5 → 0.1.6

package/src/apis/ScriptsApi.ts

@@ -28,6 +28,7 @@ import type {
   ScriptSchedulePreviewResBody,
   ScriptSecretsReqBody,
   ScriptSecretsResBody,
+  ScriptUsageResBody,
   ScriptWebhookResBody,
 } from '../models/index';
 import {
@@ -57,6 +58,8 @@ import {
     ScriptSecretsReqBodyToJSON,
     ScriptSecretsResBodyFromJSON,
     ScriptSecretsResBodyToJSON,
+    ScriptUsageResBodyFromJSON,
+    ScriptUsageResBodyToJSON,
     ScriptWebhookResBodyFromJSON,
     ScriptWebhookResBodyToJSON,
 } from '../models/index';
@@ -120,7 +123,7 @@ export interface ScriptsApiUpdateSecretsRequest {
  */
 export interface ScriptsApiInterface {
     /**
-     * Creates a script whose Python, Go or JavaScript handler is called on a schedule, from a webhook, or both. The handler\'s context carries a Spaciv API key acting with the caller\'s permissions, except the account-administration permissions (*Manage my account*, *Manage users*, *Edit my user profile*, *Edit billing address* and the system permissions), which a script\'s key never carries, plus the account and, when a project is set, the project; the key is rotated automatically. A non-null return value is written to the run\'s logs. When `webhook` is true the response\'s `webhookUrl` is the only time the URL is returned. Rejected with `422` when the source, schedule or secrets are invalid or the project does not exist, and with `409` when the account already has 50 scripts. Requires the *Manage my account* permission; a script\'s own API key cannot call this or any other script operation.
+     * Creates a script whose Python, Go or JavaScript handler is called on a schedule, from a webhook, or both. The handler\'s context carries a Spaciv API key acting with the caller\'s permissions, except the account-administration permissions (*Manage my account*, *Manage users*, *Edit my user profile*, *Edit billing address* and the system permissions), which a script\'s key never carries, plus the account and, when a project is set, the project; the key is rotated automatically. A non-null return value is written to the run\'s logs. When `webhook` is true the response\'s `webhookUrl` is the only time the URL is returned. Rejected with `422` when the source, schedule or secrets are invalid or the project does not exist, and with `409` when the account already has 50 scripts, or when the script is enabled and the account already has its limit of enabled scripts. Requires the *Manage my account* permission; a script\'s own API key cannot call this or any other script operation.
      * @summary Create a script
      * @param {ScriptPostReqBody} scriptPostReqBody 
      * @param {*} [options] Override http request option.
@@ -130,7 +133,7 @@ export interface ScriptsApiInterface {
     createRaw(requestParameters: ScriptsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptDetail>>;
 
     /**
-     * Creates a script whose Python, Go or JavaScript handler is called on a schedule, from a webhook, or both. The handler\'s context carries a Spaciv API key acting with the caller\'s permissions, except the account-administration permissions (*Manage my account*, *Manage users*, *Edit my user profile*, *Edit billing address* and the system permissions), which a script\'s key never carries, plus the account and, when a project is set, the project; the key is rotated automatically. A non-null return value is written to the run\'s logs. When `webhook` is true the response\'s `webhookUrl` is the only time the URL is returned. Rejected with `422` when the source, schedule or secrets are invalid or the project does not exist, and with `409` when the account already has 50 scripts. Requires the *Manage my account* permission; a script\'s own API key cannot call this or any other script operation.
+     * Creates a script whose Python, Go or JavaScript handler is called on a schedule, from a webhook, or both. The handler\'s context carries a Spaciv API key acting with the caller\'s permissions, except the account-administration permissions (*Manage my account*, *Manage users*, *Edit my user profile*, *Edit billing address* and the system permissions), which a script\'s key never carries, plus the account and, when a project is set, the project; the key is rotated automatically. A non-null return value is written to the run\'s logs. When `webhook` is true the response\'s `webhookUrl` is the only time the URL is returned. Rejected with `422` when the source, schedule or secrets are invalid or the project does not exist, and with `409` when the account already has 50 scripts, or when the script is enabled and the account already has its limit of enabled scripts. Requires the *Manage my account* permission; a script\'s own API key cannot call this or any other script operation.
      * Create a script
      */
     create(requestParameters: ScriptsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptDetail>;
@@ -248,6 +251,21 @@ export interface ScriptsApiInterface {
      */
     getExport(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptExportResBody>;
 
+    /**
+     * Returns the credits the account\'s script runs were charged this calendar month (UTC), against the account\'s monthly script credit limit and its other script limits, with how many runs each script made, failed and had refused. creditState is near from 80% of the monthly limit and reached once it is used, after which runs are recorded as quota_exceeded until the month ends. creditsUsed is the scripts figure of `GET /v1/account/usage/calculation-credits`. Run counts are added when runs end. Requires the *Manage my account* permission.
+     * @summary Get script usage
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ScriptsApiInterface
+     */
+    getUsageRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptUsageResBody>>;
+
+    /**
+     * Returns the credits the account\'s script runs were charged this calendar month (UTC), against the account\'s monthly script credit limit and its other script limits, with how many runs each script made, failed and had refused. creditState is near from 80% of the monthly limit and reached once it is used, after which runs are recorded as quota_exceeded until the month ends. creditsUsed is the scripts figure of `GET /v1/account/usage/calculation-credits`. Run counts are added when runs end. Requires the *Manage my account* permission.
+     * Get script usage
+     */
+    getUsage(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptUsageResBody>;
+
     /**
      * Lists the account\'s scripts, sorted by name, without their source code. Requires the *Manage my account* permission.
      * @summary List scripts
@@ -299,7 +317,7 @@ export interface ScriptsApiInterface {
     listRunsLogs(requestParameters: ScriptsApiListRunsLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptRunLogsResBody>;
 
     /**
-     * Updates the fields given. Changing the project replaces the script\'s API key with one scoped to the new project. When someone other than the key\'s owner changes the language, manifest or files, the key is replaced with one acting as them. Turning the webhook on returns its `webhookUrl` once. Rejected with `409` when `revision` is stale, or when enabling a script whose key needs re-authorising; with `422` when the result is invalid. Requires the *Manage my account* permission.
+     * Updates the fields given. Changing the project replaces the script\'s API key with one scoped to the new project. When someone other than the key\'s owner changes the language, manifest or files, the key is replaced with one acting as them. Turning the webhook on returns its `webhookUrl` once. Rejected with `409` when `revision` is stale, when enabling a script whose key needs re-authorising, or when enabling it would exceed the account\'s limit of enabled scripts; with `422` when the result is invalid, including a changed schedule that runs more often than the account\'s minimum interval. Requires the *Manage my account* permission.
      * @summary Update a script
      * @param {string} id 
      * @param {ScriptPatchReqBody} scriptPatchReqBody 
@@ -310,7 +328,7 @@ export interface ScriptsApiInterface {
     updateRaw(requestParameters: ScriptsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptDetail>>;
 
     /**
-     * Updates the fields given. Changing the project replaces the script\'s API key with one scoped to the new project. When someone other than the key\'s owner changes the language, manifest or files, the key is replaced with one acting as them. Turning the webhook on returns its `webhookUrl` once. Rejected with `409` when `revision` is stale, or when enabling a script whose key needs re-authorising; with `422` when the result is invalid. Requires the *Manage my account* permission.
+     * Updates the fields given. Changing the project replaces the script\'s API key with one scoped to the new project. When someone other than the key\'s owner changes the language, manifest or files, the key is replaced with one acting as them. Turning the webhook on returns its `webhookUrl` once. Rejected with `409` when `revision` is stale, when enabling a script whose key needs re-authorising, or when enabling it would exceed the account\'s limit of enabled scripts; with `422` when the result is invalid, including a changed schedule that runs more often than the account\'s minimum interval. Requires the *Manage my account* permission.
      * Update a script
      */
     update(requestParameters: ScriptsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptDetail>;
@@ -340,7 +358,7 @@ export interface ScriptsApiInterface {
 export class ScriptsApi extends runtime.BaseAPI implements ScriptsApiInterface {
 
     /**
-     * Creates a script whose Python, Go or JavaScript handler is called on a schedule, from a webhook, or both. The handler\'s context carries a Spaciv API key acting with the caller\'s permissions, except the account-administration permissions (*Manage my account*, *Manage users*, *Edit my user profile*, *Edit billing address* and the system permissions), which a script\'s key never carries, plus the account and, when a project is set, the project; the key is rotated automatically. A non-null return value is written to the run\'s logs. When `webhook` is true the response\'s `webhookUrl` is the only time the URL is returned. Rejected with `422` when the source, schedule or secrets are invalid or the project does not exist, and with `409` when the account already has 50 scripts. Requires the *Manage my account* permission; a script\'s own API key cannot call this or any other script operation.
+     * Creates a script whose Python, Go or JavaScript handler is called on a schedule, from a webhook, or both. The handler\'s context carries a Spaciv API key acting with the caller\'s permissions, except the account-administration permissions (*Manage my account*, *Manage users*, *Edit my user profile*, *Edit billing address* and the system permissions), which a script\'s key never carries, plus the account and, when a project is set, the project; the key is rotated automatically. A non-null return value is written to the run\'s logs. When `webhook` is true the response\'s `webhookUrl` is the only time the URL is returned. Rejected with `422` when the source, schedule or secrets are invalid or the project does not exist, and with `409` when the account already has 50 scripts, or when the script is enabled and the account already has its limit of enabled scripts. Requires the *Manage my account* permission; a script\'s own API key cannot call this or any other script operation.
      * Create a script
      */
     async createRaw(requestParameters: ScriptsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptDetail>> {
@@ -380,7 +398,7 @@ export class ScriptsApi extends runtime.BaseAPI implements ScriptsApiInterface {
     }
 
     /**
-     * Creates a script whose Python, Go or JavaScript handler is called on a schedule, from a webhook, or both. The handler\'s context carries a Spaciv API key acting with the caller\'s permissions, except the account-administration permissions (*Manage my account*, *Manage users*, *Edit my user profile*, *Edit billing address* and the system permissions), which a script\'s key never carries, plus the account and, when a project is set, the project; the key is rotated automatically. A non-null return value is written to the run\'s logs. When `webhook` is true the response\'s `webhookUrl` is the only time the URL is returned. Rejected with `422` when the source, schedule or secrets are invalid or the project does not exist, and with `409` when the account already has 50 scripts. Requires the *Manage my account* permission; a script\'s own API key cannot call this or any other script operation.
+     * Creates a script whose Python, Go or JavaScript handler is called on a schedule, from a webhook, or both. The handler\'s context carries a Spaciv API key acting with the caller\'s permissions, except the account-administration permissions (*Manage my account*, *Manage users*, *Edit my user profile*, *Edit billing address* and the system permissions), which a script\'s key never carries, plus the account and, when a project is set, the project; the key is rotated automatically. A non-null return value is written to the run\'s logs. When `webhook` is true the response\'s `webhookUrl` is the only time the URL is returned. Rejected with `422` when the source, schedule or secrets are invalid or the project does not exist, and with `409` when the account already has 50 scripts, or when the script is enabled and the account already has its limit of enabled scripts. Requires the *Manage my account* permission; a script\'s own API key cannot call this or any other script operation.
      * Create a script
      */
     async create(requestParameters: ScriptsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptDetail> {
@@ -718,6 +736,45 @@ export class ScriptsApi extends runtime.BaseAPI implements ScriptsApiInterface {
         return await response.value();
     }
 
+    /**
+     * Returns the credits the account\'s script runs were charged this calendar month (UTC), against the account\'s monthly script credit limit and its other script limits, with how many runs each script made, failed and had refused. creditState is near from 80% of the monthly limit and reached once it is used, after which runs are recorded as quota_exceeded until the month ends. creditsUsed is the scripts figure of `GET /v1/account/usage/calculation-credits`. Run counts are added when runs end. Requires the *Manage my account* permission.
+     * Get script usage
+     */
+    async getUsageRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptUsageResBody>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("accessToken", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/v1/scripts/usage`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ScriptUsageResBodyFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns the credits the account\'s script runs were charged this calendar month (UTC), against the account\'s monthly script credit limit and its other script limits, with how many runs each script made, failed and had refused. creditState is near from 80% of the monthly limit and reached once it is used, after which runs are recorded as quota_exceeded until the month ends. creditsUsed is the scripts figure of `GET /v1/account/usage/calculation-credits`. Run counts are added when runs end. Requires the *Manage my account* permission.
+     * Get script usage
+     */
+    async getUsage(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptUsageResBody> {
+        const response = await this.getUsageRaw(initOverrides);
+        return await response.value();
+    }
+
     /**
      * Lists the account\'s scripts, sorted by name, without their source code. Requires the *Manage my account* permission.
      * List scripts
@@ -868,7 +925,7 @@ export class ScriptsApi extends runtime.BaseAPI implements ScriptsApiInterface {
     }
 
     /**
-     * Updates the fields given. Changing the project replaces the script\'s API key with one scoped to the new project. When someone other than the key\'s owner changes the language, manifest or files, the key is replaced with one acting as them. Turning the webhook on returns its `webhookUrl` once. Rejected with `409` when `revision` is stale, or when enabling a script whose key needs re-authorising; with `422` when the result is invalid. Requires the *Manage my account* permission.
+     * Updates the fields given. Changing the project replaces the script\'s API key with one scoped to the new project. When someone other than the key\'s owner changes the language, manifest or files, the key is replaced with one acting as them. Turning the webhook on returns its `webhookUrl` once. Rejected with `409` when `revision` is stale, when enabling a script whose key needs re-authorising, or when enabling it would exceed the account\'s limit of enabled scripts; with `422` when the result is invalid, including a changed schedule that runs more often than the account\'s minimum interval. Requires the *Manage my account* permission.
      * Update a script
      */
     async updateRaw(requestParameters: ScriptsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptDetail>> {
@@ -916,7 +973,7 @@ export class ScriptsApi extends runtime.BaseAPI implements ScriptsApiInterface {
     }
 
     /**
-     * Updates the fields given. Changing the project replaces the script\'s API key with one scoped to the new project. When someone other than the key\'s owner changes the language, manifest or files, the key is replaced with one acting as them. Turning the webhook on returns its `webhookUrl` once. Rejected with `409` when `revision` is stale, or when enabling a script whose key needs re-authorising; with `422` when the result is invalid. Requires the *Manage my account* permission.
+     * Updates the fields given. Changing the project replaces the script\'s API key with one scoped to the new project. When someone other than the key\'s owner changes the language, manifest or files, the key is replaced with one acting as them. Turning the webhook on returns its `webhookUrl` once. Rejected with `409` when `revision` is stale, when enabling a script whose key needs re-authorising, or when enabling it would exceed the account\'s limit of enabled scripts; with `422` when the result is invalid, including a changed schedule that runs more often than the account\'s minimum interval. Requires the *Manage my account* permission.
      * Update a script
      */
     async update(requestParameters: ScriptsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptDetail> {

package/src/models/AccountCalculationUsageDay.ts

@@ -43,6 +43,12 @@ export interface AccountCalculationUsageDay {
      * @memberof AccountCalculationUsageDay
      */
     date: Date;
+    /**
+     * Credits used running scripts: one per started minute of each run.
+     * @type {number}
+     * @memberof AccountCalculationUsageDay
+     */
+    scripts: number;
 }
 
 /**
@@ -53,6 +59,7 @@ export function instanceOfAccountCalculationUsageDay(value: object): value is Ac
     if (!('ai' in value) || value['ai'] === undefined) return false;
     if (!('build' in value) || value['build'] === undefined) return false;
     if (!('date' in value) || value['date'] === undefined) return false;
+    if (!('scripts' in value) || value['scripts'] === undefined) return false;
     return true;
 }
 
@@ -70,6 +77,7 @@ export function AccountCalculationUsageDayFromJSONTyped(json: any, ignoreDiscrim
         'ai': json['ai'],
         'build': json['build'],
         'date': (new Date(json['date'])),
+        'scripts': json['scripts'],
     };
 }
 
@@ -88,6 +96,7 @@ export function AccountCalculationUsageDayToJSONTyped(value?: AccountCalculation
         'ai': value['ai'],
         'build': value['build'],
         'date': ((value['date']).toISOString().substring(0,10)),
+        'scripts': value['scripts'],
     };
 }
 

package/src/models/ScriptLimitOverrides.ts

@@ -0,0 +1,105 @@
+/* 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.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface ScriptLimitOverrides
+ */
+export interface ScriptLimitOverrides {
+    /**
+     * 
+     * @type {number}
+     * @memberof ScriptLimitOverrides
+     */
+    maxConcurrentRuns?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ScriptLimitOverrides
+     */
+    maxCreditsPerMonth?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ScriptLimitOverrides
+     */
+    maxEnabledScripts?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ScriptLimitOverrides
+     */
+    maxRunSeconds?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ScriptLimitOverrides
+     */
+    minCronIntervalSeconds?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ScriptLimitOverrides
+     */
+    webhookRequestsPerMinute?: number;
+}
+
+/**
+ * Check if a given object implements the ScriptLimitOverrides interface.
+ */
+export function instanceOfScriptLimitOverrides(value: object): value is ScriptLimitOverrides {
+    return true;
+}
+
+export function ScriptLimitOverridesFromJSON(json: any): ScriptLimitOverrides {
+    return ScriptLimitOverridesFromJSONTyped(json, false);
+}
+
+export function ScriptLimitOverridesFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptLimitOverrides {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'maxConcurrentRuns': json['maxConcurrentRuns'] == null ? undefined : json['maxConcurrentRuns'],
+        'maxCreditsPerMonth': json['maxCreditsPerMonth'] == null ? undefined : json['maxCreditsPerMonth'],
+        'maxEnabledScripts': json['maxEnabledScripts'] == null ? undefined : json['maxEnabledScripts'],
+        'maxRunSeconds': json['maxRunSeconds'] == null ? undefined : json['maxRunSeconds'],
+        'minCronIntervalSeconds': json['minCronIntervalSeconds'] == null ? undefined : json['minCronIntervalSeconds'],
+        'webhookRequestsPerMinute': json['webhookRequestsPerMinute'] == null ? undefined : json['webhookRequestsPerMinute'],
+    };
+}
+
+export function ScriptLimitOverridesToJSON(json: any): ScriptLimitOverrides {
+    return ScriptLimitOverridesToJSONTyped(json, false);
+}
+
+export function ScriptLimitOverridesToJSONTyped(value?: ScriptLimitOverrides | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'maxConcurrentRuns': value['maxConcurrentRuns'],
+        'maxCreditsPerMonth': value['maxCreditsPerMonth'],
+        'maxEnabledScripts': value['maxEnabledScripts'],
+        'maxRunSeconds': value['maxRunSeconds'],
+        'minCronIntervalSeconds': value['minCronIntervalSeconds'],
+        'webhookRequestsPerMinute': value['webhookRequestsPerMinute'],
+    };
+}
+

package/src/models/ScriptLimitValues.ts

@@ -0,0 +1,111 @@
+/* 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.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface ScriptLimitValues
+ */
+export interface ScriptLimitValues {
+    /**
+     * 
+     * @type {number}
+     * @memberof ScriptLimitValues
+     */
+    maxConcurrentRuns: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ScriptLimitValues
+     */
+    maxCreditsPerMonth: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ScriptLimitValues
+     */
+    maxEnabledScripts: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ScriptLimitValues
+     */
+    maxRunSeconds: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ScriptLimitValues
+     */
+    minCronIntervalSeconds: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ScriptLimitValues
+     */
+    webhookRequestsPerMinute: number;
+}
+
+/**
+ * Check if a given object implements the ScriptLimitValues interface.
+ */
+export function instanceOfScriptLimitValues(value: object): value is ScriptLimitValues {
+    if (!('maxConcurrentRuns' in value) || value['maxConcurrentRuns'] === undefined) return false;
+    if (!('maxCreditsPerMonth' in value) || value['maxCreditsPerMonth'] === undefined) return false;
+    if (!('maxEnabledScripts' in value) || value['maxEnabledScripts'] === undefined) return false;
+    if (!('maxRunSeconds' in value) || value['maxRunSeconds'] === undefined) return false;
+    if (!('minCronIntervalSeconds' in value) || value['minCronIntervalSeconds'] === undefined) return false;
+    if (!('webhookRequestsPerMinute' in value) || value['webhookRequestsPerMinute'] === undefined) return false;
+    return true;
+}
+
+export function ScriptLimitValuesFromJSON(json: any): ScriptLimitValues {
+    return ScriptLimitValuesFromJSONTyped(json, false);
+}
+
+export function ScriptLimitValuesFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptLimitValues {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'maxConcurrentRuns': json['maxConcurrentRuns'],
+        'maxCreditsPerMonth': json['maxCreditsPerMonth'],
+        'maxEnabledScripts': json['maxEnabledScripts'],
+        'maxRunSeconds': json['maxRunSeconds'],
+        'minCronIntervalSeconds': json['minCronIntervalSeconds'],
+        'webhookRequestsPerMinute': json['webhookRequestsPerMinute'],
+    };
+}
+
+export function ScriptLimitValuesToJSON(json: any): ScriptLimitValues {
+    return ScriptLimitValuesToJSONTyped(json, false);
+}
+
+export function ScriptLimitValuesToJSONTyped(value?: ScriptLimitValues | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'maxConcurrentRuns': value['maxConcurrentRuns'],
+        'maxCreditsPerMonth': value['maxCreditsPerMonth'],
+        'maxEnabledScripts': value['maxEnabledScripts'],
+        'maxRunSeconds': value['maxRunSeconds'],
+        'minCronIntervalSeconds': value['minCronIntervalSeconds'],
+        'webhookRequestsPerMinute': value['webhookRequestsPerMinute'],
+    };
+}
+

package/src/models/ScriptLimits.ts

@@ -0,0 +1,111 @@
+/* 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.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface ScriptLimits
+ */
+export interface ScriptLimits {
+    /**
+     * Runs the account may have in progress at once.
+     * @type {number}
+     * @memberof ScriptLimits
+     */
+    maxConcurrentRuns: number;
+    /**
+     * Credits the account's script runs may be charged in a calendar month (UTC). Once they are used, further runs are recorded as quota_exceeded and do not start.
+     * @type {number}
+     * @memberof ScriptLimits
+     */
+    maxCreditsPerMonth: number;
+    /**
+     * Scripts the account may have enabled at once.
+     * @type {number}
+     * @memberof ScriptLimits
+     */
+    maxEnabledScripts: number;
+    /**
+     * Longest a single run may take; a script's own timeout is capped to it.
+     * @type {number}
+     * @memberof ScriptLimits
+     */
+    maxRunSeconds: number;
+    /**
+     * Shortest time allowed between two scheduled runs of a script.
+     * @type {number}
+     * @memberof ScriptLimits
+     */
+    minCronIntervalSeconds: number;
+    /**
+     * Webhook calls each script accepts per minute, and at most in a burst.
+     * @type {number}
+     * @memberof ScriptLimits
+     */
+    webhookRequestsPerMinute: number;
+}
+
+/**
+ * Check if a given object implements the ScriptLimits interface.
+ */
+export function instanceOfScriptLimits(value: object): value is ScriptLimits {
+    if (!('maxConcurrentRuns' in value) || value['maxConcurrentRuns'] === undefined) return false;
+    if (!('maxCreditsPerMonth' in value) || value['maxCreditsPerMonth'] === undefined) return false;
+    if (!('maxEnabledScripts' in value) || value['maxEnabledScripts'] === undefined) return false;
+    if (!('maxRunSeconds' in value) || value['maxRunSeconds'] === undefined) return false;
+    if (!('minCronIntervalSeconds' in value) || value['minCronIntervalSeconds'] === undefined) return false;
+    if (!('webhookRequestsPerMinute' in value) || value['webhookRequestsPerMinute'] === undefined) return false;
+    return true;
+}
+
+export function ScriptLimitsFromJSON(json: any): ScriptLimits {
+    return ScriptLimitsFromJSONTyped(json, false);
+}
+
+export function ScriptLimitsFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptLimits {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'maxConcurrentRuns': json['maxConcurrentRuns'],
+        'maxCreditsPerMonth': json['maxCreditsPerMonth'],
+        'maxEnabledScripts': json['maxEnabledScripts'],
+        'maxRunSeconds': json['maxRunSeconds'],
+        'minCronIntervalSeconds': json['minCronIntervalSeconds'],
+        'webhookRequestsPerMinute': json['webhookRequestsPerMinute'],
+    };
+}
+
+export function ScriptLimitsToJSON(json: any): ScriptLimits {
+    return ScriptLimitsToJSONTyped(json, false);
+}
+
+export function ScriptLimitsToJSONTyped(value?: ScriptLimits | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'maxConcurrentRuns': value['maxConcurrentRuns'],
+        'maxCreditsPerMonth': value['maxCreditsPerMonth'],
+        'maxEnabledScripts': value['maxEnabledScripts'],
+        'maxRunSeconds': value['maxRunSeconds'],
+        'minCronIntervalSeconds': value['minCronIntervalSeconds'],
+        'webhookRequestsPerMinute': value['webhookRequestsPerMinute'],
+    };
+}
+

package/src/models/ScriptLimitsResBody.ts

@@ -0,0 +1,99 @@
+/* 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.
+ */
+
+import { mapValues } from '../runtime';
+import type { ScriptLimitValues } from './ScriptLimitValues';
+import {
+    ScriptLimitValuesFromJSON,
+    ScriptLimitValuesFromJSONTyped,
+    ScriptLimitValuesToJSON,
+    ScriptLimitValuesToJSONTyped,
+} from './ScriptLimitValues';
+import type { ScriptLimitOverrides } from './ScriptLimitOverrides';
+import {
+    ScriptLimitOverridesFromJSON,
+    ScriptLimitOverridesFromJSONTyped,
+    ScriptLimitOverridesToJSON,
+    ScriptLimitOverridesToJSONTyped,
+} from './ScriptLimitOverrides';
+
+/**
+ * 
+ * @export
+ * @interface ScriptLimitsResBody
+ */
+export interface ScriptLimitsResBody {
+    /**
+     * The code defaults for scripts.
+     * @type {ScriptLimitValues}
+     * @memberof ScriptLimitsResBody
+     */
+    defaults: ScriptLimitValues;
+    /**
+     * The limits that apply to the account.
+     * @type {ScriptLimitValues}
+     * @memberof ScriptLimitsResBody
+     */
+    effective: ScriptLimitValues;
+    /**
+     * This account's overrides; an absent field uses the default.
+     * @type {ScriptLimitOverrides}
+     * @memberof ScriptLimitsResBody
+     */
+    overrides: ScriptLimitOverrides;
+}
+
+/**
+ * Check if a given object implements the ScriptLimitsResBody interface.
+ */
+export function instanceOfScriptLimitsResBody(value: object): value is ScriptLimitsResBody {
+    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;
+}
+
+export function ScriptLimitsResBodyFromJSON(json: any): ScriptLimitsResBody {
+    return ScriptLimitsResBodyFromJSONTyped(json, false);
+}
+
+export function ScriptLimitsResBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptLimitsResBody {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'defaults': ScriptLimitValuesFromJSON(json['defaults']),
+        'effective': ScriptLimitValuesFromJSON(json['effective']),
+        'overrides': ScriptLimitOverridesFromJSON(json['overrides']),
+    };
+}
+
+export function ScriptLimitsResBodyToJSON(json: any): ScriptLimitsResBody {
+    return ScriptLimitsResBodyToJSONTyped(json, false);
+}
+
+export function ScriptLimitsResBodyToJSONTyped(value?: ScriptLimitsResBody | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'defaults': ScriptLimitValuesToJSON(value['defaults']),
+        'effective': ScriptLimitValuesToJSON(value['effective']),
+        'overrides': ScriptLimitOverridesToJSON(value['overrides']),
+    };
+}
+