@spaciv/sdk 0.1.1 → 0.1.2

package/dist/models/ScriptAuditEntry.d.ts

@@ -0,0 +1,67 @@
+/**
+ * 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 ScriptAuditEntry
+ */
+export interface ScriptAuditEntry {
+    /**
+     *
+     * @type {string}
+     * @memberof ScriptAuditEntry
+     */
+    actorType: ScriptAuditEntryActorTypeEnum;
+    /**
+     * What changed, for example created, updated, api-key-rotated or needs-reauthorisation.
+     * @type {string}
+     * @memberof ScriptAuditEntry
+     */
+    kind: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof ScriptAuditEntry
+     */
+    modifiedAt: Date;
+    /**
+     * User who made the change, when actorType is user.
+     * @type {number}
+     * @memberof ScriptAuditEntry
+     */
+    modifiedBy?: number;
+    /**
+     *
+     * @type {{ [key: string]: string; }}
+     * @memberof ScriptAuditEntry
+     */
+    params?: {
+        [key: string]: string;
+    };
+}
+/**
+ * @export
+ */
+export declare const ScriptAuditEntryActorTypeEnum: {
+    readonly User: "user";
+    readonly System: "system";
+    readonly Anonymous: "anonymous";
+};
+export type ScriptAuditEntryActorTypeEnum = typeof ScriptAuditEntryActorTypeEnum[keyof typeof ScriptAuditEntryActorTypeEnum];
+/**
+ * Check if a given object implements the ScriptAuditEntry interface.
+ */
+export declare function instanceOfScriptAuditEntry(value: object): value is ScriptAuditEntry;
+export declare function ScriptAuditEntryFromJSON(json: any): ScriptAuditEntry;
+export declare function ScriptAuditEntryFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptAuditEntry;
+export declare function ScriptAuditEntryToJSON(json: any): ScriptAuditEntry;
+export declare function ScriptAuditEntryToJSONTyped(value?: ScriptAuditEntry | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ScriptAuditEntry.js

@@ -0,0 +1,71 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ScriptAuditEntryActorTypeEnum = void 0;
+exports.instanceOfScriptAuditEntry = instanceOfScriptAuditEntry;
+exports.ScriptAuditEntryFromJSON = ScriptAuditEntryFromJSON;
+exports.ScriptAuditEntryFromJSONTyped = ScriptAuditEntryFromJSONTyped;
+exports.ScriptAuditEntryToJSON = ScriptAuditEntryToJSON;
+exports.ScriptAuditEntryToJSONTyped = ScriptAuditEntryToJSONTyped;
+/**
+ * @export
+ */
+exports.ScriptAuditEntryActorTypeEnum = {
+    User: 'user',
+    System: 'system',
+    Anonymous: 'anonymous'
+};
+/**
+ * Check if a given object implements the ScriptAuditEntry interface.
+ */
+function instanceOfScriptAuditEntry(value) {
+    if (!('actorType' in value) || value['actorType'] === undefined)
+        return false;
+    if (!('kind' in value) || value['kind'] === undefined)
+        return false;
+    if (!('modifiedAt' in value) || value['modifiedAt'] === undefined)
+        return false;
+    return true;
+}
+function ScriptAuditEntryFromJSON(json) {
+    return ScriptAuditEntryFromJSONTyped(json, false);
+}
+function ScriptAuditEntryFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'actorType': json['actorType'],
+        'kind': json['kind'],
+        'modifiedAt': (new Date(json['modifiedAt'])),
+        'modifiedBy': json['modifiedBy'] == null ? undefined : json['modifiedBy'],
+        'params': json['params'] == null ? undefined : json['params'],
+    };
+}
+function ScriptAuditEntryToJSON(json) {
+    return ScriptAuditEntryToJSONTyped(json, false);
+}
+function ScriptAuditEntryToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'actorType': value['actorType'],
+        'kind': value['kind'],
+        'modifiedAt': ((value['modifiedAt']).toISOString()),
+        'modifiedBy': value['modifiedBy'],
+        'params': value['params'],
+    };
+}

package/dist/models/ScriptAuditResBody.d.ts

@@ -0,0 +1,39 @@
+/**
+ * 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 { ScriptAuditEntry } from './ScriptAuditEntry';
+/**
+ *
+ * @export
+ * @interface ScriptAuditResBody
+ */
+export interface ScriptAuditResBody {
+    /**
+     *
+     * @type {Array<ScriptAuditEntry>}
+     * @memberof ScriptAuditResBody
+     */
+    entries: Array<ScriptAuditEntry>;
+    /**
+     *
+     * @type {string}
+     * @memberof ScriptAuditResBody
+     */
+    nextCursor?: string;
+}
+/**
+ * Check if a given object implements the ScriptAuditResBody interface.
+ */
+export declare function instanceOfScriptAuditResBody(value: object): value is ScriptAuditResBody;
+export declare function ScriptAuditResBodyFromJSON(json: any): ScriptAuditResBody;
+export declare function ScriptAuditResBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptAuditResBody;
+export declare function ScriptAuditResBodyToJSON(json: any): ScriptAuditResBody;
+export declare function ScriptAuditResBodyToJSONTyped(value?: ScriptAuditResBody | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ScriptAuditResBody.js

@@ -0,0 +1,53 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfScriptAuditResBody = instanceOfScriptAuditResBody;
+exports.ScriptAuditResBodyFromJSON = ScriptAuditResBodyFromJSON;
+exports.ScriptAuditResBodyFromJSONTyped = ScriptAuditResBodyFromJSONTyped;
+exports.ScriptAuditResBodyToJSON = ScriptAuditResBodyToJSON;
+exports.ScriptAuditResBodyToJSONTyped = ScriptAuditResBodyToJSONTyped;
+const ScriptAuditEntry_1 = require("./ScriptAuditEntry");
+/**
+ * Check if a given object implements the ScriptAuditResBody interface.
+ */
+function instanceOfScriptAuditResBody(value) {
+    if (!('entries' in value) || value['entries'] === undefined)
+        return false;
+    return true;
+}
+function ScriptAuditResBodyFromJSON(json) {
+    return ScriptAuditResBodyFromJSONTyped(json, false);
+}
+function ScriptAuditResBodyFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'entries': (json['entries'].map(ScriptAuditEntry_1.ScriptAuditEntryFromJSON)),
+        'nextCursor': json['nextCursor'] == null ? undefined : json['nextCursor'],
+    };
+}
+function ScriptAuditResBodyToJSON(json) {
+    return ScriptAuditResBodyToJSONTyped(json, false);
+}
+function ScriptAuditResBodyToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'entries': (value['entries'].map(ScriptAuditEntry_1.ScriptAuditEntryToJSON)),
+        'nextCursor': value['nextCursor'],
+    };
+}

package/dist/models/ScriptDetail.d.ts

@@ -0,0 +1,161 @@
+/**
+ * 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 { ScriptKey } from './ScriptKey';
+import type { ScriptSchedule } from './ScriptSchedule';
+import type { ScriptRuntime } from './ScriptRuntime';
+/**
+ *
+ * @export
+ * @interface ScriptDetail
+ */
+export interface ScriptDetail {
+    /**
+     *
+     * @type {Date}
+     * @memberof ScriptDetail
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {number}
+     * @memberof ScriptDetail
+     */
+    createdBy: number;
+    /**
+     *
+     * @type {string}
+     * @memberof ScriptDetail
+     */
+    description?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ScriptDetail
+     */
+    enabled: boolean;
+    /**
+     * Source files keyed by path.
+     * @type {{ [key: string]: string; }}
+     * @memberof ScriptDetail
+     */
+    files: {
+        [key: string]: string;
+    };
+    /**
+     *
+     * @type {string}
+     * @memberof ScriptDetail
+     */
+    id: string;
+    /**
+     *
+     * @type {ScriptKey}
+     * @memberof ScriptDetail
+     */
+    key: ScriptKey;
+    /**
+     *
+     * @type {string}
+     * @memberof ScriptDetail
+     */
+    language: ScriptDetailLanguageEnum;
+    /**
+     * Dependency manifest: requirements.txt for Python, go.mod for Go, package.json for JavaScript.
+     * @type {string}
+     * @memberof ScriptDetail
+     */
+    manifest?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ScriptDetail
+     */
+    name: string;
+    /**
+     * Project the script's API key is scoped to. Absent when it acts across the account.
+     * @type {number}
+     * @memberof ScriptDetail
+     */
+    project?: number;
+    /**
+     * Pass back when updating, so a concurrent change is reported rather than overwritten.
+     * @type {number}
+     * @memberof ScriptDetail
+     */
+    revision: number;
+    /**
+     * Live state from the runner; absent if the runner could not be reached.
+     * @type {ScriptRuntime}
+     * @memberof ScriptDetail
+     */
+    runtime?: ScriptRuntime;
+    /**
+     *
+     * @type {ScriptSchedule}
+     * @memberof ScriptDetail
+     */
+    schedule: ScriptSchedule;
+    /**
+     * Names of the secrets set on the script. Values are never returned.
+     * @type {Array<string>}
+     * @memberof ScriptDetail
+     */
+    secretNames: Array<string>;
+    /**
+     * The handler signature the script implements.
+     * @type {string}
+     * @memberof ScriptDetail
+     */
+    type: ScriptDetailTypeEnum;
+    /**
+     *
+     * @type {Date}
+     * @memberof ScriptDetail
+     */
+    updatedAt: Date;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ScriptDetail
+     */
+    webhook: boolean;
+    /**
+     * Returned only when a webhook URL is first issued; it cannot be retrieved later.
+     * @type {string}
+     * @memberof ScriptDetail
+     */
+    webhookUrl?: string;
+}
+/**
+ * @export
+ */
+export declare const ScriptDetailLanguageEnum: {
+    readonly Python: "python";
+    readonly Go: "go";
+    readonly Javascript: "javascript";
+};
+export type ScriptDetailLanguageEnum = typeof ScriptDetailLanguageEnum[keyof typeof ScriptDetailLanguageEnum];
+/**
+ * @export
+ */
+export declare const ScriptDetailTypeEnum: {
+    readonly Integration: "integration";
+};
+export type ScriptDetailTypeEnum = typeof ScriptDetailTypeEnum[keyof typeof ScriptDetailTypeEnum];
+/**
+ * Check if a given object implements the ScriptDetail interface.
+ */
+export declare function instanceOfScriptDetail(value: object): value is ScriptDetail;
+export declare function ScriptDetailFromJSON(json: any): ScriptDetail;
+export declare function ScriptDetailFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptDetail;
+export declare function ScriptDetailToJSON(json: any): ScriptDetail;
+export declare function ScriptDetailToJSONTyped(value?: ScriptDetail | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ScriptDetail.js

@@ -0,0 +1,130 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ScriptDetailTypeEnum = exports.ScriptDetailLanguageEnum = void 0;
+exports.instanceOfScriptDetail = instanceOfScriptDetail;
+exports.ScriptDetailFromJSON = ScriptDetailFromJSON;
+exports.ScriptDetailFromJSONTyped = ScriptDetailFromJSONTyped;
+exports.ScriptDetailToJSON = ScriptDetailToJSON;
+exports.ScriptDetailToJSONTyped = ScriptDetailToJSONTyped;
+const ScriptKey_1 = require("./ScriptKey");
+const ScriptSchedule_1 = require("./ScriptSchedule");
+const ScriptRuntime_1 = require("./ScriptRuntime");
+/**
+ * @export
+ */
+exports.ScriptDetailLanguageEnum = {
+    Python: 'python',
+    Go: 'go',
+    Javascript: 'javascript'
+};
+/**
+ * @export
+ */
+exports.ScriptDetailTypeEnum = {
+    Integration: 'integration'
+};
+/**
+ * Check if a given object implements the ScriptDetail interface.
+ */
+function instanceOfScriptDetail(value) {
+    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 (!('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;
+}
+function ScriptDetailFromJSON(json) {
+    return ScriptDetailFromJSONTyped(json, false);
+}
+function ScriptDetailFromJSONTyped(json, ignoreDiscriminator) {
+    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': (0, ScriptKey_1.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'],
+        'runtime': json['runtime'] == null ? undefined : (0, ScriptRuntime_1.ScriptRuntimeFromJSON)(json['runtime']),
+        'schedule': (0, ScriptSchedule_1.ScriptScheduleFromJSON)(json['schedule']),
+        'secretNames': json['secretNames'],
+        'type': json['type'],
+        'updatedAt': (new Date(json['updatedAt'])),
+        'webhook': json['webhook'],
+        'webhookUrl': json['webhookUrl'] == null ? undefined : json['webhookUrl'],
+    };
+}
+function ScriptDetailToJSON(json) {
+    return ScriptDetailToJSONTyped(json, false);
+}
+function ScriptDetailToJSONTyped(value, ignoreDiscriminator = false) {
+    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': (0, ScriptKey_1.ScriptKeyToJSON)(value['key']),
+        'language': value['language'],
+        'manifest': value['manifest'],
+        'name': value['name'],
+        'project': value['project'],
+        'revision': value['revision'],
+        'runtime': (0, ScriptRuntime_1.ScriptRuntimeToJSON)(value['runtime']),
+        'schedule': (0, ScriptSchedule_1.ScriptScheduleToJSON)(value['schedule']),
+        'secretNames': value['secretNames'],
+        'type': value['type'],
+        'updatedAt': ((value['updatedAt']).toISOString()),
+        'webhook': value['webhook'],
+        'webhookUrl': value['webhookUrl'],
+    };
+}