@spaciv/sdk 0.1.20 → 0.1.21

package/src/models/ScratchpadOutput.ts

@@ -0,0 +1,126 @@
+/* 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 { ScratchpadOutputFile } from './ScratchpadOutputFile';
+import {
+    ScratchpadOutputFileFromJSON,
+    ScratchpadOutputFileFromJSONTyped,
+    ScratchpadOutputFileToJSON,
+    ScratchpadOutputFileToJSONTyped,
+} from './ScratchpadOutputFile';
+
+/**
+ * 
+ * @export
+ * @interface ScratchpadOutput
+ */
+export interface ScratchpadOutput {
+    /**
+     * Why some of the output could not be collected, for example because it was over a limit.
+     * @type {string}
+     * @memberof ScratchpadOutput
+     */
+    error?: string;
+    /**
+     * Files the handler wrote to its output directory.
+     * @type {Array<ScratchpadOutputFile>}
+     * @memberof ScratchpadOutput
+     */
+    files: Array<ScratchpadOutputFile>;
+    /**
+     * 
+     * @type {any}
+     * @memberof ScratchpadOutput
+     */
+    result?: any | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof ScratchpadOutput
+     */
+    stderr: string;
+    /**
+     * Set when stderr was longer than the 256 KiB kept.
+     * @type {boolean}
+     * @memberof ScratchpadOutput
+     */
+    stderrTruncated: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof ScratchpadOutput
+     */
+    stdout: string;
+    /**
+     * Set when stdout was longer than the 256 KiB kept.
+     * @type {boolean}
+     * @memberof ScratchpadOutput
+     */
+    stdoutTruncated: boolean;
+}
+
+/**
+ * Check if a given object implements the ScratchpadOutput interface.
+ */
+export function instanceOfScratchpadOutput(value: object): value is ScratchpadOutput {
+    if (!('files' in value) || value['files'] === undefined) return false;
+    if (!('stderr' in value) || value['stderr'] === undefined) return false;
+    if (!('stderrTruncated' in value) || value['stderrTruncated'] === undefined) return false;
+    if (!('stdout' in value) || value['stdout'] === undefined) return false;
+    if (!('stdoutTruncated' in value) || value['stdoutTruncated'] === undefined) return false;
+    return true;
+}
+
+export function ScratchpadOutputFromJSON(json: any): ScratchpadOutput {
+    return ScratchpadOutputFromJSONTyped(json, false);
+}
+
+export function ScratchpadOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScratchpadOutput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'error': json['error'] == null ? undefined : json['error'],
+        'files': ((json['files'] as Array<any>).map(ScratchpadOutputFileFromJSON)),
+        'result': json['result'] == null ? undefined : json['result'],
+        'stderr': json['stderr'],
+        'stderrTruncated': json['stderrTruncated'],
+        'stdout': json['stdout'],
+        'stdoutTruncated': json['stdoutTruncated'],
+    };
+}
+
+export function ScratchpadOutputToJSON(json: any): ScratchpadOutput {
+    return ScratchpadOutputToJSONTyped(json, false);
+}
+
+export function ScratchpadOutputToJSONTyped(value?: ScratchpadOutput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'error': value['error'],
+        'files': ((value['files'] as Array<any>).map(ScratchpadOutputFileToJSON)),
+        'result': value['result'],
+        'stderr': value['stderr'],
+        'stderrTruncated': value['stderrTruncated'],
+        'stdout': value['stdout'],
+        'stdoutTruncated': value['stdoutTruncated'],
+    };
+}
+

package/src/models/ScratchpadOutputFile.ts

@@ -0,0 +1,83 @@
+/* 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 ScratchpadOutputFile
+ */
+export interface ScratchpadOutputFile {
+    /**
+     * The file's content, base64-encoded.
+     * @type {string}
+     * @memberof ScratchpadOutputFile
+     */
+    content: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ScratchpadOutputFile
+     */
+    contentType?: string;
+    /**
+     * Path relative to the output directory.
+     * @type {string}
+     * @memberof ScratchpadOutputFile
+     */
+    path: string;
+}
+
+/**
+ * Check if a given object implements the ScratchpadOutputFile interface.
+ */
+export function instanceOfScratchpadOutputFile(value: object): value is ScratchpadOutputFile {
+    if (!('content' in value) || value['content'] === undefined) return false;
+    if (!('path' in value) || value['path'] === undefined) return false;
+    return true;
+}
+
+export function ScratchpadOutputFileFromJSON(json: any): ScratchpadOutputFile {
+    return ScratchpadOutputFileFromJSONTyped(json, false);
+}
+
+export function ScratchpadOutputFileFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScratchpadOutputFile {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'content': json['content'],
+        'contentType': json['contentType'] == null ? undefined : json['contentType'],
+        'path': json['path'],
+    };
+}
+
+export function ScratchpadOutputFileToJSON(json: any): ScratchpadOutputFile {
+    return ScratchpadOutputFileToJSONTyped(json, false);
+}
+
+export function ScratchpadOutputFileToJSONTyped(value?: ScratchpadOutputFile | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'content': value['content'],
+        'contentType': value['contentType'],
+        'path': value['path'],
+    };
+}
+

package/src/models/ScratchpadRun.ts

@@ -0,0 +1,203 @@
+/* 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 { ScratchpadOutput } from './ScratchpadOutput';
+import {
+    ScratchpadOutputFromJSON,
+    ScratchpadOutputFromJSONTyped,
+    ScratchpadOutputToJSON,
+    ScratchpadOutputToJSONTyped,
+} from './ScratchpadOutput';
+
+/**
+ * 
+ * @export
+ * @interface ScratchpadRun
+ */
+export interface ScratchpadRun {
+    /**
+     * 
+     * @type {number}
+     * @memberof ScratchpadRun
+     */
+    durationMs?: number;
+    /**
+     * 
+     * @type {Date}
+     * @memberof ScratchpadRun
+     */
+    endedAt?: Date;
+    /**
+     * 
+     * @type {number}
+     * @memberof ScratchpadRun
+     */
+    exitCode: number;
+    /**
+     * When the run and its output are deleted.
+     * @type {Date}
+     * @memberof ScratchpadRun
+     */
+    expiresAt?: Date;
+    /**
+     * The code that was run, keyed by path.
+     * @type {{ [key: string]: string; }}
+     * @memberof ScratchpadRun
+     */
+    files: { [key: string]: string; };
+    /**
+     * 
+     * @type {string}
+     * @memberof ScratchpadRun
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ScratchpadRun
+     */
+    language: ScratchpadRunLanguageEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof ScratchpadRun
+     */
+    message?: string;
+    /**
+     * What the run produced. Absent while it is in progress.
+     * @type {ScratchpadOutput}
+     * @memberof ScratchpadRun
+     */
+    output?: ScratchpadOutput;
+    /**
+     * 
+     * @type {Date}
+     * @memberof ScratchpadRun
+     */
+    queuedAt?: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof ScratchpadRun
+     */
+    startedAt?: Date;
+    /**
+     * How long the sandbox took to start.
+     * @type {number}
+     * @memberof ScratchpadRun
+     */
+    startupMs?: number;
+    /**
+     * queued or running while the run is in progress, then success, error, timeout, killed or quota_exceeded.
+     * @type {string}
+     * @memberof ScratchpadRun
+     */
+    status: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof ScratchpadRun
+     */
+    timeoutSeconds: number;
+    /**
+     * Whether the run used a sandbox that had already started.
+     * @type {boolean}
+     * @memberof ScratchpadRun
+     */
+    warm: boolean;
+}
+
+
+/**
+ * @export
+ */
+export const ScratchpadRunLanguageEnum = {
+    Python: 'python',
+    Javascript: 'javascript'
+} as const;
+export type ScratchpadRunLanguageEnum = typeof ScratchpadRunLanguageEnum[keyof typeof ScratchpadRunLanguageEnum];
+
+
+/**
+ * Check if a given object implements the ScratchpadRun interface.
+ */
+export function instanceOfScratchpadRun(value: object): value is ScratchpadRun {
+    if (!('exitCode' in value) || value['exitCode'] === undefined) return false;
+    if (!('files' in value) || value['files'] === undefined) return false;
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('language' in value) || value['language'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('timeoutSeconds' in value) || value['timeoutSeconds'] === undefined) return false;
+    if (!('warm' in value) || value['warm'] === undefined) return false;
+    return true;
+}
+
+export function ScratchpadRunFromJSON(json: any): ScratchpadRun {
+    return ScratchpadRunFromJSONTyped(json, false);
+}
+
+export function ScratchpadRunFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScratchpadRun {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'durationMs': json['durationMs'] == null ? undefined : json['durationMs'],
+        'endedAt': json['endedAt'] == null ? undefined : (new Date(json['endedAt'])),
+        'exitCode': json['exitCode'],
+        'expiresAt': json['expiresAt'] == null ? undefined : (new Date(json['expiresAt'])),
+        'files': json['files'],
+        'id': json['id'],
+        'language': json['language'],
+        'message': json['message'] == null ? undefined : json['message'],
+        'output': json['output'] == null ? undefined : ScratchpadOutputFromJSON(json['output']),
+        'queuedAt': json['queuedAt'] == null ? undefined : (new Date(json['queuedAt'])),
+        'startedAt': json['startedAt'] == null ? undefined : (new Date(json['startedAt'])),
+        'startupMs': json['startupMs'] == null ? undefined : json['startupMs'],
+        'status': json['status'],
+        'timeoutSeconds': json['timeoutSeconds'],
+        'warm': json['warm'],
+    };
+}
+
+export function ScratchpadRunToJSON(json: any): ScratchpadRun {
+    return ScratchpadRunToJSONTyped(json, false);
+}
+
+export function ScratchpadRunToJSONTyped(value?: ScratchpadRun | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'durationMs': value['durationMs'],
+        'endedAt': value['endedAt'] == null ? undefined : ((value['endedAt']).toISOString()),
+        'exitCode': value['exitCode'],
+        'expiresAt': value['expiresAt'] == null ? undefined : ((value['expiresAt']).toISOString()),
+        'files': value['files'],
+        'id': value['id'],
+        'language': value['language'],
+        'message': value['message'],
+        'output': ScratchpadOutputToJSON(value['output']),
+        'queuedAt': value['queuedAt'] == null ? undefined : ((value['queuedAt']).toISOString()),
+        'startedAt': value['startedAt'] == null ? undefined : ((value['startedAt']).toISOString()),
+        'startupMs': value['startupMs'],
+        'status': value['status'],
+        'timeoutSeconds': value['timeoutSeconds'],
+        'warm': value['warm'],
+    };
+}
+

package/src/models/ScratchpadRunPostReqBody.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';
+/**
+ * 
+ * @export
+ * @interface ScratchpadRunPostReqBody
+ */
+export interface ScratchpadRunPostReqBody {
+    /**
+     * Source files keyed by path. Python needs script.py defining handle(event, ctx) and JavaScript needs script.js exporting handle(event, ctx), as an integration script does, so the code can be saved as one unchanged.
+     * @type {{ [key: string]: string; }}
+     * @memberof ScratchpadRunPostReqBody
+     */
+    files: { [key: string]: string; };
+    /**
+     * 
+     * @type {any}
+     * @memberof ScratchpadRunPostReqBody
+     */
+    input?: any | null;
+    /**
+     * python or javascript. Go code has to be saved as a script, which builds it.
+     * @type {string}
+     * @memberof ScratchpadRunPostReqBody
+     */
+    language: string;
+    /**
+     * Longest the code may run. Defaults to 30.
+     * @type {number}
+     * @memberof ScratchpadRunPostReqBody
+     */
+    timeoutSeconds?: number;
+    /**
+     * Longest to wait for the run to finish before responding. Defaults to 20.
+     * @type {number}
+     * @memberof ScratchpadRunPostReqBody
+     */
+    waitSeconds?: number;
+}
+
+/**
+ * Check if a given object implements the ScratchpadRunPostReqBody interface.
+ */
+export function instanceOfScratchpadRunPostReqBody(value: object): value is ScratchpadRunPostReqBody {
+    if (!('files' in value) || value['files'] === undefined) return false;
+    if (!('language' in value) || value['language'] === undefined) return false;
+    return true;
+}
+
+export function ScratchpadRunPostReqBodyFromJSON(json: any): ScratchpadRunPostReqBody {
+    return ScratchpadRunPostReqBodyFromJSONTyped(json, false);
+}
+
+export function ScratchpadRunPostReqBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScratchpadRunPostReqBody {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'files': json['files'],
+        'input': json['input'] == null ? undefined : json['input'],
+        'language': json['language'],
+        'timeoutSeconds': json['timeoutSeconds'] == null ? undefined : json['timeoutSeconds'],
+        'waitSeconds': json['waitSeconds'] == null ? undefined : json['waitSeconds'],
+    };
+}
+
+export function ScratchpadRunPostReqBodyToJSON(json: any): ScratchpadRunPostReqBody {
+    return ScratchpadRunPostReqBodyToJSONTyped(json, false);
+}
+
+export function ScratchpadRunPostReqBodyToJSONTyped(value?: ScratchpadRunPostReqBody | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'files': value['files'],
+        'input': value['input'],
+        'language': value['language'],
+        'timeoutSeconds': value['timeoutSeconds'],
+        'waitSeconds': value['waitSeconds'],
+    };
+}
+

package/src/models/index.ts

@@ -298,6 +298,10 @@ export * from './ScenarioListEntry';
 export * from './ScenarioListRes';
 export * from './ScenarioNotFoundDetail';
 export * from './ScenarioPatch';
+export * from './ScratchpadOutput';
+export * from './ScratchpadOutputFile';
+export * from './ScratchpadRun';
+export * from './ScratchpadRunPostReqBody';
 export * from './ScriptAuditEntry';
 export * from './ScriptAuditResBody';
 export * from './ScriptDetail';