@faiber/faiber-idp 0.3.0 → 0.5.0

package/dist/operations.js

@@ -1,186 +1,556 @@
 import { ServiceApi, urlEncoded } from "@faiber/sdk-core";
 export class IdpOperations extends ServiceApi {
-    /** GET /; permission: public/session-derived. */
+    /**
+     * Performs the status route operation for the router capability.
+     * Calls `GET /` through the shared IDP-aware Faiber client.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
     routerStatusRouteGet(options) {
         return this.client.request({ ...options, method: "GET", url: `/` });
     }
-    /** GET /api/openapi.json; permission: public/session-derived. */
+    /**
+     * Performs the openapi json operation for the router capability.
+     * Calls `GET /api/openapi.json` through the shared IDP-aware Faiber client.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
     routerOpenapiJsonGet(options) {
         return this.client.request({ ...options, method: "GET", url: `/api/openapi.json` });
     }
-    /** GET /api/v1/acl/permissions; permission: public/session-derived. */
+    /**
+     * Performs the permissions index operation for the acl capability.
+     * Calls `GET /api/v1/acl/permissions` through the shared IDP-aware Faiber client.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
     aclPermissionsIndexGet(options) {
         return this.client.request({ ...options, method: "GET", url: `/api/v1/acl/permissions` });
     }
-    /** GET /api/v1/acl/roles; permission: public/session-derived. */
+    /**
+     * Performs the roles index operation for the acl capability.
+     * Calls `GET /api/v1/acl/roles` through the shared IDP-aware Faiber client.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
     aclRolesIndexGet(options) {
         return this.client.request({ ...options, method: "GET", url: `/api/v1/acl/roles` });
     }
-    /** POST /api/v1/acl/roles; permission: public/session-derived. */
+    /**
+     * Performs the roles create operation for the acl capability.
+     * Calls `POST /api/v1/acl/roles` through the shared IDP-aware Faiber client.
+     * @param data Typed JSON request body.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
     aclRolesCreatePost(data, options) {
         return this.client.request({ ...options, method: "POST", url: `/api/v1/acl/roles`, data: data });
     }
-    /** DELETE /api/v1/acl/roles/{role_id}; permission: public/session-derived. */
+    /**
+     * Performs the roles delete operation for the acl capability.
+     * Calls `DELETE /api/v1/acl/roles/{role_id}` through the shared IDP-aware Faiber client.
+     * @param roleId Backend path identifier `role_id`.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
     aclRolesDeleteDelete(roleId, options) {
         return this.client.request({ ...options, method: "DELETE", url: `/api/v1/acl/roles/${encodeURIComponent(roleId)}` });
     }
-    /** GET /api/v1/acl/roles/{role_id}; permission: public/session-derived. */
+    /**
+     * Performs the roles show operation for the acl capability.
+     * Calls `GET /api/v1/acl/roles/{role_id}` through the shared IDP-aware Faiber client.
+     * @param roleId Backend path identifier `role_id`.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
     aclRolesShowGet(roleId, options) {
         return this.client.request({ ...options, method: "GET", url: `/api/v1/acl/roles/${encodeURIComponent(roleId)}` });
     }
-    /** PATCH /api/v1/acl/roles/{role_id}; permission: public/session-derived. */
+    /**
+     * Performs the roles update operation for the acl capability.
+     * Calls `PATCH /api/v1/acl/roles/{role_id}` through the shared IDP-aware Faiber client.
+     * @param roleId Backend path identifier `role_id`.
+     * @param data Typed JSON request body.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
     aclRolesUpdatePatch(roleId, data, options) {
         return this.client.request({ ...options, method: "PATCH", url: `/api/v1/acl/roles/${encodeURIComponent(roleId)}`, data: data });
     }
-    /** PUT /api/v1/acl/roles/{role_id}; permission: public/session-derived. */
+    /**
+     * Performs the roles update operation for the acl capability.
+     * Calls `PUT /api/v1/acl/roles/{role_id}` through the shared IDP-aware Faiber client.
+     * @param roleId Backend path identifier `role_id`.
+     * @param data Typed JSON request body.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
     aclRolesUpdatePut(roleId, data, options) {
         return this.client.request({ ...options, method: "PUT", url: `/api/v1/acl/roles/${encodeURIComponent(roleId)}`, data: data });
     }
-    /** POST /api/v1/auth/account-login; permission: public/session-derived. */
+    /**
+     * Performs the login account operation for the auth capability.
+     * Calls `POST /api/v1/auth/account-login` through the shared IDP-aware Faiber client.
+     * @param data Typed URL-encoded form.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
     authLoginAccountPost(data, options) {
         return this.client.request({ ...options, method: "POST", url: `/api/v1/auth/account-login`, data: urlEncoded(data), headers: { ...options?.headers, "Content-Type": "application/x-www-form-urlencoded" } });
     }
-    /** POST /api/v1/auth/generate/one-time; permission: public/session-derived. */
+    /**
+     * Performs the generate one time token route operation for the auth capability.
+     * Calls `POST /api/v1/auth/generate/one-time` through the shared IDP-aware Faiber client.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
     authGenerateOneTimeTokenRoutePost(options) {
         return this.client.request({ ...options, method: "POST", url: `/api/v1/auth/generate/one-time` });
     }
-    /** GET /api/v1/auth/identities; permission: public/session-derived. */
+    /**
+     * Performs the list linked identities operation for the auth capability.
+     * Calls `GET /api/v1/auth/identities` through the shared IDP-aware Faiber client.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
     authListLinkedIdentitiesGet(options) {
         return this.client.request({ ...options, method: "GET", url: `/api/v1/auth/identities` });
     }
-    /** POST /api/v1/auth/login; permission: public/session-derived. */
+    /**
+     * Performs the login operation for the auth capability.
+     * Calls `POST /api/v1/auth/login` through the shared IDP-aware Faiber client.
+     * @param data Typed URL-encoded form.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
     authLoginPost(data, options) {
         return this.client.request({ ...options, method: "POST", url: `/api/v1/auth/login`, data: urlEncoded(data), headers: { ...options?.headers, "Content-Type": "application/x-www-form-urlencoded" } });
     }
-    /** DELETE /api/v1/auth/oauth/{provider}; permission: public/session-derived. */
+    /**
+     * Performs the logout operation for the auth capability.
+     * Calls `GET /api/v1/auth/logout` through the shared IDP-aware Faiber client.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
+    authLogoutGet(options) {
+        return this.client.request({ ...options, method: "GET", url: `/api/v1/auth/logout` });
+    }
+    /**
+     * Performs the authorize operation for the auth capability.
+     * Calls `GET /api/v1/auth/native/authorize` through the shared IDP-aware Faiber client.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
+    authAuthorizeGet(options) {
+        return this.client.request({ ...options, method: "GET", url: `/api/v1/auth/native/authorize` });
+    }
+    /**
+     * Performs the token operation for the auth capability.
+     * Calls `POST /api/v1/auth/native/token` through the shared IDP-aware Faiber client.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
+    authTokenPost(options) {
+        return this.client.request({ ...options, method: "POST", url: `/api/v1/auth/native/token` });
+    }
+    /**
+     * Performs the oauth unlink operation for the auth capability.
+     * Calls `DELETE /api/v1/auth/oauth/{provider}` through the shared IDP-aware Faiber client.
+     * @param provider Backend path identifier `provider`.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
     authOauthUnlinkDelete(provider, options) {
         return this.client.request({ ...options, method: "DELETE", url: `/api/v1/auth/oauth/${encodeURIComponent(provider)}` });
     }
-    /** GET /api/v1/auth/oauth/{provider}; permission: public/session-derived. */
+    /**
+     * Performs the oauth start operation for the auth capability.
+     * Calls `GET /api/v1/auth/oauth/{provider}` through the shared IDP-aware Faiber client.
+     * @param provider Backend path identifier `provider`.
+     * @param params Typed query parameters; omitted members retain backend defaults.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
     authOauthStartGet(provider, params, options) {
         return this.client.request({ ...options, method: "GET", url: `/api/v1/auth/oauth/${encodeURIComponent(provider)}`, params });
     }
-    /** GET /api/v1/auth/oauth/{provider}/callback; permission: public/session-derived. */
+    /**
+     * Performs the oauth callback operation for the auth capability.
+     * Calls `GET /api/v1/auth/oauth/{provider}/callback` through the shared IDP-aware Faiber client.
+     * @param provider Backend path identifier `provider`.
+     * @param params Typed query parameters; omitted members retain backend defaults.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
     authOauthCallbackGet(provider, params, options) {
         return this.client.request({ ...options, method: "GET", url: `/api/v1/auth/oauth/${encodeURIComponent(provider)}/callback`, params });
     }
-    /** GET /api/v1/auth/oauth/providers; permission: public/session-derived. */
+    /**
+     * Performs the oauth providers operation for the auth capability.
+     * Calls `GET /api/v1/auth/oauth/providers` through the shared IDP-aware Faiber client.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
     authOauthProvidersGet(options) {
         return this.client.request({ ...options, method: "GET", url: `/api/v1/auth/oauth/providers` });
     }
-    /** POST /api/v1/auth/otp-login; permission: public/session-derived. */
+    /**
+     * Performs the otp login operation for the auth capability.
+     * Calls `POST /api/v1/auth/otp-login` through the shared IDP-aware Faiber client.
+     * @param data Typed URL-encoded form.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
     authOtpLoginPost(data, options) {
         return this.client.request({ ...options, method: "POST", url: `/api/v1/auth/otp-login`, data: urlEncoded(data), headers: { ...options?.headers, "Content-Type": "application/x-www-form-urlencoded" } });
     }
-    /** GET /api/v1/auth/refresh; permission: public/session-derived. */
+    /**
+     * Performs the refresh token operation for the auth capability.
+     * Calls `GET /api/v1/auth/refresh` through the shared IDP-aware Faiber client.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
     authRefreshTokenGet(options) {
         return this.client.request({ ...options, method: "GET", url: `/api/v1/auth/refresh` });
     }
-    /** POST /api/v1/auth/secure/generate/one-time; permission: public/session-derived. */
+    /**
+     * Performs the generate secure one time token route operation for the auth capability.
+     * Calls `POST /api/v1/auth/secure/generate/one-time` through the shared IDP-aware Faiber client.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
     authGenerateSecureOneTimeTokenRoutePost(options) {
         return this.client.request({ ...options, method: "POST", url: `/api/v1/auth/secure/generate/one-time` });
     }
-    /** GET /api/v1/auth/token-login; permission: public/session-derived. */
+    /**
+     * Performs the list sessions operation for the auth capability.
+     * Calls `GET /api/v1/auth/sessions` through the shared IDP-aware Faiber client.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
+    authListSessionsGet(options) {
+        return this.client.request({ ...options, method: "GET", url: `/api/v1/auth/sessions` });
+    }
+    /**
+     * Performs the delete session operation for the auth capability.
+     * Calls `DELETE /api/v1/auth/sessions/{session_id}` through the shared IDP-aware Faiber client.
+     * @param sessionId Backend path identifier `session_id`.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
+    authDeleteSessionDelete(sessionId, options) {
+        return this.client.request({ ...options, method: "DELETE", url: `/api/v1/auth/sessions/${encodeURIComponent(sessionId)}` });
+    }
+    /**
+     * Performs the login token operation for the auth capability.
+     * Calls `GET /api/v1/auth/token-login` through the shared IDP-aware Faiber client.
+     * @param params Typed query parameters; omitted members retain backend defaults.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
     authLoginTokenGet(params, options) {
         return this.client.request({ ...options, method: "GET", url: `/api/v1/auth/token-login`, params });
     }
-    /** GET /api/v1/auth/validate; permission: public/session-derived. */
+    /**
+     * Performs the validate operation for the auth capability.
+     * Calls `GET /api/v1/auth/validate` through the shared IDP-aware Faiber client.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
     authValidateGet(options) {
         return this.client.request({ ...options, method: "GET", url: `/api/v1/auth/validate` });
     }
-    /** GET /api/v1/auth/web-login; permission: public/session-derived. */
-    authLogoutGet(options) {
-        return this.client.request({ ...options, method: "GET", url: `/api/v1/auth/web-login` });
-    }
-    /** POST /api/v1/auth/web-login; permission: public/session-derived. */
+    /**
+     * Performs the login web operation for the auth capability.
+     * Calls `POST /api/v1/auth/web-login` through the shared IDP-aware Faiber client.
+     * @param data Typed URL-encoded form.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
     authLoginWebPost(data, options) {
         return this.client.request({ ...options, method: "POST", url: `/api/v1/auth/web-login`, data: urlEncoded(data), headers: { ...options?.headers, "Content-Type": "application/x-www-form-urlencoded" } });
     }
-    /** GET /api/v1/integration/flow; permission: public/session-derived. */
+    /**
+     * Performs the flow integration show operation for the integration capability.
+     * Calls `GET /api/v1/integration/flow` through the shared IDP-aware Faiber client.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
     integrationFlowIntegrationShowGet(options) {
         return this.client.request({ ...options, method: "GET", url: `/api/v1/integration/flow` });
     }
-    /** GET /api/v1/settings/oauth; permission: public/session-derived. */
+    /**
+     * Performs the oauth settings show operation for the settings capability.
+     * Calls `GET /api/v1/settings/oauth` through the shared IDP-aware Faiber client.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
     settingsOauthSettingsShowGet(options) {
         return this.client.request({ ...options, method: "GET", url: `/api/v1/settings/oauth` });
     }
-    /** PUT /api/v1/settings/oauth; permission: public/session-derived. */
+    /**
+     * Performs the oauth settings update operation for the settings capability.
+     * Calls `PUT /api/v1/settings/oauth` through the shared IDP-aware Faiber client.
+     * @param data Typed JSON request body.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
     settingsOauthSettingsUpdatePut(data, options) {
         return this.client.request({ ...options, method: "PUT", url: `/api/v1/settings/oauth`, data: data });
     }
-    /** GET /api/v1/users; permission: public/session-derived. */
+    /**
+     * Performs the users index operation for the user capability.
+     * Calls `GET /api/v1/users` through the shared IDP-aware Faiber client.
+     * @param params Typed query parameters; omitted members retain backend defaults.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
     userUsersIndexGet(params, options) {
         return this.client.request({ ...options, method: "GET", url: `/api/v1/users`, params });
     }
-    /** POST /api/v1/users; permission: public/session-derived. */
+    /**
+     * Performs the user create operation for the user capability.
+     * Calls `POST /api/v1/users` through the shared IDP-aware Faiber client.
+     * @param data Typed JSON request body.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
     userUserCreatePost(data, options) {
         return this.client.request({ ...options, method: "POST", url: `/api/v1/users`, data: data });
     }
-    /** DELETE /api/v1/users/{user_id}; permission: public/session-derived. */
+    /**
+     * Performs the user delete operation for the user capability.
+     * Calls `DELETE /api/v1/users/{user_id}` through the shared IDP-aware Faiber client.
+     * @param userId Backend path identifier `user_id`.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
     userUserDeleteDelete(userId, options) {
         return this.client.request({ ...options, method: "DELETE", url: `/api/v1/users/${encodeURIComponent(userId)}` });
     }
-    /** GET /api/v1/users/{user_id}; permission: public/session-derived. */
+    /**
+     * Performs the user find operation for the user capability.
+     * Calls `GET /api/v1/users/{user_id}` through the shared IDP-aware Faiber client.
+     * @param userId Backend path identifier `user_id`.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
     userUserFindGet(userId, options) {
         return this.client.request({ ...options, method: "GET", url: `/api/v1/users/${encodeURIComponent(userId)}` });
     }
-    /** PATCH /api/v1/users/{user_id}; permission: public/session-derived. */
+    /**
+     * Performs the user update operation for the user capability.
+     * Calls `PATCH /api/v1/users/{user_id}` through the shared IDP-aware Faiber client.
+     * @param userId Backend path identifier `user_id`.
+     * @param data Typed JSON request body.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
     userUserUpdatePatch(userId, data, options) {
         return this.client.request({ ...options, method: "PATCH", url: `/api/v1/users/${encodeURIComponent(userId)}`, data: data });
     }
-    /** PUT /api/v1/users/{user_id}; permission: public/session-derived. */
+    /**
+     * Performs the user update operation for the user capability.
+     * Calls `PUT /api/v1/users/{user_id}` through the shared IDP-aware Faiber client.
+     * @param userId Backend path identifier `user_id`.
+     * @param data Typed JSON request body.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
     userUserUpdatePut(userId, data, options) {
         return this.client.request({ ...options, method: "PUT", url: `/api/v1/users/${encodeURIComponent(userId)}`, data: data });
     }
-    /** PATCH /api/v1/users/{user_id}/change-password; permission: public/session-derived. */
+    /**
+     * Performs the change password operation for the user capability.
+     * Calls `PATCH /api/v1/users/{user_id}/change-password` through the shared IDP-aware Faiber client.
+     * @param userId Backend path identifier `user_id`.
+     * @param data Typed JSON request body.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
     userChangePasswordPatch(userId, data, options) {
         return this.client.request({ ...options, method: "PATCH", url: `/api/v1/users/${encodeURIComponent(userId)}/change-password`, data: data });
     }
-    /** PUT /api/v1/users/{user_id}/change-password; permission: public/session-derived. */
+    /**
+     * Performs the change password operation for the user capability.
+     * Calls `PUT /api/v1/users/{user_id}/change-password` through the shared IDP-aware Faiber client.
+     * @param userId Backend path identifier `user_id`.
+     * @param data Typed JSON request body.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
     userChangePasswordPut(userId, data, options) {
         return this.client.request({ ...options, method: "PUT", url: `/api/v1/users/${encodeURIComponent(userId)}/change-password`, data: data });
     }
-    /** PATCH /api/v1/users/{user_id}/change-roles; permission: public/session-derived. */
+    /**
+     * Performs the change roles operation for the user capability.
+     * Calls `PATCH /api/v1/users/{user_id}/change-roles` through the shared IDP-aware Faiber client.
+     * @param userId Backend path identifier `user_id`.
+     * @param data Typed JSON request body.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
     userChangeRolesPatch(userId, data, options) {
         return this.client.request({ ...options, method: "PATCH", url: `/api/v1/users/${encodeURIComponent(userId)}/change-roles`, data: data });
     }
-    /** PUT /api/v1/users/{user_id}/change-roles; permission: public/session-derived. */
+    /**
+     * Performs the change roles operation for the user capability.
+     * Calls `PUT /api/v1/users/{user_id}/change-roles` through the shared IDP-aware Faiber client.
+     * @param userId Backend path identifier `user_id`.
+     * @param data Typed JSON request body.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
     userChangeRolesPut(userId, data, options) {
         return this.client.request({ ...options, method: "PUT", url: `/api/v1/users/${encodeURIComponent(userId)}/change-roles`, data: data });
     }
-    /** GET /api/v1/users/{user_id}/logout; permission: public/session-derived. */
+    /**
+     * Performs the user logout operation for the user capability.
+     * Calls `GET /api/v1/users/{user_id}/logout` through the shared IDP-aware Faiber client.
+     * @param userId Backend path identifier `user_id`.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
     userUserLogoutGet(userId, options) {
         return this.client.request({ ...options, method: "GET", url: `/api/v1/users/${encodeURIComponent(userId)}/logout` });
     }
-    /** PATCH /api/v1/users/{user_id}/status; permission: public/session-derived. */
+    /**
+     * Performs the user set status operation for the user capability.
+     * Calls `PATCH /api/v1/users/{user_id}/status` through the shared IDP-aware Faiber client.
+     * @param userId Backend path identifier `user_id`.
+     * @param data Typed JSON request body.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
     userUserSetStatusPatch(userId, data, options) {
         return this.client.request({ ...options, method: "PATCH", url: `/api/v1/users/${encodeURIComponent(userId)}/status`, data: data });
     }
-    /** PUT /api/v1/users/{user_id}/status; permission: public/session-derived. */
+    /**
+     * Performs the user set status operation for the user capability.
+     * Calls `PUT /api/v1/users/{user_id}/status` through the shared IDP-aware Faiber client.
+     * @param userId Backend path identifier `user_id`.
+     * @param data Typed JSON request body.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
     userUserSetStatusPut(userId, data, options) {
         return this.client.request({ ...options, method: "PUT", url: `/api/v1/users/${encodeURIComponent(userId)}/status`, data: data });
     }
-    /** POST /api/v1/users/register; permission: public/session-derived. */
+    /**
+     * Performs the register operation for the user capability.
+     * Calls `POST /api/v1/users/register` through the shared IDP-aware Faiber client.
+     * @param data Typed JSON request body.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
     userRegisterPost(data, options) {
         return this.client.request({ ...options, method: "POST", url: `/api/v1/users/register`, data: data });
     }
-    /** POST /api/v1/users/register-email; permission: public/session-derived. */
+    /**
+     * Performs the register with email operation for the user capability.
+     * Calls `POST /api/v1/users/register-email` through the shared IDP-aware Faiber client.
+     * @param data Typed JSON request body.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
     userRegisterWithEmailPost(data, options) {
         return this.client.request({ ...options, method: "POST", url: `/api/v1/users/register-email`, data: data });
     }
-    /** POST /api/v1/users/register-phone; permission: public/session-derived. */
+    /**
+     * Performs the register with phone operation for the user capability.
+     * Calls `POST /api/v1/users/register-phone` through the shared IDP-aware Faiber client.
+     * @param data Typed JSON request body.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
     userRegisterWithPhonePost(data, options) {
         return this.client.request({ ...options, method: "POST", url: `/api/v1/users/register-phone`, data: data });
     }
-    /** GET /api/v1/users/self; permission: public/session-derived. */
+    /**
+     * Performs the users registration stats operation for the user capability.
+     * Calls `GET /api/v1/users/registration-stats` through the shared IDP-aware Faiber client.
+     * @param params Typed query parameters; omitted members retain backend defaults.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
+    userUsersRegistrationStatsGet(params, options) {
+        return this.client.request({ ...options, method: "GET", url: `/api/v1/users/registration-stats`, params });
+    }
+    /**
+     * Performs the user find self operation for the user capability.
+     * Calls `GET /api/v1/users/self` through the shared IDP-aware Faiber client.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
     userUserFindSelfGet(options) {
         return this.client.request({ ...options, method: "GET", url: `/api/v1/users/self` });
     }
-    /** GET /api/v1/users/stats; permission: public/session-derived. */
+    /**
+     * Performs the users stats operation for the user capability.
+     * Calls `GET /api/v1/users/stats` through the shared IDP-aware Faiber client.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
     userUsersStatsGet(options) {
         return this.client.request({ ...options, method: "GET", url: `/api/v1/users/stats` });
     }
-    /** GET /api/v1/users/sync; permission: public/session-derived. */
+    /**
+     * Performs the sync users operation for the user capability.
+     * Calls `GET /api/v1/users/sync` through the shared IDP-aware Faiber client.
+     * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
+     * @returns The complete Axios response, including the typed service envelope, status, and headers.
+     * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
+     */
     userSyncUsersGet(options) {
         return this.client.request({ ...options, method: "GET", url: `/api/v1/users/sync` });
     }