@djangocfg/api 2.1.223 → 2.1.225

package/dist/clients.d.ts

@@ -4,17 +4,17 @@ import useSWR from 'swr';
 
 /**
  *
- * Response model (includes read-only fields).
+ * Request model (no read-only fields).
  */
-interface TokenRefresh$1 {
-    access: string;
+interface TokenRefreshRequest$1 {
     refresh: string;
 }
 /**
  *
- * Request model (no read-only fields).
+ * Response model (includes read-only fields).
  */
-interface TokenRefreshRequest$1 {
+interface TokenRefresh$1 {
+    access: string;
     refresh: string;
 }
 
@@ -55,19 +55,6 @@ declare namespace enums {
   export { enums_OAuthConnectionProvider as OAuthConnectionProvider, enums_OTPRequestRequestChannel as OTPRequestRequestChannel };
 }
 
-/**
- * Request to complete OAuth flow (callback handler).
- *
- * Request model (no read-only fields).
- */
-interface OAuthCallbackRequestRequest$1 {
-    /** Authorization code from OAuth provider callback */
-    code: 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;
-}
 /**
  * Request to start OAuth flow.
  *
@@ -80,24 +67,37 @@ interface OAuthAuthorizeRequestRequest$1 {
     source_url?: string;
 }
 /**
- * Response with OAuth authorization URL.
+ * Response with available OAuth providers.
  *
  * Response model (includes 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. */
+interface OAuthProvidersResponse$1 {
+    /** List of available OAuth providers */
+    providers: Array<Record<string, any>>;
+}
+/**
+ * Request to complete OAuth flow (callback handler).
+ *
+ * Request model (no read-only fields).
+ */
+interface OAuthCallbackRequestRequest$1 {
+    /** Authorization code from OAuth provider callback */
+    code: 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;
 }
 /**
- * Response with available OAuth providers.
+ * Request to disconnect OAuth provider.
  *
- * Response model (includes read-only fields).
+ * Request model (no read-only fields).
  */
-interface OAuthProvidersResponse$1 {
-    /** List of available OAuth providers */
-    providers: Array<Record<string, any>>;
+interface OAuthDisconnectRequestRequest$1 {
+    /** OAuth provider to disconnect
+  
+    * `github` - GitHub */
+    provider: OAuthConnectionProvider;
 }
 /**
  * Response with JWT tokens after OAuth authentication. When 2FA is required: -
@@ -126,15 +126,15 @@ interface OAuthTokenResponse$1 {
     should_prompt_2fa?: boolean;
 }
 /**
- * Request to disconnect OAuth provider.
+ * Response with OAuth authorization URL.
  *
- * Request model (no read-only fields).
+ * Response model (includes read-only fields).
  */
-interface OAuthDisconnectRequestRequest$1 {
-    /** OAuth provider to disconnect
-  
-    * `github` - GitHub */
-    provider: OAuthConnectionProvider;
+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;
 }
 
 /**
@@ -220,6 +220,14 @@ interface UserProfileUpdateRequest$1 {
     position?: string;
     language?: string;
 }
+/**
+ *
+ * Request model (no read-only fields).
+ */
+interface CfgAccountsProfileAvatarCreateRequest$1 {
+    /** Avatar image file (JPEG, PNG, GIF, WebP, max 5MB) */
+    avatar: File | Blob;
+}
 /**
  * Response serializer for account deletion.
  *
@@ -244,14 +252,6 @@ interface PatchedUserProfileUpdateRequest$1 {
     position?: string;
     language?: string;
 }
-/**
- *
- * Request model (no read-only fields).
- */
-interface CfgAccountsProfileAvatarCreateRequest$1 {
-    /** Avatar image file (JPEG, PNG, GIF, WebP, max 5MB) */
-    avatar: File | Blob;
-}
 /**
  * Nested serializer for Centrifugo WebSocket connection token.
  *
@@ -325,6 +325,27 @@ declare class UserProfile {
     accountsProfileUpdatePartialUpdate(data?: PatchedUserProfileUpdateRequest$1): Promise<User$2>;
 }
 
+/**
+ * OTP verification response. When 2FA is required: - requires_2fa: True -
+ * session_id: UUID of 2FA verification session - refresh/access/user: null
+ * When 2FA is not required: - requires_2fa: False - session_id: null -
+ * refresh/access/user: populated
+ *
+ * Response model (includes read-only fields).
+ */
+interface OTPVerifyResponse$1 {
+    /** Whether 2FA verification is required */
+    requires_2fa?: boolean;
+    /** 2FA session ID (if requires_2fa is True) */
+    session_id?: string | null;
+    /** JWT refresh token (if requires_2fa is False) */
+    refresh?: string | null;
+    /** JWT access token (if requires_2fa is False) */
+    access?: string | null;
+    user?: User$1 | null;
+    /** Whether user should be prompted to enable 2FA */
+    should_prompt_2fa?: boolean;
+}
 /**
  * Serializer for OTP request.
  *
@@ -350,27 +371,6 @@ interface OTPRequestResponse$1 {
     /** Success message */
     message: string;
 }
-/**
- * OTP verification response. When 2FA is required: - requires_2fa: True -
- * session_id: UUID of 2FA verification session - refresh/access/user: null
- * When 2FA is not required: - requires_2fa: False - session_id: null -
- * refresh/access/user: populated
- *
- * Response model (includes read-only fields).
- */
-interface OTPVerifyResponse$1 {
-    /** Whether 2FA verification is required */
-    requires_2fa?: boolean;
-    /** 2FA session ID (if requires_2fa is True) */
-    session_id?: string | null;
-    /** JWT refresh token (if requires_2fa is False) */
-    refresh?: string | null;
-    /** JWT access token (if requires_2fa is False) */
-    access?: string | null;
-    user?: User$1 | null;
-    /** Whether user should be prompted to enable 2FA */
-    should_prompt_2fa?: boolean;
-}
 /**
  * Serializer for OTP verification.
  *
@@ -1276,6 +1276,20 @@ declare class API$2 {
     getSchemaPath(): string;
 }
 
+/**
+ * Request to get channel history.
+ *
+ * Request model (no read-only fields).
+ */
+interface CentrifugoHistoryRequestRequest$1 {
+    /** Channel name */
+    channel: string;
+    /** Maximum number of messages to return */
+    limit?: number | null;
+    since?: CentrifugoStreamPosition$1 | null;
+    /** Reverse message order (newest first) */
+    reverse?: boolean | null;
+}
 /**
  * Request to get channel presence statistics.
  *
@@ -1295,18 +1309,13 @@ interface CentrifugoInfoResponse$1 {
     result?: CentrifugoInfoResult$1 | null;
 }
 /**
- * Request to get channel history.
+ * Channel presence stats response.
  *
- * Request model (no read-only fields).
+ * Response model (includes read-only fields).
  */
-interface CentrifugoHistoryRequestRequest$1 {
-    /** Channel name */
-    channel: string;
-    /** Maximum number of messages to return */
-    limit?: number | null;
-    since?: CentrifugoStreamPosition$1 | null;
-    /** Reverse message order (newest first) */
-    reverse?: boolean | null;
+interface CentrifugoPresenceStatsResponse$1 {
+    error?: CentrifugoError$1 | null;
+    result?: CentrifugoPresenceStatsResult$1 | null;
 }
 /**
  * Request to list active channels.
@@ -1327,13 +1336,13 @@ interface CentrifugoPresenceResponse$1 {
     result?: CentrifugoPresenceResult$1 | null;
 }
 /**
- * Channel presence stats response.
+ * List of active channels response.
  *
  * Response model (includes read-only fields).
  */
-interface CentrifugoPresenceStatsResponse$1 {
+interface CentrifugoChannelsResponse$1 {
     error?: CentrifugoError$1 | null;
-    result?: CentrifugoPresenceStatsResult$1 | null;
+    result?: CentrifugoChannelsResult$1 | null;
 }
 /**
  * Channel history response.
@@ -1344,15 +1353,6 @@ interface CentrifugoHistoryResponse$1 {
     error?: CentrifugoError$1 | null;
     result?: CentrifugoHistoryResult$1 | null;
 }
-/**
- * List of active channels response.
- *
- * Response model (includes read-only fields).
- */
-interface CentrifugoChannelsResponse$1 {
-    error?: CentrifugoError$1 | null;
-    result?: CentrifugoChannelsResult$1 | null;
-}
 /**
  * Request to get channel presence.
  *
@@ -1363,13 +1363,15 @@ interface CentrifugoPresenceRequestRequest$1 {
     channel: string;
 }
 /**
- * Info result wrapper.
+ * Stream position for pagination.
  *
  * Response model (includes read-only fields).
  */
-interface CentrifugoInfoResult$1 {
-    /** List of Centrifugo nodes */
-    nodes: Array<CentrifugoNodeInfo$1>;
+interface CentrifugoStreamPosition$1 {
+    /** Stream offset */
+    offset: number;
+    /** Stream epoch */
+    epoch: string;
 }
 /**
  * Centrifugo API error structure.
@@ -1383,15 +1385,24 @@ interface CentrifugoError$1 {
     message?: string;
 }
 /**
- * Stream position for pagination.
+ * Info result wrapper.
  *
  * Response model (includes read-only fields).
  */
-interface CentrifugoStreamPosition$1 {
-    /** Stream offset */
-    offset: number;
-    /** Stream epoch */
-    epoch: string;
+interface CentrifugoInfoResult$1 {
+    /** List of Centrifugo nodes */
+    nodes: Array<CentrifugoNodeInfo$1>;
+}
+/**
+ * Presence stats result.
+ *
+ * Response model (includes read-only fields).
+ */
+interface CentrifugoPresenceStatsResult$1 {
+    /** Number of connected clients */
+    num_clients: number;
+    /** Number of unique users */
+    num_users: number;
 }
 /**
  * Presence result wrapper.
@@ -1403,15 +1414,13 @@ interface CentrifugoPresenceResult$1 {
     presence: Record<string, CentrifugoClientInfo$1>;
 }
 /**
- * Presence stats result.
+ * Channels result wrapper.
  *
  * Response model (includes read-only fields).
  */
-interface CentrifugoPresenceStatsResult$1 {
-    /** Number of connected clients */
-    num_clients: number;
-    /** Number of unique users */
-    num_users: number;
+interface CentrifugoChannelsResult$1 {
+    /** Map of channel names to channel info */
+    channels: Record<string, CentrifugoChannelInfo$1>;
 }
 /**
  * History result wrapper.
@@ -1426,15 +1435,6 @@ interface CentrifugoHistoryResult$1 {
     /** Latest stream offset */
     offset: number;
 }
-/**
- * Channels result wrapper.
- *
- * Response model (includes read-only fields).
- */
-interface CentrifugoChannelsResult$1 {
-    /** Map of channel names to channel info */
-    channels: Record<string, CentrifugoChannelInfo$1>;
-}
 /**
  * Information about a single Centrifugo node.
  *
@@ -1475,6 +1475,15 @@ interface CentrifugoClientInfo$1 {
     /** Channel-specific metadata */
     chan_info?: Record<string, any> | null;
 }
+/**
+ * Information about a single channel.
+ *
+ * Response model (includes read-only fields).
+ */
+interface CentrifugoChannelInfo$1 {
+    /** Number of connected clients in channel */
+    num_clients: number;
+}
 /**
  * Single publication (message) in channel history.
  *
@@ -1490,13 +1499,15 @@ interface CentrifugoPublication$1 {
     tags?: Record<string, any> | null;
 }
 /**
- * Information about a single channel.
+ * Process information.
  *
  * Response model (includes read-only fields).
  */
-interface CentrifugoChannelInfo$1 {
-    /** Number of connected clients in channel */
-    num_clients: number;
+interface CentrifugoProcess$1 {
+    /** CPU usage percentage */
+    cpu: number;
+    /** Resident set size in bytes */
+    rss: number;
 }
 /**
  * Server metrics.
@@ -1509,17 +1520,6 @@ interface CentrifugoMetrics$1 {
     /** Metric name to value mapping */
     items: Record<string, any>;
 }
-/**
- * Process information.
- *
- * Response model (includes read-only fields).
- */
-interface CentrifugoProcess$1 {
-    /** CPU usage percentage */
-    cpu: number;
-    /** Resident set size in bytes */
-    rss: number;
-}
 
 /**
  * API endpoints for Centrifugo Admin API.
@@ -1632,6 +1632,29 @@ interface TimelineResponse$1 {
     period_hours: number;
     interval: string;
 }
+/**
+ * Overview statistics for Centrifugo publishes.
+ *
+ * Response model (includes read-only fields).
+ */
+interface CentrifugoOverviewStats$1 {
+    /** Total publishes in period */
+    total: number;
+    /** Successful publishes */
+    successful: number;
+    /** Failed publishes */
+    failed: number;
+    /** Timeout publishes */
+    timeout: number;
+    /** Success rate percentage */
+    success_rate: number;
+    /** Average duration in milliseconds */
+    avg_duration_ms: number;
+    /** Average ACKs received */
+    avg_acks_received: number;
+    /** Statistics period in hours */
+    period_hours: number;
+}
 /**
  * Health check response.
  *
@@ -1658,29 +1681,6 @@ interface ChannelList$1 {
     /** Total number of channels */
     total_channels: number;
 }
-/**
- * Overview statistics for Centrifugo publishes.
- *
- * Response model (includes read-only fields).
- */
-interface CentrifugoOverviewStats$1 {
-    /** Total publishes in period */
-    total: number;
-    /** Successful publishes */
-    successful: number;
-    /** Failed publishes */
-    failed: number;
-    /** Timeout publishes */
-    timeout: number;
-    /** Success rate percentage */
-    success_rate: number;
-    /** Average duration in milliseconds */
-    avg_duration_ms: number;
-    /** Average ACKs received */
-    avg_acks_received: number;
-    /** Statistics period in hours */
-    period_hours: number;
-}
 /**
  * Single publish item for DRF pagination.
  *
@@ -1769,6 +1769,21 @@ declare class CentrifugoMonitoring {
     }): Promise<TimelineResponse$1>;
 }
 
+/**
+ * Request model for test message publishing.
+ *
+ * Request model (no read-only fields).
+ */
+interface PublishTestRequestRequest$1 {
+    /** Target channel name */
+    channel: string;
+    /** Message data (any JSON object) */
+    data: Record<string, any>;
+    /** Wait for client acknowledgment */
+    wait_for_ack?: boolean;
+    /** ACK timeout in seconds */
+    ack_timeout?: number;
+}
 /**
  * Response model for test message publishing.
  *
@@ -1788,19 +1803,6 @@ interface PublishTestResponse$1 {
     /** Error message if failed */
     error?: string | null;
 }
-/**
- * Response model for manual ACK.
- *
- * Response model (includes read-only fields).
- */
-interface ManualAckResponse$1 {
-    /** Whether ACK was sent successfully */
-    success: boolean;
-    /** Message ID that was acknowledged */
-    message_id: string;
-    /** Error message if failed */
-    error?: string | null;
-}
 /**
  * Request model for manual ACK sending.
  *
@@ -1813,19 +1815,17 @@ interface ManualAckRequestRequest$1 {
     client_id: string;
 }
 /**
- * Request model for test message publishing.
+ * Response model for manual ACK.
  *
- * Request model (no read-only fields).
+ * Response model (includes read-only fields).
  */
-interface PublishTestRequestRequest$1 {
-    /** Target channel name */
-    channel: string;
-    /** Message data (any JSON object) */
-    data: Record<string, any>;
-    /** Wait for client acknowledgment */
-    wait_for_ack?: boolean;
-    /** ACK timeout in seconds */
-    ack_timeout?: number;
+interface ManualAckResponse$1 {
+    /** Whether ACK was sent successfully */
+    success: boolean;
+    /** Message ID that was acknowledged */
+    message_id: string;
+    /** Error message if failed */
+    error?: string | null;
 }
 
 /**
@@ -3196,15 +3196,6 @@ 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;
-}
 /**
  * Response serializer for backup codes regeneration.
  *
@@ -3216,6 +3207,15 @@ interface BackupCodesRegenerateResponse$1 {
     /** Warning about previous codes being invalidated */
     warning: string;
 }
+/**
+ * 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.
@@ -3329,16 +3329,21 @@ declare class TotpManagement {
 }
 
 /**
- * Response serializer for setup confirmation.
+ * Response serializer for setup initiation.
  *
  * Response model (includes read-only fields).
  */
-interface ConfirmSetupResponse$1 {
-    message: string;
-    /** List of backup recovery codes (save these!) */
-    backup_codes: Array<string>;
-    /** Warning message about backup codes */
-    backup_codes_warning: string;
+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 confirming 2FA setup with first code.
@@ -3352,21 +3357,16 @@ interface ConfirmSetupRequest$1 {
     code: string;
 }
 /**
- * Response serializer for setup initiation.
+ * Response serializer for setup confirmation.
  *
  * 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;
+interface ConfirmSetupResponse$1 {
+    message: string;
+    /** List of backup recovery codes (save these!) */
+    backup_codes: Array<string>;
+    /** Warning message about backup codes */
+    backup_codes_warning: string;
 }
 /**
  * Serializer for starting 2FA setup.
@@ -3396,17 +3396,6 @@ declare class TotpSetup {
     confirmCreate(data: ConfirmSetupRequest$1): Promise<ConfirmSetupResponse$1>;
 }
 
-/**
- * Serializer for TOTP code verification during login.
- *
- * Request model (no read-only fields).
- */
-interface VerifyRequest$1 {
-    /** 2FA session ID from login response */
-    session_id: string;
-    /** 6-digit TOTP code from authenticator app */
-    code: string;
-}
 /**
  * Serializer for backup code verification during login.
  *
@@ -3435,6 +3424,17 @@ interface VerifyResponse$1 {
     /** Warning message (e.g., low backup codes) */
     warning?: string;
 }
+/**
+ * Serializer for TOTP code verification during login.
+ *
+ * Request model (no read-only fields).
+ */
+interface VerifyRequest$1 {
+    /** 2FA session ID from login response */
+    session_id: string;
+    /** 6-digit TOTP code from authenticator app */
+    code: string;
+}
 /**
  * User data returned after 2FA verification.
  *