@spaciv/sdk 0.1.21 → 0.1.23

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

@@ -0,0 +1,279 @@
+/**
+ * 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 LogicLayersApiCreateSpaceRulesetsRequest {
+    spaceRulesetCreate: SpaceRulesetCreate;
+}
+export interface LogicLayersApiCreateSpaceRulesetsImageRequest {
+    id: string;
+    filename?: Blob;
+    name?: string;
+}
+export interface LogicLayersApiDeleteSpaceRulesetsRequest {
+    id: string;
+}
+export interface LogicLayersApiDeleteSpaceRulesetsImageRequest {
+    id: string;
+}
+export interface LogicLayersApiGetSpaceRulesetsRequest {
+    id: string;
+    format?: LogicLayersApiGetSpaceRulesetsFormatEnum;
+}
+export interface LogicLayersApiGetSpaceRulesetsImageRequest {
+    id: string;
+    noFallback?: boolean;
+}
+export interface LogicLayersApiUpdateSpaceRulesetsRequest {
+    id: string;
+    spaceRulesetUpdate: SpaceRulesetUpdate;
+}
+/**
+ * LogicLayersApi - interface
+ *
+ * @export
+ * @interface LogicLayersApiInterface
+ */
+export interface LogicLayersApiInterface {
+    /**
+     * Creates a new logic layer 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 no rules. Requires the *Edit space rule sets* permission.
+     * @summary Create a logic layer
+     * @param {SpaceRulesetCreate} spaceRulesetCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LogicLayersApiInterface
+     */
+    createSpaceRulesetsRaw(requestParameters: LogicLayersApiCreateSpaceRulesetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
+    /**
+     * Creates a new logic layer 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 no rules. Requires the *Edit space rule sets* permission.
+     * Create a logic layer
+     */
+    createSpaceRulesets(requestParameters: LogicLayersApiCreateSpaceRulesetsRequest, 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 LogicLayersApiInterface
+     */
+    createSpaceRulesetsImageRaw(requestParameters: LogicLayersApiCreateSpaceRulesetsImageRequest, 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
+     */
+    createSpaceRulesetsImage(requestParameters: LogicLayersApiCreateSpaceRulesetsImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
+    /**
+     * Permanently deletes a logic layer from the current account and removes it from every variable\'s allowed `options`; a variable whose value was the logic layer moves to its first remaining option. Requires the *Edit space rule set details* permission.
+     * @summary Delete a logic layer
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LogicLayersApiInterface
+     */
+    deleteSpaceRulesetsRaw(requestParameters: LogicLayersApiDeleteSpaceRulesetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
+    /**
+     * Permanently deletes a logic layer from the current account and removes it from every variable\'s allowed `options`; a variable whose value was the logic layer moves to its first remaining option. Requires the *Edit space rule set details* permission.
+     * Delete a logic layer
+     */
+    deleteSpaceRulesets(requestParameters: LogicLayersApiDeleteSpaceRulesetsRequest, 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 LogicLayersApiInterface
+     */
+    deleteSpaceRulesetsImageRaw(requestParameters: LogicLayersApiDeleteSpaceRulesetsImageRequest, 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
+     */
+    deleteSpaceRulesetsImage(requestParameters: LogicLayersApiDeleteSpaceRulesetsImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
+    /**
+     * Returns the full detail of a logic layer, including its rules as a `LogicLayerConfig`. Each rule balances the supply objects its filters select against the demand objects its filters select, at a ratio of supply per demand or as a total spread over the demand. Configs saved by an app from before logic layers are returned as saved unless `format=logic` is set. Returns `404` if the logic layer does not exist. Requires the *View space rule set details* permission.
+     * @summary Get a logic layer
+     * @param {string} id
+     * @param {'stored' | 'logic'} [format] stored returns the config as it was saved; logic converts a config saved by an app from before logic layers into a LogicLayerConfig.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LogicLayersApiInterface
+     */
+    getSpaceRulesetsRaw(requestParameters: LogicLayersApiGetSpaceRulesetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SpaceRuleSetJSON>>;
+    /**
+     * Returns the full detail of a logic layer, including its rules as a `LogicLayerConfig`. Each rule balances the supply objects its filters select against the demand objects its filters select, at a ratio of supply per demand or as a total spread over the demand. Configs saved by an app from before logic layers are returned as saved unless `format=logic` is set. Returns `404` if the logic layer does not exist. Requires the *View space rule set details* permission.
+     * Get a logic layer
+     */
+    getSpaceRulesets(requestParameters: LogicLayersApiGetSpaceRulesetsRequest, 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 LogicLayersApiInterface
+     */
+    getSpaceRulesetsImageRaw(requestParameters: LogicLayersApiGetSpaceRulesetsImageRequest, 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
+     */
+    getSpaceRulesetsImage(requestParameters: LogicLayersApiGetSpaceRulesetsImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+    /**
+     * Returns all logic layers belonging to the current account with summary fields. Use `GET /v1/space-rulesets/{id}` to retrieve the full configuration for a specific logic layer. Requires the *View space rule sets* permission.
+     * @summary List logic layers
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LogicLayersApiInterface
+     */
+    listSpaceRulesetsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SpaceRulesetListEntry>>>;
+    /**
+     * Returns all logic layers belonging to the current account with summary fields. Use `GET /v1/space-rulesets/{id}` to retrieve the full configuration for a specific logic layer. Requires the *View space rule sets* permission.
+     * List logic layers
+     */
+    listSpaceRulesets(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SpaceRulesetListEntry>>;
+    /**
+     * Returns the spaciv-supplied preset logic layers 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 logic layers
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LogicLayersApiInterface
+     */
+    listSpaceRulesetsPresetsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SpaceRuleSet>>>;
+    /**
+     * Returns the spaciv-supplied preset logic layers 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 logic layers
+     */
+    listSpaceRulesetsPresets(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SpaceRuleSet>>;
+    /**
+     * Updates one or more fields of a logic layer. Only fields present in the request body are changed; `modifiedAt` is always updated to the current time. `config` is a `LogicLayerConfig`; one in a space rule shape from before logic layers is checked to convert to a logic layer and stored as sent. Functions may use account number variables (`{\"var\": \"account:<id>\"}`), which needs the *Variable controls* feature. Returns `400` if `config` is not a valid logic layer or uses an unknown or non-number variable, and `404` if the logic layer does not exist. Requires the *Edit space rule set details* permission.
+     * @summary Update a logic layer
+     * @param {string} id
+     * @param {SpaceRulesetUpdate} spaceRulesetUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LogicLayersApiInterface
+     */
+    updateSpaceRulesetsRaw(requestParameters: LogicLayersApiUpdateSpaceRulesetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
+    /**
+     * Updates one or more fields of a logic layer. Only fields present in the request body are changed; `modifiedAt` is always updated to the current time. `config` is a `LogicLayerConfig`; one in a space rule shape from before logic layers is checked to convert to a logic layer and stored as sent. Functions may use account number variables (`{\"var\": \"account:<id>\"}`), which needs the *Variable controls* feature. Returns `400` if `config` is not a valid logic layer or uses an unknown or non-number variable, and `404` if the logic layer does not exist. Requires the *Edit space rule set details* permission.
+     * Update a logic layer
+     */
+    updateSpaceRulesets(requestParameters: LogicLayersApiUpdateSpaceRulesetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
+}
+/**
+ *
+ */
+export declare class LogicLayersApi extends runtime.BaseAPI implements LogicLayersApiInterface {
+    /**
+     * Creates a new logic layer 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 no rules. Requires the *Edit space rule sets* permission.
+     * Create a logic layer
+     */
+    createSpaceRulesetsRaw(requestParameters: LogicLayersApiCreateSpaceRulesetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
+    /**
+     * Creates a new logic layer 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 no rules. Requires the *Edit space rule sets* permission.
+     * Create a logic layer
+     */
+    createSpaceRulesets(requestParameters: LogicLayersApiCreateSpaceRulesetsRequest, 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
+     */
+    createSpaceRulesetsImageRaw(requestParameters: LogicLayersApiCreateSpaceRulesetsImageRequest, 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
+     */
+    createSpaceRulesetsImage(requestParameters: LogicLayersApiCreateSpaceRulesetsImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
+    /**
+     * Permanently deletes a logic layer from the current account and removes it from every variable\'s allowed `options`; a variable whose value was the logic layer moves to its first remaining option. Requires the *Edit space rule set details* permission.
+     * Delete a logic layer
+     */
+    deleteSpaceRulesetsRaw(requestParameters: LogicLayersApiDeleteSpaceRulesetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
+    /**
+     * Permanently deletes a logic layer from the current account and removes it from every variable\'s allowed `options`; a variable whose value was the logic layer moves to its first remaining option. Requires the *Edit space rule set details* permission.
+     * Delete a logic layer
+     */
+    deleteSpaceRulesets(requestParameters: LogicLayersApiDeleteSpaceRulesetsRequest, 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
+     */
+    deleteSpaceRulesetsImageRaw(requestParameters: LogicLayersApiDeleteSpaceRulesetsImageRequest, 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
+     */
+    deleteSpaceRulesetsImage(requestParameters: LogicLayersApiDeleteSpaceRulesetsImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
+    /**
+     * Returns the full detail of a logic layer, including its rules as a `LogicLayerConfig`. Each rule balances the supply objects its filters select against the demand objects its filters select, at a ratio of supply per demand or as a total spread over the demand. Configs saved by an app from before logic layers are returned as saved unless `format=logic` is set. Returns `404` if the logic layer does not exist. Requires the *View space rule set details* permission.
+     * Get a logic layer
+     */
+    getSpaceRulesetsRaw(requestParameters: LogicLayersApiGetSpaceRulesetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SpaceRuleSetJSON>>;
+    /**
+     * Returns the full detail of a logic layer, including its rules as a `LogicLayerConfig`. Each rule balances the supply objects its filters select against the demand objects its filters select, at a ratio of supply per demand or as a total spread over the demand. Configs saved by an app from before logic layers are returned as saved unless `format=logic` is set. Returns `404` if the logic layer does not exist. Requires the *View space rule set details* permission.
+     * Get a logic layer
+     */
+    getSpaceRulesets(requestParameters: LogicLayersApiGetSpaceRulesetsRequest, 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
+     */
+    getSpaceRulesetsImageRaw(requestParameters: LogicLayersApiGetSpaceRulesetsImageRequest, 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
+     */
+    getSpaceRulesetsImage(requestParameters: LogicLayersApiGetSpaceRulesetsImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+    /**
+     * Returns all logic layers belonging to the current account with summary fields. Use `GET /v1/space-rulesets/{id}` to retrieve the full configuration for a specific logic layer. Requires the *View space rule sets* permission.
+     * List logic layers
+     */
+    listSpaceRulesetsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SpaceRulesetListEntry>>>;
+    /**
+     * Returns all logic layers belonging to the current account with summary fields. Use `GET /v1/space-rulesets/{id}` to retrieve the full configuration for a specific logic layer. Requires the *View space rule sets* permission.
+     * List logic layers
+     */
+    listSpaceRulesets(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SpaceRulesetListEntry>>;
+    /**
+     * Returns the spaciv-supplied preset logic layers 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 logic layers
+     */
+    listSpaceRulesetsPresetsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SpaceRuleSet>>>;
+    /**
+     * Returns the spaciv-supplied preset logic layers 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 logic layers
+     */
+    listSpaceRulesetsPresets(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SpaceRuleSet>>;
+    /**
+     * Updates one or more fields of a logic layer. Only fields present in the request body are changed; `modifiedAt` is always updated to the current time. `config` is a `LogicLayerConfig`; one in a space rule shape from before logic layers is checked to convert to a logic layer and stored as sent. Functions may use account number variables (`{\"var\": \"account:<id>\"}`), which needs the *Variable controls* feature. Returns `400` if `config` is not a valid logic layer or uses an unknown or non-number variable, and `404` if the logic layer does not exist. Requires the *Edit space rule set details* permission.
+     * Update a logic layer
+     */
+    updateSpaceRulesetsRaw(requestParameters: LogicLayersApiUpdateSpaceRulesetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
+    /**
+     * Updates one or more fields of a logic layer. Only fields present in the request body are changed; `modifiedAt` is always updated to the current time. `config` is a `LogicLayerConfig`; one in a space rule shape from before logic layers is checked to convert to a logic layer and stored as sent. Functions may use account number variables (`{\"var\": \"account:<id>\"}`), which needs the *Variable controls* feature. Returns `400` if `config` is not a valid logic layer or uses an unknown or non-number variable, and `404` if the logic layer does not exist. Requires the *Edit space rule set details* permission.
+     * Update a logic layer
+     */
+    updateSpaceRulesets(requestParameters: LogicLayersApiUpdateSpaceRulesetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
+}
+/**
+ * @export
+ */
+export declare const LogicLayersApiGetSpaceRulesetsFormatEnum: {
+    readonly Stored: "stored";
+    readonly Logic: "logic";
+};
+export type LogicLayersApiGetSpaceRulesetsFormatEnum = typeof LogicLayersApiGetSpaceRulesetsFormatEnum[keyof typeof LogicLayersApiGetSpaceRulesetsFormatEnum];

package/dist/esm/apis/{SpaceRulesetsApi.js → LogicLayersApi.js}

@@ -25,15 +25,15 @@ import { SpaceRuleSetFromJSON, SpaceRuleSetJSONFromJSON, SpaceRulesetCreateToJSO
 /**
  *
  */
-export class SpaceRulesetsApi extends runtime.BaseAPI {
+export class LogicLayersApi extends runtime.BaseAPI {
     /**
-     * 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
+     * Creates a new logic layer 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 no rules. Requires the *Edit space rule sets* permission.
+     * Create a logic layer
      */
-    createRaw(requestParameters, initOverrides) {
+    createSpaceRulesetsRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['spaceRulesetCreate'] == null) {
-                throw new runtime.RequiredError('spaceRulesetCreate', 'Required parameter "spaceRulesetCreate" was null or undefined when calling create().');
+                throw new runtime.RequiredError('spaceRulesetCreate', 'Required parameter "spaceRulesetCreate" was null or undefined when calling createSpaceRulesets().');
             }
             const queryParameters = {};
             const headerParameters = {};
@@ -57,12 +57,12 @@ export class SpaceRulesetsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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
+     * Creates a new logic layer 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 no rules. Requires the *Edit space rule sets* permission.
+     * Create a logic layer
      */
-    create(requestParameters, initOverrides) {
+    createSpaceRulesets(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.createRaw(requestParameters, initOverrides);
+            const response = yield this.createSpaceRulesetsRaw(requestParameters, initOverrides);
             return yield response.value();
         });
     }
@@ -70,10 +70,10 @@ export class SpaceRulesetsApi extends runtime.BaseAPI {
      * 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, initOverrides) {
+    createSpaceRulesetsImageRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['id'] == null) {
-                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling createImage().');
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling createSpaceRulesetsImage().');
             }
             const queryParameters = {};
             const headerParameters = {};
@@ -121,20 +121,20 @@ export class SpaceRulesetsApi extends runtime.BaseAPI {
      * 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, initOverrides) {
+    createSpaceRulesetsImage(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.createImageRaw(requestParameters, initOverrides);
+            const response = yield this.createSpaceRulesetsImageRaw(requestParameters, initOverrides);
             return yield response.value();
         });
     }
     /**
-     * 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
+     * Permanently deletes a logic layer from the current account and removes it from every variable\'s allowed `options`; a variable whose value was the logic layer moves to its first remaining option. Requires the *Edit space rule set details* permission.
+     * Delete a logic layer
      */
-    deleteRaw(requestParameters, initOverrides) {
+    deleteSpaceRulesetsRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['id'] == null) {
-                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling delete().');
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling deleteSpaceRulesets().');
             }
             const queryParameters = {};
             const headerParameters = {};
@@ -157,12 +157,12 @@ export class SpaceRulesetsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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
+     * Permanently deletes a logic layer from the current account and removes it from every variable\'s allowed `options`; a variable whose value was the logic layer moves to its first remaining option. Requires the *Edit space rule set details* permission.
+     * Delete a logic layer
      */
-    delete(requestParameters, initOverrides) {
+    deleteSpaceRulesets(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.deleteRaw(requestParameters, initOverrides);
+            const response = yield this.deleteSpaceRulesetsRaw(requestParameters, initOverrides);
             return yield response.value();
         });
     }
@@ -170,10 +170,10 @@ export class SpaceRulesetsApi extends runtime.BaseAPI {
      * 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, initOverrides) {
+    deleteSpaceRulesetsImageRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['id'] == null) {
-                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling deleteImage().');
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling deleteSpaceRulesetsImage().');
             }
             const queryParameters = {};
             const headerParameters = {};
@@ -199,22 +199,25 @@ export class SpaceRulesetsApi extends runtime.BaseAPI {
      * 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, initOverrides) {
+    deleteSpaceRulesetsImage(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.deleteImageRaw(requestParameters, initOverrides);
+            const response = yield this.deleteSpaceRulesetsImageRaw(requestParameters, initOverrides);
             return yield response.value();
         });
     }
     /**
-     * Returns the full detail of a space ruleset including its calculation configuration. Requires the *View space rule set details* permission.
-     * Get a space ruleset
+     * Returns the full detail of a logic layer, including its rules as a `LogicLayerConfig`. Each rule balances the supply objects its filters select against the demand objects its filters select, at a ratio of supply per demand or as a total spread over the demand. Configs saved by an app from before logic layers are returned as saved unless `format=logic` is set. Returns `404` if the logic layer does not exist. Requires the *View space rule set details* permission.
+     * Get a logic layer
      */
-    getRaw(requestParameters, initOverrides) {
+    getSpaceRulesetsRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['id'] == null) {
-                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling get().');
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getSpaceRulesets().');
             }
             const queryParameters = {};
+            if (requestParameters['format'] != null) {
+                queryParameters['format'] = requestParameters['format'];
+            }
             const headerParameters = {};
             if (this.configuration && this.configuration.accessToken) {
                 const token = this.configuration.accessToken;
@@ -235,12 +238,12 @@ export class SpaceRulesetsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Returns the full detail of a space ruleset including its calculation configuration. Requires the *View space rule set details* permission.
-     * Get a space ruleset
+     * Returns the full detail of a logic layer, including its rules as a `LogicLayerConfig`. Each rule balances the supply objects its filters select against the demand objects its filters select, at a ratio of supply per demand or as a total spread over the demand. Configs saved by an app from before logic layers are returned as saved unless `format=logic` is set. Returns `404` if the logic layer does not exist. Requires the *View space rule set details* permission.
+     * Get a logic layer
      */
-    get(requestParameters, initOverrides) {
+    getSpaceRulesets(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.getRaw(requestParameters, initOverrides);
+            const response = yield this.getSpaceRulesetsRaw(requestParameters, initOverrides);
             return yield response.value();
         });
     }
@@ -248,10 +251,10 @@ export class SpaceRulesetsApi extends runtime.BaseAPI {
      * 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, initOverrides) {
+    getSpaceRulesetsImageRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['id'] == null) {
-                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getImage().');
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getSpaceRulesetsImage().');
             }
             const queryParameters = {};
             if (requestParameters['noFallback'] != null) {
@@ -285,17 +288,17 @@ export class SpaceRulesetsApi extends runtime.BaseAPI {
      * 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, initOverrides) {
+    getSpaceRulesetsImage(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.getImageRaw(requestParameters, initOverrides);
+            const response = yield this.getSpaceRulesetsImageRaw(requestParameters, initOverrides);
             return yield response.value();
         });
     }
     /**
-     * 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
+     * Returns all logic layers belonging to the current account with summary fields. Use `GET /v1/space-rulesets/{id}` to retrieve the full configuration for a specific logic layer. Requires the *View space rule sets* permission.
+     * List logic layers
      */
-    listRaw(initOverrides) {
+    listSpaceRulesetsRaw(initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
             const queryParameters = {};
             const headerParameters = {};
@@ -317,20 +320,20 @@ export class SpaceRulesetsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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
+     * Returns all logic layers belonging to the current account with summary fields. Use `GET /v1/space-rulesets/{id}` to retrieve the full configuration for a specific logic layer. Requires the *View space rule sets* permission.
+     * List logic layers
      */
-    list(initOverrides) {
+    listSpaceRulesets(initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.listRaw(initOverrides);
+            const response = yield this.listSpaceRulesetsRaw(initOverrides);
             return yield response.value();
         });
     }
     /**
-     * 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
+     * Returns the spaciv-supplied preset logic layers 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 logic layers
      */
-    listPresetsRaw(initOverrides) {
+    listSpaceRulesetsPresetsRaw(initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
             const queryParameters = {};
             const headerParameters = {};
@@ -352,26 +355,26 @@ export class SpaceRulesetsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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
+     * Returns the spaciv-supplied preset logic layers 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 logic layers
      */
-    listPresets(initOverrides) {
+    listSpaceRulesetsPresets(initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.listPresetsRaw(initOverrides);
+            const response = yield this.listSpaceRulesetsPresetsRaw(initOverrides);
             return yield response.value();
         });
     }
     /**
-     * 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
+     * Updates one or more fields of a logic layer. Only fields present in the request body are changed; `modifiedAt` is always updated to the current time. `config` is a `LogicLayerConfig`; one in a space rule shape from before logic layers is checked to convert to a logic layer and stored as sent. Functions may use account number variables (`{\"var\": \"account:<id>\"}`), which needs the *Variable controls* feature. Returns `400` if `config` is not a valid logic layer or uses an unknown or non-number variable, and `404` if the logic layer does not exist. Requires the *Edit space rule set details* permission.
+     * Update a logic layer
      */
-    updateRaw(requestParameters, initOverrides) {
+    updateSpaceRulesetsRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['id'] == null) {
-                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling update().');
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling updateSpaceRulesets().');
             }
             if (requestParameters['spaceRulesetUpdate'] == null) {
-                throw new runtime.RequiredError('spaceRulesetUpdate', 'Required parameter "spaceRulesetUpdate" was null or undefined when calling update().');
+                throw new runtime.RequiredError('spaceRulesetUpdate', 'Required parameter "spaceRulesetUpdate" was null or undefined when calling updateSpaceRulesets().');
             }
             const queryParameters = {};
             const headerParameters = {};
@@ -396,13 +399,20 @@ export class SpaceRulesetsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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
+     * Updates one or more fields of a logic layer. Only fields present in the request body are changed; `modifiedAt` is always updated to the current time. `config` is a `LogicLayerConfig`; one in a space rule shape from before logic layers is checked to convert to a logic layer and stored as sent. Functions may use account number variables (`{\"var\": \"account:<id>\"}`), which needs the *Variable controls* feature. Returns `400` if `config` is not a valid logic layer or uses an unknown or non-number variable, and `404` if the logic layer does not exist. Requires the *Edit space rule set details* permission.
+     * Update a logic layer
      */
-    update(requestParameters, initOverrides) {
+    updateSpaceRulesets(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.updateRaw(requestParameters, initOverrides);
+            const response = yield this.updateSpaceRulesetsRaw(requestParameters, initOverrides);
             return yield response.value();
         });
     }
 }
+/**
+ * @export
+ */
+export const LogicLayersApiGetSpaceRulesetsFormatEnum = {
+    Stored: 'stored',
+    Logic: 'logic'
+};

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

@@ -10,10 +10,13 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { EntryPatch, ObjectGroupChangelogBody, ObjectGroupEntriesRes, ObjectGroupEntrySearchRes, ObjectGroupEntryUpdate, ObjectGroupListRes } from '../models/index';
+import type { EntryPatch, ObjectGroupChangelogBody, ObjectGroupEntriesRes, ObjectGroupEntrySearchRes, ObjectGroupEntryUpdate, ObjectGroupListRes, SelectObjectsParamsWrapperBody, Selection } from '../models/index';
 export interface ObjectGroupsApiCreateRequest {
     objectGroupChangelogBody?: ObjectGroupChangelogBody;
 }
+export interface ObjectGroupsApiCreateSelectRequest {
+    selectObjectsParamsWrapperBody: SelectObjectsParamsWrapperBody;
+}
 export interface ObjectGroupsApiDeleteRequest {
     id: string;
     action?: ObjectGroupsApiDeleteActionEnum;
@@ -100,6 +103,20 @@ export interface ObjectGroupsApiInterface {
      * Create an object group
      */
     create(requestParameters: ObjectGroupsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+    /**
+     * Lists the objects in the account\'s active object groups that `filters` select, grouped by object group, both by name. Filters match as in a calculation: an object group\'s own properties apply to each of its entries, a tree node also selects the nodes below it, and a group\'s property (`og:<object group id>`) selects that group\'s entries. At most 500 objects are returned, with `truncated` set when more matched. Nothing is changed. Requires the *View objects* permission.
+     * @summary Select objects by filters
+     * @param {SelectObjectsParamsWrapperBody} selectObjectsParamsWrapperBody
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ObjectGroupsApiInterface
+     */
+    createSelectRaw(requestParameters: ObjectGroupsApiCreateSelectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Selection>>;
+    /**
+     * Lists the objects in the account\'s active object groups that `filters` select, grouped by object group, both by name. Filters match as in a calculation: an object group\'s own properties apply to each of its entries, a tree node also selects the nodes below it, and a group\'s property (`og:<object group id>`) selects that group\'s entries. At most 500 objects are returned, with `truncated` set when more matched. Nothing is changed. Requires the *View objects* permission.
+     * Select objects by filters
+     */
+    createSelect(requestParameters: ObjectGroupsApiCreateSelectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Selection>;
     /**
      * Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. A completed purge clears the allowed `options` of object variables on the group. Requires the *Edit objects* permission.
      * @summary Delete or archive an object group
@@ -345,6 +362,16 @@ export declare class ObjectGroupsApi extends runtime.BaseAPI implements ObjectGr
      * Create an object group
      */
     create(requestParameters?: ObjectGroupsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+    /**
+     * Lists the objects in the account\'s active object groups that `filters` select, grouped by object group, both by name. Filters match as in a calculation: an object group\'s own properties apply to each of its entries, a tree node also selects the nodes below it, and a group\'s property (`og:<object group id>`) selects that group\'s entries. At most 500 objects are returned, with `truncated` set when more matched. Nothing is changed. Requires the *View objects* permission.
+     * Select objects by filters
+     */
+    createSelectRaw(requestParameters: ObjectGroupsApiCreateSelectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Selection>>;
+    /**
+     * Lists the objects in the account\'s active object groups that `filters` select, grouped by object group, both by name. Filters match as in a calculation: an object group\'s own properties apply to each of its entries, a tree node also selects the nodes below it, and a group\'s property (`og:<object group id>`) selects that group\'s entries. At most 500 objects are returned, with `truncated` set when more matched. Nothing is changed. Requires the *View objects* permission.
+     * Select objects by filters
+     */
+    createSelect(requestParameters: ObjectGroupsApiCreateSelectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Selection>;
     /**
      * Permanently deletes the object group and all its entries, or transitions it to a different lifecycle state. Pass `action=archive` to archive it (recoverable via `action=restore`) or omit `action` to purge it immediately. Returns `409` if a purge keeps conflicting with concurrent writes, in which case only some entries may have been deleted; repeating the request finishes the purge. A completed purge clears the allowed `options` of object variables on the group. Requires the *Edit objects* permission.
      * Delete or archive an object group