@rossum/api-client 0.1.20 → 0.1.22

package/types/src/users/endpoints/index.d.ts

@@ -1,8 +1,507 @@
 export declare const users: {
-    delete: (userId: number) => import("../../utils/requestConfig").ElisRequestConfig<unknown, never, never>;
-    create: (payload: import("./create").CreateUserPayload) => import("../../utils/requestConfig").ElisRequestConfig<import("../models").User, never, import("./create").CreateUserPayload>;
-    patch: (userId: number, payload: Partial<import("../models").User>) => import("../../utils/requestConfig").ElisRequestConfig<import("../models").User, never, Partial<import("../models").User>>;
-    list: (query?: import("./list").UsersListQuery) => import("../../utils/requestConfig").ElisRequestConfig<import("../../utils/listResponse").ListResponse<import("../models").User>, import("./list").UsersListQuery, never>;
-    resetPassword: (payload: import("./resetPassword").ResetPayload) => import("../../utils/requestConfig").ElisRequestConfig<import("../models/resetPassword").ResetPassword, never, import("./resetPassword").ResetPayload>;
-    get: (userId: string) => import("../../utils/requestConfig").ElisRequestConfig<import("../models").User, never, never>;
+    delete: (userId: number) => {
+        readonly endpoint: `/users/${number}`;
+        readonly method: "DELETE";
+        readonly responseSchema: import("zod").ZodUnknown;
+    };
+    create: (payload: import("./create").CreateUserPayload) => {
+        readonly endpoint: "/users";
+        readonly method: "POST";
+        readonly responseSchema: import("zod").ZodObject<{
+            id: import("zod").ZodNumber;
+            url: import("zod").ZodString;
+            firstName: import("zod").ZodOptional<import("zod").ZodString>;
+            lastName: import("zod").ZodString;
+            email: import("zod").ZodOptional<import("zod").ZodString>;
+            emailVerified: import("zod").ZodBoolean;
+            dateJoined: import("zod").ZodString;
+            username: import("zod").ZodString;
+            groups: import("zod").ZodArray<import("zod").ZodString, "many">;
+            organization: import("zod").ZodString;
+            queues: import("zod").ZodArray<import("zod").ZodString, "many">;
+            isActive: import("zod").ZodBoolean;
+            lastLogin: import("zod").ZodNullable<import("zod").ZodString>;
+            uiSettings: import("zod").ZodOptional<import("zod").ZodUnknown>;
+            metadata: import("zod").ZodOptional<import("zod").ZodUnknown>;
+            oidcId: import("zod").ZodNullable<import("zod").ZodOptional<import("zod").ZodString>>;
+            authType: import("zod").ZodUnion<[import("zod").ZodLiteral<"password">, import("zod").ZodLiteral<"sso">]>;
+            deleted: import("zod").ZodBoolean;
+            phoneNumber: import("zod").ZodNullable<import("zod").ZodString>;
+        }, "strip", import("zod").ZodTypeAny, {
+            deleted: boolean;
+            url: string;
+            id: number;
+            organization: string;
+            lastName: string;
+            emailVerified: boolean;
+            dateJoined: string;
+            username: string;
+            groups: string[];
+            queues: string[];
+            isActive: boolean;
+            lastLogin: string | null;
+            authType: "password" | "sso";
+            phoneNumber: string | null;
+            firstName?: string | undefined;
+            email?: string | undefined;
+            uiSettings?: unknown;
+            metadata?: unknown;
+            oidcId?: string | null | undefined;
+        }, {
+            deleted: boolean;
+            url: string;
+            id: number;
+            organization: string;
+            lastName: string;
+            emailVerified: boolean;
+            dateJoined: string;
+            username: string;
+            groups: string[];
+            queues: string[];
+            isActive: boolean;
+            lastLogin: string | null;
+            authType: "password" | "sso";
+            phoneNumber: string | null;
+            firstName?: string | undefined;
+            email?: string | undefined;
+            uiSettings?: unknown;
+            metadata?: unknown;
+            oidcId?: string | null | undefined;
+        }>;
+        readonly payloadSchema: import("zod").ZodObject<{
+            authType: import("zod").ZodString;
+            email: import("zod").ZodOptional<import("zod").ZodString>;
+            groups: import("zod").ZodArray<import("zod").ZodString, "many">;
+            queues: import("zod").ZodArray<import("zod").ZodString, "many">;
+            username: import("zod").ZodString;
+            firstName: import("zod").ZodOptional<import("zod").ZodString>;
+            lastName: import("zod").ZodOptional<import("zod").ZodString>;
+            organization: import("zod").ZodOptional<import("zod").ZodString>;
+            password: import("zod").ZodOptional<import("zod").ZodString>;
+            url: import("zod").ZodOptional<import("zod").ZodString>;
+            uiSettings: import("zod").ZodOptional<import("zod").ZodUnknown>;
+        }, "strip", import("zod").ZodTypeAny, {
+            username: string;
+            groups: string[];
+            queues: string[];
+            authType: string;
+            email?: string | undefined;
+            firstName?: string | undefined;
+            lastName?: string | undefined;
+            organization?: string | undefined;
+            password?: string | undefined;
+            url?: string | undefined;
+            uiSettings?: unknown;
+        }, {
+            username: string;
+            groups: string[];
+            queues: string[];
+            authType: string;
+            email?: string | undefined;
+            firstName?: string | undefined;
+            lastName?: string | undefined;
+            organization?: string | undefined;
+            password?: string | undefined;
+            url?: string | undefined;
+            uiSettings?: unknown;
+        }>;
+        readonly payload: import("./create").CreateUserPayload;
+    };
+    patch: (userId: number, payload: Partial<import("../models").User>) => {
+        readonly endpoint: `/users/${number}`;
+        readonly method: "PATCH";
+        readonly responseSchema: import("zod").ZodObject<{
+            id: import("zod").ZodNumber;
+            url: import("zod").ZodString;
+            firstName: import("zod").ZodOptional<import("zod").ZodString>;
+            lastName: import("zod").ZodString;
+            email: import("zod").ZodOptional<import("zod").ZodString>;
+            emailVerified: import("zod").ZodBoolean;
+            dateJoined: import("zod").ZodString;
+            username: import("zod").ZodString;
+            groups: import("zod").ZodArray<import("zod").ZodString, "many">;
+            organization: import("zod").ZodString;
+            queues: import("zod").ZodArray<import("zod").ZodString, "many">;
+            isActive: import("zod").ZodBoolean;
+            lastLogin: import("zod").ZodNullable<import("zod").ZodString>;
+            uiSettings: import("zod").ZodOptional<import("zod").ZodUnknown>;
+            metadata: import("zod").ZodOptional<import("zod").ZodUnknown>;
+            oidcId: import("zod").ZodNullable<import("zod").ZodOptional<import("zod").ZodString>>;
+            authType: import("zod").ZodUnion<[import("zod").ZodLiteral<"password">, import("zod").ZodLiteral<"sso">]>;
+            deleted: import("zod").ZodBoolean;
+            phoneNumber: import("zod").ZodNullable<import("zod").ZodString>;
+        }, "strip", import("zod").ZodTypeAny, {
+            deleted: boolean;
+            url: string;
+            id: number;
+            organization: string;
+            lastName: string;
+            emailVerified: boolean;
+            dateJoined: string;
+            username: string;
+            groups: string[];
+            queues: string[];
+            isActive: boolean;
+            lastLogin: string | null;
+            authType: "password" | "sso";
+            phoneNumber: string | null;
+            firstName?: string | undefined;
+            email?: string | undefined;
+            uiSettings?: unknown;
+            metadata?: unknown;
+            oidcId?: string | null | undefined;
+        }, {
+            deleted: boolean;
+            url: string;
+            id: number;
+            organization: string;
+            lastName: string;
+            emailVerified: boolean;
+            dateJoined: string;
+            username: string;
+            groups: string[];
+            queues: string[];
+            isActive: boolean;
+            lastLogin: string | null;
+            authType: "password" | "sso";
+            phoneNumber: string | null;
+            firstName?: string | undefined;
+            email?: string | undefined;
+            uiSettings?: unknown;
+            metadata?: unknown;
+            oidcId?: string | null | undefined;
+        }>;
+        readonly payloadSchema: import("zod").ZodObject<{
+            id: import("zod").ZodOptional<import("zod").ZodNumber>;
+            url: import("zod").ZodOptional<import("zod").ZodString>;
+            firstName: import("zod").ZodOptional<import("zod").ZodOptional<import("zod").ZodString>>;
+            lastName: import("zod").ZodOptional<import("zod").ZodString>;
+            email: import("zod").ZodOptional<import("zod").ZodOptional<import("zod").ZodString>>;
+            emailVerified: import("zod").ZodOptional<import("zod").ZodBoolean>;
+            dateJoined: import("zod").ZodOptional<import("zod").ZodString>;
+            username: import("zod").ZodOptional<import("zod").ZodString>;
+            groups: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
+            organization: import("zod").ZodOptional<import("zod").ZodString>;
+            queues: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
+            isActive: import("zod").ZodOptional<import("zod").ZodBoolean>;
+            lastLogin: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodString>>;
+            uiSettings: import("zod").ZodOptional<import("zod").ZodOptional<import("zod").ZodUnknown>>;
+            metadata: import("zod").ZodOptional<import("zod").ZodOptional<import("zod").ZodUnknown>>;
+            oidcId: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodOptional<import("zod").ZodString>>>;
+            authType: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodLiteral<"password">, import("zod").ZodLiteral<"sso">]>>;
+            deleted: import("zod").ZodOptional<import("zod").ZodBoolean>;
+            phoneNumber: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodString>>;
+        }, "strip", import("zod").ZodTypeAny, {
+            id?: number | undefined;
+            url?: string | undefined;
+            firstName?: string | undefined;
+            lastName?: string | undefined;
+            email?: string | undefined;
+            emailVerified?: boolean | undefined;
+            dateJoined?: string | undefined;
+            username?: string | undefined;
+            groups?: string[] | undefined;
+            organization?: string | undefined;
+            queues?: string[] | undefined;
+            isActive?: boolean | undefined;
+            lastLogin?: string | null | undefined;
+            uiSettings?: unknown;
+            metadata?: unknown;
+            oidcId?: string | null | undefined;
+            authType?: "password" | "sso" | undefined;
+            deleted?: boolean | undefined;
+            phoneNumber?: string | null | undefined;
+        }, {
+            id?: number | undefined;
+            url?: string | undefined;
+            firstName?: string | undefined;
+            lastName?: string | undefined;
+            email?: string | undefined;
+            emailVerified?: boolean | undefined;
+            dateJoined?: string | undefined;
+            username?: string | undefined;
+            groups?: string[] | undefined;
+            organization?: string | undefined;
+            queues?: string[] | undefined;
+            isActive?: boolean | undefined;
+            lastLogin?: string | null | undefined;
+            uiSettings?: unknown;
+            metadata?: unknown;
+            oidcId?: string | null | undefined;
+            authType?: "password" | "sso" | undefined;
+            deleted?: boolean | undefined;
+            phoneNumber?: string | null | undefined;
+        }>;
+        readonly payload: Partial<import("../models").User>;
+    };
+    list: (query?: import("./list").UsersListQuery) => {
+        readonly endpoint: "/users";
+        readonly method: "GET";
+        readonly responseSchema: import("zod").ZodObject<{
+            pagination: import("zod").ZodObject<{
+                next: import("zod").ZodNullable<import("zod").ZodString>;
+                previous: import("zod").ZodNullable<import("zod").ZodString>;
+                total: import("zod").ZodNumber;
+                totalPages: import("zod").ZodNumber;
+            }, "strip", import("zod").ZodTypeAny, {
+                next: string | null;
+                previous: string | null;
+                total: number;
+                totalPages: number;
+            }, {
+                next: string | null;
+                previous: string | null;
+                total: number;
+                totalPages: number;
+            }>;
+            results: import("zod").ZodArray<import("zod").ZodObject<{
+                id: import("zod").ZodNumber;
+                url: import("zod").ZodString;
+                firstName: import("zod").ZodOptional<import("zod").ZodString>;
+                lastName: import("zod").ZodString;
+                email: import("zod").ZodOptional<import("zod").ZodString>;
+                emailVerified: import("zod").ZodBoolean;
+                dateJoined: import("zod").ZodString;
+                username: import("zod").ZodString;
+                groups: import("zod").ZodArray<import("zod").ZodString, "many">;
+                organization: import("zod").ZodString;
+                queues: import("zod").ZodArray<import("zod").ZodString, "many">;
+                isActive: import("zod").ZodBoolean;
+                lastLogin: import("zod").ZodNullable<import("zod").ZodString>;
+                uiSettings: import("zod").ZodOptional<import("zod").ZodUnknown>;
+                metadata: import("zod").ZodOptional<import("zod").ZodUnknown>;
+                oidcId: import("zod").ZodNullable<import("zod").ZodOptional<import("zod").ZodString>>;
+                authType: import("zod").ZodUnion<[import("zod").ZodLiteral<"password">, import("zod").ZodLiteral<"sso">]>;
+                deleted: import("zod").ZodBoolean;
+                phoneNumber: import("zod").ZodNullable<import("zod").ZodString>;
+            }, "strip", import("zod").ZodTypeAny, {
+                deleted: boolean;
+                url: string;
+                id: number;
+                organization: string;
+                lastName: string;
+                emailVerified: boolean;
+                dateJoined: string;
+                username: string;
+                groups: string[];
+                queues: string[];
+                isActive: boolean;
+                lastLogin: string | null;
+                authType: "password" | "sso";
+                phoneNumber: string | null;
+                firstName?: string | undefined;
+                email?: string | undefined;
+                uiSettings?: unknown;
+                metadata?: unknown;
+                oidcId?: string | null | undefined;
+            }, {
+                deleted: boolean;
+                url: string;
+                id: number;
+                organization: string;
+                lastName: string;
+                emailVerified: boolean;
+                dateJoined: string;
+                username: string;
+                groups: string[];
+                queues: string[];
+                isActive: boolean;
+                lastLogin: string | null;
+                authType: "password" | "sso";
+                phoneNumber: string | null;
+                firstName?: string | undefined;
+                email?: string | undefined;
+                uiSettings?: unknown;
+                metadata?: unknown;
+                oidcId?: string | null | undefined;
+            }>, "many">;
+        }, "strip", import("zod").ZodTypeAny, {
+            results: {
+                deleted: boolean;
+                url: string;
+                id: number;
+                organization: string;
+                lastName: string;
+                emailVerified: boolean;
+                dateJoined: string;
+                username: string;
+                groups: string[];
+                queues: string[];
+                isActive: boolean;
+                lastLogin: string | null;
+                authType: "password" | "sso";
+                phoneNumber: string | null;
+                firstName?: string | undefined;
+                email?: string | undefined;
+                uiSettings?: unknown;
+                metadata?: unknown;
+                oidcId?: string | null | undefined;
+            }[];
+            pagination: {
+                next: string | null;
+                previous: string | null;
+                total: number;
+                totalPages: number;
+            };
+        }, {
+            results: {
+                deleted: boolean;
+                url: string;
+                id: number;
+                organization: string;
+                lastName: string;
+                emailVerified: boolean;
+                dateJoined: string;
+                username: string;
+                groups: string[];
+                queues: string[];
+                isActive: boolean;
+                lastLogin: string | null;
+                authType: "password" | "sso";
+                phoneNumber: string | null;
+                firstName?: string | undefined;
+                email?: string | undefined;
+                uiSettings?: unknown;
+                metadata?: unknown;
+                oidcId?: string | null | undefined;
+            }[];
+            pagination: {
+                next: string | null;
+                previous: string | null;
+                total: number;
+                totalPages: number;
+            };
+        }>;
+        readonly query: import("./list").UsersListQuery;
+        readonly querySchema: import("zod").ZodIntersection<import("zod").ZodObject<{
+            id: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodNumber, import("zod").ZodArray<import("zod").ZodNumber, "many">]>>;
+            organization: import("zod").ZodOptional<import("zod").ZodString>;
+            username: import("zod").ZodOptional<import("zod").ZodString>;
+            firstName: import("zod").ZodOptional<import("zod").ZodString>;
+            lastName: import("zod").ZodOptional<import("zod").ZodString>;
+            email: import("zod").ZodOptional<import("zod").ZodString>;
+            isActive: import("zod").ZodOptional<import("zod").ZodBoolean>;
+            lastLogin: import("zod").ZodNullable<import("zod").ZodOptional<import("zod").ZodString>>;
+            groups: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodNumber, "many">>;
+            queues: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
+            deleted: import("zod").ZodOptional<import("zod").ZodBoolean>;
+        }, "strip", import("zod").ZodTypeAny, {
+            id?: number | number[] | undefined;
+            organization?: string | undefined;
+            username?: string | undefined;
+            firstName?: string | undefined;
+            lastName?: string | undefined;
+            email?: string | undefined;
+            isActive?: boolean | undefined;
+            lastLogin?: string | null | undefined;
+            groups?: number[] | undefined;
+            queues?: string[] | undefined;
+            deleted?: boolean | undefined;
+        }, {
+            id?: number | number[] | undefined;
+            organization?: string | undefined;
+            username?: string | undefined;
+            firstName?: string | undefined;
+            lastName?: string | undefined;
+            email?: string | undefined;
+            isActive?: boolean | undefined;
+            lastLogin?: string | null | undefined;
+            groups?: number[] | undefined;
+            queues?: string[] | undefined;
+            deleted?: boolean | undefined;
+        }>, import("zod").ZodObject<{
+            pageSize: import("zod").ZodOptional<import("zod").ZodNumber>;
+            page: import("zod").ZodOptional<import("zod").ZodNumber>;
+        }, "strip", import("zod").ZodTypeAny, {
+            pageSize?: number | undefined;
+            page?: number | undefined;
+        }, {
+            pageSize?: number | undefined;
+            page?: number | undefined;
+        }>>;
+    };
+    resetPassword: (payload: import("./resetPassword").ResetPayload) => {
+        readonly endpoint: "/auth/password/reset";
+        readonly method: "POST";
+        readonly responseSchema: import("zod").ZodObject<{
+            detail: import("zod").ZodOptional<import("zod").ZodUnknown>;
+        }, "strip", import("zod").ZodTypeAny, {
+            detail?: unknown;
+        }, {
+            detail?: unknown;
+        }>;
+        readonly payloadSchema: import("zod").ZodObject<{
+            email: import("zod").ZodString;
+        }, "strip", import("zod").ZodTypeAny, {
+            email: string;
+        }, {
+            email: string;
+        }>;
+        readonly payload: import("./resetPassword").ResetPayload;
+    };
+    get: (userId: string) => {
+        readonly endpoint: `/users/${string}`;
+        readonly method: "GET";
+        readonly responseSchema: import("zod").ZodObject<{
+            id: import("zod").ZodNumber;
+            url: import("zod").ZodString;
+            firstName: import("zod").ZodOptional<import("zod").ZodString>;
+            lastName: import("zod").ZodString;
+            email: import("zod").ZodOptional<import("zod").ZodString>;
+            emailVerified: import("zod").ZodBoolean;
+            dateJoined: import("zod").ZodString;
+            username: import("zod").ZodString;
+            groups: import("zod").ZodArray<import("zod").ZodString, "many">;
+            organization: import("zod").ZodString;
+            queues: import("zod").ZodArray<import("zod").ZodString, "many">;
+            isActive: import("zod").ZodBoolean;
+            lastLogin: import("zod").ZodNullable<import("zod").ZodString>;
+            uiSettings: import("zod").ZodOptional<import("zod").ZodUnknown>;
+            metadata: import("zod").ZodOptional<import("zod").ZodUnknown>;
+            oidcId: import("zod").ZodNullable<import("zod").ZodOptional<import("zod").ZodString>>;
+            authType: import("zod").ZodUnion<[import("zod").ZodLiteral<"password">, import("zod").ZodLiteral<"sso">]>;
+            deleted: import("zod").ZodBoolean;
+            phoneNumber: import("zod").ZodNullable<import("zod").ZodString>;
+        }, "strip", import("zod").ZodTypeAny, {
+            deleted: boolean;
+            url: string;
+            id: number;
+            organization: string;
+            lastName: string;
+            emailVerified: boolean;
+            dateJoined: string;
+            username: string;
+            groups: string[];
+            queues: string[];
+            isActive: boolean;
+            lastLogin: string | null;
+            authType: "password" | "sso";
+            phoneNumber: string | null;
+            firstName?: string | undefined;
+            email?: string | undefined;
+            uiSettings?: unknown;
+            metadata?: unknown;
+            oidcId?: string | null | undefined;
+        }, {
+            deleted: boolean;
+            url: string;
+            id: number;
+            organization: string;
+            lastName: string;
+            emailVerified: boolean;
+            dateJoined: string;
+            username: string;
+            groups: string[];
+            queues: string[];
+            isActive: boolean;
+            lastLogin: string | null;
+            authType: "password" | "sso";
+            phoneNumber: string | null;
+            firstName?: string | undefined;
+            email?: string | undefined;
+            uiSettings?: unknown;
+            metadata?: unknown;
+            oidcId?: string | null | undefined;
+        }>;
+    };
 };