hcloud-sdk 16.0.0 → 18.0.0

package/lib/service/high5/internal/space/index.d.ts

@@ -1,6 +1,9 @@
 import { AxiosInstance } from "axios";
-import Base, { Options } from "../../../../Base";
+import Base, { MaybeRaw, Options } from "../../../../Base";
+import { High5JobInternal } from "./job";
 export declare class High5SpaceInternal extends Base {
+    get job(): High5JobInternal;
+    private _job?;
     constructor(options: Options, axios: AxiosInstance);
     /**
      * Deletes all spaces of an organization.
@@ -8,7 +11,9 @@ export declare class High5SpaceInternal extends Base {
      * THIS IS AN INTERNAL ENDPOINT AND CAN ONLY BE USED FROM BACKENDS WITHIN THE HCLOUD DEPLOYMENT
      * @param orgName Name of the organization
      */
-    deleteAllSpacesOfOrganization(orgName: string): Promise<void>;
+    deleteAllSpacesOfOrganization<R extends boolean = false>(orgName: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, void>>;
     /**
      * Removes the user from all spaces of an organization.
      *
@@ -16,6 +21,8 @@ export declare class High5SpaceInternal extends Base {
      * @param orgName Name of the organization
      * @param userId ID of the user
      */
-    removeUserFromAllSpacesOfOrganization(orgName: string, userId: string): Promise<void>;
+    removeUserFromAllSpacesOfOrganization<R extends boolean = false>(orgName: string, userId: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, void>>;
     protected getEndpoint(endpoint: string): string;
 }

package/lib/service/high5/internal/space/index.js

@@ -11,7 +11,14 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.High5SpaceInternal = void 0;
 const Base_1 = require("../../../../Base");
+const job_1 = require("./job");
 class High5SpaceInternal extends Base_1.default {
+    get job() {
+        if (this._job === undefined) {
+            this._job = new job_1.High5JobInternal(this.options, this.axios);
+        }
+        return this._job;
+    }
     constructor(options, axios) {
         super(options, axios);
     }
@@ -21,9 +28,10 @@ class High5SpaceInternal extends Base_1.default {
      * THIS IS AN INTERNAL ENDPOINT AND CAN ONLY BE USED FROM BACKENDS WITHIN THE HCLOUD DEPLOYMENT
      * @param orgName Name of the organization
      */
-    deleteAllSpacesOfOrganization(orgName) {
+    deleteAllSpacesOfOrganization(orgName, raw) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}`));
+            const resp = yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : undefined);
         });
     }
     /**
@@ -33,9 +41,10 @@ class High5SpaceInternal extends Base_1.default {
      * @param orgName Name of the organization
      * @param userId ID of the user
      */
-    removeUserFromAllSpacesOfOrganization(orgName, userId) {
+    removeUserFromAllSpacesOfOrganization(orgName, userId, raw) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}/spaces/user/${userId}`));
+            const resp = yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}/spaces/user/${userId}`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : undefined);
         });
     }
     getEndpoint(endpoint) {

package/lib/service/high5/internal/space/job/index.d.ts

@@ -0,0 +1,7 @@
+import Base from "../../../../../Base";
+import { High5JobLogInternal } from "./log";
+export declare class High5JobInternal extends Base {
+    get jobLog(): High5JobLogInternal;
+    private _jobLog?;
+    protected getEndpoint(endpoint: string): string;
+}

package/lib/service/high5/internal/space/job/index.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.High5JobInternal = void 0;
+const Base_1 = require("../../../../../Base");
+const log_1 = require("./log");
+class High5JobInternal extends Base_1.default {
+    get jobLog() {
+        if (this._jobLog === undefined) {
+            this._jobLog = new log_1.High5JobLogInternal(this.options, this.axios);
+        }
+        return this._jobLog;
+    }
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/high5/internal${endpoint}`;
+    }
+}
+exports.High5JobInternal = High5JobInternal;

package/lib/service/high5/internal/space/job/log/index.d.ts

@@ -0,0 +1,17 @@
+import Base, { MaybeRaw } from "../../../../../../Base";
+import { JobLogCreate, JobLogDto } from "../../../../../../interfaces/high5/space/job/JobLog";
+export declare class High5JobLogInternal extends Base {
+    /**
+     * Creates a log for a cronjob.
+     *
+     * THIS IS AN INTERNAL ENDPOINT AND CAN ONLY BE USED FROM BACKENDS WITHIN THE HCLOUD DEPLOYMENT
+     * @param orgName Name of the organization
+     * @param spaceName Name of the High5 space
+     * @param createJobLog Cronjob log to be created
+     * @returns the created cronjob log with metadata
+     */
+    createJobLog<R extends boolean = false>(orgName: string, spaceName: string, jobId: string, log: JobLogCreate, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, JobLogDto>>;
+    protected getEndpoint(endpoint: string): string;
+}

package/lib/service/high5/internal/space/job/log/index.js

@@ -0,0 +1,34 @@
+"use strict";
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.High5JobLogInternal = void 0;
+const Base_1 = require("../../../../../../Base");
+class High5JobLogInternal extends Base_1.default {
+    /**
+     * Creates a log for a cronjob.
+     *
+     * THIS IS AN INTERNAL ENDPOINT AND CAN ONLY BE USED FROM BACKENDS WITHIN THE HCLOUD DEPLOYMENT
+     * @param orgName Name of the organization
+     * @param spaceName Name of the High5 space
+     * @param createJobLog Cronjob log to be created
+     * @returns the created cronjob log with metadata
+     */
+    createJobLog(orgName, spaceName, jobId, log, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/jobs/${jobId}/logs}`), log);
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/high5/internal${endpoint}`;
+    }
+}
+exports.High5JobLogInternal = High5JobLogInternal;

package/lib/service/high5/joinToken/index.d.ts

@@ -1,5 +1,5 @@
 import { AxiosInstance } from "axios";
-import Base, { Options } from "../../../Base";
+import Base, { MaybeRaw, Options } from "../../../Base";
 import { PaginatedResponse } from "../../../interfaces/global";
 import { JoinToken } from "../../../interfaces/high5/joinToken";
 import { User } from "../../../interfaces/idp";
@@ -12,29 +12,37 @@ export declare class High5JoinToken extends Base {
      * @param page (optional) Page number: Skip the first (page * limit) results (defaults to 0)
      * @returns Object containing an array of join tokens and the total number of results found in the database (independent of limit and page)
      */
-    get(orgName: string, limit?: number, page?: number): Promise<PaginatedResponse<JoinToken>>;
+    get<R extends boolean = false>(orgName: string, limit?: number, page?: number, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, PaginatedResponse<JoinToken>>>;
     /**
      * Creates a join token for the specified organization
      * @param orgName Name of the Organization
      * @param name Name of the Join Token
      * @returns Created join token
      */
-    create(orgName: string, name: string): Promise<JoinToken>;
+    create<R extends boolean = false>(orgName: string, name: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, JoinToken>>;
     /**
      * Revokes a join token of the specified organization
      * @param orgName Name of the Organization
      * @param tokenId ID of the Join Token
      */
-    revoke(orgName: string, tokenId: string): Promise<void>;
+    revoke<R extends boolean = false>(orgName: string, tokenId: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, void>>;
     /**
      * Exchanges a join token for an agent user
      *
      * @param joinToken Join token
      * @returns An object containing the User object and the PAT that represents the agent user
      */
-    exchange(joinToken: string): Promise<{
+    exchange<R extends boolean = false>(joinToken: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, {
         user: User;
         pat: string;
-    }>;
+    }>>;
     protected getEndpoint(endpoint: string): string;
 }

package/lib/service/high5/joinToken/index.js

@@ -23,12 +23,12 @@ class High5JoinToken extends Base_1.default {
      * @param page (optional) Page number: Skip the first (page * limit) results (defaults to 0)
      * @returns Object containing an array of join tokens and the total number of results found in the database (independent of limit and page)
      */
-    get(orgName, limit, page) {
+    get(orgName, limit, page, raw) {
         return __awaiter(this, void 0, void 0, function* () {
             limit = limit || 25;
             page = page || 0;
             const resp = yield this.axios.get(this.getEndpoint(`/v1/org/${orgName}/join/token?page=${page}&limit=${limit}`));
-            return (0, paginatedResponseHelper_1.createPaginatedResponse)(resp);
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? Object.assign(Object.assign({}, resp), { data: (0, paginatedResponseHelper_1.createPaginatedResponse)(resp) }) : (0, paginatedResponseHelper_1.createPaginatedResponse)(resp));
         });
     }
     /**
@@ -37,10 +37,10 @@ class High5JoinToken extends Base_1.default {
      * @param name Name of the Join Token
      * @returns Created join token
      */
-    create(orgName, name) {
+    create(orgName, name, raw) {
         return __awaiter(this, void 0, void 0, function* () {
             const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/join/token`), { name });
-            return resp.data;
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
         });
     }
     /**
@@ -48,9 +48,10 @@ class High5JoinToken extends Base_1.default {
      * @param orgName Name of the Organization
      * @param tokenId ID of the Join Token
      */
-    revoke(orgName, tokenId) {
+    revoke(orgName, tokenId, raw) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}/join/token/${tokenId}`));
+            const resp = yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}/join/token/${tokenId}`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : undefined);
         });
     }
     /**
@@ -59,10 +60,10 @@ class High5JoinToken extends Base_1.default {
      * @param joinToken Join token
      * @returns An object containing the User object and the PAT that represents the agent user
      */
-    exchange(joinToken) {
+    exchange(joinToken, raw) {
         return __awaiter(this, void 0, void 0, function* () {
-            const res = yield this.axios.post(this.getEndpoint(`/v1/join/token`), {}, { headers: { Authorization: joinToken } });
-            return { user: res.data, pat: res.headers.authorization };
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/join/token`), {}, { headers: { Authorization: joinToken } });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? Object.assign(Object.assign({}, resp), { data: { user: resp.data, pat: resp.headers.authorization } }) : { user: resp.data, pat: resp.headers.authorization });
         });
     }
     getEndpoint(endpoint) {

package/lib/service/high5/space/database/document/array/index.d.ts

@@ -0,0 +1,73 @@
+import Base, { MaybeRaw } from "../../../../../../Base";
+import { PaginatedResponse, SearchParams } from "../../../../../../interfaces/global";
+import { Document } from "../../../../../../interfaces/high5";
+export declare class High5DocumentArray extends Base {
+    /**
+     * Retrieves all items of a specified array document which match the provided search filter(s). Will return all items of the array if no filter is provided.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param dbName Name of the Database
+     * @param key Key of the Document (it should be document with Array<object>)
+     * @param filters (optional) Array of search filters
+     * @param sorting (optional) Sorting object
+     * @param limit (optional) Max number of results (1-100; defaults to 25)
+     * @param page (optional) Page number: Skip the first (page * limit) results (defaults to 0)
+     * @returns Object containing an array of items and the total number of results found in the document (independent of limit and page)
+     */
+    searchItems<R extends boolean = false>({ orgName, spaceName, dbName, key, filters, sorting, limit, page, }: SearchParams & {
+        orgName: string;
+        spaceName: string;
+        dbName: string;
+        key: string;
+    }, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, PaginatedResponse<object>>>;
+    /**
+     * Retrieves an array item by its index.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param dbName Name of the Database
+     * @param key Key of the Document
+     * @param index Index of the arrays item
+     * @returns The requested item of the array
+     */
+    getItem<R extends boolean = false>(orgName: string, spaceName: string, dbName: string, key: string, index: number, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, object>>;
+    /**
+     * Deletes an item of the specified array by its index.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param dbName Name of the Database
+     * @param key Key of the Document
+     * @param index Index of the item of the array
+     */
+    deleteItem<R extends boolean = false>(orgName: string, spaceName: string, dbName: string, key: string, index: number, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, void>>;
+    /**
+     * Pushes a list of items to the end of the specified array document.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param dbName Name of the Database
+     * @param key Key of the Document
+     * @param items New array items to be added to the end of the specified array document
+     * @returns Updated Document
+     */
+    pushItems<R extends boolean = false>(orgName: string, spaceName: string, dbName: string, key: string, items: Array<unknown>, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Document>>;
+    /**
+     * Unshifts a list of items to the beginning of the specified array document.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param dbName Name of the Database
+     * @param key Key of the Document
+     * @param items New array items to be inserted to the beginning of the specified array document
+     * @returns Updated Document
+     */
+    unshiftItems<R extends boolean = false>(orgName: string, spaceName: string, dbName: string, key: string, items: Array<unknown>, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Document>>;
+    protected getEndpoint(endpoint: string): string;
+}

package/lib/service/high5/space/database/document/array/index.js

@@ -0,0 +1,102 @@
+"use strict";
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.High5DocumentArray = void 0;
+const Base_1 = require("../../../../../../Base");
+const paginatedResponseHelper_1 = require("../../../../../../helper/paginatedResponseHelper");
+const searchFilter_1 = require("../../../../../../helper/searchFilter");
+class High5DocumentArray extends Base_1.default {
+    /**
+     * Retrieves all items of a specified array document which match the provided search filter(s). Will return all items of the array if no filter is provided.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param dbName Name of the Database
+     * @param key Key of the Document (it should be document with Array<object>)
+     * @param filters (optional) Array of search filters
+     * @param sorting (optional) Sorting object
+     * @param limit (optional) Max number of results (1-100; defaults to 25)
+     * @param page (optional) Page number: Skip the first (page * limit) results (defaults to 0)
+     * @returns Object containing an array of items and the total number of results found in the document (independent of limit and page)
+     */
+    searchItems(_a, raw_1) {
+        return __awaiter(this, arguments, void 0, function* ({ orgName, spaceName, dbName, key, filters, sorting, limit = 25, page = 0, }, raw) {
+            const filtersDTO = filters === null || filters === void 0 ? void 0 : filters.map((f) => new searchFilter_1.SearchFilterDTO(f));
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/databases/${dbName}/documents/${key}/search?page=${page}&limit=${limit}`), {
+                filters: filtersDTO,
+                sorting: sorting,
+            });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? Object.assign(Object.assign({}, resp), { data: (0, paginatedResponseHelper_1.createPaginatedResponse)(resp) }) : (0, paginatedResponseHelper_1.createPaginatedResponse)(resp));
+        });
+    }
+    /**
+     * Retrieves an array item by its index.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param dbName Name of the Database
+     * @param key Key of the Document
+     * @param index Index of the arrays item
+     * @returns The requested item of the array
+     */
+    getItem(orgName, spaceName, dbName, key, index, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.get(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/databases/${dbName}/documents/${key}/index/${index}`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Deletes an item of the specified array by its index.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param dbName Name of the Database
+     * @param key Key of the Document
+     * @param index Index of the item of the array
+     */
+    deleteItem(orgName, spaceName, dbName, key, index, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/databases/${dbName}/documents/${key}/index/${index}`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : undefined);
+        });
+    }
+    /**
+     * Pushes a list of items to the end of the specified array document.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param dbName Name of the Database
+     * @param key Key of the Document
+     * @param items New array items to be added to the end of the specified array document
+     * @returns Updated Document
+     */
+    pushItems(orgName, spaceName, dbName, key, items, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.patch(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/databases/${dbName}/documents/${key}/push`), { value: items });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Unshifts a list of items to the beginning of the specified array document.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param dbName Name of the Database
+     * @param key Key of the Document
+     * @param items New array items to be inserted to the beginning of the specified array document
+     * @returns Updated Document
+     */
+    unshiftItems(orgName, spaceName, dbName, key, items, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.patch(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/databases/${dbName}/documents/${key}/unshift`), { value: items });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/high5${endpoint}`;
+    }
+}
+exports.High5DocumentArray = High5DocumentArray;

package/lib/service/high5/space/database/document/index.d.ts

@@ -0,0 +1,74 @@
+import Base, { MaybeRaw } from "../../../../../Base";
+import { PaginatedResponse, SearchParams } from "../../../../../interfaces/global";
+import { Document, DocumentCreateDto, DocumentPatchDto } from "../../../../../interfaces/high5";
+import { High5DocumentArray } from "./array";
+import { High5DocumentNumber } from "./number";
+export declare class High5Document extends Base {
+    get number(): High5DocumentNumber;
+    private _number?;
+    get array(): High5DocumentArray;
+    private _array?;
+    /**
+     * Retrieves all Documents of a High5 Database which match the provided search filter(s). Will return all Documents of the Database if no filter is provided.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param dbName Name of the Database
+     * @param filters (optional) Array of search filters
+     * @param sorting (optional) Sorting object
+     * @param limit (optional) Max number of results (1-100; defaults to 25)
+     * @param page (optional) Page number: Skip the first (page * limit) results (defaults to 0)
+     * @returns Object containing an array of Documents and the total number of results found in the database (independent of limit and page)
+     */
+    searchDocuments<R extends boolean = false>({ orgName, spaceName, dbName, filters, sorting, limit, page }: SearchParams & {
+        orgName: string;
+        spaceName: string;
+        dbName: string;
+    }, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, PaginatedResponse<Document>>>;
+    /**
+     * Retrieves a Document by its name.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param dbName Name of the Database
+     * @param key Key of the Document
+     * @returns The requested Document
+     */
+    getDocument<R extends boolean = false>(orgName: string, spaceName: string, dbName: string, key: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Document>>;
+    /**
+     * Creates a new Document in the provided Database.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param dbName Name of the Database
+     * @param document New document details
+     * @returns The created Document
+     */
+    createDocument<R extends boolean = false>(orgName: string, spaceName: string, dbName: string, document: DocumentCreateDto, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Document>>;
+    /**
+     * Update existing Document
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param dbName Name of the Database
+     * @param key Key of the Document
+     * @param document New value to update the Document
+     * @returns Updated Document
+     */
+    updateDocument<R extends boolean = false>(orgName: string, spaceName: string, dbName: string, key: string, document: DocumentPatchDto, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Document>>;
+    /**
+     * Deletes a Document by its key.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param dbName Name of the Database
+     * @param key Key of the Document
+     */
+    deleteDocument<R extends boolean = false>(orgName: string, spaceName: string, dbName: string, key: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, void>>;
+    protected getEndpoint(endpoint: string): string;
+}

package/lib/service/high5/space/database/document/index.js

@@ -0,0 +1,112 @@
+"use strict";
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.High5Document = void 0;
+const Base_1 = require("../../../../../Base");
+const paginatedResponseHelper_1 = require("../../../../../helper/paginatedResponseHelper");
+const searchFilter_1 = require("../../../../../helper/searchFilter");
+const array_1 = require("./array");
+const number_1 = require("./number");
+class High5Document extends Base_1.default {
+    get number() {
+        if (this._number === undefined) {
+            this._number = new number_1.High5DocumentNumber(this.options, this.axios);
+        }
+        return this._number;
+    }
+    get array() {
+        if (this._array === undefined) {
+            this._array = new array_1.High5DocumentArray(this.options, this.axios);
+        }
+        return this._array;
+    }
+    /**
+     * Retrieves all Documents of a High5 Database which match the provided search filter(s). Will return all Documents of the Database if no filter is provided.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param dbName Name of the Database
+     * @param filters (optional) Array of search filters
+     * @param sorting (optional) Sorting object
+     * @param limit (optional) Max number of results (1-100; defaults to 25)
+     * @param page (optional) Page number: Skip the first (page * limit) results (defaults to 0)
+     * @returns Object containing an array of Documents and the total number of results found in the database (independent of limit and page)
+     */
+    searchDocuments(_a, raw_1) {
+        return __awaiter(this, arguments, void 0, function* ({ orgName, spaceName, dbName, filters, sorting, limit = 25, page = 0 }, raw) {
+            const filtersDTO = filters === null || filters === void 0 ? void 0 : filters.map((f) => new searchFilter_1.SearchFilterDTO(f));
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/databases/${dbName}/documents/search?page=${page}&limit=${limit}`), {
+                filters: filtersDTO,
+                sorting: sorting,
+            });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? Object.assign(Object.assign({}, resp), { data: (0, paginatedResponseHelper_1.createPaginatedResponse)(resp) }) : (0, paginatedResponseHelper_1.createPaginatedResponse)(resp));
+        });
+    }
+    /**
+     * Retrieves a Document by its name.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param dbName Name of the Database
+     * @param key Key of the Document
+     * @returns The requested Document
+     */
+    getDocument(orgName, spaceName, dbName, key, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.get(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/databases/${dbName}/documents/${key}`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Creates a new Document in the provided Database.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param dbName Name of the Database
+     * @param document New document details
+     * @returns The created Document
+     */
+    createDocument(orgName, spaceName, dbName, document, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/databases/${dbName}/documents`), document);
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Update existing Document
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param dbName Name of the Database
+     * @param key Key of the Document
+     * @param document New value to update the Document
+     * @returns Updated Document
+     */
+    updateDocument(orgName, spaceName, dbName, key, document, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.patch(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/databases/${dbName}/documents/${key}`), document);
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Deletes a Document by its key.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param dbName Name of the Database
+     * @param key Key of the Document
+     */
+    deleteDocument(orgName, spaceName, dbName, key, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/databases/${dbName}/documents/${key}`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : undefined);
+        });
+    }
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/high5${endpoint}`;
+    }
+}
+exports.High5Document = High5Document;