@spaciv/sdk 0.1.19 → 0.1.21

package/src/apis/ScriptsApi.ts

@@ -16,6 +16,8 @@
 import * as runtime from '../runtime';
 import type {
   ErrorModel,
+  ScratchpadRun,
+  ScratchpadRunPostReqBody,
   ScriptAuditResBody,
   ScriptDetail,
   ScriptExportResBody,
@@ -34,6 +36,10 @@ import type {
 import {
     ErrorModelFromJSON,
     ErrorModelToJSON,
+    ScratchpadRunFromJSON,
+    ScratchpadRunToJSON,
+    ScratchpadRunPostReqBodyFromJSON,
+    ScratchpadRunPostReqBodyToJSON,
     ScriptAuditResBodyFromJSON,
     ScriptAuditResBodyToJSON,
     ScriptDetailFromJSON,
@@ -80,6 +86,10 @@ export interface ScriptsApiCreateSchedulePreviewRequest {
     scriptSchedulePreviewReqBody: ScriptSchedulePreviewReqBody;
 }
 
+export interface ScriptsApiCreateScratchpadRunsRequest {
+    scratchpadRunPostReqBody: ScratchpadRunPostReqBody;
+}
+
 export interface ScriptsApiDeleteRequest {
     id: string;
 }
@@ -94,6 +104,11 @@ export interface ScriptsApiGetAuditRequest {
     cursor?: string;
 }
 
+export interface ScriptsApiGetScratchpadRunsRequest {
+    runId: string;
+    waitSeconds?: number;
+}
+
 export interface ScriptsApiListRunsRequest {
     id: string;
     limit?: number;
@@ -186,6 +201,22 @@ export interface ScriptsApiInterface {
      */
     createSchedulePreview(requestParameters: ScriptsApiCreateSchedulePreviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptSchedulePreviewResBody>;
 
+    /**
+     * Runs Python or JavaScript code once in a sandbox without saving it as a script, for working something out from the account\'s data. The handler is the one an integration script implements, with `input` as `event.input`; there is no build, so dependency manifests and Go are not supported. The code runs with a read-only access token scoped to the caller: only the caller\'s view permissions, in the caller\'s current project if there is one, for 5 minutes. `ctx.fetch` sends it to the Spaciv API. Files the handler writes to its output directory (`ctx.output_dir` in Python, `ctx.outputDir` in JavaScript) are returned with its stdout, stderr and return value.  Limits: code up to 256 KiB in at most 50 files, `input` up to 1 MiB, and `timeoutSeconds` up to 120 (default 30). Of the output, stdout and stderr are kept up to 256 KiB each, the return value up to 256 KiB, and up to 20 output files totalling 2 MiB. Runs count towards the account\'s script credits and concurrent runs.  The request waits up to `waitSeconds` for the run to finish; a run still in progress is returned without `output`, and can be read with `GET /v1/scripts/scratchpad/runs/{runId}`. A run is visible only to the user who started it, and is kept for 24 hours. Returns `422` when the language or code is not accepted, and `403` for a script\'s API key or a scratchpad run\'s own token. Requires the *AI assistant* permission.
+     * @summary Run scratchpad code
+     * @param {ScratchpadRunPostReqBody} scratchpadRunPostReqBody 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ScriptsApiInterface
+     */
+    createScratchpadRunsRaw(requestParameters: ScriptsApiCreateScratchpadRunsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScratchpadRun>>;
+
+    /**
+     * Runs Python or JavaScript code once in a sandbox without saving it as a script, for working something out from the account\'s data. The handler is the one an integration script implements, with `input` as `event.input`; there is no build, so dependency manifests and Go are not supported. The code runs with a read-only access token scoped to the caller: only the caller\'s view permissions, in the caller\'s current project if there is one, for 5 minutes. `ctx.fetch` sends it to the Spaciv API. Files the handler writes to its output directory (`ctx.output_dir` in Python, `ctx.outputDir` in JavaScript) are returned with its stdout, stderr and return value.  Limits: code up to 256 KiB in at most 50 files, `input` up to 1 MiB, and `timeoutSeconds` up to 120 (default 30). Of the output, stdout and stderr are kept up to 256 KiB each, the return value up to 256 KiB, and up to 20 output files totalling 2 MiB. Runs count towards the account\'s script credits and concurrent runs.  The request waits up to `waitSeconds` for the run to finish; a run still in progress is returned without `output`, and can be read with `GET /v1/scripts/scratchpad/runs/{runId}`. A run is visible only to the user who started it, and is kept for 24 hours. Returns `422` when the language or code is not accepted, and `403` for a script\'s API key or a scratchpad run\'s own token. Requires the *AI assistant* permission.
+     * Run scratchpad code
+     */
+    createScratchpadRuns(requestParameters: ScriptsApiCreateScratchpadRunsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScratchpadRun>;
+
     /**
      * Stops any active runs, deletes the script with its secrets and run history, and revokes its API keys. Requires the *Manage my account* permission.
      * @summary Delete a script
@@ -251,6 +282,23 @@ export interface ScriptsApiInterface {
      */
     getExport(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptExportResBody>;
 
+    /**
+     * Returns a scratchpad run the caller started, with its output once it has finished. Runs are kept for 24 hours. Returns `404` when the run does not exist, has expired or was started by someone else, and `403` for a script\'s API key or a scratchpad run\'s own token. Requires the *AI assistant* permission.
+     * @summary Get a scratchpad run
+     * @param {string} runId 
+     * @param {number} [waitSeconds] Longest to wait for a run in progress to finish before responding. Defaults to 0, returning at once.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ScriptsApiInterface
+     */
+    getScratchpadRunsRaw(requestParameters: ScriptsApiGetScratchpadRunsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScratchpadRun>>;
+
+    /**
+     * Returns a scratchpad run the caller started, with its output once it has finished. Runs are kept for 24 hours. Returns `404` when the run does not exist, has expired or was started by someone else, and `403` for a script\'s API key or a scratchpad run\'s own token. Requires the *AI assistant* permission.
+     * Get a scratchpad run
+     */
+    getScratchpadRuns(requestParameters: ScriptsApiGetScratchpadRunsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScratchpadRun>;
+
     /**
      * Returns the credits the account\'s script runs were charged this calendar month (UTC), against the account\'s monthly script credit limit and its other script limits, with how many runs each script made, failed and had refused. creditState is near from 80% of the monthly limit and reached once it is used, after which runs are recorded as quota_exceeded until the month ends. creditsUsed is the scripts figure of `GET /v1/account/usage/calculation-credits`. Run counts are added when runs end. Requires the *Manage my account* permission.
      * @summary Get script usage
@@ -549,6 +597,55 @@ export class ScriptsApi extends runtime.BaseAPI implements ScriptsApiInterface {
         return await response.value();
     }
 
+    /**
+     * Runs Python or JavaScript code once in a sandbox without saving it as a script, for working something out from the account\'s data. The handler is the one an integration script implements, with `input` as `event.input`; there is no build, so dependency manifests and Go are not supported. The code runs with a read-only access token scoped to the caller: only the caller\'s view permissions, in the caller\'s current project if there is one, for 5 minutes. `ctx.fetch` sends it to the Spaciv API. Files the handler writes to its output directory (`ctx.output_dir` in Python, `ctx.outputDir` in JavaScript) are returned with its stdout, stderr and return value.  Limits: code up to 256 KiB in at most 50 files, `input` up to 1 MiB, and `timeoutSeconds` up to 120 (default 30). Of the output, stdout and stderr are kept up to 256 KiB each, the return value up to 256 KiB, and up to 20 output files totalling 2 MiB. Runs count towards the account\'s script credits and concurrent runs.  The request waits up to `waitSeconds` for the run to finish; a run still in progress is returned without `output`, and can be read with `GET /v1/scripts/scratchpad/runs/{runId}`. A run is visible only to the user who started it, and is kept for 24 hours. Returns `422` when the language or code is not accepted, and `403` for a script\'s API key or a scratchpad run\'s own token. Requires the *AI assistant* permission.
+     * Run scratchpad code
+     */
+    async createScratchpadRunsRaw(requestParameters: ScriptsApiCreateScratchpadRunsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScratchpadRun>> {
+        if (requestParameters['scratchpadRunPostReqBody'] == null) {
+            throw new runtime.RequiredError(
+                'scratchpadRunPostReqBody',
+                'Required parameter "scratchpadRunPostReqBody" was null or undefined when calling createScratchpadRuns().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("accessToken", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/v1/scripts/scratchpad/runs`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: ScratchpadRunPostReqBodyToJSON(requestParameters['scratchpadRunPostReqBody']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ScratchpadRunFromJSON(jsonValue));
+    }
+
+    /**
+     * Runs Python or JavaScript code once in a sandbox without saving it as a script, for working something out from the account\'s data. The handler is the one an integration script implements, with `input` as `event.input`; there is no build, so dependency manifests and Go are not supported. The code runs with a read-only access token scoped to the caller: only the caller\'s view permissions, in the caller\'s current project if there is one, for 5 minutes. `ctx.fetch` sends it to the Spaciv API. Files the handler writes to its output directory (`ctx.output_dir` in Python, `ctx.outputDir` in JavaScript) are returned with its stdout, stderr and return value.  Limits: code up to 256 KiB in at most 50 files, `input` up to 1 MiB, and `timeoutSeconds` up to 120 (default 30). Of the output, stdout and stderr are kept up to 256 KiB each, the return value up to 256 KiB, and up to 20 output files totalling 2 MiB. Runs count towards the account\'s script credits and concurrent runs.  The request waits up to `waitSeconds` for the run to finish; a run still in progress is returned without `output`, and can be read with `GET /v1/scripts/scratchpad/runs/{runId}`. A run is visible only to the user who started it, and is kept for 24 hours. Returns `422` when the language or code is not accepted, and `403` for a script\'s API key or a scratchpad run\'s own token. Requires the *AI assistant* permission.
+     * Run scratchpad code
+     */
+    async createScratchpadRuns(requestParameters: ScriptsApiCreateScratchpadRunsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScratchpadRun> {
+        const response = await this.createScratchpadRunsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Stops any active runs, deletes the script with its secrets and run history, and revokes its API keys. Requires the *Manage my account* permission.
      * Delete a script
@@ -736,6 +833,57 @@ export class ScriptsApi extends runtime.BaseAPI implements ScriptsApiInterface {
         return await response.value();
     }
 
+    /**
+     * Returns a scratchpad run the caller started, with its output once it has finished. Runs are kept for 24 hours. Returns `404` when the run does not exist, has expired or was started by someone else, and `403` for a script\'s API key or a scratchpad run\'s own token. Requires the *AI assistant* permission.
+     * Get a scratchpad run
+     */
+    async getScratchpadRunsRaw(requestParameters: ScriptsApiGetScratchpadRunsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScratchpadRun>> {
+        if (requestParameters['runId'] == null) {
+            throw new runtime.RequiredError(
+                'runId',
+                'Required parameter "runId" was null or undefined when calling getScratchpadRuns().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['waitSeconds'] != null) {
+            queryParameters['waitSeconds'] = requestParameters['waitSeconds'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("accessToken", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/v1/scripts/scratchpad/runs/{runId}`;
+        urlPath = urlPath.replace(`{${"runId"}}`, encodeURIComponent(String(requestParameters['runId'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ScratchpadRunFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns a scratchpad run the caller started, with its output once it has finished. Runs are kept for 24 hours. Returns `404` when the run does not exist, has expired or was started by someone else, and `403` for a script\'s API key or a scratchpad run\'s own token. Requires the *AI assistant* permission.
+     * Get a scratchpad run
+     */
+    async getScratchpadRuns(requestParameters: ScriptsApiGetScratchpadRunsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScratchpadRun> {
+        const response = await this.getScratchpadRunsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Returns the credits the account\'s script runs were charged this calendar month (UTC), against the account\'s monthly script credit limit and its other script limits, with how many runs each script made, failed and had refused. creditState is near from 80% of the monthly limit and reached once it is used, after which runs are recorded as quota_exceeded until the month ends. creditsUsed is the scripts figure of `GET /v1/account/usage/calculation-credits`. Run counts are added when runs end. Requires the *Manage my account* permission.
      * Get script usage

package/src/models/AccountDirectoryPatchBody.ts

@@ -0,0 +1,73 @@
+/* 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 AccountDirectoryPatchBody
+ */
+export interface AccountDirectoryPatchBody {
+    /**
+     * New display name for the directory. At most 255 bytes after normalising to Unicode NFC. Must not contain a forward slash or a backslash, and must not be . or ..
+     * @type {string}
+     * @memberof AccountDirectoryPatchBody
+     */
+    name?: string;
+    /**
+     * Identifier of the directory to move this one into, or an empty string to move it to the root.
+     * @type {string}
+     * @memberof AccountDirectoryPatchBody
+     */
+    parentId?: string;
+}
+
+/**
+ * Check if a given object implements the AccountDirectoryPatchBody interface.
+ */
+export function instanceOfAccountDirectoryPatchBody(value: object): value is AccountDirectoryPatchBody {
+    return true;
+}
+
+export function AccountDirectoryPatchBodyFromJSON(json: any): AccountDirectoryPatchBody {
+    return AccountDirectoryPatchBodyFromJSONTyped(json, false);
+}
+
+export function AccountDirectoryPatchBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): AccountDirectoryPatchBody {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'] == null ? undefined : json['name'],
+        'parentId': json['parentId'] == null ? undefined : json['parentId'],
+    };
+}
+
+export function AccountDirectoryPatchBodyToJSON(json: any): AccountDirectoryPatchBody {
+    return AccountDirectoryPatchBodyToJSONTyped(json, false);
+}
+
+export function AccountDirectoryPatchBodyToJSONTyped(value?: AccountDirectoryPatchBody | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'parentId': value['parentId'],
+    };
+}
+

package/src/models/AccountDirectoryPostBody.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';
+/**
+ * 
+ * @export
+ * @interface AccountDirectoryPostBody
+ */
+export interface AccountDirectoryPostBody {
+    /**
+     * Display name of the directory. At most 255 bytes after normalising to Unicode NFC. Must not contain a forward slash or a backslash, and must not be . or ..
+     * @type {string}
+     * @memberof AccountDirectoryPostBody
+     */
+    name: string;
+    /**
+     * Identifier of the directory to create this one in. Leave it out to create it at the root.
+     * @type {string}
+     * @memberof AccountDirectoryPostBody
+     */
+    parentId?: string;
+}
+
+/**
+ * Check if a given object implements the AccountDirectoryPostBody interface.
+ */
+export function instanceOfAccountDirectoryPostBody(value: object): value is AccountDirectoryPostBody {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    return true;
+}
+
+export function AccountDirectoryPostBodyFromJSON(json: any): AccountDirectoryPostBody {
+    return AccountDirectoryPostBodyFromJSONTyped(json, false);
+}
+
+export function AccountDirectoryPostBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): AccountDirectoryPostBody {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'parentId': json['parentId'] == null ? undefined : json['parentId'],
+    };
+}
+
+export function AccountDirectoryPostBodyToJSON(json: any): AccountDirectoryPostBody {
+    return AccountDirectoryPostBodyToJSONTyped(json, false);
+}
+
+export function AccountDirectoryPostBodyToJSONTyped(value?: AccountDirectoryPostBody | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'parentId': value['parentId'],
+    };
+}
+

package/src/models/AccountFilePatchBody.ts

@@ -20,18 +20,23 @@ import { mapValues } from '../runtime';
  */
 export interface AccountFilePatchBody {
     /**
-     * New display name for the file. Must not contain a forward slash or a backslash.
+     * New display name for the file. At most 255 bytes after normalising to Unicode NFC. Must not contain a forward slash or a backslash.
      * @type {string}
      * @memberof AccountFilePatchBody
      */
-    name: string;
+    name?: string;
+    /**
+     * Identifier of the directory to move the file into, or an empty string to move it to the root.
+     * @type {string}
+     * @memberof AccountFilePatchBody
+     */
+    parentId?: string;
 }
 
 /**
  * Check if a given object implements the AccountFilePatchBody interface.
  */
 export function instanceOfAccountFilePatchBody(value: object): value is AccountFilePatchBody {
-    if (!('name' in value) || value['name'] === undefined) return false;
     return true;
 }
 
@@ -45,7 +50,8 @@ export function AccountFilePatchBodyFromJSONTyped(json: any, ignoreDiscriminator
     }
     return {
         
-        'name': json['name'],
+        'name': json['name'] == null ? undefined : json['name'],
+        'parentId': json['parentId'] == null ? undefined : json['parentId'],
     };
 }
 
@@ -61,6 +67,7 @@ export function AccountFilePatchBodyToJSONTyped(value?: AccountFilePatchBody | n
     return {
         
         'name': value['name'],
+        'parentId': value['parentId'],
     };
 }
 

package/src/models/Directory.ts

@@ -0,0 +1,101 @@
+/* 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 Directory
+ */
+export interface Directory {
+    /**
+     * When the directory was created (RFC 3339).
+     * @type {Date}
+     * @memberof Directory
+     */
+    createdAt: Date;
+    /**
+     * Identifier of the user who created the directory.
+     * @type {number}
+     * @memberof Directory
+     */
+    createdBy: number;
+    /**
+     * Opaque identifier of the directory.
+     * @type {string}
+     * @memberof Directory
+     */
+    id: string;
+    /**
+     * Display name of the directory. Nothing else in the same parent has the same name, compared exactly and after normalising to Unicode NFC.
+     * @type {string}
+     * @memberof Directory
+     */
+    name: string;
+    /**
+     * Identifier of the directory this one is in. Absent for a directory at the root.
+     * @type {string}
+     * @memberof Directory
+     */
+    parentId?: string;
+}
+
+/**
+ * Check if a given object implements the Directory interface.
+ */
+export function instanceOfDirectory(value: object): value is Directory {
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('createdBy' in value) || value['createdBy'] === undefined) return false;
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    return true;
+}
+
+export function DirectoryFromJSON(json: any): Directory {
+    return DirectoryFromJSONTyped(json, false);
+}
+
+export function DirectoryFromJSONTyped(json: any, ignoreDiscriminator: boolean): Directory {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'createdAt': (new Date(json['createdAt'])),
+        'createdBy': json['createdBy'],
+        'id': json['id'],
+        'name': json['name'],
+        'parentId': json['parentId'] == null ? undefined : json['parentId'],
+    };
+}
+
+export function DirectoryToJSON(json: any): Directory {
+    return DirectoryToJSONTyped(json, false);
+}
+
+export function DirectoryToJSONTyped(value?: Directory | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'createdAt': ((value['createdAt']).toISOString()),
+        'createdBy': value['createdBy'],
+        'id': value['id'],
+        'name': value['name'],
+        'parentId': value['parentId'],
+    };
+}
+

package/src/models/DirectoryPage.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 { Directory } from './Directory';
+import {
+    DirectoryFromJSON,
+    DirectoryFromJSONTyped,
+    DirectoryToJSON,
+    DirectoryToJSONTyped,
+} from './Directory';
+
+/**
+ * 
+ * @export
+ * @interface DirectoryPage
+ */
+export interface DirectoryPage {
+    /**
+     * 
+     * @type {Array<Directory>}
+     * @memberof DirectoryPage
+     */
+    directories: Array<Directory>;
+    /**
+     * Pass back as cursor to fetch the following page. Absent on the last page.
+     * @type {string}
+     * @memberof DirectoryPage
+     */
+    nextCursor?: string;
+}
+
+/**
+ * Check if a given object implements the DirectoryPage interface.
+ */
+export function instanceOfDirectoryPage(value: object): value is DirectoryPage {
+    if (!('directories' in value) || value['directories'] === undefined) return false;
+    return true;
+}
+
+export function DirectoryPageFromJSON(json: any): DirectoryPage {
+    return DirectoryPageFromJSONTyped(json, false);
+}
+
+export function DirectoryPageFromJSONTyped(json: any, ignoreDiscriminator: boolean): DirectoryPage {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'directories': ((json['directories'] as Array<any>).map(DirectoryFromJSON)),
+        'nextCursor': json['nextCursor'] == null ? undefined : json['nextCursor'],
+    };
+}
+
+export function DirectoryPageToJSON(json: any): DirectoryPage {
+    return DirectoryPageToJSONTyped(json, false);
+}
+
+export function DirectoryPageToJSONTyped(value?: DirectoryPage | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'directories': ((value['directories'] as Array<any>).map(DirectoryToJSON)),
+        'nextCursor': value['nextCursor'],
+    };
+}
+

package/src/models/ListPage.ts

@@ -20,6 +20,13 @@ import {
     ModelRecordToJSON,
     ModelRecordToJSONTyped,
 } from './ModelRecord';
+import type { Directory } from './Directory';
+import {
+    DirectoryFromJSON,
+    DirectoryFromJSONTyped,
+    DirectoryToJSON,
+    DirectoryToJSONTyped,
+} from './Directory';
 
 /**
  * 
@@ -27,6 +34,12 @@ import {
  * @interface ListPage
  */
 export interface ListPage {
+    /**
+     * Directories directly inside the listed directory. Returned only when a parent is given, and only on the pages that hold some.
+     * @type {Array<Directory>}
+     * @memberof ListPage
+     */
+    directories?: Array<Directory>;
     /**
      * 
      * @type {Array<ModelRecord>}
@@ -59,6 +72,7 @@ export function ListPageFromJSONTyped(json: any, ignoreDiscriminator: boolean):
     }
     return {
         
+        'directories': json['directories'] == null ? undefined : ((json['directories'] as Array<any>).map(DirectoryFromJSON)),
         'files': ((json['files'] as Array<any>).map(ModelRecordFromJSON)),
         'nextCursor': json['nextCursor'] == null ? undefined : json['nextCursor'],
     };
@@ -75,6 +89,7 @@ export function ListPageToJSONTyped(value?: ListPage | null, ignoreDiscriminator
 
     return {
         
+        'directories': value['directories'] == null ? undefined : ((value['directories'] as Array<any>).map(DirectoryToJSON)),
         'files': ((value['files'] as Array<any>).map(ModelRecordToJSON)),
         'nextCursor': value['nextCursor'],
     };

package/src/models/ModelRecord.ts

@@ -38,11 +38,17 @@ export interface ModelRecord {
      */
     mimeType: string;
     /**
-     * Display name of the file, taken from the uploaded file name and changeable afterwards.
+     * Display name of the file, taken from the uploaded file name and changeable afterwards. Nothing else in the same directory has the same name, compared exactly and after normalising to Unicode NFC.
      * @type {string}
      * @memberof ModelRecord
      */
     name: string;
+    /**
+     * Identifier of the directory the file is in. Absent for a file at the root.
+     * @type {string}
+     * @memberof ModelRecord
+     */
+    parentId?: string;
     /**
      * Name of the virus signature the file matched when it was quarantined.
      * @type {string}
@@ -96,6 +102,7 @@ export function ModelRecordFromJSONTyped(json: any, ignoreDiscriminator: boolean
         'id': json['id'],
         'mimeType': json['mimeType'],
         'name': json['name'],
+        'parentId': json['parentId'] == null ? undefined : json['parentId'],
         'quarantineSignature': json['quarantineSignature'] == null ? undefined : json['quarantineSignature'],
         'quarantinedAt': json['quarantinedAt'] == null ? undefined : (new Date(json['quarantinedAt'])),
         'size': json['size'],
@@ -118,6 +125,7 @@ export function ModelRecordToJSONTyped(value?: ModelRecord | null, ignoreDiscrim
         'id': value['id'],
         'mimeType': value['mimeType'],
         'name': value['name'],
+        'parentId': value['parentId'],
         'quarantineSignature': value['quarantineSignature'],
         'quarantinedAt': value['quarantinedAt'] == null ? undefined : ((value['quarantinedAt']).toISOString()),
         'size': value['size'],