@djangocfg/api 2.1.322 → 2.1.327

package/src/_api/generated/cfg_totp/types.gen.ts

@@ -0,0 +1,479 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+export type ClientOptions = {
+    baseUrl: 'http://localhost:8000' | (string & {});
+};
+
+/**
+ * Serializer for regenerating backup codes.
+ */
+export type BackupCodesRegenerateRequest = {
+    /**
+     * TOTP code for verification
+     */
+    code: string;
+};
+
+/**
+ * Response serializer for backup codes regeneration.
+ */
+export type BackupCodesRegenerateResponse = {
+    /**
+     * List of new backup codes (save these!)
+     */
+    backup_codes: Array<string>;
+    /**
+     * Warning about previous codes being invalidated
+     */
+    warning: string;
+};
+
+/**
+ * Serializer for backup codes status.
+ */
+export type BackupCodesStatus = {
+    /**
+     * Number of unused backup codes
+     */
+    remaining_count: number;
+    /**
+     * Total number of codes generated
+     */
+    total_generated: number;
+    /**
+     * Warning if running low on codes
+     */
+    warning?: string | null;
+};
+
+/**
+ * Serializer for confirming 2FA setup with first code.
+ */
+export type ConfirmSetupRequest = {
+    /**
+     * Device ID from setup response
+     */
+    device_id: string;
+    /**
+     * 6-digit TOTP code from authenticator app
+     */
+    code: string;
+};
+
+/**
+ * Response serializer for setup confirmation.
+ */
+export type ConfirmSetupResponse = {
+    message: string;
+    /**
+     * List of backup recovery codes (save these!)
+     */
+    backup_codes: Array<string>;
+    /**
+     * Warning message about backup codes
+     */
+    backup_codes_warning: string;
+};
+
+/**
+ * Serializer for listing TOTP devices.
+ */
+export type DeviceList = {
+    readonly id: string;
+    /**
+     * Device name for identification
+     */
+    readonly name: string;
+    /**
+     * Primary device used for verification
+     */
+    readonly is_primary: boolean;
+    readonly status: DeviceListStatusEnum;
+    readonly created_at: string;
+    /**
+     * When device setup was confirmed
+     */
+    readonly confirmed_at: string | null;
+    /**
+     * Last successful verification
+     */
+    readonly last_used_at: string | null;
+};
+
+/**
+ * Response serializer for device list endpoint.
+ */
+export type DeviceListResponse = {
+    devices: Array<DeviceList>;
+    has_2fa_enabled: boolean;
+};
+
+/**
+ * * `pending` - Pending Confirmation
+ * * `active` - Active
+ * * `disabled` - Disabled
+ */
+export enum DeviceListStatusEnum {
+    PENDING = 'pending',
+    ACTIVE = 'active',
+    DISABLED = 'disabled'
+}
+
+/**
+ * Serializer for completely disabling 2FA.
+ */
+export type DisableRequest = {
+    /**
+     * TOTP code for verification
+     */
+    code: string;
+};
+
+/**
+ * Serializer for starting 2FA setup.
+ */
+export type SetupRequest = {
+    /**
+     * Device name for identification (e.g., 'My iPhone')
+     */
+    device_name?: string;
+};
+
+/**
+ * Response serializer for setup initiation.
+ */
+export type SetupResponse = {
+    /**
+     * Device ID to use for confirmation
+     */
+    device_id: string;
+    /**
+     * Base32-encoded TOTP secret (for manual entry)
+     */
+    secret: string;
+    /**
+     * otpauth:// URI for QR code generation
+     */
+    provisioning_uri: string;
+    /**
+     * Base64-encoded QR code image (data URI)
+     */
+    qr_code_base64: string;
+    /**
+     * Seconds until setup expires (typically 600 = 10 minutes)
+     */
+    expires_in: number;
+};
+
+/**
+ * User data returned after 2FA verification.
+ */
+export type TotpVerifyUser = {
+    readonly id: number;
+    readonly email: string;
+    first_name?: string;
+    last_name?: string;
+    /**
+     * Get user's full name.
+     */
+    readonly full_name: string;
+    /**
+     * Get user's initials for avatar fallback.
+     */
+    readonly initials: string;
+    /**
+     * Get formatted username for display.
+     */
+    readonly display_username: string;
+    company?: string;
+    phone?: string;
+    position?: string;
+    language?: string;
+    readonly avatar: string | null;
+    /**
+     * Staff status
+     *
+     * Designates whether the user can log into this admin site.
+     */
+    readonly is_staff: boolean;
+    /**
+     * Superuser status
+     *
+     * Designates that this user has all permissions without explicitly assigning them.
+     */
+    readonly is_superuser: boolean;
+    readonly date_joined: string;
+    readonly last_login: string | null;
+    readonly unanswered_messages_count: number;
+};
+
+/**
+ * Serializer for backup code verification during login.
+ */
+export type VerifyBackupRequest = {
+    /**
+     * 2FA session ID from login response
+     */
+    session_id: string;
+    /**
+     * 8-character backup recovery code
+     */
+    backup_code: string;
+};
+
+/**
+ * Serializer for TOTP code verification during login.
+ */
+export type VerifyRequest = {
+    /**
+     * 2FA session ID from login response
+     */
+    session_id: string;
+    /**
+     * 6-digit TOTP code from authenticator app
+     */
+    code: string;
+};
+
+/**
+ * Response serializer for successful 2FA verification.
+ */
+export type VerifyResponse = {
+    message: string;
+    /**
+     * JWT access token
+     */
+    access_token: string;
+    /**
+     * JWT refresh token
+     */
+    refresh_token: string;
+    /**
+     * User profile data
+     */
+    user: TotpVerifyUser;
+    /**
+     * Number of remaining backup codes (if backup code was used)
+     */
+    remaining_backup_codes?: number;
+    /**
+     * Warning message (e.g., low backup codes)
+     */
+    warning?: string;
+};
+
+/**
+ * Response serializer for device list endpoint.
+ */
+export type DeviceListResponseWritable = {
+    devices: Array<unknown>;
+    has_2fa_enabled: boolean;
+};
+
+/**
+ * User data returned after 2FA verification.
+ */
+export type TotpVerifyUserWritable = {
+    first_name?: string;
+    last_name?: string;
+    company?: string;
+    phone?: string;
+    position?: string;
+    language?: string;
+};
+
+/**
+ * Response serializer for successful 2FA verification.
+ */
+export type VerifyResponseWritable = {
+    message: string;
+    /**
+     * JWT access token
+     */
+    access_token: string;
+    /**
+     * JWT refresh token
+     */
+    refresh_token: string;
+    /**
+     * User profile data
+     */
+    user: TotpVerifyUserWritable;
+    /**
+     * Number of remaining backup codes (if backup code was used)
+     */
+    remaining_backup_codes?: number;
+    /**
+     * Warning message (e.g., low backup codes)
+     */
+    warning?: string;
+};
+
+export type CfgTotpBackupCodesRetrieveData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/cfg/totp/backup-codes/';
+};
+
+export type CfgTotpBackupCodesRetrieveResponses = {
+    200: BackupCodesStatus;
+};
+
+export type CfgTotpBackupCodesRetrieveResponse = CfgTotpBackupCodesRetrieveResponses[keyof CfgTotpBackupCodesRetrieveResponses];
+
+export type CfgTotpBackupCodesRegenerateCreateData = {
+    body: BackupCodesRegenerateRequest;
+    path?: never;
+    query?: never;
+    url: '/cfg/totp/backup-codes/regenerate/';
+};
+
+export type CfgTotpBackupCodesRegenerateCreateErrors = {
+    /**
+     * Invalid code or 2FA not enabled
+     */
+    400: unknown;
+};
+
+export type CfgTotpBackupCodesRegenerateCreateResponses = {
+    200: BackupCodesRegenerateResponse;
+};
+
+export type CfgTotpBackupCodesRegenerateCreateResponse = CfgTotpBackupCodesRegenerateCreateResponses[keyof CfgTotpBackupCodesRegenerateCreateResponses];
+
+export type CfgTotpDevicesRetrieveData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/cfg/totp/devices/';
+};
+
+export type CfgTotpDevicesRetrieveResponses = {
+    200: DeviceListResponse;
+};
+
+export type CfgTotpDevicesRetrieveResponse = CfgTotpDevicesRetrieveResponses[keyof CfgTotpDevicesRetrieveResponses];
+
+export type CfgTotpDevicesDestroyData = {
+    body?: never;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/cfg/totp/devices/{id}/';
+};
+
+export type CfgTotpDevicesDestroyResponses = {
+    /**
+     * No response body
+     */
+    204: void;
+};
+
+export type CfgTotpDevicesDestroyResponse = CfgTotpDevicesDestroyResponses[keyof CfgTotpDevicesDestroyResponses];
+
+export type CfgTotpDisableCreateData = {
+    body: DisableRequest;
+    path?: never;
+    query?: never;
+    url: '/cfg/totp/disable/';
+};
+
+export type CfgTotpDisableCreateErrors = {
+    /**
+     * Invalid code
+     */
+    400: unknown;
+};
+
+export type CfgTotpDisableCreateResponses = {
+    /**
+     * 2FA disabled successfully
+     */
+    200: unknown;
+};
+
+export type CfgTotpSetupCreateData = {
+    body?: SetupRequest;
+    path?: never;
+    query?: never;
+    url: '/cfg/totp/setup/';
+};
+
+export type CfgTotpSetupCreateErrors = {
+    /**
+     * 2FA already enabled or invalid request
+     */
+    400: unknown;
+};
+
+export type CfgTotpSetupCreateResponses = {
+    200: SetupResponse;
+};
+
+export type CfgTotpSetupCreateResponse = CfgTotpSetupCreateResponses[keyof CfgTotpSetupCreateResponses];
+
+export type CfgTotpSetupConfirmCreateData = {
+    body: ConfirmSetupRequest;
+    path?: never;
+    query?: never;
+    url: '/cfg/totp/setup/confirm/';
+};
+
+export type CfgTotpSetupConfirmCreateErrors = {
+    /**
+     * Invalid code or setup expired
+     */
+    400: unknown;
+};
+
+export type CfgTotpSetupConfirmCreateResponses = {
+    200: ConfirmSetupResponse;
+};
+
+export type CfgTotpSetupConfirmCreateResponse = CfgTotpSetupConfirmCreateResponses[keyof CfgTotpSetupConfirmCreateResponses];
+
+export type CfgTotpVerifyCreateData = {
+    body: VerifyRequest;
+    path?: never;
+    query?: never;
+    url: '/cfg/totp/verify/';
+};
+
+export type CfgTotpVerifyCreateErrors = {
+    /**
+     * Invalid code or session
+     */
+    400: unknown;
+    /**
+     * Too many attempts
+     */
+    403: unknown;
+};
+
+export type CfgTotpVerifyCreateResponses = {
+    200: VerifyResponse;
+};
+
+export type CfgTotpVerifyCreateResponse = CfgTotpVerifyCreateResponses[keyof CfgTotpVerifyCreateResponses];
+
+export type CfgTotpVerifyBackupCreateData = {
+    body: VerifyBackupRequest;
+    path?: never;
+    query?: never;
+    url: '/cfg/totp/verify/backup/';
+};
+
+export type CfgTotpVerifyBackupCreateErrors = {
+    /**
+     * Invalid backup code or session
+     */
+    400: unknown;
+};
+
+export type CfgTotpVerifyBackupCreateResponses = {
+    200: VerifyResponse;
+};
+
+export type CfgTotpVerifyBackupCreateResponse = CfgTotpVerifyBackupCreateResponses[keyof CfgTotpVerifyBackupCreateResponses];

package/src/_api/generated/index.ts

@@ -0,0 +1,30 @@
+// AUTO-GENERATED by django_generator / ts_extras.wrapper
+// Top-level barrel — one singleton API per group, baseUrl from Next.js env.
+// DO NOT EDIT — re-run `make gen`.
+
+import { API as CfgAccountsAPI, LocalStorageAdapter as CfgAccountsStorage } from './cfg_accounts';
+import { API as CfgCentrifugoAPI, LocalStorageAdapter as CfgCentrifugoStorage } from './cfg_centrifugo';
+import { API as CfgTotpAPI, LocalStorageAdapter as CfgTotpStorage } from './cfg_totp';
+
+const isStaticBuild = process.env.NEXT_PUBLIC_STATIC_BUILD === 'true';
+const baseUrl = isStaticBuild ? '' : process.env.NEXT_PUBLIC_API_URL || '';
+
+export const cfgAccountsApi = new CfgAccountsAPI(baseUrl, { storage: new CfgAccountsStorage() });
+export const cfgCentrifugoApi = new CfgCentrifugoAPI(baseUrl, { storage: new CfgCentrifugoStorage() });
+export const cfgTotpApi = new CfgTotpAPI(baseUrl, { storage: new CfgTotpStorage() });
+
+// API wrapper classes — for users who need to construct their own
+// instance (e.g. with MemoryStorageAdapter in SSR/tests).
+export { API as CfgAccountsAPI } from './cfg_accounts';
+export { API as CfgCentrifugoAPI } from './cfg_centrifugo';
+export { API as CfgTotpAPI } from './cfg_totp';
+
+// Hey API SDK classes — one per OpenAPI tag. Lets consumers call
+// `Centrifugo.cfgCentrifugoAuthTokenRetrieve({...})` directly without
+// going through the wrapper singleton.
+export { Accounts, OAuth, UserProfile, Auth } from './cfg_accounts';
+export { Centrifugo, CentrifugoAuth } from './cfg_centrifugo';
+export { Totp, BackupCodes, TotpManagement, TotpSetup, TotpVerification } from './cfg_totp';
+
+// Shared utilities (errors, storage adapters, logger).
+export * from './_shared';

package/src/_api/index.ts

@@ -1,23 +1,5 @@
-// Singletons + BaseClient
-export { api, apiAccounts, apiTotp, apiCentrifugo, BaseClient, LocalStorageAdapter, MemoryStorageAdapter } from './BaseClient';
-
-// cfg_accounts
-export * from './generated/cfg_accounts';
-export { Schemas, Fetchers, Enums } from './generated/cfg_accounts';
-export * as CfgAccountsTypes from './generated/cfg_accounts';
-
-// cfg_centrifugo
-export { getCentrifugoAuthTokenRetrieve } from './generated/cfg_centrifugo';
-export * as CentrifugoHooks from './generated/cfg_centrifugo/_utils/hooks';
-export * as CentrifugoFetchers from './generated/cfg_centrifugo/_utils/fetchers';
-export * as CentrifugoTypes from './generated/cfg_centrifugo/_utils/schemas';
-
-// cfg_totp
-export * as TotpHooks from './generated/cfg_totp/_utils/hooks';
-export * as TotpFetchers from './generated/cfg_totp/_utils/fetchers';
-export * as TotpTypes from './generated/cfg_totp/_utils/schemas';
-
-// API Classes
-export { API as AccountsAPI } from './generated/cfg_accounts';
-export { API as TotpAPI } from './generated/cfg_totp';
-export { API as CentrifugoAPI } from './generated/cfg_centrifugo';
+// Re-export the generated barrel directly. Per-group API singletons,
+// API classes (AccountsAPI/TotpAPI/CentrifugoAPI), and shared utilities
+// (LocalStorageAdapter / MemoryStorageAdapter / APIError / ...) all come
+// from `_api/generated/index.ts`.
+export * from './generated';