@spaciv/sdk 0.1.0 → 0.1.2

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'],
+    };
+}
+

package/src/models/ScriptListResBody.ts

@@ -0,0 +1,74 @@
+/* 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 { ScriptSummary } from './ScriptSummary';
+import {
+    ScriptSummaryFromJSON,
+    ScriptSummaryFromJSONTyped,
+    ScriptSummaryToJSON,
+    ScriptSummaryToJSONTyped,
+} from './ScriptSummary';
+
+/**
+ * 
+ * @export
+ * @interface ScriptListResBody
+ */
+export interface ScriptListResBody {
+    /**
+     * 
+     * @type {Array<ScriptSummary>}
+     * @memberof ScriptListResBody
+     */
+    scripts: Array<ScriptSummary>;
+}
+
+/**
+ * Check if a given object implements the ScriptListResBody interface.
+ */
+export function instanceOfScriptListResBody(value: object): value is ScriptListResBody {
+    if (!('scripts' in value) || value['scripts'] === undefined) return false;
+    return true;
+}
+
+export function ScriptListResBodyFromJSON(json: any): ScriptListResBody {
+    return ScriptListResBodyFromJSONTyped(json, false);
+}
+
+export function ScriptListResBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptListResBody {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'scripts': ((json['scripts'] as Array<any>).map(ScriptSummaryFromJSON)),
+    };
+}
+
+export function ScriptListResBodyToJSON(json: any): ScriptListResBody {
+    return ScriptListResBodyToJSONTyped(json, false);
+}
+
+export function ScriptListResBodyToJSONTyped(value?: ScriptListResBody | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'scripts': ((value['scripts'] as Array<any>).map(ScriptSummaryToJSON)),
+    };
+}
+

package/src/models/ScriptLogLine.ts

@@ -0,0 +1,75 @@
+/* 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 ScriptLogLine
+ */
+export interface ScriptLogLine {
+    /**
+     * 
+     * @type {string}
+     * @memberof ScriptLogLine
+     */
+    message: string;
+    /**
+     * 
+     * @type {Date}
+     * @memberof ScriptLogLine
+     */
+    timestamp: Date;
+}
+
+/**
+ * Check if a given object implements the ScriptLogLine interface.
+ */
+export function instanceOfScriptLogLine(value: object): value is ScriptLogLine {
+    if (!('message' in value) || value['message'] === undefined) return false;
+    if (!('timestamp' in value) || value['timestamp'] === undefined) return false;
+    return true;
+}
+
+export function ScriptLogLineFromJSON(json: any): ScriptLogLine {
+    return ScriptLogLineFromJSONTyped(json, false);
+}
+
+export function ScriptLogLineFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptLogLine {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'message': json['message'],
+        'timestamp': (new Date(json['timestamp'])),
+    };
+}
+
+export function ScriptLogLineToJSON(json: any): ScriptLogLine {
+    return ScriptLogLineToJSONTyped(json, false);
+}
+
+export function ScriptLogLineToJSONTyped(value?: ScriptLogLine | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'message': value['message'],
+        'timestamp': ((value['timestamp']).toISOString()),
+    };
+}
+

package/src/models/ScriptPatchReqBody.ts

@@ -0,0 +1,158 @@
+/* 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 { ScriptSchedule } from './ScriptSchedule';
+import {
+    ScriptScheduleFromJSON,
+    ScriptScheduleFromJSONTyped,
+    ScriptScheduleToJSON,
+    ScriptScheduleToJSONTyped,
+} from './ScriptSchedule';
+
+/**
+ * 
+ * @export
+ * @interface ScriptPatchReqBody
+ */
+export interface ScriptPatchReqBody {
+    /**
+     * 
+     * @type {string}
+     * @memberof ScriptPatchReqBody
+     */
+    description?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ScriptPatchReqBody
+     */
+    enabled?: boolean;
+    /**
+     * 
+     * @type {{ [key: string]: string; }}
+     * @memberof ScriptPatchReqBody
+     */
+    files?: { [key: string]: string; };
+    /**
+     * 
+     * @type {string}
+     * @memberof ScriptPatchReqBody
+     */
+    language?: ScriptPatchReqBodyLanguageEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof ScriptPatchReqBody
+     */
+    manifest?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ScriptPatchReqBody
+     */
+    name?: string;
+    /**
+     * 0 removes the project.
+     * @type {number}
+     * @memberof ScriptPatchReqBody
+     */
+    project?: number;
+    /**
+     * The revision last read; a different current revision is rejected with 409.
+     * @type {number}
+     * @memberof ScriptPatchReqBody
+     */
+    revision: number;
+    /**
+     * 
+     * @type {ScriptSchedule}
+     * @memberof ScriptPatchReqBody
+     */
+    schedule?: ScriptSchedule;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ScriptPatchReqBody
+     */
+    webhook?: boolean;
+}
+
+
+/**
+ * @export
+ */
+export const ScriptPatchReqBodyLanguageEnum = {
+    Python: 'python',
+    Go: 'go',
+    Javascript: 'javascript'
+} as const;
+export type ScriptPatchReqBodyLanguageEnum = typeof ScriptPatchReqBodyLanguageEnum[keyof typeof ScriptPatchReqBodyLanguageEnum];
+
+
+/**
+ * Check if a given object implements the ScriptPatchReqBody interface.
+ */
+export function instanceOfScriptPatchReqBody(value: object): value is ScriptPatchReqBody {
+    if (!('revision' in value) || value['revision'] === undefined) return false;
+    return true;
+}
+
+export function ScriptPatchReqBodyFromJSON(json: any): ScriptPatchReqBody {
+    return ScriptPatchReqBodyFromJSONTyped(json, false);
+}
+
+export function ScriptPatchReqBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptPatchReqBody {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'description': json['description'] == null ? undefined : json['description'],
+        'enabled': json['enabled'] == null ? undefined : json['enabled'],
+        'files': json['files'] == null ? undefined : json['files'],
+        'language': json['language'] == null ? undefined : json['language'],
+        'manifest': json['manifest'] == null ? undefined : json['manifest'],
+        'name': json['name'] == null ? undefined : json['name'],
+        'project': json['project'] == null ? undefined : json['project'],
+        'revision': json['revision'],
+        'schedule': json['schedule'] == null ? undefined : ScriptScheduleFromJSON(json['schedule']),
+        'webhook': json['webhook'] == null ? undefined : json['webhook'],
+    };
+}
+
+export function ScriptPatchReqBodyToJSON(json: any): ScriptPatchReqBody {
+    return ScriptPatchReqBodyToJSONTyped(json, false);
+}
+
+export function ScriptPatchReqBodyToJSONTyped(value?: ScriptPatchReqBody | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'description': value['description'],
+        'enabled': value['enabled'],
+        'files': value['files'],
+        'language': value['language'],
+        'manifest': value['manifest'],
+        'name': value['name'],
+        'project': value['project'],
+        'revision': value['revision'],
+        'schedule': ScriptScheduleToJSON(value['schedule']),
+        'webhook': value['webhook'],
+    };
+}
+