@spaciv/sdk 0.1.21 → 0.1.23

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

@@ -22,21 +22,21 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SpaceRulesetsApi = void 0;
+exports.LogicLayersApiGetSpaceRulesetsFormatEnum = exports.LogicLayersApi = void 0;
 const runtime = require("../runtime");
 const index_1 = require("../models/index");
 /**
  *
  */
-class SpaceRulesetsApi extends runtime.BaseAPI {
+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 = {};
@@ -60,12 +60,12 @@ 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();
         });
     }
@@ -73,10 +73,10 @@ 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 = {};
@@ -124,20 +124,20 @@ 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 = {};
@@ -160,12 +160,12 @@ 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();
         });
     }
@@ -173,10 +173,10 @@ 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 = {};
@@ -202,22 +202,25 @@ 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;
@@ -238,12 +241,12 @@ 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();
         });
     }
@@ -251,10 +254,10 @@ 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) {
@@ -288,17 +291,17 @@ 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 = {};
@@ -320,20 +323,20 @@ 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 = {};
@@ -355,26 +358,26 @@ 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 = {};
@@ -399,14 +402,21 @@ 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();
         });
     }
 }
-exports.SpaceRulesetsApi = SpaceRulesetsApi;
+exports.LogicLayersApi = LogicLayersApi;
+/**
+ * @export
+ */
+exports.LogicLayersApiGetSpaceRulesetsFormatEnum = {
+    Stored: 'stored',
+    Logic: 'logic'
+};

package/dist/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

package/dist/apis/ObjectGroupsApi.js

@@ -71,6 +71,46 @@ class ObjectGroupsApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * 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, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['selectObjectsParamsWrapperBody'] == null) {
+                throw new runtime.RequiredError('selectObjectsParamsWrapperBody', 'Required parameter "selectObjectsParamsWrapperBody" was null or undefined when calling createSelect().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("accessToken", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/v1/object-groups/select`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.SelectObjectsParamsWrapperBodyToJSON)(requestParameters['selectObjectsParamsWrapperBody']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.SelectionFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * 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, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createSelectRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * 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

package/dist/apis/PropertiesApi.d.ts

@@ -53,7 +53,7 @@ export interface PropertiesApiInterface {
      */
     create(requestParameters: PropertiesApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
     /**
-     * Permanently removes the specified property and all its nodes. The property is removed from every variable\'s allowed `options`, and a variable whose value was the property moves to its first remaining option; node variables on the property lose their options. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
+     * Permanently removes the specified property and all its nodes. The property is removed from every variable\'s allowed `options`, and a variable whose value was the property moves to its first remaining option; node variables on the property lose their options. Built-in properties, including object group properties (id `og:<object group id>`), cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
      * @summary Delete a property
      * @param {string} id
      * @param {*} [options] Override http request option.
@@ -62,7 +62,7 @@ export interface PropertiesApiInterface {
      */
     deleteRaw(requestParameters: PropertiesApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Permanently removes the specified property and all its nodes. The property is removed from every variable\'s allowed `options`, and a variable whose value was the property moves to its first remaining option; node variables on the property lose their options. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
+     * Permanently removes the specified property and all its nodes. The property is removed from every variable\'s allowed `options`, and a variable whose value was the property moves to its first remaining option; node variables on the property lose their options. Built-in properties, including object group properties (id `og:<object group id>`), cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
      * Delete a property
      */
     delete(requestParameters: PropertiesApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
@@ -81,7 +81,7 @@ export interface PropertiesApiInterface {
      */
     duplicate(requestParameters: PropertiesApiDuplicateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
     /**
-     * Returns the full record for a single property, including its metadata and — for tree-type properties — the complete node hierarchy.  Callers with only the *View public properties* permission receive a `403` if the property is not public. Built-in system properties (such as `count`, `module`, `consumer`) are always available to callers with either permission. Callers with *Edit properties* are treated as having full view access, since a caller trusted to modify a property must also be able to read it.
+     * Returns the full record for a single property, including its metadata and — for tree-type properties — the complete node hierarchy.  Callers with only the *View public properties* permission receive a `403` if the property is not public. Built-in system properties (`count`, `growth`) are always available to callers with either permission. An object group property has the id `og:<object group id>`, is named after its object group, and its tree has one node per object in the group (node id = object id) under a `Root` node; it returns `404` when the object group does not exist, and `403` unless the caller can see the group\'s objects (*View objects* or *Edit objects*, or *View public objects* for a public group) and, for a private group, has full property access. Callers with *Edit properties* are treated as having full view access, since a caller trusted to modify a property must also be able to read it.
      * @summary Get a property
      * @param {string} id
      * @param {*} [options] Override http request option.
@@ -90,12 +90,12 @@ export interface PropertiesApiInterface {
      */
     getRaw(requestParameters: PropertiesApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PropertyRes>>;
     /**
-     * Returns the full record for a single property, including its metadata and — for tree-type properties — the complete node hierarchy.  Callers with only the *View public properties* permission receive a `403` if the property is not public. Built-in system properties (such as `count`, `module`, `consumer`) are always available to callers with either permission. Callers with *Edit properties* are treated as having full view access, since a caller trusted to modify a property must also be able to read it.
+     * Returns the full record for a single property, including its metadata and — for tree-type properties — the complete node hierarchy.  Callers with only the *View public properties* permission receive a `403` if the property is not public. Built-in system properties (`count`, `growth`) are always available to callers with either permission. An object group property has the id `og:<object group id>`, is named after its object group, and its tree has one node per object in the group (node id = object id) under a `Root` node; it returns `404` when the object group does not exist, and `403` unless the caller can see the group\'s objects (*View objects* or *Edit objects*, or *View public objects* for a public group) and, for a private group, has full property access. Callers with *Edit properties* are treated as having full view access, since a caller trusted to modify a property must also be able to read it.
      * Get a property
      */
     get(requestParameters: PropertiesApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PropertyRes>;
     /**
-     * Returns all properties available to the account, sorted alphabetically by name. Built-in system properties are always included.  Callers with *View properties* or *Edit properties* see all properties; callers with only *View public properties* see only those marked public. Use `types` to restrict results to specific property types.
+     * Returns all properties available to the account, sorted alphabetically by name. Built-in system properties are included: `count` and `growth`, and one tree property per active object group, with the id `og:<object group id>`, named after the group, whose nodes are the group\'s objects. An object group property is listed only to callers who can see that group\'s objects (*View objects* or *Edit objects*, or *View public objects* for a public group), and is public when its group is.  Callers with *View properties* or *Edit properties* see all properties; callers with only *View public properties* see only those marked public. Use `types` to restrict results to specific property types.
      * @summary List properties
      * @param {Array<number>} [types] Filter by property type. Pass one or more numeric type values (e.g. the integer values of the PropertyType enum). When omitted, all types are returned.
      * @param {Array<number>} [objectTypes]
@@ -105,12 +105,12 @@ export interface PropertiesApiInterface {
      */
     listRaw(requestParameters: PropertiesApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PropertyListRes>>;
     /**
-     * Returns all properties available to the account, sorted alphabetically by name. Built-in system properties are always included.  Callers with *View properties* or *Edit properties* see all properties; callers with only *View public properties* see only those marked public. Use `types` to restrict results to specific property types.
+     * Returns all properties available to the account, sorted alphabetically by name. Built-in system properties are included: `count` and `growth`, and one tree property per active object group, with the id `og:<object group id>`, named after the group, whose nodes are the group\'s objects. An object group property is listed only to callers who can see that group\'s objects (*View objects* or *Edit objects*, or *View public objects* for a public group), and is public when its group is.  Callers with *View properties* or *Edit properties* see all properties; callers with only *View public properties* see only those marked public. Use `types` to restrict results to specific property types.
      * List properties
      */
     list(requestParameters: PropertiesApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PropertyListRes>;
     /**
-     * Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout.  Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Deleted nodes are removed from node variables\' allowed `options`, and a variable whose value was a deleted node moves to its first remaining option; renamed nodes are renamed in both the options and the value. Node changes are rejected with a `400` for built-in property ids (e.g. `module`, `space`), which are not backed by a real stored property and cannot hold node data.  New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`.  Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
+     * Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout.  Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Deleted nodes are removed from node variables\' allowed `options`, and a variable whose value was a deleted node moves to its first remaining option; renamed nodes are renamed in both the options and the value. Node changes are rejected with a `400` for the built-in property ids `count` and `growth`, which are not backed by a real stored property and cannot hold node data. Any update to an object group property (id `og:<object group id>`) is rejected with a `400`: its name and nodes come from the object group.  New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`.  Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
      * @summary Update a property
      * @param {string} id
      * @param {PropertyBody} [propertyBody]
@@ -120,7 +120,7 @@ export interface PropertiesApiInterface {
      */
     updateRaw(requestParameters: PropertiesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout.  Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Deleted nodes are removed from node variables\' allowed `options`, and a variable whose value was a deleted node moves to its first remaining option; renamed nodes are renamed in both the options and the value. Node changes are rejected with a `400` for built-in property ids (e.g. `module`, `space`), which are not backed by a real stored property and cannot hold node data.  New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`.  Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
+     * Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout.  Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Deleted nodes are removed from node variables\' allowed `options`, and a variable whose value was a deleted node moves to its first remaining option; renamed nodes are renamed in both the options and the value. Node changes are rejected with a `400` for the built-in property ids `count` and `growth`, which are not backed by a real stored property and cannot hold node data. Any update to an object group property (id `og:<object group id>`) is rejected with a `400`: its name and nodes come from the object group.  New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`.  Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
      * Update a property
      */
     update(requestParameters: PropertiesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
@@ -140,12 +140,12 @@ export declare class PropertiesApi extends runtime.BaseAPI implements Properties
      */
     create(requestParameters?: PropertiesApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
     /**
-     * Permanently removes the specified property and all its nodes. The property is removed from every variable\'s allowed `options`, and a variable whose value was the property moves to its first remaining option; node variables on the property lose their options. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
+     * Permanently removes the specified property and all its nodes. The property is removed from every variable\'s allowed `options`, and a variable whose value was the property moves to its first remaining option; node variables on the property lose their options. Built-in properties, including object group properties (id `og:<object group id>`), cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
      * Delete a property
      */
     deleteRaw(requestParameters: PropertiesApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Permanently removes the specified property and all its nodes. The property is removed from every variable\'s allowed `options`, and a variable whose value was the property moves to its first remaining option; node variables on the property lose their options. Built-in properties cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
+     * Permanently removes the specified property and all its nodes. The property is removed from every variable\'s allowed `options`, and a variable whose value was the property moves to its first remaining option; node variables on the property lose their options. Built-in properties, including object group properties (id `og:<object group id>`), cannot be deleted. Requires the *Edit properties* permission. Returns `409` if a live data collection uses the property for anonymisation.
      * Delete a property
      */
     delete(requestParameters: PropertiesApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
@@ -160,32 +160,32 @@ export declare class PropertiesApi extends runtime.BaseAPI implements Properties
      */
     duplicate(requestParameters: PropertiesApiDuplicateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
     /**
-     * Returns the full record for a single property, including its metadata and — for tree-type properties — the complete node hierarchy.  Callers with only the *View public properties* permission receive a `403` if the property is not public. Built-in system properties (such as `count`, `module`, `consumer`) are always available to callers with either permission. Callers with *Edit properties* are treated as having full view access, since a caller trusted to modify a property must also be able to read it.
+     * Returns the full record for a single property, including its metadata and — for tree-type properties — the complete node hierarchy.  Callers with only the *View public properties* permission receive a `403` if the property is not public. Built-in system properties (`count`, `growth`) are always available to callers with either permission. An object group property has the id `og:<object group id>`, is named after its object group, and its tree has one node per object in the group (node id = object id) under a `Root` node; it returns `404` when the object group does not exist, and `403` unless the caller can see the group\'s objects (*View objects* or *Edit objects*, or *View public objects* for a public group) and, for a private group, has full property access. Callers with *Edit properties* are treated as having full view access, since a caller trusted to modify a property must also be able to read it.
      * Get a property
      */
     getRaw(requestParameters: PropertiesApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PropertyRes>>;
     /**
-     * Returns the full record for a single property, including its metadata and — for tree-type properties — the complete node hierarchy.  Callers with only the *View public properties* permission receive a `403` if the property is not public. Built-in system properties (such as `count`, `module`, `consumer`) are always available to callers with either permission. Callers with *Edit properties* are treated as having full view access, since a caller trusted to modify a property must also be able to read it.
+     * Returns the full record for a single property, including its metadata and — for tree-type properties — the complete node hierarchy.  Callers with only the *View public properties* permission receive a `403` if the property is not public. Built-in system properties (`count`, `growth`) are always available to callers with either permission. An object group property has the id `og:<object group id>`, is named after its object group, and its tree has one node per object in the group (node id = object id) under a `Root` node; it returns `404` when the object group does not exist, and `403` unless the caller can see the group\'s objects (*View objects* or *Edit objects*, or *View public objects* for a public group) and, for a private group, has full property access. Callers with *Edit properties* are treated as having full view access, since a caller trusted to modify a property must also be able to read it.
      * Get a property
      */
     get(requestParameters: PropertiesApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PropertyRes>;
     /**
-     * Returns all properties available to the account, sorted alphabetically by name. Built-in system properties are always included.  Callers with *View properties* or *Edit properties* see all properties; callers with only *View public properties* see only those marked public. Use `types` to restrict results to specific property types.
+     * Returns all properties available to the account, sorted alphabetically by name. Built-in system properties are included: `count` and `growth`, and one tree property per active object group, with the id `og:<object group id>`, named after the group, whose nodes are the group\'s objects. An object group property is listed only to callers who can see that group\'s objects (*View objects* or *Edit objects*, or *View public objects* for a public group), and is public when its group is.  Callers with *View properties* or *Edit properties* see all properties; callers with only *View public properties* see only those marked public. Use `types` to restrict results to specific property types.
      * List properties
      */
     listRaw(requestParameters: PropertiesApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PropertyListRes>>;
     /**
-     * Returns all properties available to the account, sorted alphabetically by name. Built-in system properties are always included.  Callers with *View properties* or *Edit properties* see all properties; callers with only *View public properties* see only those marked public. Use `types` to restrict results to specific property types.
+     * Returns all properties available to the account, sorted alphabetically by name. Built-in system properties are included: `count` and `growth`, and one tree property per active object group, with the id `og:<object group id>`, named after the group, whose nodes are the group\'s objects. An object group property is listed only to callers who can see that group\'s objects (*View objects* or *Edit objects*, or *View public objects* for a public group), and is public when its group is.  Callers with *View properties* or *Edit properties* see all properties; callers with only *View public properties* see only those marked public. Use `types` to restrict results to specific property types.
      * List properties
      */
     list(requestParameters?: PropertiesApiListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PropertyListRes>;
     /**
-     * Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout.  Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Deleted nodes are removed from node variables\' allowed `options`, and a variable whose value was a deleted node moves to its first remaining option; renamed nodes are renamed in both the options and the value. Node changes are rejected with a `400` for built-in property ids (e.g. `module`, `space`), which are not backed by a real stored property and cannot hold node data.  New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`.  Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
+     * Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout.  Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Deleted nodes are removed from node variables\' allowed `options`, and a variable whose value was a deleted node moves to its first remaining option; renamed nodes are renamed in both the options and the value. Node changes are rejected with a `400` for the built-in property ids `count` and `growth`, which are not backed by a real stored property and cannot hold node data. Any update to an object group property (id `og:<object group id>`) is rejected with a `400`: its name and nodes come from the object group.  New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`.  Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
      * Update a property
      */
     updateRaw(requestParameters: PropertiesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout.  Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Deleted nodes are removed from node variables\' allowed `options`, and a variable whose value was a deleted node moves to its first remaining option; renamed nodes are renamed in both the options and the value. Node changes are rejected with a `400` for built-in property ids (e.g. `module`, `space`), which are not backed by a real stored property and cannot hold node data.  New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`.  Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
+     * Applies an incremental update to the specified property. The request body may contain updated metadata and node changes for tree-type properties. Supports large node sets — the request body limit is 64 MB with a 20-second read timeout.  Renaming a node ID requires the *Edit property ID* permission in addition to *Edit properties*; a `403` is returned if that permission is absent. Deleted nodes are removed from node variables\' allowed `options`, and a variable whose value was a deleted node moves to its first remaining option; renamed nodes are renamed in both the options and the value. Node changes are rejected with a `400` for the built-in property ids `count` and `growth`, which are not backed by a real stored property and cannot hold node data. Any update to an object group property (id `og:<object group id>`) is rejected with a `400`: its name and nodes come from the object group.  New or re-parented nodes are placed after their siblings. A node\'s `position` moves it to that zero-based index among its siblings (clamped to the end); negative positions are rejected with a `400`.  Setting `delete` removes the property. While a live data collection uses the property for anonymisation, deleting it, changing its type away from tree, clearing all nodes, or deleting, re-parenting or changing the ID of an existing node returns a `409`; adding nodes under a parent and editing names are allowed.
      * Update a property
      */
     update(requestParameters: PropertiesApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;