@spaciv/sdk 0.1.1 → 0.1.2

package/src/models/ScriptSecretsResBody.ts

@@ -0,0 +1,225 @@
+/* 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';
+
+/**
+ * 
+ * @export
+ * @interface ScriptSecretsResBody
+ */
+export interface ScriptSecretsResBody {
+    /**
+     * 
+     * @type {Date}
+     * @memberof ScriptSecretsResBody
+     */
+    createdAt: Date;
+    /**
+     * 
+     * @type {number}
+     * @memberof ScriptSecretsResBody
+     */
+    createdBy: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof ScriptSecretsResBody
+     */
+    description?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ScriptSecretsResBody
+     */
+    enabled: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof ScriptSecretsResBody
+     */
+    id: string;
+    /**
+     * 
+     * @type {ScriptKey}
+     * @memberof ScriptSecretsResBody
+     */
+    key: ScriptKey;
+    /**
+     * 
+     * @type {string}
+     * @memberof ScriptSecretsResBody
+     */
+    language: ScriptSecretsResBodyLanguageEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof ScriptSecretsResBody
+     */
+    name: string;
+    /**
+     * Project the script's API key is scoped to. Absent when it acts across the account.
+     * @type {number}
+     * @memberof ScriptSecretsResBody
+     */
+    project?: number;
+    /**
+     * Pass back when updating, so a concurrent change is reported rather than overwritten.
+     * @type {number}
+     * @memberof ScriptSecretsResBody
+     */
+    revision: number;
+    /**
+     * 
+     * @type {ScriptSchedule}
+     * @memberof ScriptSecretsResBody
+     */
+    schedule: ScriptSchedule;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof ScriptSecretsResBody
+     */
+    secretNames: Array<string>;
+    /**
+     * The handler signature the script implements.
+     * @type {string}
+     * @memberof ScriptSecretsResBody
+     */
+    type: ScriptSecretsResBodyTypeEnum;
+    /**
+     * 
+     * @type {Date}
+     * @memberof ScriptSecretsResBody
+     */
+    updatedAt: Date;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ScriptSecretsResBody
+     */
+    webhook: boolean;
+}
+
+
+/**
+ * @export
+ */
+export const ScriptSecretsResBodyLanguageEnum = {
+    Python: 'python',
+    Go: 'go',
+    Javascript: 'javascript'
+} as const;
+export type ScriptSecretsResBodyLanguageEnum = typeof ScriptSecretsResBodyLanguageEnum[keyof typeof ScriptSecretsResBodyLanguageEnum];
+
+/**
+ * @export
+ */
+export const ScriptSecretsResBodyTypeEnum = {
+    Integration: 'integration'
+} as const;
+export type ScriptSecretsResBodyTypeEnum = typeof ScriptSecretsResBodyTypeEnum[keyof typeof ScriptSecretsResBodyTypeEnum];
+
+
+/**
+ * Check if a given object implements the ScriptSecretsResBody interface.
+ */
+export function instanceOfScriptSecretsResBody(value: object): value is ScriptSecretsResBody {
+    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 (!('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 ScriptSecretsResBodyFromJSON(json: any): ScriptSecretsResBody {
+    return ScriptSecretsResBodyFromJSONTyped(json, false);
+}
+
+export function ScriptSecretsResBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptSecretsResBody {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'createdAt': (new Date(json['createdAt'])),
+        'createdBy': json['createdBy'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'enabled': json['enabled'],
+        'id': json['id'],
+        'key': ScriptKeyFromJSON(json['key']),
+        'language': json['language'],
+        'name': json['name'],
+        'project': json['project'] == null ? undefined : json['project'],
+        'revision': json['revision'],
+        'schedule': ScriptScheduleFromJSON(json['schedule']),
+        'secretNames': json['secretNames'],
+        'type': json['type'],
+        'updatedAt': (new Date(json['updatedAt'])),
+        'webhook': json['webhook'],
+    };
+}
+
+export function ScriptSecretsResBodyToJSON(json: any): ScriptSecretsResBody {
+    return ScriptSecretsResBodyToJSONTyped(json, false);
+}
+
+export function ScriptSecretsResBodyToJSONTyped(value?: ScriptSecretsResBody | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'createdAt': ((value['createdAt']).toISOString()),
+        'createdBy': value['createdBy'],
+        'description': value['description'],
+        'enabled': value['enabled'],
+        'id': value['id'],
+        'key': ScriptKeyToJSON(value['key']),
+        'language': value['language'],
+        'name': value['name'],
+        'project': value['project'],
+        'revision': value['revision'],
+        'schedule': ScriptScheduleToJSON(value['schedule']),
+        'secretNames': value['secretNames'],
+        'type': value['type'],
+        'updatedAt': ((value['updatedAt']).toISOString()),
+        'webhook': value['webhook'],
+    };
+}
+

package/src/models/ScriptSummary.ts

@@ -0,0 +1,216 @@
+/* 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';
+
+/**
+ * 
+ * @export
+ * @interface ScriptSummary
+ */
+export interface ScriptSummary {
+    /**
+     * 
+     * @type {Date}
+     * @memberof ScriptSummary
+     */
+    createdAt: Date;
+    /**
+     * 
+     * @type {number}
+     * @memberof ScriptSummary
+     */
+    createdBy: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof ScriptSummary
+     */
+    description?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ScriptSummary
+     */
+    enabled: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof ScriptSummary
+     */
+    id: string;
+    /**
+     * 
+     * @type {ScriptKey}
+     * @memberof ScriptSummary
+     */
+    key: ScriptKey;
+    /**
+     * 
+     * @type {string}
+     * @memberof ScriptSummary
+     */
+    language: ScriptSummaryLanguageEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof ScriptSummary
+     */
+    name: string;
+    /**
+     * Project the script's API key is scoped to. Absent when it acts across the account.
+     * @type {number}
+     * @memberof ScriptSummary
+     */
+    project?: number;
+    /**
+     * Pass back when updating, so a concurrent change is reported rather than overwritten.
+     * @type {number}
+     * @memberof ScriptSummary
+     */
+    revision: number;
+    /**
+     * 
+     * @type {ScriptSchedule}
+     * @memberof ScriptSummary
+     */
+    schedule: ScriptSchedule;
+    /**
+     * The handler signature the script implements.
+     * @type {string}
+     * @memberof ScriptSummary
+     */
+    type: ScriptSummaryTypeEnum;
+    /**
+     * 
+     * @type {Date}
+     * @memberof ScriptSummary
+     */
+    updatedAt: Date;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ScriptSummary
+     */
+    webhook: boolean;
+}
+
+
+/**
+ * @export
+ */
+export const ScriptSummaryLanguageEnum = {
+    Python: 'python',
+    Go: 'go',
+    Javascript: 'javascript'
+} as const;
+export type ScriptSummaryLanguageEnum = typeof ScriptSummaryLanguageEnum[keyof typeof ScriptSummaryLanguageEnum];
+
+/**
+ * @export
+ */
+export const ScriptSummaryTypeEnum = {
+    Integration: 'integration'
+} as const;
+export type ScriptSummaryTypeEnum = typeof ScriptSummaryTypeEnum[keyof typeof ScriptSummaryTypeEnum];
+
+
+/**
+ * Check if a given object implements the ScriptSummary interface.
+ */
+export function instanceOfScriptSummary(value: object): value is ScriptSummary {
+    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 (!('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 (!('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 ScriptSummaryFromJSON(json: any): ScriptSummary {
+    return ScriptSummaryFromJSONTyped(json, false);
+}
+
+export function ScriptSummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptSummary {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'createdAt': (new Date(json['createdAt'])),
+        'createdBy': json['createdBy'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'enabled': json['enabled'],
+        'id': json['id'],
+        'key': ScriptKeyFromJSON(json['key']),
+        'language': json['language'],
+        'name': json['name'],
+        'project': json['project'] == null ? undefined : json['project'],
+        'revision': json['revision'],
+        'schedule': ScriptScheduleFromJSON(json['schedule']),
+        'type': json['type'],
+        'updatedAt': (new Date(json['updatedAt'])),
+        'webhook': json['webhook'],
+    };
+}
+
+export function ScriptSummaryToJSON(json: any): ScriptSummary {
+    return ScriptSummaryToJSONTyped(json, false);
+}
+
+export function ScriptSummaryToJSONTyped(value?: ScriptSummary | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'createdAt': ((value['createdAt']).toISOString()),
+        'createdBy': value['createdBy'],
+        'description': value['description'],
+        'enabled': value['enabled'],
+        'id': value['id'],
+        'key': ScriptKeyToJSON(value['key']),
+        'language': value['language'],
+        'name': value['name'],
+        'project': value['project'],
+        'revision': value['revision'],
+        'schedule': ScriptScheduleToJSON(value['schedule']),
+        'type': value['type'],
+        'updatedAt': ((value['updatedAt']).toISOString()),
+        'webhook': value['webhook'],
+    };
+}
+

package/src/models/ScriptWebhookResBody.ts

@@ -0,0 +1,66 @@
+/* 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 ScriptWebhookResBody
+ */
+export interface ScriptWebhookResBody {
+    /**
+     * 
+     * @type {string}
+     * @memberof ScriptWebhookResBody
+     */
+    webhookUrl: string;
+}
+
+/**
+ * Check if a given object implements the ScriptWebhookResBody interface.
+ */
+export function instanceOfScriptWebhookResBody(value: object): value is ScriptWebhookResBody {
+    if (!('webhookUrl' in value) || value['webhookUrl'] === undefined) return false;
+    return true;
+}
+
+export function ScriptWebhookResBodyFromJSON(json: any): ScriptWebhookResBody {
+    return ScriptWebhookResBodyFromJSONTyped(json, false);
+}
+
+export function ScriptWebhookResBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptWebhookResBody {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'webhookUrl': json['webhookUrl'],
+    };
+}
+
+export function ScriptWebhookResBodyToJSON(json: any): ScriptWebhookResBody {
+    return ScriptWebhookResBodyToJSONTyped(json, false);
+}
+
+export function ScriptWebhookResBodyToJSONTyped(value?: ScriptWebhookResBody | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'webhookUrl': value['webhookUrl'],
+    };
+}
+

package/src/models/index.ts

@@ -294,6 +294,28 @@ export * from './ScenarioListEntry';
 export * from './ScenarioListRes';
 export * from './ScenarioNotFoundDetail';
 export * from './ScenarioPatch';
+export * from './ScriptAuditEntry';
+export * from './ScriptAuditResBody';
+export * from './ScriptDetail';
+export * from './ScriptExport';
+export * from './ScriptExportResBody';
+export * from './ScriptExportRun';
+export * from './ScriptKey';
+export * from './ScriptListResBody';
+export * from './ScriptLogLine';
+export * from './ScriptPatchReqBody';
+export * from './ScriptPostReqBody';
+export * from './ScriptRun';
+export * from './ScriptRunLogsResBody';
+export * from './ScriptRunsResBody';
+export * from './ScriptRuntime';
+export * from './ScriptSchedule';
+export * from './ScriptSchedulePreviewReqBody';
+export * from './ScriptSchedulePreviewResBody';
+export * from './ScriptSecretsReqBody';
+export * from './ScriptSecretsResBody';
+export * from './ScriptSummary';
+export * from './ScriptWebhookResBody';
 export * from './SendPasswordPutReqBody';
 export * from './SerializedEvent';
 export * from './SingleSelectChangelogData';