@iblai/data-layer 1.12.0 → 1.12.3

package/dist/src/features/core/types.d.ts

@@ -128,3 +128,42 @@ export interface RbacResourceListResponse {
     /** The raw list endpoint payload before normalization. */
     raw: unknown;
 }
+/** One row of `GET /api/core/users/accessible/`. */
+export interface AccessibleUser {
+    id: number;
+    username: string;
+    email: string;
+    name: string;
+}
+/**
+ * Sort orders `GET /api/core/users/accessible/` accepts. A `-` prefix reverses
+ * the order.
+ */
+export type AccessibleUsersSort = 'email' | 'name' | 'username' | '-email' | '-name' | '-username';
+/**
+ * Query params of `GET /api/core/users/accessible/`. A type alias rather than an
+ * interface so it keeps the implicit index signature `buildEndpointFromService`
+ * requires of its `Args`.
+ */
+export type AccessibleUsersRequest = {
+    /** Filter by email. */
+    email?: string;
+    /** Filter by username. */
+    username?: string;
+    /**
+     * RBAC action the caller must hold on a user for them to be listed, e.g.
+     * `Ibl.Mentor/Memory/read`. Defaults server-side to `Ibl.Core/Users/read`.
+     */
+    required_action?: string;
+    page?: number;
+    page_size?: number;
+    /** Defaults server-side to `name`. */
+    sort?: AccessibleUsersSort;
+};
+/** Standard DRF envelope returned by `GET /api/core/users/accessible/`. */
+export interface AccessibleUsersListResponse {
+    count: number;
+    next: string | null;
+    previous: string | null;
+    results: AccessibleUser[];
+}