hcloud-sdk 15.0.0 → 17.0.0

package/lib/service/dali/avatar/DaliHigh5Pool.js

@@ -0,0 +1,61 @@
+"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.DaliHigh5Pool = void 0;
+const Base_1 = require("../../../Base");
+class DaliHigh5Pool extends Base_1.default {
+    /**
+     * Creates a default avatar for the specified High5 pool.
+     * @param orgName Name of the organization
+     * @param spaceName Name of the space
+     * @param poolName Name of the pool
+     * @returns Public URL of the created avatar
+     */
+    createAvatar(orgName, spaceName, poolName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/avatar/org/${orgName}/spaces/high5/${spaceName}/pools/${poolName}`), {});
+            return resp.data;
+        });
+    }
+    /**
+     * Deletes the avatar of the High5 pool from cloud storage. If you want to update it instead, use updateAvatar().
+     * @param orgName Name of the organization
+     * @param spaceName Name of the space
+     * @param poolName Name of the pool
+     */
+    deleteAvatar(orgName, spaceName, poolName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.axios.delete(this.getEndpoint(`/v1/avatar/org/${orgName}/spaces/high5/${spaceName}/pools/${poolName}`));
+        });
+    }
+    /**
+     * Updates the avatar of the specified High5 pool
+     * @param orgName Name of the organization
+     * @param spaceName Name of the space
+     * @param poolName Name of the pool
+     * @param file Image as Javascript File
+     * @returns Public URL of the new avatar
+     */
+    updateAvatar(orgName, spaceName, poolName, file) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const data = new FormData();
+            data.append("avatar", file);
+            const resp = yield this.axios.put(this.getEndpoint(`/v1/avatar/org/${orgName}/spaces/high5/${spaceName}/pools/${poolName}`), data, {
+                headers: { "Content-Type": "multipart/form-data" },
+            });
+            return resp.data;
+        });
+    }
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/dali${endpoint}`;
+    }
+}
+exports.DaliHigh5Pool = DaliHigh5Pool;

package/lib/service/dali/avatar/DaliHigh5Space.d.ts

@@ -1,6 +1,6 @@
 import Base from "../../../Base";
 import { AvatarCreated } from "../../../interfaces/dali";
-export declare class DaliHigh5 extends Base {
+export declare class DaliHigh5Space extends Base {
     /**
      * Creates a default avatar for the specified High5 space.
      * @param orgName Name of the organization

package/lib/service/dali/avatar/DaliHigh5Space.js

@@ -9,9 +9,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DaliHigh5 = void 0;
+exports.DaliHigh5Space = void 0;
 const Base_1 = require("../../../Base");
-class DaliHigh5 extends Base_1.default {
+class DaliHigh5Space extends Base_1.default {
     /**
      * Creates a default avatar for the specified High5 space.
      * @param orgName Name of the organization
@@ -55,4 +55,4 @@ class DaliHigh5 extends Base_1.default {
         return `${this.options.server}/api/dali${endpoint}`;
     }
 }
-exports.DaliHigh5 = DaliHigh5;
+exports.DaliHigh5Space = DaliHigh5Space;

package/lib/service/dali/avatar/DaliServiceAccount.d.ts

@@ -0,0 +1,26 @@
+import Base from "../../../Base";
+import { AvatarCreated } from "../../../interfaces/dali";
+export declare class DaliServiceAccount extends Base {
+    /**
+     * Creates a default avatar for the specified service account.
+     * @param orgName Name of the organization
+     * @param serviceAccountId ID of the service account
+     * @returns Public URL of the created avatar
+     */
+    createAvatar(orgName: string, serviceAccountId: string): Promise<AvatarCreated>;
+    /**
+     * Deletes the avatar of the service account from cloud storage. If you want to update it instead, use updateAvatar().
+     * @param orgName Name of the organization
+     * @param serviceAccountId ID of the service account
+     */
+    deleteAvatar(orgName: string, serviceAccountId: string): Promise<void>;
+    /**
+     * Updates the avatar of the specified service account.
+     * @param orgName Name of the organization
+     * @param serviceAccountId ID of the service account
+     * @param file Image as Javascript File
+     * @returns Public URL of the new avatar
+     */
+    updateAvatar(orgName: string, serviceAccountId: string, file: File): Promise<AvatarCreated>;
+    protected getEndpoint(endpoint: string): string;
+}

package/lib/service/dali/avatar/DaliServiceAccount.js

@@ -0,0 +1,58 @@
+"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.DaliServiceAccount = void 0;
+const Base_1 = require("../../../Base");
+class DaliServiceAccount extends Base_1.default {
+    /**
+     * Creates a default avatar for the specified service account.
+     * @param orgName Name of the organization
+     * @param serviceAccountId ID of the service account
+     * @returns Public URL of the created avatar
+     */
+    createAvatar(orgName, serviceAccountId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/avatar/org/${orgName}/service-accounts/${serviceAccountId}`), {});
+            return resp.data;
+        });
+    }
+    /**
+     * Deletes the avatar of the service account from cloud storage. If you want to update it instead, use updateAvatar().
+     * @param orgName Name of the organization
+     * @param serviceAccountId ID of the service account
+     */
+    deleteAvatar(orgName, serviceAccountId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.axios.delete(this.getEndpoint(`/v1/avatar/org/${orgName}/service-accounts/${serviceAccountId}`));
+        });
+    }
+    /**
+     * Updates the avatar of the specified service account.
+     * @param orgName Name of the organization
+     * @param serviceAccountId ID of the service account
+     * @param file Image as Javascript File
+     * @returns Public URL of the new avatar
+     */
+    updateAvatar(orgName, serviceAccountId, file) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const data = new FormData();
+            data.append("avatar", file);
+            const resp = yield this.axios.put(this.getEndpoint(`/v1/avatar/org/${orgName}/service-accounts/${serviceAccountId}`), data, {
+                headers: { "Content-Type": "multipart/form-data" },
+            });
+            return resp.data;
+        });
+    }
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/dali${endpoint}`;
+    }
+}
+exports.DaliServiceAccount = DaliServiceAccount;

package/lib/service/friday/index.d.ts

@@ -0,0 +1,13 @@
+import Base from "../../Base";
+import { Version } from "../../interfaces/global";
+import { FridaySpace } from "./space";
+export default class Friday extends Base {
+    get space(): FridaySpace;
+    private _space?;
+    /**
+     * Requests the endpoint version
+     * @returns Version object
+     */
+    version(): Promise<Version>;
+    protected getEndpoint(endpoint: string): string;
+}

package/lib/service/friday/index.js

@@ -0,0 +1,35 @@
+"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 });
+const Base_1 = require("../../Base");
+const space_1 = require("./space");
+class Friday extends Base_1.default {
+    get space() {
+        if (this._space === undefined) {
+            this._space = new space_1.FridaySpace(this.options, this.axios);
+        }
+        return this._space;
+    }
+    /**
+     * Requests the endpoint version
+     * @returns Version object
+     */
+    version() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.get(this.getEndpoint("/v1/version"));
+            return resp.data;
+        });
+    }
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/friday${endpoint}`;
+    }
+}
+exports.default = Friday;

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

@@ -0,0 +1,58 @@
+import Base from "../../../../../Base";
+import { Document, DocumentCreateDto, DocumentPatchDto } from "../../../../../interfaces/friday";
+import { PaginatedResponse, SearchParams } from "../../../../../interfaces/global";
+export declare class FridayDocument extends Base {
+    /**
+     * Retrieves all Documents of a Friday 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)
+     */
+    searchDatabases({ orgName, spaceName, dbName, filters, sorting, limit, page, }: SearchParams & {
+        orgName: string;
+        spaceName: string;
+        dbName: string;
+    }): Promise<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(orgName: string, spaceName: string, dbName: string, key: string): Promise<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(orgName: string, spaceName: string, dbName: string, document: DocumentCreateDto): Promise<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(orgName: string, spaceName: string, dbName: string, key: string, document: DocumentPatchDto): Promise<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(orgName: string, spaceName: string, dbName: string, key: string): Promise<void>;
+    protected getEndpoint(endpoint: string): string;
+}

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

@@ -0,0 +1,97 @@
+"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.FridayDocument = void 0;
+const Base_1 = require("../../../../../Base");
+const paginatedResponseHelper_1 = require("../../../../../helper/paginatedResponseHelper");
+const searchFilter_1 = require("../../../../../helper/searchFilter");
+class FridayDocument extends Base_1.default {
+    /**
+     * Retrieves all Documents of a Friday 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)
+     */
+    searchDatabases(_a) {
+        return __awaiter(this, arguments, void 0, function* ({ orgName, spaceName, dbName, filters, sorting, limit = 25, page = 0, }) {
+            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 (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) {
+        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 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) {
+        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 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) {
+        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 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) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/databases/${dbName}/documents/${key}`));
+        });
+    }
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/friday${endpoint}`;
+    }
+}
+exports.FridayDocument = FridayDocument;

package/lib/service/friday/space/database/index.d.ts

@@ -0,0 +1,55 @@
+import Base from "../../../../Base";
+import { Database } from "../../../../interfaces/friday";
+import { PaginatedResponse, SearchParams } from "../../../../interfaces/global";
+import { FridayDocument } from "./document";
+export declare class FridayDatabase extends Base {
+    get document(): FridayDocument;
+    private _document?;
+    /**
+     * Retrieves all Databases of a Friday Space which match the provided search filter(s). Will return all Databases of the Space if no filter is provided.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @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 Databases and the total number of results found in the database (independent of limit and page)
+     */
+    searchDatabases({ orgName, spaceName, filters, sorting, limit, page, }: SearchParams & {
+        orgName: string;
+        spaceName: string;
+    }): Promise<PaginatedResponse<Database>>;
+    /**
+     * Retrieves a Database by its name.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param dbName Name of the Database
+     * @returns The requested Database
+     */
+    getDatabase(orgName: string, spaceName: string, dbName: string): Promise<Database>;
+    /**
+     * Creates a new Database in the provided Space.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param name Name of the new Database
+     * @returns The created Database
+     */
+    createDatabase(orgName: string, spaceName: string, name: string): Promise<Database>;
+    /**
+     * Rename a Database
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param dbName Name of the Database
+     * @param name New name of the Database
+     * @returns Updated Database
+     */
+    renameDatabase(orgName: string, spaceName: string, dbName: string, name: string): Promise<Database>;
+    /**
+     * Deletes a Database by its name.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param dbName Name of the Database
+     */
+    deleteDatabase(orgName: string, spaceName: string, dbName: string): Promise<void>;
+    protected getEndpoint(endpoint: string): string;
+}

package/lib/service/friday/space/database/index.js

@@ -0,0 +1,101 @@
+"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.FridayDatabase = void 0;
+const Base_1 = require("../../../../Base");
+const paginatedResponseHelper_1 = require("../../../../helper/paginatedResponseHelper");
+const searchFilter_1 = require("../../../../helper/searchFilter");
+const document_1 = require("./document");
+class FridayDatabase extends Base_1.default {
+    get document() {
+        if (this._document === undefined) {
+            this._document = new document_1.FridayDocument(this.options, this.axios);
+        }
+        return this._document;
+    }
+    /**
+     * Retrieves all Databases of a Friday Space which match the provided search filter(s). Will return all Databases of the Space if no filter is provided.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @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 Databases and the total number of results found in the database (independent of limit and page)
+     */
+    searchDatabases(_a) {
+        return __awaiter(this, arguments, void 0, function* ({ orgName, spaceName, filters, sorting, limit = 25, page = 0, }) {
+            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/search?page=${page}&limit=${limit}`), {
+                filters: filtersDTO,
+                sorting: sorting,
+            });
+            return (0, paginatedResponseHelper_1.createPaginatedResponse)(resp);
+        });
+    }
+    /**
+     * Retrieves a Database by its name.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param dbName Name of the Database
+     * @returns The requested Database
+     */
+    getDatabase(orgName, spaceName, dbName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.get(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/databases/${dbName}`));
+            return resp.data;
+        });
+    }
+    /**
+     * Creates a new Database in the provided Space.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param name Name of the new Database
+     * @returns The created Database
+     */
+    createDatabase(orgName, spaceName, name) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/databases`), { name });
+            return resp.data;
+        });
+    }
+    /**
+     * Rename a Database
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param dbName Name of the Database
+     * @param name New name of the Database
+     * @returns Updated Database
+     */
+    renameDatabase(orgName, spaceName, dbName, name) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.patch(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/databases/${dbName}/name`), {
+                name: name,
+            });
+            return resp.data;
+        });
+    }
+    /**
+     * Deletes a Database by its name.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param dbName Name of the Database
+     */
+    deleteDatabase(orgName, spaceName, dbName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/databases/${dbName}`));
+        });
+    }
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/friday${endpoint}`;
+    }
+}
+exports.FridayDatabase = FridayDatabase;

package/lib/service/friday/space/index.d.ts

@@ -0,0 +1,81 @@
+import Base from "../../../Base";
+import { FridaySpace as Space, FridaySpaceEntityPermission as SpaceEntityPermission, FridaySpacePermission as SpacePermission } from "../../../interfaces/friday/space";
+import { PaginatedResponse, SearchParams } from "../../../interfaces/global";
+import { FridayDatabase } from "./database";
+export declare class FridaySpace extends Base {
+    get database(): FridayDatabase;
+    private _database?;
+    /**
+     * Retrieves all Friday Spaces of the specified Organization matching the search filter(s). Will return all Spaces if no search filter is provided.
+     * @param orgName Name of the organization
+     * @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 Friday Spaces and the total number of results found in the database (independent of limit and page)
+     */
+    searchSpaces({ orgName, filters, sorting, limit, page }: SearchParams & {
+        orgName: string;
+    }): Promise<PaginatedResponse<Space>>;
+    /**
+     * Retrieves a Friday Space by its name.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Friday Space
+     * @returns The requested Space
+     */
+    getSpace(orgName: string, spaceName: string): Promise<Space>;
+    /**
+     * Creates a new Friday Space in the specified Organization.
+     * @param orgName Name of the Organization
+     * @param name Name for the new Space
+     * @returns The created Space
+     */
+    createSpace(orgName: string, name: string): Promise<Space>;
+    /**
+     * Delete a space by its name.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     */
+    deleteSpace(orgName: string, spaceName: string): Promise<void>;
+    /**
+     * Updates the name of a space.
+     * @param orgName Name of the organization
+     * @param spaceName Current name of the space
+     * @param newSpaceName New name for the space
+     * @returns The updated space
+     */
+    renameSpace(orgName: string, spaceName: string, newSpaceName: string): Promise<Space>;
+    /**
+     * Retrieves permissions of a space matching the search filter(s). Will return all permissions of the space if no search filter is provided.
+     * @param orgName Name of the organization
+     * @param spaceName Name of the space
+     * @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 Friday Space Permissions and the total number of results found in the database (independent of limit and page)
+     */
+    searchSpacePermissions({ orgName, spaceName, filters, sorting, limit, page, }: SearchParams & {
+        orgName: string;
+        spaceName: string;
+    }): Promise<PaginatedResponse<SpaceEntityPermission>>;
+    /**
+     * Adds/Updates/Removes the permission a user has in the specified space.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param userId ID of the User
+     * @param permission New permission
+     * @returns The Space with updated permissions
+     */
+    updateUserSpacePermission(orgName: string, spaceName: string, userId: string, permission: SpacePermission): Promise<SpaceEntityPermission>;
+    /**
+     * Adds/Updates/Removes the permission a team has in the specified space. Note: A team cannot be an owner of a Space.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param teamName Name of the Team
+     * @param permission New permission
+     * @returns The Space with updated permissions
+     */
+    updateTeamSpacePermission(orgName: string, spaceName: string, teamName: string, permission: SpacePermission): Promise<SpaceEntityPermission>;
+    protected getEndpoint(endpoint: string): string;
+}