@djangocfg/api 2.1.356 → 2.1.358

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

@@ -5,17 +5,91 @@ export type ClientOptions = {
 };
 
 /**
- * Response serializer for account deletion.
+ * Serializer for API key response (masked).
  */
-export type AccountDeleteResponse = {
+export type ApiKey = {
     /**
-     * Human-readable message about the deletion
+     * Masked API key
      */
-    message: string;
+    key: string;
+    /**
+     * When the key was last regenerated
+     */
+    reissued_at: string | null;
+    /**
+     * When the key was created
+     */
+    created_at: string;
+};
+
+/**
+ * Serializer for API key regeneration response (full key shown once).
+ */
+export type ApiKeyRegenerate = {
+    /**
+     * New API key (shown only once)
+     */
+    key: string;
+    /**
+     * When the key was regenerated
+     */
+    reissued_at: string;
+};
+
+/**
+ * Serializer for API key response (masked).
+ */
+export type ApiKeyRequest = {
+    /**
+     * Masked API key
+     */
+    key: string;
+    /**
+     * When the key was last regenerated
+     */
+    reissued_at: string | null;
+    /**
+     * When the key was created
+     */
+    created_at: string;
+};
+
+/**
+ * Serializer for testing an API key.
+ */
+export type ApiKeyTestRequest = {
+    /**
+     * API key to test
+     */
+    key: string;
+};
+
+/**
+ * Serializer for API key test result.
+ */
+export type ApiKeyTestResult = {
+    /**
+     * Whether the key is valid
+     */
+    valid: boolean;
+    /**
+     * User ID if valid, null otherwise
+     */
+    user_id: string | null;
+};
+
+/**
+ * Response serializer for account deletion.
+ */
+export type AccountDeleteResponse = {
     /**
      * Whether the account was successfully deleted
      */
     success: boolean;
+    /**
+     * Human-readable message about the deletion
+     */
+    message: string;
 };
 
 /**
@@ -65,53 +139,58 @@ export type BackupCodesStatus = {
  */
 export type CentrifugoToken = {
     /**
-     * Centrifugo WebSocket URL
+     * JWT token for Centrifugo WebSocket connection
      */
-    centrifugo_url: string;
+    token: string;
     /**
-     * List of allowed channels for this user
+     * Centrifugo WebSocket URL
      */
-    channels: Array<string>;
+    centrifugo_url: string;
     /**
      * Token expiration time (ISO 8601)
      */
     expires_at: string;
     /**
-     * JWT token for Centrifugo WebSocket connection
+     * List of allowed channels for this user
      */
-    token: string;
+    channels: Array<string>;
 };
 
 /**
  * Serializer for updating user profile.
  */
 export type CfgUserUpdateRequest = {
-    company?: string;
     first_name?: string;
-    language?: string;
     last_name?: string;
+    company?: string;
     phone?: string;
     position?: string;
+    language?: string;
+    /**
+     * IANA timezone name (e.g. 'Asia/Seoul'). Auto-detected from browser via X-Timezone header.
+     */
+    timezone?: string;
 };
 
 /**
  * Serializer for confirming 2FA setup with first code.
  */
 export type ConfirmSetupRequest = {
-    /**
-     * 6-digit TOTP code from authenticator app
-     */
-    code: string;
     /**
      * 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!)
      */
@@ -120,7 +199,6 @@ export type ConfirmSetupResponse = {
      * Warning message about backup codes
      */
     backup_codes_warning: string;
-    message: string;
 };
 
 /**
@@ -130,17 +208,17 @@ export type ConfirmSetupResponse = {
  */
 export type ConnectionTokenResponse = {
     /**
-     * Centrifugo Url
+     * Token
      *
-     * Centrifugo WebSocket URL
+     * JWT token for Centrifugo connection
      */
-    centrifugo_url: string;
+    token: string;
     /**
-     * Channels
+     * Centrifugo Url
      *
-     * List of allowed channels
+     * Centrifugo WebSocket URL
      */
-    channels: Array<string>;
+    centrifugo_url: string;
     /**
      * Expires At
      *
@@ -148,36 +226,36 @@ export type ConnectionTokenResponse = {
      */
     expires_at: string;
     /**
-     * Token
+     * Channels
      *
-     * JWT token for Centrifugo connection
+     * List of allowed channels
      */
-    token: string;
+    channels: Array<string>;
 };
 
 /**
  * Serializer for listing TOTP devices.
  */
 export type DeviceList = {
+    readonly id: string;
     /**
-     * When device setup was confirmed
+     * Device name for identification
      */
-    readonly confirmed_at: string | null;
-    readonly created_at: string;
-    readonly id: string;
+    readonly name: string;
     /**
      * Primary device used for verification
      */
     readonly is_primary: boolean;
+    readonly status: DeviceStatusEnum;
+    readonly created_at: string;
     /**
-     * Last successful verification
+     * When device setup was confirmed
      */
-    readonly last_used_at: string | null;
+    readonly confirmed_at: string | null;
     /**
-     * Device name for identification
+     * Last successful verification
      */
-    readonly name: string;
-    readonly status: DeviceListStatusEnum;
+    readonly last_used_at: string | null;
 };
 
 /**
@@ -193,7 +271,7 @@ export type DeviceListResponse = {
  * * `active` - Active
  * * `disabled` - Disabled
  */
-export enum DeviceListStatusEnum {
+export enum DeviceStatusEnum {
     PENDING = 'pending',
     ACTIVE = 'active',
     DISABLED = 'disabled'
@@ -245,48 +323,48 @@ export type OAuthCallbackRequestRequest = {
      * Authorization code from OAuth provider callback
      */
     code: string;
-    /**
-     * Same redirect_uri used in authorize request. If not provided, uses config's site_url + callback_path
-     */
-    redirect_uri?: string;
     /**
      * State token for CSRF verification (from authorize response)
      */
     state: string;
+    /**
+     * Same redirect_uri used in authorize request. If not provided, uses config's site_url + callback_path
+     */
+    redirect_uri?: string;
 };
 
 /**
  * Serializer for OAuth connection info (user-facing).
  */
 export type OAuthConnection = {
-    /**
-     * When this OAuth connection was created
-     */
-    readonly connected_at: string;
     readonly id: number;
-    /**
-     * Last time this OAuth connection was used for login
-     */
-    readonly last_login_at: string;
     /**
      * OAuth provider name (github, google, etc.)
      *
      * * `github` - GitHub
      */
-    readonly provider: ProviderEnum;
+    readonly provider: OAuthProviderEnum;
+    readonly provider_display: string;
     /**
-     * Avatar URL from OAuth provider
+     * Username on the OAuth provider platform
      */
-    readonly provider_avatar_url: string;
-    readonly provider_display: string;
+    readonly provider_username: string;
     /**
      * Email from OAuth provider (may differ from user.email)
      */
     readonly provider_email: string;
     /**
-     * Username on the OAuth provider platform
+     * Avatar URL from OAuth provider
      */
-    readonly provider_username: string;
+    readonly provider_avatar_url: string;
+    /**
+     * When this OAuth connection was created
+     */
+    readonly connected_at: string;
+    /**
+     * Last time this OAuth connection was used for login
+     */
+    readonly last_login_at: string;
 };
 
 /**
@@ -298,7 +376,7 @@ export type OAuthDisconnectRequestRequest = {
      *
      * * `github` - GitHub
      */
-    provider: ProviderEnum;
+    provider: OAuthProviderEnum;
 };
 
 /**
@@ -315,6 +393,13 @@ export type OAuthError = {
     error_description?: string;
 };
 
+/**
+ * * `github` - GitHub
+ */
+export enum OAuthProviderEnum {
+    GITHUB = 'github'
+}
+
 /**
  * Response with available OAuth providers.
  */
@@ -342,39 +427,39 @@ export type OAuthProvidersResponse = {
  */
 export type OAuthTokenResponse = {
     /**
-     * JWT access token (null when requires_2fa=True)
+     * True if 2FA verification is required
      */
-    access?: string | null;
+    requires_2fa?: boolean;
     /**
-     * True if a new OAuth connection was created
+     * 2FA session ID (only when requires_2fa=True)
      */
-    is_new_connection: boolean;
+    session_id?: string | null;
     /**
-     * True if a new user was created during this OAuth flow
+     * JWT access token (null when requires_2fa=True)
      */
-    is_new_user: boolean;
+    access?: string | null;
     /**
      * JWT refresh token (null when requires_2fa=True)
      */
     refresh?: string | null;
     /**
-     * True if 2FA verification is required
+     * Authenticated user info (null when requires_2fa=True)
      */
-    requires_2fa?: boolean;
+    user?: {
+        [key: string]: unknown;
+    } | null;
     /**
-     * 2FA session ID (only when requires_2fa=True)
+     * True if a new user was created during this OAuth flow
      */
-    session_id?: string | null;
+    is_new_user: boolean;
     /**
-     * True if user should be prompted to enable 2FA
+     * True if a new OAuth connection was created
      */
-    should_prompt_2fa?: boolean;
+    is_new_connection: boolean;
     /**
-     * Authenticated user info (null when requires_2fa=True)
+     * True if user should be prompted to enable 2FA
      */
-    user?: {
-        [key: string]: unknown;
-    } | null;
+    should_prompt_2fa?: boolean;
 };
 
 /**
@@ -458,14 +543,6 @@ export type OtpVerifyRequest = {
  * - refresh/access/user: populated
  */
 export type OtpVerifyResponse = {
-    /**
-     * JWT access token (if requires_2fa is False)
-     */
-    access?: string | null;
-    /**
-     * JWT refresh token (if requires_2fa is False)
-     */
-    refresh?: string | null;
     /**
      * Whether 2FA verification is required
      */
@@ -475,34 +552,39 @@ export type OtpVerifyResponse = {
      */
     session_id?: string | null;
     /**
-     * Whether user should be prompted to enable 2FA
+     * JWT refresh token (if requires_2fa is False)
      */
-    should_prompt_2fa?: boolean;
+    refresh?: string | null;
+    /**
+     * JWT access token (if requires_2fa is False)
+     */
+    access?: string | null;
     /**
      * User information (if requires_2fa is False)
      */
     user?: User | null;
+    /**
+     * Whether user should be prompted to enable 2FA
+     */
+    should_prompt_2fa?: boolean;
 };
 
 /**
  * Serializer for updating user profile.
  */
 export type PatchedCfgUserUpdateRequest = {
-    company?: string;
     first_name?: string;
-    language?: string;
     last_name?: string;
+    company?: string;
     phone?: string;
     position?: string;
+    language?: string;
+    /**
+     * IANA timezone name (e.g. 'Asia/Seoul'). Auto-detected from browser via X-Timezone header.
+     */
+    timezone?: string;
 };
 
-/**
- * * `github` - GitHub
- */
-export enum ProviderEnum {
-    GITHUB = 'github'
-}
-
 /**
  * Serializer for starting 2FA setup.
  */
@@ -522,9 +604,9 @@ export type SetupResponse = {
      */
     device_id: string;
     /**
-     * Seconds until setup expires (typically 600 = 10 minutes)
+     * Base32-encoded TOTP secret (for manual entry)
      */
-    expires_in: number;
+    secret: string;
     /**
      * otpauth:// URI for QR code generation
      */
@@ -534,9 +616,9 @@ export type SetupResponse = {
      */
     qr_code_base64: string;
     /**
-     * Base32-encoded TOTP secret (for manual entry)
+     * Seconds until setup expires (typically 600 = 10 minutes)
      */
-    secret: string;
+    expires_in: number;
 };
 
 export type TokenRefresh = {
@@ -552,24 +634,31 @@ export type TokenRefreshRequest = {
  * User data returned after 2FA verification.
  */
 export type TotpVerifyUser = {
-    readonly avatar: string | null;
-    company?: string;
-    readonly date_joined: string;
-    /**
-     * Get formatted username for display.
-     */
-    readonly display_username: string;
+    readonly id: number;
     readonly email: string;
     first_name?: string;
+    last_name?: string;
     /**
      * Get user's full name.
      */
     readonly full_name: string;
-    readonly id: number;
     /**
      * 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;
+    /**
+     * IANA timezone name (e.g. 'Asia/Seoul'). Auto-detected from browser via X-Timezone header.
+     */
+    timezone?: string;
+    readonly avatar: string | null;
     /**
      * Staff status
      *
@@ -582,37 +671,41 @@ export type TotpVerifyUser = {
      * Designates that this user has all permissions without explicitly assigning them.
      */
     readonly is_superuser: boolean;
-    language?: string;
+    readonly date_joined: string;
     readonly last_login: string | null;
-    last_name?: string;
-    phone?: string;
-    position?: string;
     readonly unanswered_messages_count: number;
+    readonly api_key: string | null;
 };
 
 /**
  * Serializer for user details.
  */
 export type User = {
-    readonly avatar: string | null;
-    readonly centrifugo: CentrifugoToken | null;
-    company?: string;
-    readonly date_joined: string;
-    /**
-     * Get formatted username for display.
-     */
-    readonly display_username: string;
+    readonly id: number;
     readonly email: string;
     first_name?: string;
+    last_name?: string;
     /**
      * Get user's full name.
      */
     readonly full_name: string;
-    readonly id: number;
     /**
      * 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;
+    /**
+     * IANA timezone name (e.g. 'Asia/Seoul'). Auto-detected from browser via X-Timezone header.
+     */
+    timezone?: string;
+    readonly avatar: string | null;
     /**
      * Staff status
      *
@@ -625,69 +718,79 @@ export type User = {
      * Designates that this user has all permissions without explicitly assigning them.
      */
     readonly is_superuser: boolean;
-    language?: string;
+    readonly date_joined: string;
     readonly last_login: string | null;
-    last_name?: string;
-    phone?: string;
-    position?: string;
     readonly unanswered_messages_count: number;
+    readonly centrifugo: CentrifugoToken | null;
+    readonly api_key: string | null;
 };
 
 /**
  * Serializer for backup code verification during login.
  */
 export type VerifyBackupRequest = {
-    /**
-     * 8-character backup recovery code
-     */
-    backup_code: string;
     /**
      * 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 = {
-    /**
-     * 6-digit TOTP code from authenticator app
-     */
-    code: string;
     /**
      * 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;
-    message: string;
     /**
      * JWT refresh token
      */
     refresh_token: string;
-    /**
-     * Number of remaining backup codes (if backup code was used)
-     */
-    remaining_backup_codes?: number;
     /**
      * 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;
 };
 
+export type CfgAccountsOauthConnectionsResponse200AutoRef = Array<OAuthConnection>;
+
+export type CfgAccountsOauthDisconnectResponse200AutoRef = {
+    message?: string;
+};
+
+/**
+ * 2FA disabled successfully
+ */
+export type CfgTotpDisableResponse200AutoRef = unknown;
+
 /**
  * Response serializer for device list endpoint.
  */
@@ -710,14 +813,6 @@ export type DeviceListResponseWritable = {
  * - refresh/access/user: populated
  */
 export type OtpVerifyResponseWritable = {
-    /**
-     * JWT access token (if requires_2fa is False)
-     */
-    access?: string | null;
-    /**
-     * JWT refresh token (if requires_2fa is False)
-     */
-    refresh?: string | null;
     /**
      * Whether 2FA verification is required
      */
@@ -727,13 +822,21 @@ export type OtpVerifyResponseWritable = {
      */
     session_id?: string | null;
     /**
-     * Whether user should be prompted to enable 2FA
+     * JWT refresh token (if requires_2fa is False)
      */
-    should_prompt_2fa?: boolean;
+    refresh?: string | null;
+    /**
+     * JWT access token (if requires_2fa is False)
+     */
+    access?: string | null;
     /**
      * User information (if requires_2fa is False)
      */
     user?: UserWritable | null;
+    /**
+     * Whether user should be prompted to enable 2FA
+     */
+    should_prompt_2fa?: boolean;
 };
 
 export type TokenRefreshWritable = {
@@ -744,53 +847,114 @@ export type TokenRefreshWritable = {
  * User data returned after 2FA verification.
  */
 export type TotpVerifyUserWritable = {
-    company?: string;
     first_name?: string;
-    language?: string;
     last_name?: string;
+    company?: string;
     phone?: string;
     position?: string;
+    language?: string;
+    /**
+     * IANA timezone name (e.g. 'Asia/Seoul'). Auto-detected from browser via X-Timezone header.
+     */
+    timezone?: string;
 };
 
 /**
  * Serializer for user details.
  */
 export type UserWritable = {
-    company?: string;
     first_name?: string;
-    language?: string;
     last_name?: string;
+    company?: string;
     phone?: string;
     position?: string;
+    language?: string;
+    /**
+     * IANA timezone name (e.g. 'Asia/Seoul'). Auto-detected from browser via X-Timezone header.
+     */
+    timezone?: string;
 };
 
 /**
  * Response serializer for successful 2FA verification.
  */
 export type VerifyResponseWritable = {
+    message: string;
     /**
      * JWT access token
      */
     access_token: string;
-    message: string;
     /**
      * JWT refresh token
      */
     refresh_token: string;
-    /**
-     * Number of remaining backup codes (if backup code was used)
-     */
-    remaining_backup_codes?: number;
     /**
      * 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 CfgAccountsApiKeyRetrieveData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/cfg/accounts/api-key/';
+};
+
+export type CfgAccountsApiKeyRetrieveErrors = {
+    /**
+     * Authentication credentials were not provided.
+     */
+    401: unknown;
+};
+
+export type CfgAccountsApiKeyRetrieveResponses = {
+    200: ApiKey;
+};
+
+export type CfgAccountsApiKeyRetrieveResponse = CfgAccountsApiKeyRetrieveResponses[keyof CfgAccountsApiKeyRetrieveResponses];
+
+export type CfgAccountsApiKeyRegenerateCreateData = {
+    body: ApiKeyRequest;
+    path?: never;
+    query?: never;
+    url: '/cfg/accounts/api-key/regenerate/';
+};
+
+export type CfgAccountsApiKeyRegenerateCreateErrors = {
+    /**
+     * Authentication credentials were not provided.
+     */
+    401: unknown;
+};
+
+export type CfgAccountsApiKeyRegenerateCreateResponses = {
+    200: ApiKeyRegenerate;
+};
+
+export type CfgAccountsApiKeyRegenerateCreateResponse = CfgAccountsApiKeyRegenerateCreateResponses[keyof CfgAccountsApiKeyRegenerateCreateResponses];
+
+export type CfgAccountsApiKeyTestCreateData = {
+    body: ApiKeyTestRequest;
+    path?: never;
+    query?: never;
+    url: '/cfg/accounts/api-key/test/';
+};
+
+export type CfgAccountsApiKeyTestCreateResponses = {
+    200: ApiKeyTestResult;
+};
+
+export type CfgAccountsApiKeyTestCreateResponse = CfgAccountsApiKeyTestCreateResponses[keyof CfgAccountsApiKeyTestCreateResponses];
+
 export type CfgAccountsOauthConnectionsListData = {
     body?: never;
     path?: never;
@@ -799,7 +963,7 @@ export type CfgAccountsOauthConnectionsListData = {
 };
 
 export type CfgAccountsOauthConnectionsListResponses = {
-    200: Array<OAuthConnection>;
+    200: CfgAccountsOauthConnectionsResponse200AutoRef;
 };
 
 export type CfgAccountsOauthConnectionsListResponse = CfgAccountsOauthConnectionsListResponses[keyof CfgAccountsOauthConnectionsListResponses];
@@ -819,9 +983,7 @@ export type CfgAccountsOauthDisconnectCreateErrors = {
 export type CfgAccountsOauthDisconnectCreateError = CfgAccountsOauthDisconnectCreateErrors[keyof CfgAccountsOauthDisconnectCreateErrors];
 
 export type CfgAccountsOauthDisconnectCreateResponses = {
-    200: {
-        message?: string;
-    };
+    200: CfgAccountsOauthDisconnectResponse200AutoRef;
 };
 
 export type CfgAccountsOauthDisconnectCreateResponse = CfgAccountsOauthDisconnectCreateResponses[keyof CfgAccountsOauthDisconnectCreateResponses];
@@ -1203,12 +1365,11 @@ export type CfgTotpDisableCreateErrors = {
 };
 
 export type CfgTotpDisableCreateResponses = {
-    /**
-     * 2FA disabled successfully
-     */
-    200: unknown;
+    200: CfgTotpDisableResponse200AutoRef;
 };
 
+export type CfgTotpDisableCreateResponse = CfgTotpDisableCreateResponses[keyof CfgTotpDisableCreateResponses];
+
 export type CfgTotpSetupCreateData = {
     body?: SetupRequest;
     path?: never;