@ale-rainbow/web-sdk 5.1.0

package/lib/services/admin/admin-user.service.d.ts

@@ -0,0 +1,338 @@
+/**
+ * @module Admin
+ */
+import type { Observable } from "rxjs";
+import type { User, AuthService, ErrorHelperService, LoggerService } from "../..";
+import { Company } from "../..";
+import type { ServiceEventsToUnion } from "../../services/service";
+import type { SDKAdminCompanyService } from "../../services/admin/admin-company.service";
+import type { ContactService } from "../../services/core/contact.service";
+/**
+ * A paginated result from a user search query.
+ */
+export interface UserSearchResult {
+    /** The users matching the query for the requested page. */
+    users: User[];
+    /** Total number of users matching the query. */
+    total: number;
+    /** Maximum number of items returned per page. */
+    limit: number;
+    /** Offset of the current page. */
+    offset: number;
+}
+/**
+ * Events emitted by {@link SDKAdminUserService} after successful user operations.
+ *
+ * Subscribe via `adminService.user.events('ON_ADMIN_USER_ADDED').subscribe(...)`.
+ */
+export interface AdminUserServiceEvents {
+    /** Fired after a new user has been successfully created. */
+    ON_ADMIN_USER_ADDED: {
+        user: User;
+    };
+    /** Fired after an existing user has been updated (profile, tags, restore, etc.). */
+    ON_ADMIN_USER_UPDATED: {
+        user: Partial<User> & {
+            dbId: string;
+        };
+    };
+    /** Fired after a user has been removed or marked as pending deletion. */
+    ON_ADMIN_USER_REMOVED: {
+        userId: string;
+        pendingDelete?: boolean;
+    };
+    /** Fired after a bulk delete completes — contains the login emails of removed users. */
+    ON_ADMIN_USERS_BULK_REMOVED: {
+        loginEmails: string[];
+    };
+    /** Fired after a bulk tag update completes. */
+    ON_ADMIN_USERS_BULK_TAGS_UPDATED: {
+        users: Array<{
+            loginEmail: string;
+            tags: string[];
+        }>;
+    };
+}
+/**
+ * Options for filtering and sorting the advanced user search.
+ */
+export interface UserSearchOptions {
+    /** Search users by internal phone number instead of display name. */
+    searchByInternalNumber?: boolean;
+    /** Filter by tag name. */
+    filterByTag?: string;
+    /** Filter by customization template identifier. */
+    filterByProfile?: string;
+    /** Filter by department name. */
+    filterByDepartment?: string;
+    /** Filter by site identifier. Use `"noSite"` to match users with no site. */
+    filterBySite?: string;
+    /** When `true`, return only administrators. */
+    isAdministrator?: boolean;
+    /** When `true`, return only regular members (excludes all admin roles). */
+    isMember?: boolean;
+    /** When `true`/`false`, filter by activation status. */
+    isActivated?: boolean;
+    /** When `true`, return only suspended (pending termination) users. */
+    isTerminated?: boolean;
+    /** When `true`, include users pending termination in normal results. */
+    includePendingTermination?: boolean;
+    /** Field to sort by (e.g. `"reverseDisplayName"`). */
+    sortField?: string;
+    /**
+     * When `true`, skips full Contact instantiation and returns a lightweight object with only the fields
+     * needed for list display. Significantly faster for large result sets. Defaults to `false`.
+     */
+    useLightParser?: boolean;
+}
+/**
+ * Body for {@link SDKAdminUserService.update}.
+ *
+ * Carries the user fields editable from the admin user form, in the REST
+ * camelCase naming expected by `PUT /api/rainbow/admin/v1.0/users/:userId`.
+ * All fields are optional (the API accepts a partial body); only `id` is
+ * required. The `id` is sent in the URL path and stripped from the body.
+ */
+export interface AdminUserUpdatePayload {
+    /** User unique identifier — used in the URL path, stripped from the body. */
+    id: string;
+    /**
+     * New login email. Send it only when it actually changes — the API rejects a
+     * body carrying the value the user already holds.
+     */
+    loginEmail?: string;
+    firstName?: string;
+    lastName?: string;
+    title?: string;
+    jobTitle?: string;
+    department?: string;
+    userInfo1?: string;
+    userInfo2?: string;
+    language?: string;
+    country?: string;
+    timezone?: string;
+    visibility?: string;
+    siteId?: string;
+    loginPhone?: {
+        E164: string;
+    } | null;
+    /**
+     * New password set by an administrator on behalf of the user. Send it only
+     * when the administrator actually sets one — omit the field otherwise, never
+     * send an empty string. The password policy is enforced server-side.
+     */
+    password?: string;
+    /**
+     * Full list of {@link UserRole} values held by the user. The API *replaces*
+     * the whole list, so callers must send every role to keep — including the
+     * ones they do not manage — not only the ones they changed.
+     */
+    roles?: string[];
+    /**
+     * Marks the account as initialized. The backend sets it on its own when the
+     * user completes the onboarding wizard; an administrator sends it explicitly
+     * to repair an account left at `false` by a wizard that crashed mid-way.
+     */
+    isInitialized?: boolean;
+    /** Authentication policy, set via the caller's login-policy mapping. */
+    authenticationType?: string;
+    mfaRainbowPolicyId?: string;
+    rainbowPasswordlessPolicyId?: string;
+    singleSignOnId?: string;
+}
+/**
+ * Admin sub-service for user management within a company.
+ *
+ * Accessible via `adminService.user`.
+ *
+ * @example
+ * ```ts
+ * const users = await adminService.user.getAll(companyId);
+ * const users = await adminService.user.getAll(companyId, 'full', [{ key: 'roles', value: 'admin' }]);
+ * const newUser = await adminService.user.create('john@acme.com', 'John', 'Doe', 'p@ss', companyId);
+ * await adminService.user.update({ id: '123', firstName: 'Jane' });
+ * await adminService.user.remove(userId);
+ * ```
+ */
+export interface SDKAdminUserService {
+    events: <const E extends keyof AdminUserServiceEvents & string>(...names: E[]) => Observable<ServiceEventsToUnion<Pick<AdminUserServiceEvents, E>>>;
+    start: () => void;
+    /** Stops the service, removing XMPP handlers and completing the event stream. */
+    stop: () => void;
+    /**
+     * Fetches all users belonging to a company.
+     *
+     * @param companyRef - The target company, as either its string ID or a {@link Company} instance.
+     * @param detailsLevel - Optional response format (`"small"`, `"medium"`, `"full"`). Defaults to `"small"`.
+     * @param filters - Optional array of `{ key, value }` query parameter objects for server-side filtering.
+     * @returns An array of raw user data objects.
+     * @throws {@link RainbowError} when the request fails.
+     */
+    getAll: (companyRef: string | Company, detailsLevel?: string, filters?: Array<{
+        key: string;
+        value: string;
+    }>) => Promise<unknown[]>;
+    /**
+     * Creates a new user account inside a company.
+     *
+     * @param login - Login email address for the new user.
+     * @param firstName - First name of the new user.
+     * @param lastName - Last name of the new user.
+     * @param password - Initial password for the new user.
+     * @param companyRef - The target company, as either its string ID or a {@link Company} instance.
+     * @param tags - Optional array of tag strings to assign to the user.
+     * @returns The raw data of the created user.
+     * @throws {@link RainbowError} when creation fails.
+     */
+    create: (login: string, firstName: string, lastName: string, password: string, companyRef: string | Company, tags?: string[]) => Promise<unknown>;
+    /**
+     * Deletes a user account.
+     *
+     * @param userId - The unique identifier of the user to delete.
+     * @param pendingDelete - When `true`, schedules the user for pending termination instead of immediate deletion.
+     * @throws {@link RainbowError} when the deletion fails.
+     */
+    remove: (userId: string, pendingDelete?: boolean) => Promise<void>;
+    /**
+     * Cancels the pending deletion of a user account, restoring it to active state.
+     *
+     * @param userId - The unique identifier of the user to restore.
+     * @returns The raw data of the restored user.
+     * @throws {@link RainbowError} when the request fails.
+     */
+    cancelDelete: (userId: string) => Promise<unknown>;
+    /**
+     * Force-deletes a user account (superadmin only).
+     *
+     * @param userId - The unique identifier of the user to force-delete.
+     * @returns The raw data of the deleted user.
+     * @throws {@link RainbowError} when the deletion fails.
+     */
+    forceDelete: (userId: string) => Promise<unknown>;
+    /**
+     * Updates an existing user account.
+     *
+     * The `user` object must contain an `id` property. The call is a no-op when
+     * `user` is falsy or has no `id`.
+     *
+     * @param user - Partial or full user object. Must include `id`.
+     * @throws {@link RainbowError} when the update fails.
+     */
+    update: (user: AdminUserUpdatePayload) => Promise<void>;
+    /**
+     * Searches users with advanced filtering and pagination.
+     *
+     * @param companyRef - The target company, as either its string ID or a {@link Company} instance.
+     * @param page - Page number (1-based).
+     * @param pageSize - Number of users per page.
+     * @param searchPattern - Optional text to search by display name or phone number.
+     * @param options - Optional filters and sort options.
+     * @returns A {@link UserSearchResult} with the matching users and pagination metadata.
+     * @throws {@link RainbowError} when the request fails.
+     */
+    search: (companyRef: string | Company, page: number, pageSize: number, searchPattern?: string, options?: UserSearchOptions) => Promise<UserSearchResult>;
+    /**
+     * Exports the list of deleted (pending-termination) users for a company as a CSV Blob.
+     *
+     * The returned Blob has MIME type `text/csv; charset=utf-8-sig` and is prefixed with a
+     * UTF-8 BOM so that spreadsheet applications open it correctly.
+     *
+     * @param companyRef - The target company, as either its string ID or a {@link Company} instance.
+     * @returns A {@link Blob} containing the CSV data.
+     * @throws {@link RainbowError} when the request fails.
+     */
+    exportDeletedUsers: (companyRef: string | Company) => Promise<Blob>;
+    /**
+     * Fetches all users matching the given search pattern and filter options, handling pagination transparently.
+     *
+     * @param companyRef - The target company, as either its string ID or a {@link Company} instance.
+     * @param searchPattern - Optional text to filter users by display name or phone number.
+     * @param options - Optional filters and sort options (same as {@link search}).
+     * @returns All matching {@link User} instances.
+     * @throws {@link RainbowError} when the request fails.
+     */
+    fetchAllUsers: (companyRef: string | Company, searchPattern?: string, options?: UserSearchOptions) => Promise<User[]>;
+    /**
+     * Sets the tags assigned to a user, replacing the current tag list entirely.
+     *
+     * @param userId - The unique identifier of the user.
+     * @param tags - The new list of tag strings to assign to the user.
+     * @throws {@link RainbowError} when the request fails.
+     */
+    setTags: (userId: string, tags: string[]) => Promise<void>;
+    /**
+     * Assigns tags to a set of users via mass provisioning.
+     * Replaces all existing tags on each user with the provided list.
+     * Resolves when the import completes (via XMPP notification).
+     *
+     * @param companyRef - Company owning the users.
+     * @param users - Users to update. Each must have a `loginEmail`.
+     * @param tags - Tag list to assign (up to 5). Pass an empty array to clear all tags.
+     */
+    bulkSetTags: (companyRef: string | Company, users: Pick<User, "loginEmail">[], tags: string[]) => Promise<void>;
+    /**
+     * Deletes a set of users via mass provisioning.
+     * Resolves when the import completes (via XMPP notification).
+     *
+     * @param companyRef - Company owning the users.
+     * @param users - Users to delete. Each must have a `loginEmail`.
+     */
+    bulkDelete: (companyRef: string | Company, users: Pick<User, "loginEmail">[]) => Promise<void>;
+}
+declare const SDKAdminUserServiceRB_base: object & (abstract new (...args: any[]) => import("../../services/service").EventsMixinTemplate<AdminUserServiceEvents>);
+/**
+ * @internal
+ */
+export declare class SDKAdminUserServiceRB extends SDKAdminUserServiceRB_base implements SDKAdminUserService {
+    private readonly authService;
+    private readonly loggerService;
+    private readonly errorHelperService;
+    private readonly adminCompanyService;
+    private readonly contactService;
+    private readonly xmppService;
+    private xmppManagementHandler;
+    private readonly pendingImports;
+    stop(): void;
+    constructor(authService: AuthService, loggerService: LoggerService, errorHelperService: ErrorHelperService, adminCompanyService: SDKAdminCompanyService, contactService: ContactService);
+    start(): void;
+    private onManagementMessage;
+    getAll(companyRef: string | Company, detailsLevel?: string, filters?: Array<{
+        key: string;
+        value: string;
+    }>): Promise<unknown[]>;
+    create(login: string, firstName: string, lastName: string, password: string, companyRef: string | Company, tags?: string[]): Promise<unknown>;
+    cancelDelete(userId: string): Promise<unknown>;
+    forceDelete(userId: string): Promise<unknown>;
+    remove(userId: string, pendingDelete?: boolean): Promise<void>;
+    search(companyRef: string | Company, page: number, pageSize: number, searchPattern?: string, options?: UserSearchOptions): Promise<UserSearchResult>;
+    update(user: AdminUserUpdatePayload): Promise<void>;
+    fetchAllUsers(companyRef: string | Company, searchPattern?: string, options?: UserSearchOptions): Promise<User[]>;
+    exportDeletedUsers(companyRef: string | Company): Promise<Blob>;
+    /**
+     * Builds a lightweight User-compatible object from raw server JSON for listing purposes.
+     * Avoids the cost of instantiating a full Contact (updateFromUserData, computeDisplayName, updateAvatar).
+     * Only includes fields needed for the admin user table.
+     */
+    private parseUserForListing;
+    private buildInitialsAvatar;
+    /**
+     * Assigns tags to a set of users via mass provisioning.
+     * Replaces all existing tags on each user with the provided list.
+     *
+     * @param companyRef - Company owning the users.
+     * @param users - Users to update. Each must have a `loginEmail`.
+     * @param tags - Tag list to assign (up to 5). Pass an empty array to clear all tags.
+     */
+    bulkSetTags(companyRef: string | Company, users: Pick<User, "loginEmail">[], tags: string[]): Promise<void>;
+    /**
+     * Deletes a set of users via mass provisioning.
+     *
+     * @param companyRef - Company owning the users.
+     * @param users - Users to delete. Each must have a `loginEmail`.
+     */
+    bulkDelete(companyRef: string | Company, users: Pick<User, "loginEmail">[]): Promise<void>;
+    private massProvision;
+    setTags(userId: string, tags: string[]): Promise<void>;
+}
+export {};
+//# sourceMappingURL=admin-user.service.d.ts.map

package/lib/services/admin/admin-user.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"admin-user.service.d.ts","sourceRoot":"","sources":["../../../src/services/admin/admin-user.service.ts"],"names":[],"mappings":"AACA;;GAEG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AACvC,OAAO,KAAK,EAAE,IAAI,EAAE,WAAW,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACjG,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAE/C,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,uCAAuC,CAAC;AAElF,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,2DAA2D,CAAC;AACxG,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oDAAoD,CAAC;AAIzF;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B,2DAA2D;IAC3D,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,gDAAgD;IAChD,KAAK,EAAE,MAAM,CAAC;IACd,iDAAiD;IACjD,KAAK,EAAE,MAAM,CAAC;IACd,kCAAkC;IAClC,MAAM,EAAE,MAAM,CAAC;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACnC,4DAA4D;IAC5D,mBAAmB,EAAE;QAAE,IAAI,EAAE,IAAI,CAAC;KAAE,CAAC;IACrC,oFAAoF;IACpF,qBAAqB,EAAE;QAAE,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG;YAAE,IAAI,EAAE,MAAM,CAAC;SAAE,CAAC;KAAE,CAAC;IACpE,yEAAyE;IACzE,qBAAqB,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,aAAa,CAAC,EAAE,OAAO,CAAC;KAAE,CAAC;IACpE,wFAAwF;IACxF,2BAA2B,EAAE;QAAE,WAAW,EAAE,MAAM,EAAE,CAAC;KAAE,CAAC;IACxD,+CAA+C;IAC/C,gCAAgC,EAAE;QAAE,KAAK,EAAE,KAAK,CAAC;YAAE,UAAU,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,EAAE,CAAC;SAAE,CAAC,CAAC;KAAE,CAAC;CAChG;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAC9B,qEAAqE;IACrE,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,0BAA0B;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mDAAmD;IACnD,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,iCAAiC;IACjC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,6EAA6E;IAC7E,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,+CAA+C;IAC/C,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,2EAA2E;IAC3E,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,wDAAwD;IACxD,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,sEAAsE;IACtE,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,wEAAwE;IACxE,yBAAyB,CAAC,EAAE,OAAO,CAAC;IACpC,sDAAsD;IACtD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,sBAAsB;IACnC,6EAA6E;IAC7E,EAAE,EAAE,MAAM,CAAC;IACX;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;KAAE,GAAG,IAAI,CAAC;IACtC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB;;;;OAIG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,wEAAwE;IACxE,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,2BAA2B,CAAC,EAAE,MAAM,CAAC;IACrC,cAAc,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,mBAAmB;IAChC,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC,SAAS,MAAM,sBAAsB,GAAG,MAAM,EAAE,GAAG,KAAK,EAAE,CAAC,EAAE,KAAK,UAAU,CAAC,oBAAoB,CAAC,IAAI,CAAC,sBAAsB,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAEpJ,KAAK,EAAE,MAAM,IAAI,CAAC;IAElB,iFAAiF;IACjF,IAAI,EAAE,MAAM,IAAI,CAAC;IAEjB;;;;;;;;OAQG;IACH,MAAM,EAAE,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,EAAE,YAAY,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,KAAK,CAAC;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;KAAE,CAAC,KAAK,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IAEtI;;;;;;;;;;;OAWG;IACH,MAAM,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IAElJ;;;;;;OAMG;IACH,MAAM,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnE;;;;;;OAMG;IACH,YAAY,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IAEnD;;;;;;OAMG;IACH,WAAW,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IAElD;;;;;;;;OAQG;IACH,MAAM,EAAE,CAAC,IAAI,EAAE,sBAAsB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAExD;;;;;;;;;;OAUG;IACH,MAAM,EAAE,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,iBAAiB,KAAK,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAEzJ;;;;;;;;;OASG;IACH,kBAAkB,EAAE,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpE;;;;;;;;OAQG;IACH,aAAa,EAAE,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,EAAE,aAAa,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,iBAAiB,KAAK,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IAEtH;;;;;;OAMG;IACH,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3D;;;;;;;;OAQG;IACH,WAAW,EAAE,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,IAAI,EAAE,YAAY,CAAC,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhH;;;;;;OAMG;IACH,UAAU,EAAE,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,IAAI,EAAE,YAAY,CAAC,EAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CAClG;;AAED;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,0BAAsC,YAAW,mBAAmB;IAcvG,OAAO,CAAC,QAAQ,CAAC,WAAW;IAC5B,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,QAAQ,CAAC,kBAAkB;IACnC,OAAO,CAAC,QAAQ,CAAC,mBAAmB;IACpC,OAAO,CAAC,QAAQ,CAAC,cAAc;IAjBnC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA0C;IACtE,OAAO,CAAC,qBAAqB,CAAa;IAC1C,OAAO,CAAC,QAAQ,CAAC,cAAc,CAA+E;IAEvG,IAAI,IAAI,IAAI;gBASE,WAAW,EAAE,WAAW,EACxB,aAAa,EAAE,aAAa,EAC5B,kBAAkB,EAAE,kBAAkB,EACtC,mBAAmB,EAAE,sBAAsB,EAC3C,cAAc,EAAE,cAAc;IAK5C,KAAK,IAAI,IAAI;IASpB,OAAO,CAAC,mBAAmB;IA4Bd,MAAM,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,EAAE,YAAY,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,KAAK,CAAC;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;KAAE,CAAC,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAuBjI,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAoC7I,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAiB9C,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAiB7C,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAiB9D,MAAM,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAgEpJ,MAAM,CAAC,IAAI,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAuBnD,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,EAAE,aAAa,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;IAqBjH,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAkB5E;;;;OAIG;IACH,OAAO,CAAC,mBAAmB;IAqD3B,OAAO,CAAC,mBAAmB;IA4B3B;;;;;;;OAOG;IACU,WAAW,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,IAAI,EAAE,YAAY,CAAC,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAaxH;;;;;OAKG;IACU,UAAU,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,IAAI,EAAE,YAAY,CAAC,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;YASzF,aAAa;IAuBd,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;CActE"}

package/lib/services/admin/admin.common.d.ts

@@ -0,0 +1,40 @@
+/**
+ * @module Admin
+ */
+/**
+ * Enumeration of the possible details levels in data.
+ */
+export declare enum DetailLevel {
+    /** Minimum number of fields. */
+    SMALL = "small",
+    /** Medium number of fields. */
+    MEDIUM = "medium",
+    /** All fields. */
+    FULL = "full"
+}
+/**
+ * Interface that represents a paginated list of items.
+ */
+export interface IPaginatedList<T> {
+    items: T[];
+    total: number;
+    limit?: number;
+    offset?: number;
+}
+type IfEquals<X, Y, A = X, B = never> = (<T>() => T extends X ? 1 : 2) extends (<T>() => T extends Y ? 1 : 2) ? A : B;
+/** Produces a union of a type's writable keys. */
+export type WritableKeys<T> = {
+    [P in keyof T]: IfEquals<{
+        [Q in P]: T[P];
+    }, {
+        -readonly [Q in P]: T[P];
+    }, P>;
+}[keyof T];
+/** Constructs a type containing only the writable properties of T. */
+export type Writable<T> = Pick<T, WritableKeys<T>>;
+/** Removes `readonly` from all properties of T. */
+export type Mutable<Type> = {
+    -readonly [Property in keyof Type]: Type[Property];
+};
+export {};
+//# sourceMappingURL=admin.common.d.ts.map

package/lib/services/admin/admin.common.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"admin.common.d.ts","sourceRoot":"","sources":["../../../src/services/admin/admin.common.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;GAEG;AACH,oBAAY,WAAW;IACnB,gCAAgC;IAChC,KAAK,UAAU;IACf,+BAA+B;IAC/B,MAAM,WAAW;IACjB,kBAAkB;IAClB,IAAI,SAAS;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc,CAAC,CAAC;IAC7B,KAAK,EAAE,CAAC,EAAE,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,KAAK,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAEtH,kDAAkD;AAClD,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,QAAQ,CAAC;SAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;KAAE,EAAE;QAAE,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;KAAE,EAAE,CAAC,CAAC;CAAE,CAAC,MAAM,CAAC,CAAC,CAAC;AAEzH,sEAAsE;AACtE,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;AAEnD,mDAAmD;AACnD,MAAM,MAAM,OAAO,CAAC,IAAI,IAAI;IAAE,CAAC,UAAU,QAAQ,IAAI,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC;CAAG,CAAC"}

package/lib/services/admin/admin.service.d.ts

@@ -0,0 +1,138 @@
+/**
+ * @module Admin
+ */
+import { Service } from "../../services/service";
+import type { SDKAdminCompanyService } from "../../services/admin/admin-company.service";
+import type { SDKAdminUserService } from "../../services/admin/admin-user.service";
+import type { SDKAdminDepartmentService } from "../../services/admin/admin-department.service";
+import type { SDKAdminTagService } from "../../services/admin/admin-tag.service";
+import type { SDKAdminUserProfileService } from "../../services/admin/admin-user-profile.service";
+import type { SDKAdminSubscriptionService } from "../../services/admin/admin-subscription.service";
+import type { SDKAdminAlarmService } from "../../services/admin/admin-alarm.service";
+import type { SDKAdminManagementService } from "../../services/admin/admin-management.service";
+import type { SDKAdminRvcpService } from "../../services/admin/admin-rvcp.service";
+import type { SDKAdminSiteService } from "../../services/admin/admin-site.service";
+import type { SDKAdminInvitationService } from "../../services/admin/admin-invitation.service";
+/** @internal */
+export declare const SDK_ADMIN_SVC = "SDKAdminService";
+/**
+ * Entry point for all admin-related operations.
+ *
+ * Provides access to three specialised sub-services grouped by domain:
+ * - {@link SDKAdminCompanyService} — company CRUD
+ * - {@link SDKAdminUserService} — user CRUD within a company
+ * - {@link SDKAdminDepartmentService} — department read access
+ *
+ * @example
+ * ```ts
+ * const sdk = RainbowSDK.getInstance();
+ * const version = await sdk.adminService.getServerVersion();
+ * const companies = await sdk.adminService.company.getAll();
+ * const users = await sdk.adminService.user.getAll(companyId);
+ * const tags = await sdk.adminService.tag.getAll(companyId);
+ * ```
+ */
+export interface SDKAdminService {
+    /**
+     * Sub-service for company management (get, create, remove).
+     * @see {@link SDKAdminCompanyService}
+     */
+    readonly company: SDKAdminCompanyService;
+    /**
+     * Sub-service for user management within a company (get, create, update, remove).
+     * @see {@link SDKAdminUserService}
+     */
+    readonly user: SDKAdminUserService;
+    /**
+     * Sub-service for department read access.
+     * @see {@link SDKAdminDepartmentService}
+     */
+    readonly department: SDKAdminDepartmentService;
+    /**
+     * Sub-service for user tag management (list, stats, rename, remove).
+     * @see {@link SDKAdminTagService}
+     */
+    readonly tag: SDKAdminTagService;
+    /**
+     * Sub-service for user profile customization template management.
+     * @see {@link SDKAdminUserProfileService}
+     */
+    readonly userProfile: SDKAdminUserProfileService;
+    /**
+     * Sub-service for company subscription management.
+     * @see {@link SDKAdminSubscriptionService}
+     */
+    readonly subscription: SDKAdminSubscriptionService;
+    /**
+     * Sub-service for site management.
+     * @see {@link SDKAdminSiteService}
+     */
+    readonly site: SDKAdminSiteService;
+    /**
+     * Sub-service for join-company invitation management.
+     * @see {@link SDKAdminInvitationService}
+     */
+    readonly invitation: SDKAdminInvitationService;
+    /**
+     * Sub-service for alarm counter retrieval.
+     * @see {@link SDKAdminAlarmService}
+     */
+    readonly alarm: SDKAdminAlarmService;
+    /**
+     * Sub-service for role checking and impersonation management.
+     * @see {@link SDKAdminManagementService}
+     */
+    readonly management: SDKAdminManagementService;
+    /**
+     * Sub-service for RVCP (Rainbow Voice Cloud Platform) operations.
+     * @see {@link SDKAdminRvcpService}
+     */
+    readonly rvcp: SDKAdminRvcpService;
+    /**
+     * Returns the Rainbow server version.
+     *
+     * This call also serves as an admin-access probe: it throws with a 403 error
+     * when the authenticated user does not have admin privileges.
+     *
+     * @returns The server version string (e.g. `"2.170.0"`).
+     * @throws {@link RainbowError} when the request fails or the user is not authorized.
+     */
+    getServerVersion: () => Promise<string>;
+}
+/**
+ * @internal
+ */
+export declare class SDKAdminServiceRB extends Service implements SDKAdminService {
+    private readonly authService;
+    private readonly loggerService;
+    private readonly errorHelperService;
+    private readonly xmppService;
+    private xmppHandlers;
+    readonly company: SDKAdminCompanyService;
+    readonly department: SDKAdminDepartmentService;
+    readonly tag: SDKAdminTagService;
+    readonly userProfile: SDKAdminUserProfileService;
+    readonly subscription: SDKAdminSubscriptionService;
+    readonly site: SDKAdminSiteService;
+    readonly user: SDKAdminUserService;
+    readonly invitation: SDKAdminInvitationService;
+    readonly alarm: SDKAdminAlarmService;
+    readonly management: SDKAdminManagementService;
+    readonly rvcp: SDKAdminRvcpService;
+    static getInstance(): SDKAdminServiceRB;
+    static build(): SDKAdminServiceRB;
+    protected constructor();
+    start(): Promise<void>;
+    /**
+     * Re-registers the XMPP handlers dropped by the disconnection. Deliberately does NOT go through
+     * `stop()`: the session state it clears (notably `management.company`) is only ever populated by
+     * `management.init()`, which the admin menu calls once on mount and never again — wiping it here
+     * would silently fall back to the administrator's own company for the rest of the session.
+     */
+    reconnect(): Promise<void>;
+    stop(): Promise<void>;
+    private registerXmppHandlers;
+    private onManagementMessage;
+    getServerVersion(): Promise<string>;
+}
+//# sourceMappingURL=admin.service.d.ts.map

package/lib/services/admin/admin.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"admin.service.d.ts","sourceRoot":"","sources":["../../../src/services/admin/admin.service.ts"],"names":[],"mappings":"AAEA;;GAEG;AAGH,OAAO,EAAE,OAAO,EAAE,MAAM,uCAAuC,CAAC;AAOhE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,2DAA2D,CAAC;AAExG,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,wDAAwD,CAAC;AAElG,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,8DAA8D,CAAC;AAE9G,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,uDAAuD,CAAC;AAEhG,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,gEAAgE,CAAC;AAEjH,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,gEAAgE,CAAC;AAElH,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,yDAAyD,CAAC;AAEpG,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,8DAA8D,CAAC;AAE9G,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,wDAAwD,CAAC;AAElG,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,wDAAwD,CAAC;AAElG,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,8DAA8D,CAAC;AAG9G,gBAAgB;AAChB,eAAO,MAAM,aAAa,oBAAoB,CAAC;AAE/C;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,eAAe;IAE5B;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,sBAAsB,CAAC;IAEzC;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,mBAAmB,CAAC;IAEnC;;;OAGG;IACH,QAAQ,CAAC,UAAU,EAAE,yBAAyB,CAAC;IAE/C;;;OAGG;IACH,QAAQ,CAAC,GAAG,EAAE,kBAAkB,CAAC;IAEjC;;;OAGG;IACH,QAAQ,CAAC,WAAW,EAAE,0BAA0B,CAAC;IAEjD;;;OAGG;IACH,QAAQ,CAAC,YAAY,EAAE,2BAA2B,CAAC;IAEnD;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,mBAAmB,CAAC;IAEnC;;;OAGG;IACH,QAAQ,CAAC,UAAU,EAAE,yBAAyB,CAAC;IAE/C;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,oBAAoB,CAAC;IAErC;;;OAGG;IACH,QAAQ,CAAC,UAAU,EAAE,yBAAyB,CAAC;IAE/C;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,mBAAmB,CAAC;IAEnC;;;;;;;;OAQG;IACH,gBAAgB,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;CAC3C;AAED;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,OAAQ,YAAW,eAAe;IACrE,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA0C;IACtE,OAAO,CAAC,QAAQ,CAAC,aAAa,CAA8C;IAC5E,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAwD;IAC3F,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA0C;IACtE,OAAO,CAAC,YAAY,CAAwB;IAE5C,SAAgB,OAAO,EAAE,sBAAsB,CAAC;IAChD,SAAgB,UAAU,EAAE,yBAAyB,CAAC;IACtD,SAAgB,GAAG,EAAE,kBAAkB,CAAC;IACxC,SAAgB,WAAW,EAAE,0BAA0B,CAAC;IACxD,SAAgB,YAAY,EAAE,2BAA2B,CAAC;IAC1D,SAAgB,IAAI,EAAE,mBAAmB,CAAC;IAC1C,SAAgB,IAAI,EAAE,mBAAmB,CAAC;IAC1C,SAAgB,UAAU,EAAE,yBAAyB,CAAC;IACtD,SAAgB,KAAK,EAAE,oBAAoB,CAAC;IAC5C,SAAgB,UAAU,EAAE,yBAAyB,CAAC;IACtD,SAAgB,IAAI,EAAE,mBAAmB,CAAC;WAE5B,WAAW;WACX,KAAK;IAEnB,SAAS;IAoBI,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAOnC;;;;;OAKG;IACU,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IAQ1B,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAalC,OAAO,CAAC,oBAAoB;IAa5B,OAAO,CAAC,mBAAmB;IAcd,gBAAgB,IAAI,OAAO,CAAC,MAAM,CAAC;CAenD"}

package/lib/services/admin/index.d.ts

@@ -0,0 +1,14 @@
+export * from "./admin.common";
+export * from "./admin.service";
+export * from "./admin-company.service";
+export * from "./admin-user.service";
+export * from "./admin-department.service";
+export * from "./admin-tag.service";
+export * from "./admin-user-profile.service";
+export * from "./admin-subscription.service";
+export * from "./admin-alarm.service";
+export * from "./admin-management.service";
+export * from "./admin-rvcp.service";
+export * from "./admin-site.service";
+export * from "./admin-invitation.service";
+//# sourceMappingURL=index.d.ts.map

package/lib/services/admin/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/services/admin/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,qBAAqB,CAAC;AACpC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,uBAAuB,CAAC;AACtC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,4BAA4B,CAAC"}