@spaciv/sdk 0.1.5 → 0.1.6

package/src/models/ScriptUsage.ts

@@ -0,0 +1,93 @@
+/* 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 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 function instanceOfScriptUsage(value: object): value is ScriptUsage {
+    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: any): ScriptUsage {
+    return ScriptUsageFromJSONTyped(json, false);
+}
+
+export function ScriptUsageFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptUsage {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'failedRuns': json['failedRuns'],
+        'quotaExceededRuns': json['quotaExceededRuns'],
+        'runs': json['runs'],
+        'scriptId': json['scriptId'],
+    };
+}
+
+export function ScriptUsageToJSON(json: any): ScriptUsage {
+    return ScriptUsageToJSONTyped(json, false);
+}
+
+export function ScriptUsageToJSONTyped(value?: ScriptUsage | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'failedRuns': value['failedRuns'],
+        'quotaExceededRuns': value['quotaExceededRuns'],
+        'runs': value['runs'],
+        'scriptId': value['scriptId'],
+    };
+}
+

package/src/models/ScriptUsageResBody.ts

@@ -0,0 +1,183 @@
+/* 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 { ScriptLimits } from './ScriptLimits';
+import {
+    ScriptLimitsFromJSON,
+    ScriptLimitsFromJSONTyped,
+    ScriptLimitsToJSON,
+    ScriptLimitsToJSONTyped,
+} from './ScriptLimits';
+import type { ScriptUsage } from './ScriptUsage';
+import {
+    ScriptUsageFromJSON,
+    ScriptUsageFromJSONTyped,
+    ScriptUsageToJSON,
+    ScriptUsageToJSONTyped,
+} 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 const ScriptUsageResBodyCreditStateEnum = {
+    Ok: 'ok',
+    Near: 'near',
+    Reached: 'reached'
+} as const;
+export type ScriptUsageResBodyCreditStateEnum = typeof ScriptUsageResBodyCreditStateEnum[keyof typeof ScriptUsageResBodyCreditStateEnum];
+
+
+/**
+ * Check if a given object implements the ScriptUsageResBody interface.
+ */
+export function instanceOfScriptUsageResBody(value: object): value is ScriptUsageResBody {
+    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;
+}
+
+export function ScriptUsageResBodyFromJSON(json: any): ScriptUsageResBody {
+    return ScriptUsageResBodyFromJSONTyped(json, false);
+}
+
+export function ScriptUsageResBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptUsageResBody {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'creditState': json['creditState'],
+        'creditsUsed': json['creditsUsed'],
+        'enabledScripts': json['enabledScripts'],
+        'failedRuns': json['failedRuns'],
+        'limits': 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'] as Array<any>).map(ScriptUsageFromJSON)),
+    };
+}
+
+export function ScriptUsageResBodyToJSON(json: any): ScriptUsageResBody {
+    return ScriptUsageResBodyToJSONTyped(json, false);
+}
+
+export function ScriptUsageResBodyToJSONTyped(value?: ScriptUsageResBody | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'creditState': value['creditState'],
+        'creditsUsed': value['creditsUsed'],
+        'enabledScripts': value['enabledScripts'],
+        'failedRuns': value['failedRuns'],
+        'limits': ScriptLimitsToJSON(value['limits']),
+        'period': value['period'],
+        'periodEnd': ((value['periodEnd']).toISOString()),
+        'periodStart': ((value['periodStart']).toISOString()),
+        'quotaExceededRuns': value['quotaExceededRuns'],
+        'runs': value['runs'],
+        'scripts': ((value['scripts'] as Array<any>).map(ScriptUsageToJSON)),
+    };
+}
+

package/src/models/index.ts

@@ -301,6 +301,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';
@@ -315,6 +319,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';