@iblai/iblai-api 4.251.0-core → 4.252.0-core

package/dist/types/services/CoreService.d.ts

@@ -15,6 +15,9 @@ import type { PaginatedRbacGroupList } from '../models/PaginatedRbacGroupList';
 import type { PaginatedRbacPolicyList } from '../models/PaginatedRbacPolicyList';
 import type { PaginatedRbacRoleList } from '../models/PaginatedRbacRoleList';
 import type { PaginatedUserGroupList } from '../models/PaginatedUserGroupList';
+import type { PaginatedWatchedGroupListList } from '../models/PaginatedWatchedGroupListList';
+import type { PaginatedWatchedUserReadList } from '../models/PaginatedWatchedUserReadList';
+import type { PaginatedWatcherReadList } from '../models/PaginatedWatcherReadList';
 import type { PatchedDemographicsFieldDefinitionWrite } from '../models/PatchedDemographicsFieldDefinitionWrite';
 import type { PatchedPlatformPublicImageAsset } from '../models/PatchedPlatformPublicImageAsset';
 import type { PatchedPlatformPublicMetadata } from '../models/PatchedPlatformPublicMetadata';
@@ -23,6 +26,8 @@ import type { PatchedRbacPolicy } from '../models/PatchedRbacPolicy';
 import type { PatchedRbacRole } from '../models/PatchedRbacRole';
 import type { PatchedUserGroup } from '../models/PatchedUserGroup';
 import type { PatchedUserPlatformMetadataUpdate } from '../models/PatchedUserPlatformMetadataUpdate';
+import type { PatchedWatchedGroupUpdate } from '../models/PatchedWatchedGroupUpdate';
+import type { PatchedWatcherUpdate } from '../models/PatchedWatcherUpdate';
 import type { PermissionCheckRequest } from '../models/PermissionCheckRequest';
 import type { PlatformApiKey } from '../models/PlatformApiKey';
 import type { PlatformConfigurationList } from '../models/PlatformConfigurationList';
@@ -67,6 +72,14 @@ import type { UserProxyGetResponse } from '../models/UserProxyGetResponse';
 import type { UserProxyPostRequest } from '../models/UserProxyPostRequest';
 import type { UserProxyPostResponse } from '../models/UserProxyPostResponse';
 import type { UserSearchViewGetResponse } from '../models/UserSearchViewGetResponse';
+import type { WatchedGroupCreate } from '../models/WatchedGroupCreate';
+import type { WatchedGroupDetail } from '../models/WatchedGroupDetail';
+import type { WatchedGroupUpdate } from '../models/WatchedGroupUpdate';
+import type { WatchedUserRead } from '../models/WatchedUserRead';
+import type { WatchedUserWrite } from '../models/WatchedUserWrite';
+import type { WatcherRead } from '../models/WatcherRead';
+import type { WatcherUpdate } from '../models/WatcherUpdate';
+import type { WatcherWrite } from '../models/WatcherWrite';
 import type { WhitelistedDomain } from '../models/WhitelistedDomain';
 import type { CancelablePromise } from '../core/CancelablePromise';
 export declare class CoreService {
@@ -1638,6 +1651,357 @@ export declare class CoreService {
         query?: string;
         sort?: string;
     }): CancelablePromise<UserSearchViewGetResponse>;
+    /**
+     * List watched groups visible to the caller
+     * CRUD for WatchedGroup. Watcher mutations live on the nested /watchers/ endpoint;
+     * POST here accepts an optional `watchers` array as a create-time convenience.
+     * @returns PaginatedWatchedGroupListList
+     * @throws ApiError
+     */
+    static coreWatchedGroupsList({ limit, offset, platformKey, }: {
+        /**
+         * Number of results to return per page.
+         */
+        limit?: number;
+        /**
+         * The initial index from which to return the results.
+         */
+        offset?: number;
+        /**
+         * Service-account only: target platform key. Non-SA callers' platform is sourced from the auth token and this is ignored.
+         */
+        platformKey?: string;
+    }): CancelablePromise<PaginatedWatchedGroupListList>;
+    /**
+     * Create a watched group
+     * CRUD for WatchedGroup. Watcher mutations live on the nested /watchers/ endpoint;
+     * POST here accepts an optional `watchers` array as a create-time convenience.
+     * @returns WatchedGroupDetail
+     * @throws ApiError
+     */
+    static coreWatchedGroupsCreate({ requestBody, platformKey, watchedUserLimit, watcherLimit, }: {
+        requestBody: WatchedGroupCreate;
+        /**
+         * Service-account only: target platform key. Non-SA callers' platform is sourced from the auth token and this is ignored.
+         */
+        platformKey?: string;
+        /**
+         * Inline up to N watched users in the response (0 = none, max 100). Use the nested /watched-users/ endpoint for paginated walks.
+         */
+        watchedUserLimit?: number;
+        /**
+         * Inline up to N watchers in the response (0 = none, max 100). Use the nested /watchers/ endpoint for paginated walks.
+         */
+        watcherLimit?: number;
+    }): CancelablePromise<WatchedGroupDetail>;
+    /**
+     * Retrieve a watched group
+     * CRUD for WatchedGroup. Watcher mutations live on the nested /watchers/ endpoint;
+     * POST here accepts an optional `watchers` array as a create-time convenience.
+     * @returns WatchedGroupDetail
+     * @throws ApiError
+     */
+    static coreWatchedGroupsRetrieve({ id, platformKey, watchedUserLimit, watcherLimit, }: {
+        /**
+         * A unique integer value identifying this Watched Group.
+         */
+        id: number;
+        /**
+         * Service-account only: target platform key. Non-SA callers' platform is sourced from the auth token and this is ignored.
+         */
+        platformKey?: string;
+        /**
+         * Inline up to N watched users in the response (0 = none, max 100). Use the nested /watched-users/ endpoint for paginated walks.
+         */
+        watchedUserLimit?: number;
+        /**
+         * Inline up to N watchers in the response (0 = none, max 100). Use the nested /watchers/ endpoint for paginated walks.
+         */
+        watcherLimit?: number;
+    }): CancelablePromise<WatchedGroupDetail>;
+    /**
+     * Update a watched group's name
+     * CRUD for WatchedGroup. Watcher mutations live on the nested /watchers/ endpoint;
+     * POST here accepts an optional `watchers` array as a create-time convenience.
+     * @returns WatchedGroupDetail
+     * @throws ApiError
+     */
+    static coreWatchedGroupsUpdate({ id, platformKey, watchedUserLimit, watcherLimit, requestBody, }: {
+        /**
+         * A unique integer value identifying this Watched Group.
+         */
+        id: number;
+        /**
+         * Service-account only: target platform key. Non-SA callers' platform is sourced from the auth token and this is ignored.
+         */
+        platformKey?: string;
+        /**
+         * Inline up to N watched users in the response (0 = none, max 100). Use the nested /watched-users/ endpoint for paginated walks.
+         */
+        watchedUserLimit?: number;
+        /**
+         * Inline up to N watchers in the response (0 = none, max 100). Use the nested /watchers/ endpoint for paginated walks.
+         */
+        watcherLimit?: number;
+        requestBody?: WatchedGroupUpdate;
+    }): CancelablePromise<WatchedGroupDetail>;
+    /**
+     * Partially update a watched group's name
+     * CRUD for WatchedGroup. Watcher mutations live on the nested /watchers/ endpoint;
+     * POST here accepts an optional `watchers` array as a create-time convenience.
+     * @returns WatchedGroupDetail
+     * @throws ApiError
+     */
+    static coreWatchedGroupsPartialUpdate({ id, platformKey, watchedUserLimit, watcherLimit, requestBody, }: {
+        /**
+         * A unique integer value identifying this Watched Group.
+         */
+        id: number;
+        /**
+         * Service-account only: target platform key. Non-SA callers' platform is sourced from the auth token and this is ignored.
+         */
+        platformKey?: string;
+        /**
+         * Inline up to N watched users in the response (0 = none, max 100). Use the nested /watched-users/ endpoint for paginated walks.
+         */
+        watchedUserLimit?: number;
+        /**
+         * Inline up to N watchers in the response (0 = none, max 100). Use the nested /watchers/ endpoint for paginated walks.
+         */
+        watcherLimit?: number;
+        requestBody?: PatchedWatchedGroupUpdate;
+    }): CancelablePromise<WatchedGroupDetail>;
+    /**
+     * Delete a watched group
+     * CRUD for WatchedGroup. Watcher mutations live on the nested /watchers/ endpoint;
+     * POST here accepts an optional `watchers` array as a create-time convenience.
+     * @returns void
+     * @throws ApiError
+     */
+    static coreWatchedGroupsDestroy({ id, platformKey, }: {
+        /**
+         * A unique integer value identifying this Watched Group.
+         */
+        id: number;
+        /**
+         * Service-account only: target platform key. Non-SA callers' platform is sourced from the auth token and this is ignored.
+         */
+        platformKey?: string;
+    }): CancelablePromise<void>;
+    /**
+     * List watched users in a watched group (paginated)
+     * CRUD-minus-update for watched users (UserGroupLink rows) under a WatchedGroup.
+     *
+     * Resource path: /platforms/{pk}/watchedgroups/{wg_id}/watchedusers/{link_id}/
+     * No PATCH/PUT — there's nothing meaningful to update on a UserGroupLink for
+     * this feature. Add via POST, remove via DELETE.
+     * @returns PaginatedWatchedUserReadList
+     * @throws ApiError
+     */
+    static coreWatchedGroupsWatchedUsersList({ watchedGroupPk, limit, offset, platformKey, }: {
+        watchedGroupPk: number;
+        /**
+         * Number of results to return per page.
+         */
+        limit?: number;
+        /**
+         * The initial index from which to return the results.
+         */
+        offset?: number;
+        /**
+         * Service-account only: target platform key. Non-SA callers' platform is sourced from the auth token and this is ignored.
+         */
+        platformKey?: string;
+    }): CancelablePromise<PaginatedWatchedUserReadList>;
+    /**
+     * Add a user to the watched group
+     * CRUD-minus-update for watched users (UserGroupLink rows) under a WatchedGroup.
+     *
+     * Resource path: /platforms/{pk}/watchedgroups/{wg_id}/watchedusers/{link_id}/
+     * No PATCH/PUT — there's nothing meaningful to update on a UserGroupLink for
+     * this feature. Add via POST, remove via DELETE.
+     * @returns WatchedUserRead
+     * @throws ApiError
+     */
+    static coreWatchedGroupsWatchedUsersCreate({ watchedGroupPk, requestBody, platformKey, }: {
+        watchedGroupPk: number;
+        requestBody: WatchedUserWrite;
+        /**
+         * Service-account only: target platform key. Non-SA callers' platform is sourced from the auth token and this is ignored.
+         */
+        platformKey?: string;
+    }): CancelablePromise<WatchedUserRead>;
+    /**
+     * Retrieve a single watched-user link
+     * CRUD-minus-update for watched users (UserGroupLink rows) under a WatchedGroup.
+     *
+     * Resource path: /platforms/{pk}/watchedgroups/{wg_id}/watchedusers/{link_id}/
+     * No PATCH/PUT — there's nothing meaningful to update on a UserGroupLink for
+     * this feature. Add via POST, remove via DELETE.
+     * @returns WatchedUserRead
+     * @throws ApiError
+     */
+    static coreWatchedGroupsWatchedUsersRetrieve({ id, watchedGroupPk, platformKey, }: {
+        id: number;
+        watchedGroupPk: number;
+        /**
+         * Service-account only: target platform key. Non-SA callers' platform is sourced from the auth token and this is ignored.
+         */
+        platformKey?: string;
+    }): CancelablePromise<WatchedUserRead>;
+    /**
+     * Remove a user from the watched group
+     * CRUD-minus-update for watched users (UserGroupLink rows) under a WatchedGroup.
+     *
+     * Resource path: /platforms/{pk}/watchedgroups/{wg_id}/watchedusers/{link_id}/
+     * No PATCH/PUT — there's nothing meaningful to update on a UserGroupLink for
+     * this feature. Add via POST, remove via DELETE.
+     * @returns void
+     * @throws ApiError
+     */
+    static coreWatchedGroupsWatchedUsersDestroy({ id, watchedGroupPk, platformKey, }: {
+        id: number;
+        watchedGroupPk: number;
+        /**
+         * Service-account only: target platform key. Non-SA callers' platform is sourced from the auth token and this is ignored.
+         */
+        platformKey?: string;
+    }): CancelablePromise<void>;
+    /**
+     * List watchers of a watched group (paginated)
+     * CRUD for watchers nested under a WatchedGroup.
+     *
+     * Resource path: /platforms/{pk}/watchedgroups/{wg_id}/watchers/{watcher_id}/
+     * `is_owner` here covers two cases that both deserve owner-level perms on a
+     * watcher row:
+     * - the watcher themselves (WATCHER_OWNER well-known role)
+     * - the parent WatchedGroup's owner (WATCHED_GROUP_OWNER role grants
+     * `Ibl.Core/Watchers*`)
+     * @returns PaginatedWatcherReadList
+     * @throws ApiError
+     */
+    static coreWatchedGroupsWatchersList({ watchedGroupPk, limit, offset, platformKey, }: {
+        watchedGroupPk: number;
+        /**
+         * Number of results to return per page.
+         */
+        limit?: number;
+        /**
+         * The initial index from which to return the results.
+         */
+        offset?: number;
+        /**
+         * Service-account only: target platform key. Non-SA callers' platform is sourced from the auth token and this is ignored.
+         */
+        platformKey?: string;
+    }): CancelablePromise<PaginatedWatcherReadList>;
+    /**
+     * Add a watcher to a watched group
+     * CRUD for watchers nested under a WatchedGroup.
+     *
+     * Resource path: /platforms/{pk}/watchedgroups/{wg_id}/watchers/{watcher_id}/
+     * `is_owner` here covers two cases that both deserve owner-level perms on a
+     * watcher row:
+     * - the watcher themselves (WATCHER_OWNER well-known role)
+     * - the parent WatchedGroup's owner (WATCHED_GROUP_OWNER role grants
+     * `Ibl.Core/Watchers*`)
+     * @returns WatcherRead
+     * @throws ApiError
+     */
+    static coreWatchedGroupsWatchersCreate({ watchedGroupPk, requestBody, platformKey, }: {
+        watchedGroupPk: number;
+        requestBody: WatcherWrite;
+        /**
+         * Service-account only: target platform key. Non-SA callers' platform is sourced from the auth token and this is ignored.
+         */
+        platformKey?: string;
+    }): CancelablePromise<WatcherRead>;
+    /**
+     * Retrieve a single watcher
+     * CRUD for watchers nested under a WatchedGroup.
+     *
+     * Resource path: /platforms/{pk}/watchedgroups/{wg_id}/watchers/{watcher_id}/
+     * `is_owner` here covers two cases that both deserve owner-level perms on a
+     * watcher row:
+     * - the watcher themselves (WATCHER_OWNER well-known role)
+     * - the parent WatchedGroup's owner (WATCHED_GROUP_OWNER role grants
+     * `Ibl.Core/Watchers*`)
+     * @returns WatcherRead
+     * @throws ApiError
+     */
+    static coreWatchedGroupsWatchersRetrieve({ id, watchedGroupPk, platformKey, }: {
+        id: number;
+        watchedGroupPk: number;
+        /**
+         * Service-account only: target platform key. Non-SA callers' platform is sourced from the auth token and this is ignored.
+         */
+        platformKey?: string;
+    }): CancelablePromise<WatcherRead>;
+    /**
+     * Replace a watcher's events
+     * CRUD for watchers nested under a WatchedGroup.
+     *
+     * Resource path: /platforms/{pk}/watchedgroups/{wg_id}/watchers/{watcher_id}/
+     * `is_owner` here covers two cases that both deserve owner-level perms on a
+     * watcher row:
+     * - the watcher themselves (WATCHER_OWNER well-known role)
+     * - the parent WatchedGroup's owner (WATCHED_GROUP_OWNER role grants
+     * `Ibl.Core/Watchers*`)
+     * @returns WatcherRead
+     * @throws ApiError
+     */
+    static coreWatchedGroupsWatchersUpdate({ id, watchedGroupPk, requestBody, platformKey, }: {
+        id: number;
+        watchedGroupPk: number;
+        requestBody: WatcherUpdate;
+        /**
+         * Service-account only: target platform key. Non-SA callers' platform is sourced from the auth token and this is ignored.
+         */
+        platformKey?: string;
+    }): CancelablePromise<WatcherRead>;
+    /**
+     * Update a watcher's events
+     * CRUD for watchers nested under a WatchedGroup.
+     *
+     * Resource path: /platforms/{pk}/watchedgroups/{wg_id}/watchers/{watcher_id}/
+     * `is_owner` here covers two cases that both deserve owner-level perms on a
+     * watcher row:
+     * - the watcher themselves (WATCHER_OWNER well-known role)
+     * - the parent WatchedGroup's owner (WATCHED_GROUP_OWNER role grants
+     * `Ibl.Core/Watchers*`)
+     * @returns WatcherRead
+     * @throws ApiError
+     */
+    static coreWatchedGroupsWatchersPartialUpdate({ id, watchedGroupPk, platformKey, requestBody, }: {
+        id: number;
+        watchedGroupPk: number;
+        /**
+         * Service-account only: target platform key. Non-SA callers' platform is sourced from the auth token and this is ignored.
+         */
+        platformKey?: string;
+        requestBody?: PatchedWatcherUpdate;
+    }): CancelablePromise<WatcherRead>;
+    /**
+     * Remove (or unsubscribe) a watcher from a watched group
+     * CRUD for watchers nested under a WatchedGroup.
+     *
+     * Resource path: /platforms/{pk}/watchedgroups/{wg_id}/watchers/{watcher_id}/
+     * `is_owner` here covers two cases that both deserve owner-level perms on a
+     * watcher row:
+     * - the watcher themselves (WATCHER_OWNER well-known role)
+     * - the parent WatchedGroup's owner (WATCHED_GROUP_OWNER role grants
+     * `Ibl.Core/Watchers*`)
+     * @returns void
+     * @throws ApiError
+     */
+    static coreWatchedGroupsWatchersDestroy({ id, watchedGroupPk, platformKey, }: {
+        id: number;
+        watchedGroupPk: number;
+        /**
+         * Service-account only: target platform key. Non-SA callers' platform is sourced from the auth token and this is ignored.
+         */
+        platformKey?: string;
+    }): CancelablePromise<void>;
     /**
      * Get a list of departments with metrics and filtering options.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iblai/iblai-api",
-  "version": "4.251.0-core",
+  "version": "4.252.0-core",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",
   "type": "module",