@spaciv/sdk 0.1.20 → 0.1.22

package/dist/esm/apis/SpaceRulesetsApi.d.ts

@@ -1,269 +0,0 @@
-/**
- * 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 { SpaceRuleSet, SpaceRuleSetJSON, SpaceRulesetCreate, SpaceRulesetListEntry, SpaceRulesetUpdate } from '../models/index';
-export interface SpaceRulesetsApiCreateRequest {
-    spaceRulesetCreate: SpaceRulesetCreate;
-}
-export interface SpaceRulesetsApiCreateImageRequest {
-    id: string;
-    filename?: Blob;
-    name?: string;
-}
-export interface SpaceRulesetsApiDeleteRequest {
-    id: string;
-}
-export interface SpaceRulesetsApiDeleteImageRequest {
-    id: string;
-}
-export interface SpaceRulesetsApiGetRequest {
-    id: string;
-}
-export interface SpaceRulesetsApiGetImageRequest {
-    id: string;
-    noFallback?: boolean;
-}
-export interface SpaceRulesetsApiUpdateRequest {
-    id: string;
-    spaceRulesetUpdate: SpaceRulesetUpdate;
-}
-/**
- * SpaceRulesetsApi - interface
- *
- * @export
- * @interface SpaceRulesetsApiInterface
- */
-export interface SpaceRulesetsApiInterface {
-    /**
-     * Creates a new space ruleset for the current account. Supply `preset` to copy an existing built-in preset as the starting configuration; the preset\'s space modules are cloned into the account\'s module library as needed. Omit `preset` to start with an empty configuration for the given `type`. Requires the *Edit space rule sets* permission.
-     * @summary Create a space ruleset
-     * @param {SpaceRulesetCreate} spaceRulesetCreate
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof SpaceRulesetsApiInterface
-     */
-    createRaw(requestParameters: SpaceRulesetsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
-    /**
-     * Creates a new space ruleset for the current account. Supply `preset` to copy an existing built-in preset as the starting configuration; the preset\'s space modules are cloned into the account\'s module library as needed. Omit `preset` to start with an empty configuration for the given `type`. Requires the *Edit space rule sets* permission.
-     * Create a space ruleset
-     */
-    create(requestParameters: SpaceRulesetsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
-    /**
-     * Uploads an illustrative image for a space ruleset. Send the file as `multipart/form-data` with the field key `file`. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). No larger than 4 MB. Replaces any previously uploaded image. Requires the *Edit space rule sets* permission.
-     * @summary Upload a space ruleset image
-     * @param {string} id
-     * @param {Blob} [filename] filename of the file being uploaded
-     * @param {string} [name] general purpose name for multipart form value
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof SpaceRulesetsApiInterface
-     */
-    createImageRaw(requestParameters: SpaceRulesetsApiCreateImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
-    /**
-     * Uploads an illustrative image for a space ruleset. Send the file as `multipart/form-data` with the field key `file`. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). No larger than 4 MB. Replaces any previously uploaded image. Requires the *Edit space rule sets* permission.
-     * Upload a space ruleset image
-     */
-    createImage(requestParameters: SpaceRulesetsApiCreateImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
-    /**
-     * Permanently deletes a space ruleset from the current account and removes it from every variable\'s allowed `options`; a variable whose value was the ruleset moves to its first remaining option. Requires the *Edit space rule set details* permission.
-     * @summary Delete a space ruleset
-     * @param {string} id
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof SpaceRulesetsApiInterface
-     */
-    deleteRaw(requestParameters: SpaceRulesetsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
-    /**
-     * Permanently deletes a space ruleset from the current account and removes it from every variable\'s allowed `options`; a variable whose value was the ruleset moves to its first remaining option. Requires the *Edit space rule set details* permission.
-     * Delete a space ruleset
-     */
-    delete(requestParameters: SpaceRulesetsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
-    /**
-     * Removes the custom image for a space ruleset. After deletion, `GET /v1/space-rulesets/{id}/image` returns a generated default image unless `noFallback` is set. Requires the *Edit space rule sets* permission.
-     * @summary Delete a space ruleset image
-     * @param {string} id
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof SpaceRulesetsApiInterface
-     */
-    deleteImageRaw(requestParameters: SpaceRulesetsApiDeleteImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
-    /**
-     * Removes the custom image for a space ruleset. After deletion, `GET /v1/space-rulesets/{id}/image` returns a generated default image unless `noFallback` is set. Requires the *Edit space rule sets* permission.
-     * Delete a space ruleset image
-     */
-    deleteImage(requestParameters: SpaceRulesetsApiDeleteImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
-    /**
-     * Returns the full detail of a space ruleset including its calculation configuration. Requires the *View space rule set details* permission.
-     * @summary Get a space ruleset
-     * @param {string} id
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof SpaceRulesetsApiInterface
-     */
-    getRaw(requestParameters: SpaceRulesetsApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SpaceRuleSetJSON>>;
-    /**
-     * Returns the full detail of a space ruleset including its calculation configuration. Requires the *View space rule set details* permission.
-     * Get a space ruleset
-     */
-    get(requestParameters: SpaceRulesetsApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SpaceRuleSetJSON>;
-    /**
-     * Returns the illustrative image for a space ruleset. If no image has been uploaded and `noFallback` is not set, a default image is generated from the ruleset name. The response `Content-Type` header reflects the actual image format. Requires the *View space rule sets* permission. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the stored image matches a virus signature; the bytes are kept for investigation.
-     * @summary Get a space ruleset image
-     * @param {string} id
-     * @param {boolean} [noFallback] When true, returns 404 if no custom image has been uploaded rather than generating a default image from the ruleset name.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof SpaceRulesetsApiInterface
-     */
-    getImageRaw(requestParameters: SpaceRulesetsApiGetImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
-    /**
-     * Returns the illustrative image for a space ruleset. If no image has been uploaded and `noFallback` is not set, a default image is generated from the ruleset name. The response `Content-Type` header reflects the actual image format. Requires the *View space rule sets* permission. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the stored image matches a virus signature; the bytes are kept for investigation.
-     * Get a space ruleset image
-     */
-    getImage(requestParameters: SpaceRulesetsApiGetImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
-    /**
-     * Returns all space rulesets belonging to the current account with summary fields. Use `GET /v1/space-rulesets/{id}` to retrieve the full configuration for a specific ruleset. Requires the *View space rule sets* permission.
-     * @summary List space rulesets
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof SpaceRulesetsApiInterface
-     */
-    listRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SpaceRulesetListEntry>>>;
-    /**
-     * Returns all space rulesets belonging to the current account with summary fields. Use `GET /v1/space-rulesets/{id}` to retrieve the full configuration for a specific ruleset. Requires the *View space rule sets* permission.
-     * List space rulesets
-     */
-    list(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SpaceRulesetListEntry>>;
-    /**
-     * Returns the spaciv-supplied preset space rulesets available to all accounts. Pass one of the returned IDs as `preset` when calling `POST /v1/space-rulesets` to create a copy in the current account. Requires the *View space rule sets* permission.
-     * @summary List preset space rulesets
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof SpaceRulesetsApiInterface
-     */
-    listPresetsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SpaceRuleSet>>>;
-    /**
-     * Returns the spaciv-supplied preset space rulesets available to all accounts. Pass one of the returned IDs as `preset` when calling `POST /v1/space-rulesets` to create a copy in the current account. Requires the *View space rule sets* permission.
-     * List preset space rulesets
-     */
-    listPresets(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SpaceRuleSet>>;
-    /**
-     * Updates one or more fields of a space ruleset. Only fields present in the request body are changed; `modifiedAt` is always updated to the current time. Returns `404` if the ruleset does not exist. Requires the *Edit space rule set details* permission.
-     * @summary Update a space ruleset
-     * @param {string} id
-     * @param {SpaceRulesetUpdate} spaceRulesetUpdate
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof SpaceRulesetsApiInterface
-     */
-    updateRaw(requestParameters: SpaceRulesetsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
-    /**
-     * Updates one or more fields of a space ruleset. Only fields present in the request body are changed; `modifiedAt` is always updated to the current time. Returns `404` if the ruleset does not exist. Requires the *Edit space rule set details* permission.
-     * Update a space ruleset
-     */
-    update(requestParameters: SpaceRulesetsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
-}
-/**
- *
- */
-export declare class SpaceRulesetsApi extends runtime.BaseAPI implements SpaceRulesetsApiInterface {
-    /**
-     * Creates a new space ruleset for the current account. Supply `preset` to copy an existing built-in preset as the starting configuration; the preset\'s space modules are cloned into the account\'s module library as needed. Omit `preset` to start with an empty configuration for the given `type`. Requires the *Edit space rule sets* permission.
-     * Create a space ruleset
-     */
-    createRaw(requestParameters: SpaceRulesetsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
-    /**
-     * Creates a new space ruleset for the current account. Supply `preset` to copy an existing built-in preset as the starting configuration; the preset\'s space modules are cloned into the account\'s module library as needed. Omit `preset` to start with an empty configuration for the given `type`. Requires the *Edit space rule sets* permission.
-     * Create a space ruleset
-     */
-    create(requestParameters: SpaceRulesetsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
-    /**
-     * Uploads an illustrative image for a space ruleset. Send the file as `multipart/form-data` with the field key `file`. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). No larger than 4 MB. Replaces any previously uploaded image. Requires the *Edit space rule sets* permission.
-     * Upload a space ruleset image
-     */
-    createImageRaw(requestParameters: SpaceRulesetsApiCreateImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
-    /**
-     * Uploads an illustrative image for a space ruleset. Send the file as `multipart/form-data` with the field key `file`. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). No larger than 4 MB. Replaces any previously uploaded image. Requires the *Edit space rule sets* permission.
-     * Upload a space ruleset image
-     */
-    createImage(requestParameters: SpaceRulesetsApiCreateImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
-    /**
-     * Permanently deletes a space ruleset from the current account and removes it from every variable\'s allowed `options`; a variable whose value was the ruleset moves to its first remaining option. Requires the *Edit space rule set details* permission.
-     * Delete a space ruleset
-     */
-    deleteRaw(requestParameters: SpaceRulesetsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
-    /**
-     * Permanently deletes a space ruleset from the current account and removes it from every variable\'s allowed `options`; a variable whose value was the ruleset moves to its first remaining option. Requires the *Edit space rule set details* permission.
-     * Delete a space ruleset
-     */
-    delete(requestParameters: SpaceRulesetsApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
-    /**
-     * Removes the custom image for a space ruleset. After deletion, `GET /v1/space-rulesets/{id}/image` returns a generated default image unless `noFallback` is set. Requires the *Edit space rule sets* permission.
-     * Delete a space ruleset image
-     */
-    deleteImageRaw(requestParameters: SpaceRulesetsApiDeleteImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
-    /**
-     * Removes the custom image for a space ruleset. After deletion, `GET /v1/space-rulesets/{id}/image` returns a generated default image unless `noFallback` is set. Requires the *Edit space rule sets* permission.
-     * Delete a space ruleset image
-     */
-    deleteImage(requestParameters: SpaceRulesetsApiDeleteImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
-    /**
-     * Returns the full detail of a space ruleset including its calculation configuration. Requires the *View space rule set details* permission.
-     * Get a space ruleset
-     */
-    getRaw(requestParameters: SpaceRulesetsApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SpaceRuleSetJSON>>;
-    /**
-     * Returns the full detail of a space ruleset including its calculation configuration. Requires the *View space rule set details* permission.
-     * Get a space ruleset
-     */
-    get(requestParameters: SpaceRulesetsApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SpaceRuleSetJSON>;
-    /**
-     * Returns the illustrative image for a space ruleset. If no image has been uploaded and `noFallback` is not set, a default image is generated from the ruleset name. The response `Content-Type` header reflects the actual image format. Requires the *View space rule sets* permission. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the stored image matches a virus signature; the bytes are kept for investigation.
-     * Get a space ruleset image
-     */
-    getImageRaw(requestParameters: SpaceRulesetsApiGetImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
-    /**
-     * Returns the illustrative image for a space ruleset. If no image has been uploaded and `noFallback` is not set, a default image is generated from the ruleset name. The response `Content-Type` header reflects the actual image format. Requires the *View space rule sets* permission. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the stored image matches a virus signature; the bytes are kept for investigation.
-     * Get a space ruleset image
-     */
-    getImage(requestParameters: SpaceRulesetsApiGetImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
-    /**
-     * Returns all space rulesets belonging to the current account with summary fields. Use `GET /v1/space-rulesets/{id}` to retrieve the full configuration for a specific ruleset. Requires the *View space rule sets* permission.
-     * List space rulesets
-     */
-    listRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SpaceRulesetListEntry>>>;
-    /**
-     * Returns all space rulesets belonging to the current account with summary fields. Use `GET /v1/space-rulesets/{id}` to retrieve the full configuration for a specific ruleset. Requires the *View space rule sets* permission.
-     * List space rulesets
-     */
-    list(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SpaceRulesetListEntry>>;
-    /**
-     * Returns the spaciv-supplied preset space rulesets available to all accounts. Pass one of the returned IDs as `preset` when calling `POST /v1/space-rulesets` to create a copy in the current account. Requires the *View space rule sets* permission.
-     * List preset space rulesets
-     */
-    listPresetsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SpaceRuleSet>>>;
-    /**
-     * Returns the spaciv-supplied preset space rulesets available to all accounts. Pass one of the returned IDs as `preset` when calling `POST /v1/space-rulesets` to create a copy in the current account. Requires the *View space rule sets* permission.
-     * List preset space rulesets
-     */
-    listPresets(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SpaceRuleSet>>;
-    /**
-     * Updates one or more fields of a space ruleset. Only fields present in the request body are changed; `modifiedAt` is always updated to the current time. Returns `404` if the ruleset does not exist. Requires the *Edit space rule set details* permission.
-     * Update a space ruleset
-     */
-    updateRaw(requestParameters: SpaceRulesetsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
-    /**
-     * Updates one or more fields of a space ruleset. Only fields present in the request body are changed; `modifiedAt` is always updated to the current time. Returns `404` if the ruleset does not exist. Requires the *Edit space rule set details* permission.
-     * Update a space ruleset
-     */
-    update(requestParameters: SpaceRulesetsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
-}