@djangocfg/api 2.1.308 → 2.1.310

package/dist/clients.d.cts

@@ -45,24 +45,15 @@ declare namespace enums {
 }
 
 /**
- * Response with available OAuth providers.
- *
- * Response model (includes read-only fields).
- */
-interface OAuthProvidersResponse$1 {
-    /** List of available OAuth providers */
-    providers: Array<Record<string, any>>;
-}
-/**
- * Response with OAuth authorization URL.
+ * Request to start OAuth flow.
  *
- * Response model (includes read-only fields).
+ * Request model (no read-only fields).
  */
-interface OAuthAuthorizeResponse$1 {
-    /** Full URL to redirect user to OAuth provider */
-    authorization_url: string;
-    /** State token for CSRF protection. Store this and verify on callback. */
-    state: string;
+interface OAuthAuthorizeRequestRequest$1 {
+    /** URL to redirect after OAuth authorization. If not provided, uses config's site_url + callback_path */
+    redirect_uri?: string;
+    /** Optional source URL for registration tracking */
+    source_url?: string;
 }
 /**
  * Request to complete OAuth flow (callback handler).
@@ -77,6 +68,32 @@ interface OAuthCallbackRequestRequest$1 {
     /** Same redirect_uri used in authorize request. If not provided, uses config's site_url + callback_path */
     redirect_uri?: string;
 }
+/**
+ * Response with JWT tokens after OAuth authentication. When 2FA is required: -
+ * requires_2fa: True - session_id: UUID of 2FA verification session -
+ * access/refresh/user: null When 2FA is not required: - requires_2fa: False -
+ * session_id: null - access/refresh/user: populated
+ *
+ * Response model (includes read-only fields).
+ */
+interface OAuthTokenResponse$1 {
+    /** True if 2FA verification is required */
+    requires_2fa?: boolean;
+    /** 2FA session ID (only when requires_2fa=True) */
+    session_id?: string | null;
+    /** JWT access token (null when requires_2fa=True) */
+    access?: string | null;
+    /** JWT refresh token (null when requires_2fa=True) */
+    refresh?: string | null;
+    /** Authenticated user info (null when requires_2fa=True) */
+    user?: Record<string, any> | null;
+    /** True if a new user was created during this OAuth flow */
+    is_new_user: boolean;
+    /** True if a new OAuth connection was created */
+    is_new_connection: boolean;
+    /** True if user should be prompted to enable 2FA */
+    should_prompt_2fa?: boolean;
+}
 /**
  * Serializer for OAuth connection info (user-facing).
  *
@@ -101,41 +118,15 @@ interface OAuthConnection$1 {
     last_login_at: string;
 }
 /**
- * Request to start OAuth flow.
- *
- * Request model (no read-only fields).
- */
-interface OAuthAuthorizeRequestRequest$1 {
-    /** URL to redirect after OAuth authorization. If not provided, uses config's site_url + callback_path */
-    redirect_uri?: string;
-    /** Optional source URL for registration tracking */
-    source_url?: string;
-}
-/**
- * Response with JWT tokens after OAuth authentication. When 2FA is required: -
- * requires_2fa: True - session_id: UUID of 2FA verification session -
- * access/refresh/user: null When 2FA is not required: - requires_2fa: False -
- * session_id: null - access/refresh/user: populated
+ * Response with OAuth authorization URL.
  *
  * Response model (includes read-only fields).
  */
-interface OAuthTokenResponse$1 {
-    /** True if 2FA verification is required */
-    requires_2fa?: boolean;
-    /** 2FA session ID (only when requires_2fa=True) */
-    session_id?: string | null;
-    /** JWT access token (null when requires_2fa=True) */
-    access?: string | null;
-    /** JWT refresh token (null when requires_2fa=True) */
-    refresh?: string | null;
-    /** Authenticated user info (null when requires_2fa=True) */
-    user?: Record<string, any> | null;
-    /** True if a new user was created during this OAuth flow */
-    is_new_user: boolean;
-    /** True if a new OAuth connection was created */
-    is_new_connection: boolean;
-    /** True if user should be prompted to enable 2FA */
-    should_prompt_2fa?: boolean;
+interface OAuthAuthorizeResponse$1 {
+    /** Full URL to redirect user to OAuth provider */
+    authorization_url: string;
+    /** State token for CSRF protection. Store this and verify on callback. */
+    state: string;
 }
 /**
  * Request to disconnect OAuth provider.
@@ -148,6 +139,15 @@ interface OAuthDisconnectRequestRequest$1 {
     * `github` - GitHub */
     provider: OAuthConnectionProvider;
 }
+/**
+ * Response with available OAuth providers.
+ *
+ * Response model (includes read-only fields).
+ */
+interface OAuthProvidersResponse$1 {
+    /** List of available OAuth providers */
+    providers: Array<Record<string, any>>;
+}
 
 /**
  * API endpoints for Oauth.
@@ -194,7 +194,7 @@ declare class Oauth {
  *
  * Request model (no read-only fields).
  */
-interface UserProfileUpdateRequest$1 {
+interface PatchedUserProfileUpdateRequest$1 {
     first_name?: string;
     last_name?: string;
     company?: string;
@@ -203,17 +203,23 @@ interface UserProfileUpdateRequest$1 {
     language?: string;
 }
 /**
- * Serializer for updating user profile.
  *
  * Request model (no read-only fields).
  */
-interface PatchedUserProfileUpdateRequest$1 {
-    first_name?: string;
-    last_name?: string;
-    company?: string;
-    phone?: string;
-    position?: string;
-    language?: string;
+interface CfgAccountsProfileAvatarCreateRequest$1 {
+    /** Avatar image file (JPEG, PNG, GIF, WebP, max 5MB) */
+    avatar: File | Blob;
+}
+/**
+ * Response serializer for account deletion.
+ *
+ * Response model (includes read-only fields).
+ */
+interface AccountDeleteResponse$1 {
+    /** Whether the account was successfully deleted */
+    success: boolean;
+    /** Human-readable message about the deletion */
+    message: string;
 }
 /**
  * Serializer for user details.
@@ -246,23 +252,17 @@ interface User$2 {
     centrifugo: CentrifugoToken$2 | null;
 }
 /**
- * Response serializer for account deletion.
- *
- * Response model (includes read-only fields).
- */
-interface AccountDeleteResponse$1 {
-    /** Whether the account was successfully deleted */
-    success: boolean;
-    /** Human-readable message about the deletion */
-    message: string;
-}
-/**
+ * Serializer for updating user profile.
  *
  * Request model (no read-only fields).
  */
-interface CfgAccountsProfileAvatarCreateRequest$1 {
-    /** Avatar image file (JPEG, PNG, GIF, WebP, max 5MB) */
-    avatar: File | Blob;
+interface UserProfileUpdateRequest$1 {
+    first_name?: string;
+    last_name?: string;
+    company?: string;
+    phone?: string;
+    position?: string;
+    language?: string;
 }
 /**
  * Nested serializer for Centrifugo WebSocket connection token.
@@ -337,18 +337,6 @@ declare class UserProfile {
     accountsProfileUpdatePartialUpdate(data?: PatchedUserProfileUpdateRequest$1): Promise<User$2>;
 }
 
-/**
- * Serializer for OTP verification.
- *
- * Request model (no read-only fields).
- */
-interface OTPVerifyRequest$1 {
-    /** Email address used for OTP request */
-    identifier: string;
-    otp: string;
-    /** Source URL for tracking login (e.g., https://my.djangocfg.com) */
-    source_url?: string;
-}
 /**
  * OTP verification response. When 2FA is required: - requires_2fa: True -
  * session_id: UUID of 2FA verification session - refresh/access/user: null
@@ -371,24 +359,36 @@ interface OTPVerifyResponse$1 {
     should_prompt_2fa?: boolean;
 }
 /**
- * Serializer for OTP request.
+ * OTP request response.
+ *
+ * Response model (includes read-only fields).
+ */
+interface OTPRequestResponse$1 {
+    /** Success message */
+    message: string;
+}
+/**
+ * Serializer for OTP verification.
  *
  * Request model (no read-only fields).
  */
-interface OTPRequestRequest$1 {
-    /** Email address for OTP delivery */
+interface OTPVerifyRequest$1 {
+    /** Email address used for OTP request */
     identifier: string;
-    /** Source URL for tracking registration (e.g., https://my.djangocfg.com) */
+    otp: string;
+    /** Source URL for tracking login (e.g., https://my.djangocfg.com) */
     source_url?: string;
 }
 /**
- * OTP request response.
+ * Serializer for OTP request.
  *
- * Response model (includes read-only fields).
+ * Request model (no read-only fields).
  */
-interface OTPRequestResponse$1 {
-    /** Success message */
-    message: string;
+interface OTPRequestRequest$1 {
+    /** Email address for OTP delivery */
+    identifier: string;
+    /** Source URL for tracking registration (e.g., https://my.djangocfg.com) */
+    source_url?: string;
 }
 /**
  * Serializer for user details.
@@ -1630,15 +1630,6 @@ declare class API$1 {
     getSchemaPath(): string;
 }
 
-/**
- * Serializer for regenerating backup codes.
- *
- * Request model (no read-only fields).
- */
-interface BackupCodesRegenerateRequest$1 {
-    /** TOTP code for verification */
-    code: string;
-}
 /**
  * Response serializer for backup codes regeneration.
  *
@@ -1663,6 +1654,15 @@ interface BackupCodesStatus$1 {
     /** Warning if running low on codes */
     warning?: string | null;
 }
+/**
+ * Serializer for regenerating backup codes.
+ *
+ * Request model (no read-only fields).
+ */
+interface BackupCodesRegenerateRequest$1 {
+    /** TOTP code for verification */
+    code: string;
+}
 
 /**
  * API endpoints for Backup Codes.
@@ -1692,15 +1692,6 @@ declare enum DeviceListStatus {
     DISABLED = "disabled"
 }
 
-/**
- * Response serializer for device list endpoint.
- *
- * Response model (includes read-only fields).
- */
-interface DeviceListResponse$1 {
-    devices: Array<DeviceList$1>;
-    has_2fa_enabled: boolean;
-}
 /**
  * Serializer for completely disabling 2FA.
  *
@@ -1710,6 +1701,15 @@ interface DisableRequest$1 {
     /** TOTP code for verification */
     code: string;
 }
+/**
+ * Response serializer for device list endpoint.
+ *
+ * Response model (includes read-only fields).
+ */
+interface DeviceListResponse$1 {
+    devices: Array<DeviceList$1>;
+    has_2fa_enabled: boolean;
+}
 /**
  * Serializer for listing TOTP devices.
  *
@@ -1759,23 +1759,6 @@ interface ConfirmSetupRequest$1 {
     /** 6-digit TOTP code from authenticator app */
     code: string;
 }
-/**
- * Response serializer for setup initiation.
- *
- * Response model (includes read-only fields).
- */
-interface SetupResponse$1 {
-    /** 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;
-}
 /**
  * Serializer for starting 2FA setup.
  *
@@ -1797,6 +1780,23 @@ interface ConfirmSetupResponse$1 {
     /** Warning message about backup codes */
     backup_codes_warning: string;
 }
+/**
+ * Response serializer for setup initiation.
+ *
+ * Response model (includes read-only fields).
+ */
+interface SetupResponse$1 {
+    /** 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;
+}
 
 /**
  * API endpoints for TOTP Setup.
@@ -1816,6 +1816,23 @@ declare class TotpSetup {
     confirmCreate(data: ConfirmSetupRequest$1): Promise<ConfirmSetupResponse$1>;
 }
 
+/**
+ * Response serializer for successful 2FA verification.
+ *
+ * Response model (includes read-only fields).
+ */
+interface VerifyResponse$1 {
+    message: string;
+    /** JWT access token */
+    access_token: string;
+    /** JWT refresh token */
+    refresh_token: string;
+    user: TotpVerifyUser$1;
+    /** Number of remaining backup codes (if backup code was used) */
+    remaining_backup_codes?: number;
+    /** Warning message (e.g., low backup codes) */
+    warning?: string;
+}
 /**
  * Serializer for TOTP code verification during login.
  *
@@ -1838,23 +1855,6 @@ interface VerifyBackupRequest$1 {
     /** 8-character backup recovery code */
     backup_code: string;
 }
-/**
- * Response serializer for successful 2FA verification.
- *
- * Response model (includes read-only fields).
- */
-interface VerifyResponse$1 {
-    message: string;
-    /** JWT access token */
-    access_token: string;
-    /** JWT refresh token */
-    refresh_token: string;
-    user: TotpVerifyUser$1;
-    /** Number of remaining backup codes (if backup code was used) */
-    remaining_backup_codes?: number;
-    /** Warning message (e.g., low backup codes) */
-    warning?: string;
-}
 /**
  * User data returned after 2FA verification.
  *