@spaciv/sdk 0.1.1 → 0.1.2

package/src/apis/UsersApi.ts

@@ -98,7 +98,7 @@ export interface UsersApiInterface {
     createImport(requestParameters: UsersApiCreateImportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 
     /**
-     * Permanently deletes the authenticated user\'s own account and all associated data. Requires the *Edit my user profile* permission. This action is irreversible.
+     * Permanently deletes the authenticated user\'s own account and all associated data. Requires the *Edit my user profile* permission. This action is irreversible. A script\'s own API key cannot delete its user.
      * @summary Delete the current user\'s account
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -107,7 +107,7 @@ export interface UsersApiInterface {
     deleteRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
 
     /**
-     * Permanently deletes the authenticated user\'s own account and all associated data. Requires the *Edit my user profile* permission. This action is irreversible.
+     * Permanently deletes the authenticated user\'s own account and all associated data. Requires the *Edit my user profile* permission. This action is irreversible. A script\'s own API key cannot delete its user.
      * Delete the current user\'s account
      */
     delete(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
@@ -317,7 +317,7 @@ export class UsersApi extends runtime.BaseAPI implements UsersApiInterface {
     }
 
     /**
-     * Permanently deletes the authenticated user\'s own account and all associated data. Requires the *Edit my user profile* permission. This action is irreversible.
+     * Permanently deletes the authenticated user\'s own account and all associated data. Requires the *Edit my user profile* permission. This action is irreversible. A script\'s own API key cannot delete its user.
      * Delete the current user\'s account
      */
     async deleteRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
@@ -347,7 +347,7 @@ export class UsersApi extends runtime.BaseAPI implements UsersApiInterface {
     }
 
     /**
-     * Permanently deletes the authenticated user\'s own account and all associated data. Requires the *Edit my user profile* permission. This action is irreversible.
+     * Permanently deletes the authenticated user\'s own account and all associated data. Requires the *Edit my user profile* permission. This action is irreversible. A script\'s own API key cannot delete its user.
      * Delete the current user\'s account
      */
     async delete(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {

package/src/apis/index.ts

@@ -22,6 +22,7 @@ export * from './ProjectsApi';
 export * from './PropertiesApi';
 export * from './ReportsApi';
 export * from './ScenariosApi';
+export * from './ScriptsApi';
 export * from './ServiceApi';
 export * from './SpaceRulesetsApi';
 export * from './TemplateProjectsApi';

package/src/models/APIKey.ts

@@ -67,6 +67,12 @@ export interface APIKey {
      * @memberof APIKey
      */
     projectId: number;
+    /**
+     * Set when the key is created and rotated by a script; it can't be revoked here.
+     * @type {string}
+     * @memberof APIKey
+     */
+    scriptId?: string;
 }
 
 /**
@@ -101,6 +107,7 @@ export function APIKeyFromJSONTyped(json: any, ignoreDiscriminator: boolean): AP
         'name': json['name'],
         'prefix': json['prefix'],
         'projectId': json['projectId'],
+        'scriptId': json['scriptId'] == null ? undefined : json['scriptId'],
     };
 }
 
@@ -123,6 +130,7 @@ export function APIKeyToJSONTyped(value?: APIKey | null, ignoreDiscriminator: bo
         'name': value['name'],
         'prefix': value['prefix'],
         'projectId': value['projectId'],
+        'scriptId': value['scriptId'],
     };
 }
 

package/src/models/ScriptAuditEntry.ts

@@ -0,0 +1,112 @@
+/* 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 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 const ScriptAuditEntryActorTypeEnum = {
+    User: 'user',
+    System: 'system',
+    Anonymous: 'anonymous'
+} as const;
+export type ScriptAuditEntryActorTypeEnum = typeof ScriptAuditEntryActorTypeEnum[keyof typeof ScriptAuditEntryActorTypeEnum];
+
+
+/**
+ * Check if a given object implements the ScriptAuditEntry interface.
+ */
+export function instanceOfScriptAuditEntry(value: object): value is ScriptAuditEntry {
+    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;
+}
+
+export function ScriptAuditEntryFromJSON(json: any): ScriptAuditEntry {
+    return ScriptAuditEntryFromJSONTyped(json, false);
+}
+
+export function ScriptAuditEntryFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptAuditEntry {
+    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'],
+    };
+}
+
+export function ScriptAuditEntryToJSON(json: any): ScriptAuditEntry {
+    return ScriptAuditEntryToJSONTyped(json, false);
+}
+
+export function ScriptAuditEntryToJSONTyped(value?: ScriptAuditEntry | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'actorType': value['actorType'],
+        'kind': value['kind'],
+        'modifiedAt': ((value['modifiedAt']).toISOString()),
+        'modifiedBy': value['modifiedBy'],
+        'params': value['params'],
+    };
+}
+

package/src/models/ScriptAuditResBody.ts

@@ -0,0 +1,82 @@
+/* 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 { ScriptAuditEntry } from './ScriptAuditEntry';
+import {
+    ScriptAuditEntryFromJSON,
+    ScriptAuditEntryFromJSONTyped,
+    ScriptAuditEntryToJSON,
+    ScriptAuditEntryToJSONTyped,
+} 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 function instanceOfScriptAuditResBody(value: object): value is ScriptAuditResBody {
+    if (!('entries' in value) || value['entries'] === undefined) return false;
+    return true;
+}
+
+export function ScriptAuditResBodyFromJSON(json: any): ScriptAuditResBody {
+    return ScriptAuditResBodyFromJSONTyped(json, false);
+}
+
+export function ScriptAuditResBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptAuditResBody {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'entries': ((json['entries'] as Array<any>).map(ScriptAuditEntryFromJSON)),
+        'nextCursor': json['nextCursor'] == null ? undefined : json['nextCursor'],
+    };
+}
+
+export function ScriptAuditResBodyToJSON(json: any): ScriptAuditResBody {
+    return ScriptAuditResBodyToJSONTyped(json, false);
+}
+
+export function ScriptAuditResBodyToJSONTyped(value?: ScriptAuditResBody | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'entries': ((value['entries'] as Array<any>).map(ScriptAuditEntryToJSON)),
+        'nextCursor': value['nextCursor'],
+    };
+}
+

package/src/models/ScriptDetail.ts

@@ -0,0 +1,265 @@
+/* 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';
+
+/**
+ * 
+ * @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 const ScriptDetailLanguageEnum = {
+    Python: 'python',
+    Go: 'go',
+    Javascript: 'javascript'
+} as const;
+export type ScriptDetailLanguageEnum = typeof ScriptDetailLanguageEnum[keyof typeof ScriptDetailLanguageEnum];
+
+/**
+ * @export
+ */
+export const ScriptDetailTypeEnum = {
+    Integration: 'integration'
+} as const;
+export type ScriptDetailTypeEnum = typeof ScriptDetailTypeEnum[keyof typeof ScriptDetailTypeEnum];
+
+
+/**
+ * Check if a given object implements the ScriptDetail interface.
+ */
+export function instanceOfScriptDetail(value: object): value is ScriptDetail {
+    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;
+}
+
+export function ScriptDetailFromJSON(json: any): ScriptDetail {
+    return ScriptDetailFromJSONTyped(json, false);
+}
+
+export function ScriptDetailFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptDetail {
+    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'],
+        '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 ScriptDetailToJSON(json: any): ScriptDetail {
+    return ScriptDetailToJSONTyped(json, false);
+}
+
+export function ScriptDetailToJSONTyped(value?: ScriptDetail | 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'],
+        'runtime': ScriptRuntimeToJSON(value['runtime']),
+        'schedule': ScriptScheduleToJSON(value['schedule']),
+        'secretNames': value['secretNames'],
+        'type': value['type'],
+        'updatedAt': ((value['updatedAt']).toISOString()),
+        'webhook': value['webhook'],
+        'webhookUrl': value['webhookUrl'],
+    };
+}
+