hcloud-sdk 22.4.0 → 22.5.0

package/changelog.md

@@ -1,6 +1,5 @@
-## [22.4.0](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/compare/v22.3.0...v22.4.0) (2026-07-23)
+## [22.5.0](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/compare/v22.4.0...v22.5.0) (2026-07-23)
 
 ### Features
 
-* update error codes ([746b535](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/746b535126921eba8510df861baff12351276cfd))
-* update error codes ([c15e73a](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/c15e73aaa020d13b5f2431f423b5304f657d506b))
+* implements addressbooks on spacelevel ([b604a47](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/b604a47338b03a9164b7b791ab29b638f8c88e58))

package/lib/interfaces/cosmo/addressBook/index.d.ts

@@ -0,0 +1,28 @@
+import { ReducedUser } from "../../idp/user";
+export type AddressBook = {
+    _id: string;
+    name: string;
+    description?: string;
+    members: string[];
+    createDate: number;
+    modifyDate: number;
+    creator: ReducedUser;
+};
+export type AddressBookCreate = {
+    /** Name of the address book (1–128 chars) */
+    name: string;
+    /** Optional description (max 512 chars) */
+    description?: string;
+    /** Initial list of member email addresses */
+    members?: string[];
+};
+export type AddressBookUpdate = {
+    /** New name of the address book (1–128 chars) */
+    name?: string;
+    /** Updated description (max 512 chars) */
+    description?: string;
+};
+export type AddressBookMemberRequest = {
+    /** List of email addresses to add or remove (min 1) */
+    emails: string[];
+};

package/lib/interfaces/cosmo/addressBook/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/service/cosmo/addressBook/index.d.ts

@@ -0,0 +1,112 @@
+import Base, { MaybeRaw } from "../../../Base";
+import { AddressBook, AddressBookCreate, AddressBookUpdate } from "../../../interfaces/cosmo/addressBook";
+import { SearchFilter, Sorting } from "../../../interfaces/global/SearchFilters";
+/**
+ * @class CosmoAddressBook
+ * @extends Base
+ *
+ * @remarks
+ * **Under development, breaking changes possible**
+ *
+ * Represents an Address Book resource in Cosmo, providing methods to interact with the Address Book API.
+ * Address books exist on space level and hold named groups of e-mail addresses (members).
+ */
+export declare class CosmoAddressBook extends Base {
+    protected getEndpoint(endpoint: string): string;
+    private basePath;
+    /**
+     * Search address books of a Space with optional filters, sorting and pagination.
+     * @remarks
+     * **Under development, breaking changes possible**
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param filters Optional search filters
+     * @param sorting Optional sorting definition
+     * @param limit Maximum number of results per page (default 100)
+     * @param page Zero-based page number (default 0)
+     * @returns Paginated result with items and total count
+     */
+    searchAddressBooks<R extends boolean = false>(orgName: string, spaceName: string, { filters, sorting, limit, page }?: {
+        filters?: SearchFilter[];
+        sorting?: Sorting;
+        limit?: number;
+        page?: number;
+    }, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, AddressBook[]>>;
+    /**
+     * Create a new Address Book inside the specified Space.
+     * @remarks
+     * **Under development, breaking changes possible**
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param data Address book creation payload
+     * @returns The created AddressBook
+     */
+    createAddressBook<R extends boolean = false>(orgName: string, spaceName: string, data: AddressBookCreate, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, AddressBook>>;
+    /**
+     * Get a single Address Book by its ID.
+     * @remarks
+     * **Under development, breaking changes possible**
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param bookId ID of the Address Book
+     * @returns The requested AddressBook
+     */
+    getAddressBook<R extends boolean = false>(orgName: string, spaceName: string, bookId: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, AddressBook>>;
+    /**
+     * Update an existing Address Book (rename / change description).
+     * @remarks
+     * **Under development, breaking changes possible**
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param bookId ID of the Address Book
+     * @param data Fields to update
+     * @returns The updated AddressBook
+     */
+    updateAddressBook<R extends boolean = false>(orgName: string, spaceName: string, bookId: string, data: AddressBookUpdate, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, AddressBook>>;
+    /**
+     * Delete an Address Book by its ID.
+     * @remarks
+     * **Under development, breaking changes possible**
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param bookId ID of the Address Book to delete
+     * @returns 204 No Content on success
+     */
+    deleteAddressBook<R extends boolean = false>(orgName: string, spaceName: string, bookId: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, void>>;
+    /**
+     * Add one or more members (by e-mail) to an Address Book.
+     * @remarks
+     * **Under development, breaking changes possible**
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param bookId ID of the Address Book
+     * @param emails List of e-mail addresses to add (min 1)
+     * @returns The updated AddressBook
+     */
+    addAddressBookMembers<R extends boolean = false>(orgName: string, spaceName: string, bookId: string, emails: string[], raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, AddressBook>>;
+    /**
+     * Remove one or more members (by e-mail) from an Address Book.
+     * @remarks
+     * **Under development, breaking changes possible**
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param bookId ID of the Address Book
+     * @param emails List of e-mail addresses to remove (min 1)
+     * @returns The updated AddressBook
+     */
+    removeAddressBookMembers<R extends boolean = false>(orgName: string, spaceName: string, bookId: string, emails: string[], raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, AddressBook>>;
+}

package/lib/service/cosmo/addressBook/index.js

@@ -0,0 +1,150 @@
+"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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CosmoAddressBook = void 0;
+const Base_1 = __importDefault(require("../../../Base"));
+/**
+ * @class CosmoAddressBook
+ * @extends Base
+ *
+ * @remarks
+ * **Under development, breaking changes possible**
+ *
+ * Represents an Address Book resource in Cosmo, providing methods to interact with the Address Book API.
+ * Address books exist on space level and hold named groups of e-mail addresses (members).
+ */
+class CosmoAddressBook extends Base_1.default {
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/cosmo${endpoint}`;
+    }
+    basePath(orgName, spaceName) {
+        return `/v1/org/${orgName}/spaces/${spaceName}/address-book`;
+    }
+    /**
+     * Search address books of a Space with optional filters, sorting and pagination.
+     * @remarks
+     * **Under development, breaking changes possible**
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param filters Optional search filters
+     * @param sorting Optional sorting definition
+     * @param limit Maximum number of results per page (default 100)
+     * @param page Zero-based page number (default 0)
+     * @returns Paginated result with items and total count
+     */
+    searchAddressBooks(orgName_1, spaceName_1) {
+        return __awaiter(this, arguments, void 0, function* (orgName, spaceName, { filters, sorting, limit, page } = {}, raw) {
+            const resp = yield this.axios.post(this.getEndpoint(`${this.basePath(orgName, spaceName)}/search`), Object.assign({ filters: filters !== null && filters !== void 0 ? filters : [] }, (sorting ? { sorting } : {})), { params: { limit: limit !== null && limit !== void 0 ? limit : 100, page: page !== null && page !== void 0 ? page : 0 } });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Create a new Address Book inside the specified Space.
+     * @remarks
+     * **Under development, breaking changes possible**
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param data Address book creation payload
+     * @returns The created AddressBook
+     */
+    createAddressBook(orgName, spaceName, data, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.post(this.getEndpoint(this.basePath(orgName, spaceName)), data);
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Get a single Address Book by its ID.
+     * @remarks
+     * **Under development, breaking changes possible**
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param bookId ID of the Address Book
+     * @returns The requested AddressBook
+     */
+    getAddressBook(orgName, spaceName, bookId, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.get(this.getEndpoint(`${this.basePath(orgName, spaceName)}/${bookId}`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Update an existing Address Book (rename / change description).
+     * @remarks
+     * **Under development, breaking changes possible**
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param bookId ID of the Address Book
+     * @param data Fields to update
+     * @returns The updated AddressBook
+     */
+    updateAddressBook(orgName, spaceName, bookId, data, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.patch(this.getEndpoint(`${this.basePath(orgName, spaceName)}/${bookId}`), data);
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Delete an Address Book by its ID.
+     * @remarks
+     * **Under development, breaking changes possible**
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param bookId ID of the Address Book to delete
+     * @returns 204 No Content on success
+     */
+    deleteAddressBook(orgName, spaceName, bookId, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.delete(this.getEndpoint(`${this.basePath(orgName, spaceName)}/${bookId}`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : undefined);
+        });
+    }
+    /**
+     * Add one or more members (by e-mail) to an Address Book.
+     * @remarks
+     * **Under development, breaking changes possible**
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param bookId ID of the Address Book
+     * @param emails List of e-mail addresses to add (min 1)
+     * @returns The updated AddressBook
+     */
+    addAddressBookMembers(orgName, spaceName, bookId, emails, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const payload = { emails };
+            const resp = yield this.axios.post(this.getEndpoint(`${this.basePath(orgName, spaceName)}/${bookId}/members`), payload);
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Remove one or more members (by e-mail) from an Address Book.
+     * @remarks
+     * **Under development, breaking changes possible**
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param bookId ID of the Address Book
+     * @param emails List of e-mail addresses to remove (min 1)
+     * @returns The updated AddressBook
+     */
+    removeAddressBookMembers(orgName, spaceName, bookId, emails, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const payload = { emails };
+            const resp = yield this.axios.delete(this.getEndpoint(`${this.basePath(orgName, spaceName)}/${bookId}/members`), {
+                data: payload,
+            });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+}
+exports.CosmoAddressBook = CosmoAddressBook;

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

@@ -1,5 +1,6 @@
 import Base from "../../Base";
 import { Version } from "../../interfaces/global";
+import { CosmoAddressBook } from "./addressBook";
 import { CosmoAsset } from "./asset";
 import { CosmoComment } from "./comment";
 import { CosmoEvent } from "./event";
@@ -16,6 +17,8 @@ import { CosmoStack } from "./stack";
 import { CosmoStats } from "./stats";
 import { CosmoTag } from "./tag";
 export default class CosmoService extends Base {
+    get cosmoAddressBook(): CosmoAddressBook;
+    private _cosmoAddressBook?;
     get cosmoAsset(): CosmoAsset;
     private _cosmoAsset?;
     get cosmoSpace(): CosmoSpace;

package/lib/service/cosmo/index.js

@@ -13,6 +13,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const Base_1 = __importDefault(require("../../Base"));
+const addressBook_1 = require("./addressBook");
 const asset_1 = require("./asset");
 const comment_1 = require("./comment");
 const event_1 = require("./event");
@@ -29,6 +30,12 @@ const stack_1 = require("./stack");
 const stats_1 = require("./stats");
 const tag_1 = require("./tag");
 class CosmoService extends Base_1.default {
+    get cosmoAddressBook() {
+        if (this._cosmoAddressBook === undefined) {
+            this._cosmoAddressBook = new addressBook_1.CosmoAddressBook(this.options, this.axios);
+        }
+        return this._cosmoAddressBook;
+    }
     get cosmoAsset() {
         if (this._cosmoAsset === undefined) {
             this._cosmoAsset = new asset_1.CosmoAsset(this.options, this.axios);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hcloud-sdk",
-  "version": "22.4.0",
+  "version": "22.5.0",
   "description": "hcloud platform sdk",
   "main": "index.js",
   "types": "index.d.ts",