@spaciv/sdk 0.1.1 → 0.1.2

package/src/models/ScriptExport.ts

@@ -0,0 +1,289 @@
+/* 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 { ScriptKey } from './ScriptKey';
+import {
+    ScriptKeyFromJSON,
+    ScriptKeyFromJSONTyped,
+    ScriptKeyToJSON,
+    ScriptKeyToJSONTyped,
+} from './ScriptKey';
+import type { ScriptSchedule } from './ScriptSchedule';
+import {
+    ScriptScheduleFromJSON,
+    ScriptScheduleFromJSONTyped,
+    ScriptScheduleToJSON,
+    ScriptScheduleToJSONTyped,
+} from './ScriptSchedule';
+import type { ScriptRuntime } from './ScriptRuntime';
+import {
+    ScriptRuntimeFromJSON,
+    ScriptRuntimeFromJSONTyped,
+    ScriptRuntimeToJSON,
+    ScriptRuntimeToJSONTyped,
+} from './ScriptRuntime';
+import type { ScriptExportRun } from './ScriptExportRun';
+import {
+    ScriptExportRunFromJSON,
+    ScriptExportRunFromJSONTyped,
+    ScriptExportRunToJSON,
+    ScriptExportRunToJSONTyped,
+} from './ScriptExportRun';
+
+/**
+ * 
+ * @export
+ * @interface ScriptExport
+ */
+export interface ScriptExport {
+    /**
+     * 
+     * @type {Date}
+     * @memberof ScriptExport
+     */
+    createdAt: Date;
+    /**
+     * 
+     * @type {number}
+     * @memberof ScriptExport
+     */
+    createdBy: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof ScriptExport
+     */
+    description?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ScriptExport
+     */
+    enabled: boolean;
+    /**
+     * Source files keyed by path.
+     * @type {{ [key: string]: string; }}
+     * @memberof ScriptExport
+     */
+    files: { [key: string]: string; };
+    /**
+     * 
+     * @type {string}
+     * @memberof ScriptExport
+     */
+    id: string;
+    /**
+     * 
+     * @type {ScriptKey}
+     * @memberof ScriptExport
+     */
+    key: ScriptKey;
+    /**
+     * 
+     * @type {string}
+     * @memberof ScriptExport
+     */
+    language: ScriptExportLanguageEnum;
+    /**
+     * Dependency manifest: requirements.txt for Python, go.mod for Go, package.json for JavaScript.
+     * @type {string}
+     * @memberof ScriptExport
+     */
+    manifest?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ScriptExport
+     */
+    name: string;
+    /**
+     * Project the script's API key is scoped to. Absent when it acts across the account.
+     * @type {number}
+     * @memberof ScriptExport
+     */
+    project?: number;
+    /**
+     * Pass back when updating, so a concurrent change is reported rather than overwritten.
+     * @type {number}
+     * @memberof ScriptExport
+     */
+    revision: number;
+    /**
+     * Every build and run still kept, newest first.
+     * @type {Array<ScriptExportRun>}
+     * @memberof ScriptExport
+     */
+    runs: Array<ScriptExportRun>;
+    /**
+     * Set when the run history could not be read in full, in which case runs holds only the newest part that was read. Page through the script's runs endpoint for the rest.
+     * @type {string}
+     * @memberof ScriptExport
+     */
+    runsError?: string;
+    /**
+     * Live state from the runner; absent if the runner could not be reached.
+     * @type {ScriptRuntime}
+     * @memberof ScriptExport
+     */
+    runtime?: ScriptRuntime;
+    /**
+     * 
+     * @type {ScriptSchedule}
+     * @memberof ScriptExport
+     */
+    schedule: ScriptSchedule;
+    /**
+     * Names of the secrets set on the script. Values are never returned.
+     * @type {Array<string>}
+     * @memberof ScriptExport
+     */
+    secretNames: Array<string>;
+    /**
+     * The handler signature the script implements.
+     * @type {string}
+     * @memberof ScriptExport
+     */
+    type: ScriptExportTypeEnum;
+    /**
+     * 
+     * @type {Date}
+     * @memberof ScriptExport
+     */
+    updatedAt: Date;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ScriptExport
+     */
+    webhook: boolean;
+    /**
+     * Returned only when a webhook URL is first issued; it cannot be retrieved later.
+     * @type {string}
+     * @memberof ScriptExport
+     */
+    webhookUrl?: string;
+}
+
+
+/**
+ * @export
+ */
+export const ScriptExportLanguageEnum = {
+    Python: 'python',
+    Go: 'go',
+    Javascript: 'javascript'
+} as const;
+export type ScriptExportLanguageEnum = typeof ScriptExportLanguageEnum[keyof typeof ScriptExportLanguageEnum];
+
+/**
+ * @export
+ */
+export const ScriptExportTypeEnum = {
+    Integration: 'integration'
+} as const;
+export type ScriptExportTypeEnum = typeof ScriptExportTypeEnum[keyof typeof ScriptExportTypeEnum];
+
+
+/**
+ * Check if a given object implements the ScriptExport interface.
+ */
+export function instanceOfScriptExport(value: object): value is ScriptExport {
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('createdBy' in value) || value['createdBy'] === undefined) return false;
+    if (!('enabled' in value) || value['enabled'] === undefined) return false;
+    if (!('files' in value) || value['files'] === undefined) return false;
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('key' in value) || value['key'] === undefined) return false;
+    if (!('language' in value) || value['language'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('revision' in value) || value['revision'] === undefined) return false;
+    if (!('runs' in value) || value['runs'] === undefined) return false;
+    if (!('schedule' in value) || value['schedule'] === undefined) return false;
+    if (!('secretNames' in value) || value['secretNames'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
+    if (!('webhook' in value) || value['webhook'] === undefined) return false;
+    return true;
+}
+
+export function ScriptExportFromJSON(json: any): ScriptExport {
+    return ScriptExportFromJSONTyped(json, false);
+}
+
+export function ScriptExportFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptExport {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'createdAt': (new Date(json['createdAt'])),
+        'createdBy': json['createdBy'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'enabled': json['enabled'],
+        'files': json['files'],
+        'id': json['id'],
+        'key': ScriptKeyFromJSON(json['key']),
+        'language': json['language'],
+        'manifest': json['manifest'] == null ? undefined : json['manifest'],
+        'name': json['name'],
+        'project': json['project'] == null ? undefined : json['project'],
+        'revision': json['revision'],
+        'runs': ((json['runs'] as Array<any>).map(ScriptExportRunFromJSON)),
+        'runsError': json['runsError'] == null ? undefined : json['runsError'],
+        'runtime': json['runtime'] == null ? undefined : ScriptRuntimeFromJSON(json['runtime']),
+        'schedule': ScriptScheduleFromJSON(json['schedule']),
+        'secretNames': json['secretNames'],
+        'type': json['type'],
+        'updatedAt': (new Date(json['updatedAt'])),
+        'webhook': json['webhook'],
+        'webhookUrl': json['webhookUrl'] == null ? undefined : json['webhookUrl'],
+    };
+}
+
+export function ScriptExportToJSON(json: any): ScriptExport {
+    return ScriptExportToJSONTyped(json, false);
+}
+
+export function ScriptExportToJSONTyped(value?: ScriptExport | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'createdAt': ((value['createdAt']).toISOString()),
+        'createdBy': value['createdBy'],
+        'description': value['description'],
+        'enabled': value['enabled'],
+        'files': value['files'],
+        'id': value['id'],
+        'key': ScriptKeyToJSON(value['key']),
+        'language': value['language'],
+        'manifest': value['manifest'],
+        'name': value['name'],
+        'project': value['project'],
+        'revision': value['revision'],
+        'runs': ((value['runs'] as Array<any>).map(ScriptExportRunToJSON)),
+        'runsError': value['runsError'],
+        'runtime': ScriptRuntimeToJSON(value['runtime']),
+        'schedule': ScriptScheduleToJSON(value['schedule']),
+        'secretNames': value['secretNames'],
+        'type': value['type'],
+        'updatedAt': ((value['updatedAt']).toISOString()),
+        'webhook': value['webhook'],
+        'webhookUrl': value['webhookUrl'],
+    };
+}
+

package/src/models/ScriptExportResBody.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';
+import type { ScriptExport } from './ScriptExport';
+import {
+    ScriptExportFromJSON,
+    ScriptExportFromJSONTyped,
+    ScriptExportToJSON,
+    ScriptExportToJSONTyped,
+} from './ScriptExport';
+
+/**
+ * 
+ * @export
+ * @interface ScriptExportResBody
+ */
+export interface ScriptExportResBody {
+    /**
+     * 
+     * @type {Date}
+     * @memberof ScriptExportResBody
+     */
+    exportedAt: Date;
+    /**
+     * 
+     * @type {Array<ScriptExport>}
+     * @memberof ScriptExportResBody
+     */
+    scripts: Array<ScriptExport>;
+}
+
+/**
+ * Check if a given object implements the ScriptExportResBody interface.
+ */
+export function instanceOfScriptExportResBody(value: object): value is ScriptExportResBody {
+    if (!('exportedAt' in value) || value['exportedAt'] === undefined) return false;
+    if (!('scripts' in value) || value['scripts'] === undefined) return false;
+    return true;
+}
+
+export function ScriptExportResBodyFromJSON(json: any): ScriptExportResBody {
+    return ScriptExportResBodyFromJSONTyped(json, false);
+}
+
+export function ScriptExportResBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptExportResBody {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'exportedAt': (new Date(json['exportedAt'])),
+        'scripts': ((json['scripts'] as Array<any>).map(ScriptExportFromJSON)),
+    };
+}
+
+export function ScriptExportResBodyToJSON(json: any): ScriptExportResBody {
+    return ScriptExportResBodyToJSONTyped(json, false);
+}
+
+export function ScriptExportResBodyToJSONTyped(value?: ScriptExportResBody | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'exportedAt': ((value['exportedAt']).toISOString()),
+        'scripts': ((value['scripts'] as Array<any>).map(ScriptExportToJSON)),
+    };
+}
+

package/src/models/ScriptExportRun.ts

@@ -0,0 +1,151 @@
+/* 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 ScriptExportRun
+ */
+export interface ScriptExportRun {
+    /**
+     * 
+     * @type {number}
+     * @memberof ScriptExportRun
+     */
+    durationMs?: number;
+    /**
+     * 
+     * @type {Date}
+     * @memberof ScriptExportRun
+     */
+    endedAt?: Date;
+    /**
+     * 
+     * @type {number}
+     * @memberof ScriptExportRun
+     */
+    exitCode: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof ScriptExportRun
+     */
+    id: string;
+    /**
+     * "build" for a dependency build, "run" for an execution.
+     * @type {string}
+     * @memberof ScriptExportRun
+     */
+    kind: string;
+    /**
+     * API path that returns the run's logs while the run is kept.
+     * @type {string}
+     * @memberof ScriptExportRun
+     */
+    logsPath: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ScriptExportRun
+     */
+    message?: string;
+    /**
+     * 
+     * @type {Date}
+     * @memberof ScriptExportRun
+     */
+    queuedAt?: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof ScriptExportRun
+     */
+    startedAt?: Date;
+    /**
+     * 
+     * @type {string}
+     * @memberof ScriptExportRun
+     */
+    status: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ScriptExportRun
+     */
+    trigger: string;
+}
+
+/**
+ * Check if a given object implements the ScriptExportRun interface.
+ */
+export function instanceOfScriptExportRun(value: object): value is ScriptExportRun {
+    if (!('exitCode' in value) || value['exitCode'] === undefined) return false;
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('kind' in value) || value['kind'] === undefined) return false;
+    if (!('logsPath' in value) || value['logsPath'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('trigger' in value) || value['trigger'] === undefined) return false;
+    return true;
+}
+
+export function ScriptExportRunFromJSON(json: any): ScriptExportRun {
+    return ScriptExportRunFromJSONTyped(json, false);
+}
+
+export function ScriptExportRunFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptExportRun {
+    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'],
+        'id': json['id'],
+        'kind': json['kind'],
+        'logsPath': json['logsPath'],
+        'message': json['message'] == null ? undefined : json['message'],
+        'queuedAt': json['queuedAt'] == null ? undefined : (new Date(json['queuedAt'])),
+        'startedAt': json['startedAt'] == null ? undefined : (new Date(json['startedAt'])),
+        'status': json['status'],
+        'trigger': json['trigger'],
+    };
+}
+
+export function ScriptExportRunToJSON(json: any): ScriptExportRun {
+    return ScriptExportRunToJSONTyped(json, false);
+}
+
+export function ScriptExportRunToJSONTyped(value?: ScriptExportRun | 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'],
+        'id': value['id'],
+        'kind': value['kind'],
+        'logsPath': value['logsPath'],
+        'message': value['message'],
+        'queuedAt': value['queuedAt'] == null ? undefined : ((value['queuedAt']).toISOString()),
+        'startedAt': value['startedAt'] == null ? undefined : ((value['startedAt']).toISOString()),
+        'status': value['status'],
+        'trigger': value['trigger'],
+    };
+}
+

package/src/models/ScriptKey.ts

@@ -0,0 +1,109 @@
+/* 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 ScriptKey
+ */
+export interface ScriptKey {
+    /**
+     * 
+     * @type {Date}
+     * @memberof ScriptKey
+     */
+    expiresAt?: Date;
+    /**
+     * Why the last automatic rotation failed or why the key needs re-authorising.
+     * @type {string}
+     * @memberof ScriptKey
+     */
+    lastError?: string;
+    /**
+     * User whose permissions the key acts with.
+     * @type {number}
+     * @memberof ScriptKey
+     */
+    ownerUserId?: number;
+    /**
+     * When the key is next replaced automatically.
+     * @type {Date}
+     * @memberof ScriptKey
+     */
+    rotateAt?: Date;
+    /**
+     * Whether the script's Spaciv API key is usable. While "needs_reauthorisation", runs are paused until someone with *Manage my account* re-authorises it.
+     * @type {string}
+     * @memberof ScriptKey
+     */
+    status: ScriptKeyStatusEnum;
+}
+
+
+/**
+ * @export
+ */
+export const ScriptKeyStatusEnum = {
+    Active: 'active',
+    NeedsReauthorisation: 'needs_reauthorisation'
+} as const;
+export type ScriptKeyStatusEnum = typeof ScriptKeyStatusEnum[keyof typeof ScriptKeyStatusEnum];
+
+
+/**
+ * Check if a given object implements the ScriptKey interface.
+ */
+export function instanceOfScriptKey(value: object): value is ScriptKey {
+    if (!('status' in value) || value['status'] === undefined) return false;
+    return true;
+}
+
+export function ScriptKeyFromJSON(json: any): ScriptKey {
+    return ScriptKeyFromJSONTyped(json, false);
+}
+
+export function ScriptKeyFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptKey {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'expiresAt': json['expiresAt'] == null ? undefined : (new Date(json['expiresAt'])),
+        'lastError': json['lastError'] == null ? undefined : json['lastError'],
+        'ownerUserId': json['ownerUserId'] == null ? undefined : json['ownerUserId'],
+        'rotateAt': json['rotateAt'] == null ? undefined : (new Date(json['rotateAt'])),
+        'status': json['status'],
+    };
+}
+
+export function ScriptKeyToJSON(json: any): ScriptKey {
+    return ScriptKeyToJSONTyped(json, false);
+}
+
+export function ScriptKeyToJSONTyped(value?: ScriptKey | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'expiresAt': value['expiresAt'] == null ? undefined : ((value['expiresAt']).toISOString()),
+        'lastError': value['lastError'],
+        'ownerUserId': value['ownerUserId'],
+        'rotateAt': value['rotateAt'] == null ? undefined : ((value['rotateAt']).toISOString()),
+        'status': value['status'],
+    };
+}
+