hcloud-sdk 22.29.0 → 22.31.0

package/changelog.md

@@ -1,9 +1,5 @@
-## [22.29.0](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/compare/v22.28.0...v22.29.0) (2026-09-09)
+## [22.31.0](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/compare/v22.30.0...v22.31.0) (2026-09-14)
 
 ### Features
 
-* introduce nats message object ([0cfff40](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/0cfff40042da3875cd737c1eb3953ef22e569dc4))
-
-### Reverts
-
-* introduce a new nats subject for standard user information ([8c61176](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/8c6117617ff972db702646307a677eb6c0f756d6))
+* **cosmo:** add avatar support for address books ([042edae](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/042edae9ccd7d54c198588a2961880c850574200))

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

@@ -1,11 +1,16 @@
 import { ReducedUser } from "../../idp/user";
+/** Members as key-value pairs: mandatory e-mail address -> optional display name */
+export type AddressBookMembers = Record<string, string | undefined>;
 export type AddressBook = {
     _id: string;
     name: string;
     description?: string;
-    members: string[];
+    members: AddressBookMembers;
+    /** IDs of internal teams referenced by the address book */
+    teamIds: string[];
     createDate: number;
     modifyDate: number;
+    avatarUrl: string;
     creator: ReducedUser;
 };
 export type AddressBookCreate = {
@@ -13,8 +18,10 @@ export type AddressBookCreate = {
     name: string;
     /** Optional description (max 512 chars) */
     description?: string;
-    /** Initial list of member email addresses */
-    members?: string[];
+    /** Initial members (e-mail -> optional display name) */
+    members?: AddressBookMembers;
+    /** Initial list of internal team IDs to reference */
+    teamIds?: string[];
 };
 export type AddressBookUpdate = {
     /** New name of the address book (1–128 chars) */
@@ -22,7 +29,15 @@ export type AddressBookUpdate = {
     /** Updated description (max 512 chars) */
     description?: string;
 };
-export type AddressBookMemberRequest = {
-    /** List of email addresses to add or remove (min 1) */
+export type AddressBookMemberAddRequest = {
+    /** Members to add (e-mail -> optional display name, min 1) */
+    members: AddressBookMembers;
+};
+export type AddressBookMemberRemoveRequest = {
+    /** List of email addresses to remove (min 1) */
     emails: string[];
 };
+export type AddressBookTeamRequest = {
+    /** List of internal team IDs to add or remove (min 1) */
+    teamIds: string[];
+};

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

@@ -1,5 +1,5 @@
 import Base, { MaybeRaw } from "../../../Base";
-import { AddressBook, AddressBookCreate, AddressBookUpdate } from "../../../interfaces/cosmo/addressBook";
+import { AddressBook, AddressBookCreate, AddressBookMembers, AddressBookUpdate } from "../../../interfaces/cosmo/addressBook";
 import { SearchFilter, Sorting } from "../../../interfaces/global/SearchFilters";
 /**
  * @class CosmoAddressBook
@@ -84,16 +84,16 @@ export declare class CosmoAddressBook extends Base {
         raw: R;
     }): Promise<MaybeRaw<R, void>>;
     /**
-     * Add one or more members (by e-mail) to an Address Book.
+     * Add one or more members 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)
+     * @param members Members to add (e-mail -> optional display name)
      * @returns The updated AddressBook
      */
-    addAddressBookMembers<R extends boolean = false>(orgName: string, spaceName: string, bookId: string, emails: string[], raw?: {
+    addAddressBookMembers<R extends boolean = false>(orgName: string, spaceName: string, bookId: string, members: AddressBookMembers, raw?: {
         raw: R;
     }): Promise<MaybeRaw<R, AddressBook>>;
     /**
@@ -109,4 +109,42 @@ export declare class CosmoAddressBook extends Base {
     removeAddressBookMembers<R extends boolean = false>(orgName: string, spaceName: string, bookId: string, emails: string[], raw?: {
         raw: R;
     }): Promise<MaybeRaw<R, AddressBook>>;
+    /**
+     * Add one or more internal team references to an Address Book. Team membership stays live: changes to a
+     * referenced team are reflected in the address book's recipients.
+     * @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 teamIds List of internal team IDs to add (min 1)
+     * @returns The updated AddressBook
+     */
+    addAddressBookTeams<R extends boolean = false>(orgName: string, spaceName: string, bookId: string, teamIds: string[], raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, AddressBook>>;
+    /**
+     * Remove one or more internal team references 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 teamIds List of internal team IDs to remove (min 1)
+     * @returns The updated AddressBook
+     */
+    removeAddressBookTeams<R extends boolean = false>(orgName: string, spaceName: string, bookId: string, teamIds: string[], raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, AddressBook>>;
+    /**
+     * Updates the avatar of the specified Address Book.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param bookId ID of the Address Book
+     * @param file Image as Javascript File
+     * @returns AddressBook details with updated avatar
+     */
+    updateAvatar<R extends boolean = false>(orgName: string, spaceName: string, bookId: string, file: File, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, AddressBook>>;
 }

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

@@ -111,18 +111,18 @@ class CosmoAddressBook extends Base_1.default {
         });
     }
     /**
-     * Add one or more members (by e-mail) to an Address Book.
+     * Add one or more members 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)
+     * @param members Members to add (e-mail -> optional display name)
      * @returns The updated AddressBook
      */
-    addAddressBookMembers(orgName, spaceName, bookId, emails, raw) {
+    addAddressBookMembers(orgName, spaceName, bookId, members, raw) {
         return __awaiter(this, void 0, void 0, function* () {
-            const payload = { emails };
+            const payload = { members };
             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);
         });
@@ -146,5 +146,60 @@ class CosmoAddressBook extends Base_1.default {
             return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
         });
     }
+    /**
+     * Add one or more internal team references to an Address Book. Team membership stays live: changes to a
+     * referenced team are reflected in the address book's recipients.
+     * @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 teamIds List of internal team IDs to add (min 1)
+     * @returns The updated AddressBook
+     */
+    addAddressBookTeams(orgName, spaceName, bookId, teamIds, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const payload = { teamIds };
+            const resp = yield this.axios.post(this.getEndpoint(`${this.basePath(orgName, spaceName)}/${bookId}/teams`), payload);
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Remove one or more internal team references 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 teamIds List of internal team IDs to remove (min 1)
+     * @returns The updated AddressBook
+     */
+    removeAddressBookTeams(orgName, spaceName, bookId, teamIds, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const payload = { teamIds };
+            const resp = yield this.axios.delete(this.getEndpoint(`${this.basePath(orgName, spaceName)}/${bookId}/teams`), {
+                data: payload,
+            });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Updates the avatar of the specified Address Book.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param bookId ID of the Address Book
+     * @param file Image as Javascript File
+     * @returns AddressBook details with updated avatar
+     */
+    updateAvatar(orgName, spaceName, bookId, file, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const data = new FormData();
+            data.append("avatar", file);
+            const resp = yield this.axios.patch(this.getEndpoint(`${this.basePath(orgName, spaceName)}/${bookId}/avatar`), data, {
+                headers: { "Content-Type": "multipart/form-data" },
+            });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
 }
 exports.CosmoAddressBook = CosmoAddressBook;

package/lib/service/dali/DaliAvatar.d.ts

@@ -1,4 +1,5 @@
 import Base from "../../Base";
+import { DaliAddressBook } from "./avatar/DaliAddressBook";
 import { DaliCosmoSpace } from "./avatar/DaliCosmoSpace";
 import { DaliHigh5Pool } from "./avatar/DaliHigh5Pool";
 import { DaliHigh5Space } from "./avatar/DaliHigh5Space";
@@ -44,6 +45,11 @@ export declare class DaliAvatar extends Base {
      */
     get cosmoSpace(): DaliCosmoSpace;
     private _cosmoSpace?;
+    /**
+     * Handles everything around address book avatars
+     */
+    get addressBook(): DaliAddressBook;
+    private _addressBook?;
     /**
      * Handles everything around OAuth applications avatars
      */

package/lib/service/dali/DaliAvatar.js

@@ -5,6 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DaliAvatar = void 0;
 const Base_1 = __importDefault(require("../../Base"));
+const DaliAddressBook_1 = require("./avatar/DaliAddressBook");
 const DaliCosmoSpace_1 = require("./avatar/DaliCosmoSpace");
 const DaliHigh5Pool_1 = require("./avatar/DaliHigh5Pool");
 const DaliHigh5Space_1 = require("./avatar/DaliHigh5Space");
@@ -78,6 +79,15 @@ class DaliAvatar extends Base_1.default {
         }
         return this._cosmoSpace;
     }
+    /**
+     * Handles everything around address book avatars
+     */
+    get addressBook() {
+        if (this._addressBook === undefined) {
+            this._addressBook = new DaliAddressBook_1.DaliAddressBook(this.options, this.axios);
+        }
+        return this._addressBook;
+    }
     /**
      * Handles everything around OAuth applications avatars
      */

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

@@ -0,0 +1,35 @@
+import Base, { MaybeRaw } from "../../../Base";
+import { AvatarCreated } from "../../../interfaces/dali";
+export declare class DaliAddressBook extends Base {
+    /**
+     * Creates a default avatar for the specified Address Book.
+     * @param orgName Name of the organization
+     * @param spaceName Name of the Cosmo space
+     * @param bookId ID of the Address Book
+     * @returns Public URL of the created avatar
+     */
+    createAvatar<R extends boolean = false>(orgName: string, spaceName: string, bookId: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, AvatarCreated>>;
+    /**
+     * Deletes the avatar of the Address Book from cloud storage. If you want to update it instead, use updateAvatar().
+     * @param orgName Name of the organization
+     * @param spaceName Name of the Cosmo space
+     * @param bookId ID of the Address Book
+     */
+    deleteAvatar<R extends boolean = false>(orgName: string, spaceName: string, bookId: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, string>>;
+    /**
+     * Updates the avatar of the specified Address Book
+     * @param orgName Name of the organization
+     * @param spaceName Name of the Cosmo space
+     * @param bookId ID of the Address Book
+     * @param file Image as Javascript File
+     * @returns Public URL of the new avatar
+     */
+    updateAvatar<R extends boolean = false>(orgName: string, spaceName: string, bookId: string, file: File, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, AvatarCreated>>;
+    protected getEndpoint(endpoint: string): string;
+}

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

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

package/package.json

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