@spaciv/sdk 0.1.4 → 0.1.6

package/dist/esm/models/ScriptLimitOverrides.js

@@ -0,0 +1,51 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the ScriptLimitOverrides interface.
+ */
+export function instanceOfScriptLimitOverrides(value) {
+    return true;
+}
+export function ScriptLimitOverridesFromJSON(json) {
+    return ScriptLimitOverridesFromJSONTyped(json, false);
+}
+export function ScriptLimitOverridesFromJSONTyped(json, ignoreDiscriminator) {
+    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) {
+    return ScriptLimitOverridesToJSONTyped(json, false);
+}
+export function ScriptLimitOverridesToJSONTyped(value, ignoreDiscriminator = false) {
+    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/dist/esm/models/ScriptLimitValues.d.ts

@@ -0,0 +1,62 @@
+/**
+ * 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 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 declare function instanceOfScriptLimitValues(value: object): value is ScriptLimitValues;
+export declare function ScriptLimitValuesFromJSON(json: any): ScriptLimitValues;
+export declare function ScriptLimitValuesFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptLimitValues;
+export declare function ScriptLimitValuesToJSON(json: any): ScriptLimitValues;
+export declare function ScriptLimitValuesToJSONTyped(value?: ScriptLimitValues | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ScriptLimitValues.js

@@ -0,0 +1,63 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the ScriptLimitValues interface.
+ */
+export function instanceOfScriptLimitValues(value) {
+    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) {
+    return ScriptLimitValuesFromJSONTyped(json, false);
+}
+export function ScriptLimitValuesFromJSONTyped(json, ignoreDiscriminator) {
+    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) {
+    return ScriptLimitValuesToJSONTyped(json, false);
+}
+export function ScriptLimitValuesToJSONTyped(value, ignoreDiscriminator = false) {
+    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/dist/esm/models/ScriptLimits.d.ts

@@ -0,0 +1,62 @@
+/**
+ * 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 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 declare function instanceOfScriptLimits(value: object): value is ScriptLimits;
+export declare function ScriptLimitsFromJSON(json: any): ScriptLimits;
+export declare function ScriptLimitsFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptLimits;
+export declare function ScriptLimitsToJSON(json: any): ScriptLimits;
+export declare function ScriptLimitsToJSONTyped(value?: ScriptLimits | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ScriptLimits.js

@@ -0,0 +1,63 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the ScriptLimits interface.
+ */
+export function instanceOfScriptLimits(value) {
+    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) {
+    return ScriptLimitsFromJSONTyped(json, false);
+}
+export function ScriptLimitsFromJSONTyped(json, ignoreDiscriminator) {
+    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) {
+    return ScriptLimitsToJSONTyped(json, false);
+}
+export function ScriptLimitsToJSONTyped(value, ignoreDiscriminator = false) {
+    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/dist/esm/models/ScriptLimitsResBody.d.ts

@@ -0,0 +1,46 @@
+/**
+ * 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 { ScriptLimitValues } from './ScriptLimitValues';
+import type { ScriptLimitOverrides } 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 declare function instanceOfScriptLimitsResBody(value: object): value is ScriptLimitsResBody;
+export declare function ScriptLimitsResBodyFromJSON(json: any): ScriptLimitsResBody;
+export declare function ScriptLimitsResBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptLimitsResBody;
+export declare function ScriptLimitsResBodyToJSON(json: any): ScriptLimitsResBody;
+export declare function ScriptLimitsResBodyToJSONTyped(value?: ScriptLimitsResBody | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ScriptLimitsResBody.js

@@ -0,0 +1,53 @@
+/* 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 { ScriptLimitValuesFromJSON, ScriptLimitValuesToJSON, } from './ScriptLimitValues';
+import { ScriptLimitOverridesFromJSON, ScriptLimitOverridesToJSON, } from './ScriptLimitOverrides';
+/**
+ * Check if a given object implements the ScriptLimitsResBody interface.
+ */
+export 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;
+}
+export function ScriptLimitsResBodyFromJSON(json) {
+    return ScriptLimitsResBodyFromJSONTyped(json, false);
+}
+export function ScriptLimitsResBodyFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'defaults': ScriptLimitValuesFromJSON(json['defaults']),
+        'effective': ScriptLimitValuesFromJSON(json['effective']),
+        'overrides': ScriptLimitOverridesFromJSON(json['overrides']),
+    };
+}
+export function ScriptLimitsResBodyToJSON(json) {
+    return ScriptLimitsResBodyToJSONTyped(json, false);
+}
+export function ScriptLimitsResBodyToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'defaults': ScriptLimitValuesToJSON(value['defaults']),
+        'effective': ScriptLimitValuesToJSON(value['effective']),
+        'overrides': ScriptLimitOverridesToJSON(value['overrides']),
+    };
+}

package/dist/esm/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/esm/models/ScriptUsage.js

@@ -0,0 +1,55 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the ScriptUsage interface.
+ */
+export 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;
+}
+export function ScriptUsageFromJSON(json) {
+    return ScriptUsageFromJSONTyped(json, false);
+}
+export function ScriptUsageFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'failedRuns': json['failedRuns'],
+        'quotaExceededRuns': json['quotaExceededRuns'],
+        'runs': json['runs'],
+        'scriptId': json['scriptId'],
+    };
+}
+export function ScriptUsageToJSON(json) {
+    return ScriptUsageToJSONTyped(json, false);
+}
+export 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/esm/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;