@spaciv/sdk 0.0.0 → 0.1.0

package/dist/esm/apis/ObjectGroupsApi.js

@@ -0,0 +1,774 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * spaciv API
+ * The spaciv API powers workplace planning: modelling how many people an organisation has, how they work, and how much space that requires.  ## Getting started  1. Exchange credentials for an access token using one of the operations under    **Authentication**. 2. Send that token on every subsequent request as `Authorization: Bearer <token>`. 3. Access tokens are short lived. Call `POST /v1/auth/refresh-token` to obtain a new one    before the old one expires.  ## Conventions  Every operation is versioned under `/v1`. Collections are plural (`GET /v1/dashboards` lists, `POST /v1/dashboards` creates) and individual records live beneath them (`/v1/dashboards/{id}`). Singular paths such as `/v1/account`, `/v1/project` and `/v1/user` refer to the record the access token was issued for.  Request and response bodies are JSON. Timestamps are RFC 3339. Identifiers are opaque strings unless documented otherwise, and collection operations return the records visible to the account the token was issued for.  Failures return an [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) problem document with a `detail` field describing what went wrong.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@spaciv.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as runtime from '../runtime';
+import { EntryPatchToJSON, ObjectGroupChangelogBodyFromJSON, ObjectGroupChangelogBodyToJSON, ObjectGroupEntriesResFromJSON, ObjectGroupEntrySearchResFromJSON, ObjectGroupEntryUpdateToJSON, ObjectGroupListResFromJSON, } from '../models/index';
+/**
+ *
+ */
+export class ObjectGroupsApi extends runtime.BaseAPI {
+    /**
+     * Creates a new object group for the account and returns its generated ID. Requires the *Edit objects* permission.
+     * Create an object group
+     */
+    createRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            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`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: ObjectGroupChangelogBodyToJSON(requestParameters['objectGroupChangelogBody']),
+            }, initOverrides);
+            if (this.isJsonMime(response.headers.get('content-type'))) {
+                return new runtime.JSONApiResponse(response);
+            }
+            else {
+                return new runtime.TextApiResponse(response);
+            }
+        });
+    }
+    /**
+     * Creates a new object group for the account and returns its generated ID. Requires the *Edit objects* permission.
+     * Create an object group
+     */
+    create() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.createRaw(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. Requires the *Edit objects* permission.
+     * Delete or archive an object group
+     */
+    deleteRaw(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().');
+            }
+            const queryParameters = {};
+            if (requestParameters['action'] != null) {
+                queryParameters['action'] = requestParameters['action'];
+            }
+            const headerParameters = {};
+            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/{id}`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response);
+        });
+    }
+    /**
+     * 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. Requires the *Edit objects* permission.
+     * Delete or archive an object group
+     */
+    delete(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.deleteRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone.  Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
+     * Delete entries from an object group
+     */
+    deleteEntriesRaw(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 deleteEntries().');
+            }
+            if (requestParameters['objectGroupEntryUpdate'] == null) {
+                throw new runtime.RequiredError('objectGroupEntryUpdate', 'Required parameter "objectGroupEntryUpdate" was null or undefined when calling deleteEntries().');
+            }
+            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/{id}/entries`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+                body: requestParameters['objectGroupEntryUpdate'].map(ObjectGroupEntryUpdateToJSON),
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Permanently removes one or more entries from the specified object group. Each item in the body must include the `id` of the entry to delete. Removing an entry that is not there succeeds and leaves the group\'s counts alone.  Returns `404` if the object group does not exist, and `409` if an entry keeps being changed by other writers while it is being deleted. Entries are deleted one at a time, so a failure part way through leaves the earlier ones deleted; re-sending the same request finishes the job. Requires the *Edit objects* permission.
+     * Delete entries from an object group
+     */
+    deleteEntries(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.deleteEntriesRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Permanently removes the image attached to the specified entry. Requires the *Edit objects* permission.
+     * Delete an entry\'s image
+     */
+    deleteEntriesImageRaw(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 deleteEntriesImage().');
+            }
+            if (requestParameters['entryId'] == null) {
+                throw new runtime.RequiredError('entryId', 'Required parameter "entryId" was null or undefined when calling deleteEntriesImage().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            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/{id}/entries/{entryId}/image`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            urlPath = urlPath.replace(`{${"entryId"}}`, encodeURIComponent(String(requestParameters['entryId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response);
+        });
+    }
+    /**
+     * Permanently removes the image attached to the specified entry. Requires the *Edit objects* permission.
+     * Delete an entry\'s image
+     */
+    deleteEntriesImage(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.deleteEntriesImageRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates a full copy of the specified object group — including all its entries — and returns the new group\'s ID. The copy is named \"Copy of <original name>\". If copying fails, the partial copy is removed; if that cleanup also fails, the error reports it and a partial copy may remain. Returns `409` if the copy keeps conflicting with concurrent writes and the partial copy was removed. Requires the *Edit objects* permission.
+     * Duplicate an object group
+     */
+    duplicateRaw(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 duplicate().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            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/{id}/duplicate`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            if (this.isJsonMime(response.headers.get('content-type'))) {
+                return new runtime.JSONApiResponse(response);
+            }
+            else {
+                return new runtime.TextApiResponse(response);
+            }
+        });
+    }
+    /**
+     * Creates a full copy of the specified object group — including all its entries — and returns the new group\'s ID. The copy is named \"Copy of <original name>\". If copying fails, the partial copy is removed; if that cleanup also fails, the error reports it and a partial copy may remain. Returns `409` if the copy keeps conflicting with concurrent writes and the partial copy was removed. Requires the *Edit objects* permission.
+     * Duplicate an object group
+     */
+    duplicate(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.duplicateRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Returns the full record for a single object group, including its name, description, visibility flag, and attached properties.  Callers with the *View objects* permission receive the group regardless of its `isPublic` flag. Callers with only the *View public objects* permission receive a `403` if the group is not public.
+     * Get an object group
+     */
+    getRaw(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().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            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/{id}`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => ObjectGroupChangelogBodyFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns the full record for a single object group, including its name, description, visibility flag, and attached properties.  Callers with the *View objects* permission receive the group regardless of its `isPublic` flag. Callers with only the *View public objects* permission receive a `403` if the group is not public.
+     * Get an object group
+     */
+    get(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Returns the image attached to the specified entry within an object group. The response `Content-Type` reflects the uploaded image format.  Callers with only the *View public objects* permission receive a `403` if the parent group is not public. Supply `withDefault` to receive a fallback image instead of an error when no entry-specific image has been uploaded. 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.
+     * Download an entry\'s image
+     */
+    getEntriesImageRaw(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 getEntriesImage().');
+            }
+            if (requestParameters['entryId'] == null) {
+                throw new runtime.RequiredError('entryId', 'Required parameter "entryId" was null or undefined when calling getEntriesImage().');
+            }
+            const queryParameters = {};
+            if (requestParameters['withDefault'] != null) {
+                queryParameters['withDefault'] = requestParameters['withDefault'];
+            }
+            const headerParameters = {};
+            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/{id}/entries/{entryId}/image`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            urlPath = urlPath.replace(`{${"entryId"}}`, encodeURIComponent(String(requestParameters['entryId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            if (this.isJsonMime(response.headers.get('content-type'))) {
+                return new runtime.JSONApiResponse(response);
+            }
+            else {
+                return new runtime.TextApiResponse(response);
+            }
+        });
+    }
+    /**
+     * Returns the image attached to the specified entry within an object group. The response `Content-Type` reflects the uploaded image format.  Callers with only the *View public objects* permission receive a `403` if the parent group is not public. Supply `withDefault` to receive a fallback image instead of an error when no entry-specific image has been uploaded. 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.
+     * Download an entry\'s image
+     */
+    getEntriesImage(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getEntriesImageRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Returns the binary content of the file attached to the object group, with the appropriate `Content-Type` header. Requires the *View objects* permission. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the stored file matches a virus signature; the bytes are kept for investigation.
+     * Download an object group\'s file
+     */
+    getFileRaw(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 getFile().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            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/{id}/file`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            if (this.isJsonMime(response.headers.get('content-type'))) {
+                return new runtime.JSONApiResponse(response);
+            }
+            else {
+                return new runtime.TextApiResponse(response);
+            }
+        });
+    }
+    /**
+     * Returns the binary content of the file attached to the object group, with the appropriate `Content-Type` header. Requires the *View objects* permission. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the stored file matches a virus signature; the bytes are kept for investigation.
+     * Download an object group\'s file
+     */
+    getFile(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getFileRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Returns all object groups for the account, sorted alphabetically by name. Requires the *View objects* permission.  By default only active groups are returned; pass `showArchived=true` to list archived groups instead.
+     * List object groups
+     */
+    listRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            if (requestParameters['showArchived'] != null) {
+                queryParameters['showArchived'] = requestParameters['showArchived'];
+            }
+            const headerParameters = {};
+            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`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => ObjectGroupListResFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns all object groups for the account, sorted alphabetically by name. Requires the *View objects* permission.  By default only active groups are returned; pass `showArchived=true` to list archived groups instead.
+     * List object groups
+     */
+    list() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.listRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Returns a page of entries belonging to the specified object group, along with the total entry count and an opaque `cursor` for the next page. A page can hold fewer than `limit` entries, or none, and still carry a `cursor`: keep requesting until `cursor` is empty. Pages reached by a non-zero `start` carry no `cursor`.  Returns `400` for a `cursor` that did not come from this group. Returns `404` if the group does not exist. Callers with only the *View public objects* permission receive a `403` instead, and also if the group is not public.
+     * List entries in an object group
+     */
+    listEntriesRaw(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 listEntries().');
+            }
+            const queryParameters = {};
+            if (requestParameters['start'] != null) {
+                queryParameters['start'] = requestParameters['start'];
+            }
+            if (requestParameters['limit'] != null) {
+                queryParameters['limit'] = requestParameters['limit'];
+            }
+            if (requestParameters['cursor'] != null) {
+                queryParameters['cursor'] = requestParameters['cursor'];
+            }
+            const headerParameters = {};
+            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/{id}/entries`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => ObjectGroupEntriesResFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns a page of entries belonging to the specified object group, along with the total entry count and an opaque `cursor` for the next page. A page can hold fewer than `limit` entries, or none, and still carry a `cursor`: keep requesting until `cursor` is empty. Pages reached by a non-zero `start` carry no `cursor`.  Returns `400` for a `cursor` that did not come from this group. Returns `404` if the group does not exist. Callers with only the *View public objects* permission receive a `403` instead, and also if the group is not public.
+     * List entries in an object group
+     */
+    listEntries(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listEntriesRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates or updates one or more entries within the specified object group in a single request. Each item in the body must include an `id`; if an entry with that ID already exists it is updated, otherwise a new entry is created. Returns `409` if an entry is being changed concurrently and the write cannot be retried safely; entries are written one at a time, so a failure part way through leaves the earlier ones written. Requires the *Edit objects* permission.
+     * Upsert entries in an object group
+     */
+    replaceEntriesRaw(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 replaceEntries().');
+            }
+            if (requestParameters['objectGroupEntryUpdate'] == null) {
+                throw new runtime.RequiredError('objectGroupEntryUpdate', 'Required parameter "objectGroupEntryUpdate" was null or undefined when calling replaceEntries().');
+            }
+            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/{id}/entries`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'PUT',
+                headers: headerParameters,
+                query: queryParameters,
+                body: requestParameters['objectGroupEntryUpdate'].map(ObjectGroupEntryUpdateToJSON),
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Creates or updates one or more entries within the specified object group in a single request. Each item in the body must include an `id`; if an entry with that ID already exists it is updated, otherwise a new entry is created. Returns `409` if an entry is being changed concurrently and the write cannot be retried safely; entries are written one at a time, so a failure part way through leaves the earlier ones written. Requires the *Edit objects* permission.
+     * Upsert entries in an object group
+     */
+    replaceEntries(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.replaceEntriesRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Returns entries matching `q`, as id and name only, with an opaque `cursor` for the next page when one exists. Each request reads a bounded slice of the index, so a page can hold fewer than `limit` entries and still carry a `cursor`.  A group whose entries predate the search index answers `indexing` while one is built in the background, and the same query answers normally once it is. An empty `q` returns the group from the start, so a picker has something to show before anything is typed.  Pass `ids` instead of `q` to resolve known entries by name, for selections a search result does not cover. At most 200 per request; resolve a longer selection in batches.  Returns `400` for more than 200 `ids`, or for a `cursor` that did not come from this group and this query. Returns `404` if the group does not exist. Callers with only the *View public objects* permission receive a `403` instead, and also if the group is not public.
+     * Search entries in an object group
+     */
+    searchEntriesRaw(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 searchEntries().');
+            }
+            const queryParameters = {};
+            if (requestParameters['q'] != null) {
+                queryParameters['q'] = requestParameters['q'];
+            }
+            if (requestParameters['ids'] != null) {
+                queryParameters['ids'] = requestParameters['ids'].join(runtime.COLLECTION_FORMATS["csv"]);
+            }
+            if (requestParameters['limit'] != null) {
+                queryParameters['limit'] = requestParameters['limit'];
+            }
+            if (requestParameters['cursor'] != null) {
+                queryParameters['cursor'] = requestParameters['cursor'];
+            }
+            const headerParameters = {};
+            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/{id}/entries/search`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => ObjectGroupEntrySearchResFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns entries matching `q`, as id and name only, with an opaque `cursor` for the next page when one exists. Each request reads a bounded slice of the index, so a page can hold fewer than `limit` entries and still carry a `cursor`.  A group whose entries predate the search index answers `indexing` while one is built in the background, and the same query answers normally once it is. An empty `q` returns the group from the start, so a picker has something to show before anything is typed.  Pass `ids` instead of `q` to resolve known entries by name, for selections a search result does not cover. At most 200 per request; resolve a longer selection in batches.  Returns `400` for more than 200 `ids`, or for a `cursor` that did not come from this group and this query. Returns `404` if the group does not exist. Callers with only the *View public objects* permission receive a `403` instead, and also if the group is not public.
+     * Search entries in an object group
+     */
+    searchEntries(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.searchEntriesRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Applies a partial update to the specified object group. Only the fields present in the request body are changed; omitted fields are left as-is. Returns 404 if the group does not exist, including when it is deleted while the update is in progress. Requires the *Edit objects* permission.
+     * Update an object group
+     */
+    updateRaw(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().');
+            }
+            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/{id}`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'PATCH',
+                headers: headerParameters,
+                query: queryParameters,
+                body: ObjectGroupChangelogBodyToJSON(requestParameters['objectGroupChangelogBody']),
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Applies a partial update to the specified object group. Only the fields present in the request body are changed; omitted fields are left as-is. Returns 404 if the group does not exist, including when it is deleted while the update is in progress. Requires the *Edit objects* permission.
+     * Update an object group
+     */
+    update(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.updateRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Applies a partial update to one or more existing entries within the specified object group. Each item in the body must include the `id` of an entry that already exists, and the same `id` cannot be listed twice; use `PUT` to create entries and `DELETE` to remove them.  Only the fields present in an item are changed, and `properties` merges one property at a time: a property named in the request replaces that property\'s nodes, a property named with a `null` value or an empty `nodes` map is removed from the entry, and a property the request does not name is left as-is.  Every entry is resolved before any of them is written, so a `404` means nothing was changed; an entry deleted after that point reports as a `409` instead. Writing is one transaction per entry rather than a single atomic batch, so a failure once writing has begun leaves the earlier entries updated; the error names them. Re-sending the same request finishes the job, since applying a patch twice is a no-op. Returns `409` if an entry is being changed concurrently and the write cannot be retried safely. Requires the *Edit objects* permission.
+     * Partially update entries in an object group
+     */
+    updateEntriesRaw(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 updateEntries().');
+            }
+            if (requestParameters['entryPatch'] == null) {
+                throw new runtime.RequiredError('entryPatch', 'Required parameter "entryPatch" was null or undefined when calling updateEntries().');
+            }
+            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/{id}/entries`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'PATCH',
+                headers: headerParameters,
+                query: queryParameters,
+                body: requestParameters['entryPatch'].map(EntryPatchToJSON),
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Applies a partial update to one or more existing entries within the specified object group. Each item in the body must include the `id` of an entry that already exists, and the same `id` cannot be listed twice; use `PUT` to create entries and `DELETE` to remove them.  Only the fields present in an item are changed, and `properties` merges one property at a time: a property named in the request replaces that property\'s nodes, a property named with a `null` value or an empty `nodes` map is removed from the entry, and a property the request does not name is left as-is.  Every entry is resolved before any of them is written, so a `404` means nothing was changed; an entry deleted after that point reports as a `409` instead. Writing is one transaction per entry rather than a single atomic batch, so a failure once writing has begun leaves the earlier entries updated; the error names them. Re-sending the same request finishes the job, since applying a patch twice is a no-op. Returns `409` if an entry is being changed concurrently and the write cannot be retried safely. Requires the *Edit objects* permission.
+     * Partially update entries in an object group
+     */
+    updateEntries(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.updateEntriesRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Uploads an image for the specified entry, replacing any previously uploaded image. 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). Maximum file size is 4 MB. Requires the *Edit objects* permission.
+     * Upload an entry image
+     */
+    updateEntriesImageRaw(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 updateEntriesImage().');
+            }
+            if (requestParameters['entryId'] == null) {
+                throw new runtime.RequiredError('entryId', 'Required parameter "entryId" was null or undefined when calling updateEntriesImage().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("accessToken", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const consumes = [
+                { contentType: 'multipart/form-data' },
+            ];
+            // @ts-ignore: canConsumeForm may be unused
+            const canConsumeForm = runtime.canConsumeForm(consumes);
+            let formParams;
+            let useForm = false;
+            // use FormData to transmit files using content-type "multipart/form-data"
+            useForm = canConsumeForm;
+            if (useForm) {
+                formParams = new FormData();
+            }
+            else {
+                formParams = new URLSearchParams();
+            }
+            if (requestParameters['filename'] != null) {
+                formParams.append('filename', requestParameters['filename']);
+            }
+            if (requestParameters['name'] != null) {
+                formParams.append('name', requestParameters['name']);
+            }
+            let urlPath = `/v1/object-groups/{id}/entries/{entryId}/image`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            urlPath = urlPath.replace(`{${"entryId"}}`, encodeURIComponent(String(requestParameters['entryId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'PUT',
+                headers: headerParameters,
+                query: queryParameters,
+                body: formParams,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response);
+        });
+    }
+    /**
+     * Uploads an image for the specified entry, replacing any previously uploaded image. 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). Maximum file size is 4 MB. Requires the *Edit objects* permission.
+     * Upload an entry image
+     */
+    updateEntriesImage(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.updateEntriesImageRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Uploads a file and attaches it to the object group, replacing any previously uploaded file. Send the file as `multipart/form-data` with the field key `file`. Maximum file size is 4 MB. If no file is included in the form, any existing file is deleted. Requires the *Edit objects* permission.
+     * Upload or replace an object group\'s file
+     */
+    updateFileRaw(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 updateFile().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("accessToken", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const consumes = [
+                { contentType: 'multipart/form-data' },
+            ];
+            // @ts-ignore: canConsumeForm may be unused
+            const canConsumeForm = runtime.canConsumeForm(consumes);
+            let formParams;
+            let useForm = false;
+            // use FormData to transmit files using content-type "multipart/form-data"
+            useForm = canConsumeForm;
+            if (useForm) {
+                formParams = new FormData();
+            }
+            else {
+                formParams = new URLSearchParams();
+            }
+            if (requestParameters['filename'] != null) {
+                formParams.append('filename', requestParameters['filename']);
+            }
+            if (requestParameters['name'] != null) {
+                formParams.append('name', requestParameters['name']);
+            }
+            let urlPath = `/v1/object-groups/{id}/file`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'PUT',
+                headers: headerParameters,
+                query: queryParameters,
+                body: formParams,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response);
+        });
+    }
+    /**
+     * Uploads a file and attaches it to the object group, replacing any previously uploaded file. Send the file as `multipart/form-data` with the field key `file`. Maximum file size is 4 MB. If no file is included in the form, any existing file is deleted. Requires the *Edit objects* permission.
+     * Upload or replace an object group\'s file
+     */
+    updateFile(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.updateFileRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+/**
+ * @export
+ */
+export const ObjectGroupsApiDeleteActionEnum = {
+    Archive: 'archive',
+    Restore: 'restore',
+    Purge: 'purge'
+};