@spaciv/sdk 0.1.1 → 0.1.2

package/src/apis/ScriptsApi.ts

@@ -0,0 +1,984 @@
+/* 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 * as runtime from '../runtime';
+import type {
+  ErrorModel,
+  ScriptAuditResBody,
+  ScriptDetail,
+  ScriptExportResBody,
+  ScriptListResBody,
+  ScriptPatchReqBody,
+  ScriptPostReqBody,
+  ScriptRunLogsResBody,
+  ScriptRunsResBody,
+  ScriptSchedulePreviewReqBody,
+  ScriptSchedulePreviewResBody,
+  ScriptSecretsReqBody,
+  ScriptSecretsResBody,
+  ScriptWebhookResBody,
+} from '../models/index';
+import {
+    ErrorModelFromJSON,
+    ErrorModelToJSON,
+    ScriptAuditResBodyFromJSON,
+    ScriptAuditResBodyToJSON,
+    ScriptDetailFromJSON,
+    ScriptDetailToJSON,
+    ScriptExportResBodyFromJSON,
+    ScriptExportResBodyToJSON,
+    ScriptListResBodyFromJSON,
+    ScriptListResBodyToJSON,
+    ScriptPatchReqBodyFromJSON,
+    ScriptPatchReqBodyToJSON,
+    ScriptPostReqBodyFromJSON,
+    ScriptPostReqBodyToJSON,
+    ScriptRunLogsResBodyFromJSON,
+    ScriptRunLogsResBodyToJSON,
+    ScriptRunsResBodyFromJSON,
+    ScriptRunsResBodyToJSON,
+    ScriptSchedulePreviewReqBodyFromJSON,
+    ScriptSchedulePreviewReqBodyToJSON,
+    ScriptSchedulePreviewResBodyFromJSON,
+    ScriptSchedulePreviewResBodyToJSON,
+    ScriptSecretsReqBodyFromJSON,
+    ScriptSecretsReqBodyToJSON,
+    ScriptSecretsResBodyFromJSON,
+    ScriptSecretsResBodyToJSON,
+    ScriptWebhookResBodyFromJSON,
+    ScriptWebhookResBodyToJSON,
+} from '../models/index';
+
+export interface ScriptsApiCreateRequest {
+    scriptPostReqBody: ScriptPostReqBody;
+}
+
+export interface ScriptsApiCreateReauthoriseRequest {
+    id: string;
+}
+
+export interface ScriptsApiCreateRegenerateWebhookRequest {
+    id: string;
+}
+
+export interface ScriptsApiCreateSchedulePreviewRequest {
+    scriptSchedulePreviewReqBody: ScriptSchedulePreviewReqBody;
+}
+
+export interface ScriptsApiDeleteRequest {
+    id: string;
+}
+
+export interface ScriptsApiGetRequest {
+    id: string;
+}
+
+export interface ScriptsApiGetAuditRequest {
+    id: string;
+    limit?: number;
+    cursor?: string;
+}
+
+export interface ScriptsApiListRunsRequest {
+    id: string;
+    limit?: number;
+    cursor?: string;
+}
+
+export interface ScriptsApiListRunsLogsRequest {
+    id: string;
+    runId: string;
+}
+
+export interface ScriptsApiUpdateRequest {
+    id: string;
+    scriptPatchReqBody: ScriptPatchReqBody;
+}
+
+export interface ScriptsApiUpdateSecretsRequest {
+    id: string;
+    scriptSecretsReqBody: ScriptSecretsReqBody;
+}
+
+/**
+ * ScriptsApi - interface
+ * 
+ * @export
+ * @interface ScriptsApiInterface
+ */
+export interface ScriptsApiInterface {
+    /**
+     * Creates a script whose Python, Go or JavaScript handler is called on a schedule, from a webhook, or both. The handler\'s context carries a Spaciv API key acting with the caller\'s permissions, except the account-administration permissions (*Manage my account*, *Manage users*, *Edit my user profile*, *Edit billing address* and the system permissions), which a script\'s key never carries, plus the account and, when a project is set, the project; the key is rotated automatically. A non-null return value is written to the run\'s logs. When `webhook` is true the response\'s `webhookUrl` is the only time the URL is returned. Rejected with `422` when the source, schedule or secrets are invalid or the project does not exist, and with `409` when the account already has 50 scripts. Requires the *Manage my account* permission; a script\'s own API key cannot call this or any other script operation.
+     * @summary Create a script
+     * @param {ScriptPostReqBody} scriptPostReqBody 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ScriptsApiInterface
+     */
+    createRaw(requestParameters: ScriptsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptDetail>>;
+
+    /**
+     * Creates a script whose Python, Go or JavaScript handler is called on a schedule, from a webhook, or both. The handler\'s context carries a Spaciv API key acting with the caller\'s permissions, except the account-administration permissions (*Manage my account*, *Manage users*, *Edit my user profile*, *Edit billing address* and the system permissions), which a script\'s key never carries, plus the account and, when a project is set, the project; the key is rotated automatically. A non-null return value is written to the run\'s logs. When `webhook` is true the response\'s `webhookUrl` is the only time the URL is returned. Rejected with `422` when the source, schedule or secrets are invalid or the project does not exist, and with `409` when the account already has 50 scripts. Requires the *Manage my account* permission; a script\'s own API key cannot call this or any other script operation.
+     * Create a script
+     */
+    create(requestParameters: ScriptsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptDetail>;
+
+    /**
+     * Replaces the script\'s API key with a new one acting with the caller\'s permissions, except the account-administration permissions (*Manage my account*, *Manage users*, *Edit my user profile*, *Edit billing address* and the system permissions), which a script\'s key never carries, and revokes the old one. Use it when the key needs re-authorising because its owner lost access, or to hand the script to another user. Requires the *Manage my account* permission.
+     * @summary Re-authorise a script
+     * @param {string} id 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ScriptsApiInterface
+     */
+    createReauthoriseRaw(requestParameters: ScriptsApiCreateReauthoriseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptDetail>>;
+
+    /**
+     * Replaces the script\'s API key with a new one acting with the caller\'s permissions, except the account-administration permissions (*Manage my account*, *Manage users*, *Edit my user profile*, *Edit billing address* and the system permissions), which a script\'s key never carries, and revokes the old one. Use it when the key needs re-authorising because its owner lost access, or to hand the script to another user. Requires the *Manage my account* permission.
+     * Re-authorise a script
+     */
+    createReauthorise(requestParameters: ScriptsApiCreateReauthoriseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptDetail>;
+
+    /**
+     * Issues a new webhook URL and immediately invalidates the previous one. The URL is returned only in this response. Rejected with `409` when the script\'s webhook is turned off, or when another request regenerated it at the same time; the URL returned to that request is the valid one. Requires the *Manage my account* permission.
+     * @summary Regenerate a script\'s webhook URL
+     * @param {string} id 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ScriptsApiInterface
+     */
+    createRegenerateWebhookRaw(requestParameters: ScriptsApiCreateRegenerateWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptWebhookResBody>>;
+
+    /**
+     * Issues a new webhook URL and immediately invalidates the previous one. The URL is returned only in this response. Rejected with `409` when the script\'s webhook is turned off, or when another request regenerated it at the same time; the URL returned to that request is the valid one. Requires the *Manage my account* permission.
+     * Regenerate a script\'s webhook URL
+     */
+    createRegenerateWebhook(requestParameters: ScriptsApiCreateRegenerateWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptWebhookResBody>;
+
+    /**
+     * Checks a cron expression and time zone and returns the next times it would run, so a schedule can be confirmed before saving. An invalid schedule is reported in `error` with `valid` false rather than as an error response. Requires the *Manage my account* permission.
+     * @summary Preview a script schedule
+     * @param {ScriptSchedulePreviewReqBody} scriptSchedulePreviewReqBody 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ScriptsApiInterface
+     */
+    createSchedulePreviewRaw(requestParameters: ScriptsApiCreateSchedulePreviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptSchedulePreviewResBody>>;
+
+    /**
+     * Checks a cron expression and time zone and returns the next times it would run, so a schedule can be confirmed before saving. An invalid schedule is reported in `error` with `valid` false rather than as an error response. Requires the *Manage my account* permission.
+     * Preview a script schedule
+     */
+    createSchedulePreview(requestParameters: ScriptsApiCreateSchedulePreviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptSchedulePreviewResBody>;
+
+    /**
+     * 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
+     * @param {string} id 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ScriptsApiInterface
+     */
+    deleteRaw(requestParameters: ScriptsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * 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
+     */
+    delete(requestParameters: ScriptsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * Returns a script with its source, the names of its secrets (never their values), its API key\'s status and, when the runner can be reached, its build state, next scheduled run and resource limits. Requires the *Manage my account* permission.
+     * @summary Get a script
+     * @param {string} id 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ScriptsApiInterface
+     */
+    getRaw(requestParameters: ScriptsApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptDetail>>;
+
+    /**
+     * Returns a script with its source, the names of its secrets (never their values), its API key\'s status and, when the runner can be reached, its build state, next scheduled run and resource limits. Requires the *Manage my account* permission.
+     * Get a script
+     */
+    get(requestParameters: ScriptsApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptDetail>;
+
+    /**
+     * Lists changes to the script and its API key, newest first. Requires the *Manage my account* permission.
+     * @summary List a script\'s activity
+     * @param {string} id 
+     * @param {number} [limit] 
+     * @param {string} [cursor] nextCursor from the previous page.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ScriptsApiInterface
+     */
+    getAuditRaw(requestParameters: ScriptsApiGetAuditRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptAuditResBody>>;
+
+    /**
+     * Lists changes to the script and its API key, newest first. Requires the *Manage my account* permission.
+     * List a script\'s activity
+     */
+    getAudit(requestParameters: ScriptsApiGetAuditRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptAuditResBody>;
+
+    /**
+     * Returns every script in the account with its settings, source, dependency manifest and secret names (never their values), and each script\'s run history: every build and run still kept, with the API path of its logs. A history too long to read within the request keeps its newest runs and sets runsError; page through the script\'s runs for the rest. Webhook URLs are not included. Requires the *Manage my account* permission.
+     * @summary Export scripts
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ScriptsApiInterface
+     */
+    getExportRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptExportResBody>>;
+
+    /**
+     * Returns every script in the account with its settings, source, dependency manifest and secret names (never their values), and each script\'s run history: every build and run still kept, with the API path of its logs. A history too long to read within the request keeps its newest runs and sets runsError; page through the script\'s runs for the rest. Webhook URLs are not included. Requires the *Manage my account* permission.
+     * Export scripts
+     */
+    getExport(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptExportResBody>;
+
+    /**
+     * Lists the account\'s scripts, sorted by name, without their source code. Requires the *Manage my account* permission.
+     * @summary List scripts
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ScriptsApiInterface
+     */
+    listRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptListResBody>>;
+
+    /**
+     * Lists the account\'s scripts, sorted by name, without their source code. Requires the *Manage my account* permission.
+     * List scripts
+     */
+    list(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptListResBody>;
+
+    /**
+     * Lists the script\'s builds and runs, newest first. Requires the *Manage my account* permission.
+     * @summary List a script\'s runs
+     * @param {string} id 
+     * @param {number} [limit] 
+     * @param {string} [cursor] nextCursor from the previous page.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ScriptsApiInterface
+     */
+    listRunsRaw(requestParameters: ScriptsApiListRunsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptRunsResBody>>;
+
+    /**
+     * Lists the script\'s builds and runs, newest first. Requires the *Manage my account* permission.
+     * List a script\'s runs
+     */
+    listRuns(requestParameters: ScriptsApiListRunsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptRunsResBody>;
+
+    /**
+     * Returns the output the run or build wrote to stdout and stderr. Requires the *Manage my account* permission.
+     * @summary Get a script run\'s logs
+     * @param {string} id 
+     * @param {string} runId 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ScriptsApiInterface
+     */
+    listRunsLogsRaw(requestParameters: ScriptsApiListRunsLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptRunLogsResBody>>;
+
+    /**
+     * Returns the output the run or build wrote to stdout and stderr. Requires the *Manage my account* permission.
+     * Get a script run\'s logs
+     */
+    listRunsLogs(requestParameters: ScriptsApiListRunsLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptRunLogsResBody>;
+
+    /**
+     * Updates the fields given. Changing the project replaces the script\'s API key with one scoped to the new project. When someone other than the key\'s owner changes the language, manifest or files, the key is replaced with one acting as them. Turning the webhook on returns its `webhookUrl` once. Rejected with `409` when `revision` is stale, or when enabling a script whose key needs re-authorising; with `422` when the result is invalid. Requires the *Manage my account* permission.
+     * @summary Update a script
+     * @param {string} id 
+     * @param {ScriptPatchReqBody} scriptPatchReqBody 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ScriptsApiInterface
+     */
+    updateRaw(requestParameters: ScriptsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptDetail>>;
+
+    /**
+     * Updates the fields given. Changing the project replaces the script\'s API key with one scoped to the new project. When someone other than the key\'s owner changes the language, manifest or files, the key is replaced with one acting as them. Turning the webhook on returns its `webhookUrl` once. Rejected with `409` when `revision` is stale, or when enabling a script whose key needs re-authorising; with `422` when the result is invalid. Requires the *Manage my account* permission.
+     * Update a script
+     */
+    update(requestParameters: ScriptsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptDetail>;
+
+    /**
+     * Adds, replaces or removes the script\'s secrets; secrets not named are left unchanged. Values are write-only and are never returned; the response has the script\'s new `revision`. When someone other than the key\'s owner sets secrets, the script\'s API key is replaced with one acting as them. Names must be upper-case environment variable names and must not start with `SPACIV_`, which is reserved for the values Spaciv provides. Requires the *Manage my account* permission.
+     * @summary Set script secrets
+     * @param {string} id 
+     * @param {ScriptSecretsReqBody} scriptSecretsReqBody 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ScriptsApiInterface
+     */
+    updateSecretsRaw(requestParameters: ScriptsApiUpdateSecretsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptSecretsResBody>>;
+
+    /**
+     * Adds, replaces or removes the script\'s secrets; secrets not named are left unchanged. Values are write-only and are never returned; the response has the script\'s new `revision`. When someone other than the key\'s owner sets secrets, the script\'s API key is replaced with one acting as them. Names must be upper-case environment variable names and must not start with `SPACIV_`, which is reserved for the values Spaciv provides. Requires the *Manage my account* permission.
+     * Set script secrets
+     */
+    updateSecrets(requestParameters: ScriptsApiUpdateSecretsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptSecretsResBody>;
+
+}
+
+/**
+ * 
+ */
+export class ScriptsApi extends runtime.BaseAPI implements ScriptsApiInterface {
+
+    /**
+     * Creates a script whose Python, Go or JavaScript handler is called on a schedule, from a webhook, or both. The handler\'s context carries a Spaciv API key acting with the caller\'s permissions, except the account-administration permissions (*Manage my account*, *Manage users*, *Edit my user profile*, *Edit billing address* and the system permissions), which a script\'s key never carries, plus the account and, when a project is set, the project; the key is rotated automatically. A non-null return value is written to the run\'s logs. When `webhook` is true the response\'s `webhookUrl` is the only time the URL is returned. Rejected with `422` when the source, schedule or secrets are invalid or the project does not exist, and with `409` when the account already has 50 scripts. Requires the *Manage my account* permission; a script\'s own API key cannot call this or any other script operation.
+     * Create a script
+     */
+    async createRaw(requestParameters: ScriptsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptDetail>> {
+        if (requestParameters['scriptPostReqBody'] == null) {
+            throw new runtime.RequiredError(
+                'scriptPostReqBody',
+                'Required parameter "scriptPostReqBody" was null or undefined when calling create().'
+            );
+        }
+
+        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`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: ScriptPostReqBodyToJSON(requestParameters['scriptPostReqBody']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ScriptDetailFromJSON(jsonValue));
+    }
+
+    /**
+     * Creates a script whose Python, Go or JavaScript handler is called on a schedule, from a webhook, or both. The handler\'s context carries a Spaciv API key acting with the caller\'s permissions, except the account-administration permissions (*Manage my account*, *Manage users*, *Edit my user profile*, *Edit billing address* and the system permissions), which a script\'s key never carries, plus the account and, when a project is set, the project; the key is rotated automatically. A non-null return value is written to the run\'s logs. When `webhook` is true the response\'s `webhookUrl` is the only time the URL is returned. Rejected with `422` when the source, schedule or secrets are invalid or the project does not exist, and with `409` when the account already has 50 scripts. Requires the *Manage my account* permission; a script\'s own API key cannot call this or any other script operation.
+     * Create a script
+     */
+    async create(requestParameters: ScriptsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptDetail> {
+        const response = await this.createRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Replaces the script\'s API key with a new one acting with the caller\'s permissions, except the account-administration permissions (*Manage my account*, *Manage users*, *Edit my user profile*, *Edit billing address* and the system permissions), which a script\'s key never carries, and revokes the old one. Use it when the key needs re-authorising because its owner lost access, or to hand the script to another user. Requires the *Manage my account* permission.
+     * Re-authorise a script
+     */
+    async createReauthoriseRaw(requestParameters: ScriptsApiCreateReauthoriseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptDetail>> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling createReauthorise().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        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/{id}/reauthorise`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ScriptDetailFromJSON(jsonValue));
+    }
+
+    /**
+     * Replaces the script\'s API key with a new one acting with the caller\'s permissions, except the account-administration permissions (*Manage my account*, *Manage users*, *Edit my user profile*, *Edit billing address* and the system permissions), which a script\'s key never carries, and revokes the old one. Use it when the key needs re-authorising because its owner lost access, or to hand the script to another user. Requires the *Manage my account* permission.
+     * Re-authorise a script
+     */
+    async createReauthorise(requestParameters: ScriptsApiCreateReauthoriseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptDetail> {
+        const response = await this.createReauthoriseRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Issues a new webhook URL and immediately invalidates the previous one. The URL is returned only in this response. Rejected with `409` when the script\'s webhook is turned off, or when another request regenerated it at the same time; the URL returned to that request is the valid one. Requires the *Manage my account* permission.
+     * Regenerate a script\'s webhook URL
+     */
+    async createRegenerateWebhookRaw(requestParameters: ScriptsApiCreateRegenerateWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptWebhookResBody>> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling createRegenerateWebhook().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        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/{id}/regenerate-webhook`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ScriptWebhookResBodyFromJSON(jsonValue));
+    }
+
+    /**
+     * Issues a new webhook URL and immediately invalidates the previous one. The URL is returned only in this response. Rejected with `409` when the script\'s webhook is turned off, or when another request regenerated it at the same time; the URL returned to that request is the valid one. Requires the *Manage my account* permission.
+     * Regenerate a script\'s webhook URL
+     */
+    async createRegenerateWebhook(requestParameters: ScriptsApiCreateRegenerateWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptWebhookResBody> {
+        const response = await this.createRegenerateWebhookRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Checks a cron expression and time zone and returns the next times it would run, so a schedule can be confirmed before saving. An invalid schedule is reported in `error` with `valid` false rather than as an error response. Requires the *Manage my account* permission.
+     * Preview a script schedule
+     */
+    async createSchedulePreviewRaw(requestParameters: ScriptsApiCreateSchedulePreviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptSchedulePreviewResBody>> {
+        if (requestParameters['scriptSchedulePreviewReqBody'] == null) {
+            throw new runtime.RequiredError(
+                'scriptSchedulePreviewReqBody',
+                'Required parameter "scriptSchedulePreviewReqBody" was null or undefined when calling createSchedulePreview().'
+            );
+        }
+
+        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/schedule-preview`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: ScriptSchedulePreviewReqBodyToJSON(requestParameters['scriptSchedulePreviewReqBody']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ScriptSchedulePreviewResBodyFromJSON(jsonValue));
+    }
+
+    /**
+     * Checks a cron expression and time zone and returns the next times it would run, so a schedule can be confirmed before saving. An invalid schedule is reported in `error` with `valid` false rather than as an error response. Requires the *Manage my account* permission.
+     * Preview a script schedule
+     */
+    async createSchedulePreview(requestParameters: ScriptsApiCreateSchedulePreviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptSchedulePreviewResBody> {
+        const response = await this.createSchedulePreviewRaw(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
+     */
+    async deleteRaw(requestParameters: ScriptsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling delete().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        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/{id}`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * 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
+     */
+    async delete(requestParameters: ScriptsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Returns a script with its source, the names of its secrets (never their values), its API key\'s status and, when the runner can be reached, its build state, next scheduled run and resource limits. Requires the *Manage my account* permission.
+     * Get a script
+     */
+    async getRaw(requestParameters: ScriptsApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptDetail>> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling get().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        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/{id}`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ScriptDetailFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns a script with its source, the names of its secrets (never their values), its API key\'s status and, when the runner can be reached, its build state, next scheduled run and resource limits. Requires the *Manage my account* permission.
+     * Get a script
+     */
+    async get(requestParameters: ScriptsApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptDetail> {
+        const response = await this.getRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Lists changes to the script and its API key, newest first. Requires the *Manage my account* permission.
+     * List a script\'s activity
+     */
+    async getAuditRaw(requestParameters: ScriptsApiGetAuditRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptAuditResBody>> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling getAudit().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        if (requestParameters['cursor'] != null) {
+            queryParameters['cursor'] = requestParameters['cursor'];
+        }
+
+        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/{id}/audit`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ScriptAuditResBodyFromJSON(jsonValue));
+    }
+
+    /**
+     * Lists changes to the script and its API key, newest first. Requires the *Manage my account* permission.
+     * List a script\'s activity
+     */
+    async getAudit(requestParameters: ScriptsApiGetAuditRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptAuditResBody> {
+        const response = await this.getAuditRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Returns every script in the account with its settings, source, dependency manifest and secret names (never their values), and each script\'s run history: every build and run still kept, with the API path of its logs. A history too long to read within the request keeps its newest runs and sets runsError; page through the script\'s runs for the rest. Webhook URLs are not included. Requires the *Manage my account* permission.
+     * Export scripts
+     */
+    async getExportRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptExportResBody>> {
+        const queryParameters: any = {};
+
+        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/export`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ScriptExportResBodyFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns every script in the account with its settings, source, dependency manifest and secret names (never their values), and each script\'s run history: every build and run still kept, with the API path of its logs. A history too long to read within the request keeps its newest runs and sets runsError; page through the script\'s runs for the rest. Webhook URLs are not included. Requires the *Manage my account* permission.
+     * Export scripts
+     */
+    async getExport(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptExportResBody> {
+        const response = await this.getExportRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Lists the account\'s scripts, sorted by name, without their source code. Requires the *Manage my account* permission.
+     * List scripts
+     */
+    async listRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptListResBody>> {
+        const queryParameters: any = {};
+
+        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`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ScriptListResBodyFromJSON(jsonValue));
+    }
+
+    /**
+     * Lists the account\'s scripts, sorted by name, without their source code. Requires the *Manage my account* permission.
+     * List scripts
+     */
+    async list(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptListResBody> {
+        const response = await this.listRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Lists the script\'s builds and runs, newest first. Requires the *Manage my account* permission.
+     * List a script\'s runs
+     */
+    async listRunsRaw(requestParameters: ScriptsApiListRunsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptRunsResBody>> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling listRuns().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        if (requestParameters['cursor'] != null) {
+            queryParameters['cursor'] = requestParameters['cursor'];
+        }
+
+        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/{id}/runs`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ScriptRunsResBodyFromJSON(jsonValue));
+    }
+
+    /**
+     * Lists the script\'s builds and runs, newest first. Requires the *Manage my account* permission.
+     * List a script\'s runs
+     */
+    async listRuns(requestParameters: ScriptsApiListRunsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptRunsResBody> {
+        const response = await this.listRunsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Returns the output the run or build wrote to stdout and stderr. Requires the *Manage my account* permission.
+     * Get a script run\'s logs
+     */
+    async listRunsLogsRaw(requestParameters: ScriptsApiListRunsLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptRunLogsResBody>> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling listRunsLogs().'
+            );
+        }
+
+        if (requestParameters['runId'] == null) {
+            throw new runtime.RequiredError(
+                'runId',
+                'Required parameter "runId" was null or undefined when calling listRunsLogs().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        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/{id}/runs/{runId}/logs`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+        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) => ScriptRunLogsResBodyFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns the output the run or build wrote to stdout and stderr. Requires the *Manage my account* permission.
+     * Get a script run\'s logs
+     */
+    async listRunsLogs(requestParameters: ScriptsApiListRunsLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptRunLogsResBody> {
+        const response = await this.listRunsLogsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Updates the fields given. Changing the project replaces the script\'s API key with one scoped to the new project. When someone other than the key\'s owner changes the language, manifest or files, the key is replaced with one acting as them. Turning the webhook on returns its `webhookUrl` once. Rejected with `409` when `revision` is stale, or when enabling a script whose key needs re-authorising; with `422` when the result is invalid. Requires the *Manage my account* permission.
+     * Update a script
+     */
+    async updateRaw(requestParameters: ScriptsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptDetail>> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling update().'
+            );
+        }
+
+        if (requestParameters['scriptPatchReqBody'] == null) {
+            throw new runtime.RequiredError(
+                'scriptPatchReqBody',
+                'Required parameter "scriptPatchReqBody" was null or undefined when calling update().'
+            );
+        }
+
+        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/{id}`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'PATCH',
+            headers: headerParameters,
+            query: queryParameters,
+            body: ScriptPatchReqBodyToJSON(requestParameters['scriptPatchReqBody']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ScriptDetailFromJSON(jsonValue));
+    }
+
+    /**
+     * Updates the fields given. Changing the project replaces the script\'s API key with one scoped to the new project. When someone other than the key\'s owner changes the language, manifest or files, the key is replaced with one acting as them. Turning the webhook on returns its `webhookUrl` once. Rejected with `409` when `revision` is stale, or when enabling a script whose key needs re-authorising; with `422` when the result is invalid. Requires the *Manage my account* permission.
+     * Update a script
+     */
+    async update(requestParameters: ScriptsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptDetail> {
+        const response = await this.updateRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Adds, replaces or removes the script\'s secrets; secrets not named are left unchanged. Values are write-only and are never returned; the response has the script\'s new `revision`. When someone other than the key\'s owner sets secrets, the script\'s API key is replaced with one acting as them. Names must be upper-case environment variable names and must not start with `SPACIV_`, which is reserved for the values Spaciv provides. Requires the *Manage my account* permission.
+     * Set script secrets
+     */
+    async updateSecretsRaw(requestParameters: ScriptsApiUpdateSecretsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptSecretsResBody>> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling updateSecrets().'
+            );
+        }
+
+        if (requestParameters['scriptSecretsReqBody'] == null) {
+            throw new runtime.RequiredError(
+                'scriptSecretsReqBody',
+                'Required parameter "scriptSecretsReqBody" was null or undefined when calling updateSecrets().'
+            );
+        }
+
+        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/{id}/secrets`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: ScriptSecretsReqBodyToJSON(requestParameters['scriptSecretsReqBody']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ScriptSecretsResBodyFromJSON(jsonValue));
+    }
+
+    /**
+     * Adds, replaces or removes the script\'s secrets; secrets not named are left unchanged. Values are write-only and are never returned; the response has the script\'s new `revision`. When someone other than the key\'s owner sets secrets, the script\'s API key is replaced with one acting as them. Names must be upper-case environment variable names and must not start with `SPACIV_`, which is reserved for the values Spaciv provides. Requires the *Manage my account* permission.
+     * Set script secrets
+     */
+    async updateSecrets(requestParameters: ScriptsApiUpdateSecretsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptSecretsResBody> {
+        const response = await this.updateSecretsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}