@djangocfg/api 2.1.225 → 2.1.227

package/dist/clients.d.cts

@@ -4,17 +4,17 @@ import useSWR from 'swr';
 
 /**
  *
- * Request model (no read-only fields).
+ * Response model (includes read-only fields).
  */
-interface TokenRefreshRequest$1 {
+interface TokenRefresh$1 {
+    access: string;
     refresh: string;
 }
 /**
  *
- * Response model (includes read-only fields).
+ * Request model (no read-only fields).
  */
-interface TokenRefresh$1 {
-    access: string;
+interface TokenRefreshRequest$1 {
     refresh: string;
 }
 
@@ -56,48 +56,37 @@ declare namespace enums {
 }
 
 /**
- * Request to start OAuth flow.
+ * Request to disconnect OAuth provider.
  *
  * 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;
+interface OAuthDisconnectRequestRequest$1 {
+    /** OAuth provider to disconnect
+  
+    * `github` - GitHub */
+    provider: OAuthConnectionProvider;
 }
 /**
- * Response with available OAuth providers.
+ * Response with OAuth authorization URL.
  *
  * Response model (includes read-only fields).
  */
-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) */
+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;
-    /** Same redirect_uri used in authorize request. If not provided, uses config's site_url + callback_path */
-    redirect_uri?: string;
 }
 /**
- * Request to disconnect OAuth provider.
+ * Request to start OAuth flow.
  *
  * Request model (no read-only fields).
  */
-interface OAuthDisconnectRequestRequest$1 {
-    /** OAuth provider to disconnect
-  
-    * `github` - GitHub */
-    provider: OAuthConnectionProvider;
+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: -
@@ -126,15 +115,26 @@ interface OAuthTokenResponse$1 {
     should_prompt_2fa?: boolean;
 }
 /**
- * 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;
 }
 
 /**
@@ -177,6 +177,27 @@ declare class Oauth {
     accountsOauthProvidersRetrieve(): Promise<OAuthProvidersResponse$1>;
 }
 
+/**
+ * Serializer for updating user profile.
+ *
+ * Request model (no read-only fields).
+ */
+interface UserProfileUpdateRequest$1 {
+    first_name?: string;
+    last_name?: string;
+    company?: string;
+    phone?: string;
+    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;
+}
 /**
  * Serializer for user details.
  *
@@ -212,7 +233,7 @@ interface User$2 {
  *
  * Request model (no read-only fields).
  */
-interface UserProfileUpdateRequest$1 {
+interface PatchedUserProfileUpdateRequest$1 {
     first_name?: string;
     last_name?: string;
     company?: string;
@@ -220,14 +241,6 @@ 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.
  *
@@ -239,19 +252,6 @@ interface AccountDeleteResponse$1 {
     /** Human-readable message about the deletion */
     message: 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;
-}
 /**
  * Nested serializer for Centrifugo WebSocket connection token.
  *
@@ -325,6 +325,22 @@ declare class UserProfile {
     accountsProfileUpdatePartialUpdate(data?: PatchedUserProfileUpdateRequest$1): Promise<User$2>;
 }
 
+/**
+ * Serializer for OTP request.
+ *
+ * Request model (no read-only fields).
+ */
+interface OTPRequestRequest$1 {
+    /** Email address or phone number for OTP delivery */
+    identifier: string;
+    /** Delivery channel: 'email' or 'phone'. Auto-detected if not provided.
+  
+    * `email` - Email
+    * `phone` - Phone */
+    channel?: OTPRequestRequestChannel;
+    /** Source URL for tracking registration (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
@@ -346,22 +362,6 @@ interface OTPVerifyResponse$1 {
     /** Whether user should be prompted to enable 2FA */
     should_prompt_2fa?: boolean;
 }
-/**
- * Serializer for OTP request.
- *
- * Request model (no read-only fields).
- */
-interface OTPRequestRequest$1 {
-    /** Email address or phone number for OTP delivery */
-    identifier: string;
-    /** Delivery channel: 'email' or 'phone'. Auto-detected if not provided.
-  
-    * `email` - Email
-    * `phone` - Phone */
-    channel?: OTPRequestRequestChannel;
-    /** Source URL for tracking registration (e.g., https://my.djangocfg.com) */
-    source_url?: string;
-}
 /**
  * OTP request response.
  *
@@ -1277,27 +1277,22 @@ declare class API$2 {
 }
 
 /**
- * Request to get channel history.
+ * Channel history 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 CentrifugoHistoryResponse$1 {
+    error?: CentrifugoError$1 | null;
+    result?: CentrifugoHistoryResult$1 | null;
 }
 /**
- * Request to get channel presence statistics.
+ * Channel presence response.
  *
- * Request model (no read-only fields).
+ * Response model (includes read-only fields).
  */
-interface CentrifugoPresenceStatsRequestRequest$1 {
-    /** Channel name */
-    channel: string;
+interface CentrifugoPresenceResponse$1 {
+    error?: CentrifugoError$1 | null;
+    result?: CentrifugoPresenceResult$1 | null;
 }
 /**
  * Server info response.
@@ -1309,31 +1304,13 @@ interface CentrifugoInfoResponse$1 {
     result?: CentrifugoInfoResult$1 | null;
 }
 /**
- * Channel presence stats response.
- *
- * Response model (includes read-only fields).
- */
-interface CentrifugoPresenceStatsResponse$1 {
-    error?: CentrifugoError$1 | null;
-    result?: CentrifugoPresenceStatsResult$1 | null;
-}
-/**
- * Request to list active channels.
+ * Request to get channel presence.
  *
  * Request model (no read-only fields).
  */
-interface CentrifugoChannelsRequestRequest$1 {
-    /** Pattern to filter channels (e.g., 'user:*') */
-    pattern?: string | null;
-}
-/**
- * Channel presence response.
- *
- * Response model (includes read-only fields).
- */
-interface CentrifugoPresenceResponse$1 {
-    error?: CentrifugoError$1 | null;
-    result?: CentrifugoPresenceResult$1 | null;
+interface CentrifugoPresenceRequestRequest$1 {
+    /** Channel name */
+    channel: string;
 }
 /**
  * List of active channels response.
@@ -1345,33 +1322,58 @@ interface CentrifugoChannelsResponse$1 {
     result?: CentrifugoChannelsResult$1 | null;
 }
 /**
- * Channel history response.
+ * Request to get channel presence statistics.
  *
- * Response model (includes read-only fields).
+ * Request model (no read-only fields).
  */
-interface CentrifugoHistoryResponse$1 {
-    error?: CentrifugoError$1 | null;
-    result?: CentrifugoHistoryResult$1 | null;
+interface CentrifugoPresenceStatsRequestRequest$1 {
+    /** Channel name */
+    channel: string;
 }
 /**
- * Request to get channel presence.
+ * Request to get channel history.
  *
  * Request model (no read-only fields).
  */
-interface CentrifugoPresenceRequestRequest$1 {
+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;
 }
 /**
- * Stream position for pagination.
+ * Request to list active channels.
+ *
+ * Request model (no read-only fields).
+ */
+interface CentrifugoChannelsRequestRequest$1 {
+    /** Pattern to filter channels (e.g., 'user:*') */
+    pattern?: string | null;
+}
+/**
+ * Channel presence stats response.
  *
  * Response model (includes read-only fields).
  */
-interface CentrifugoStreamPosition$1 {
-    /** Stream offset */
-    offset: number;
-    /** Stream epoch */
+interface CentrifugoPresenceStatsResponse$1 {
+    error?: CentrifugoError$1 | null;
+    result?: CentrifugoPresenceStatsResult$1 | null;
+}
+/**
+ * History result wrapper.
+ *
+ * Response model (includes read-only fields).
+ */
+interface CentrifugoHistoryResult$1 {
+    /** List of publications */
+    publications: Array<CentrifugoPublication$1>;
+    /** Current stream epoch */
     epoch: string;
+    /** Latest stream offset */
+    offset: number;
 }
 /**
  * Centrifugo API error structure.
@@ -1384,6 +1386,15 @@ interface CentrifugoError$1 {
     /** Error message */
     message?: string;
 }
+/**
+ * Presence result wrapper.
+ *
+ * Response model (includes read-only fields).
+ */
+interface CentrifugoPresenceResult$1 {
+    /** Map of client IDs to client info */
+    presence: Record<string, CentrifugoClientInfo$1>;
+}
 /**
  * Info result wrapper.
  *
@@ -1394,46 +1405,64 @@ interface CentrifugoInfoResult$1 {
     nodes: Array<CentrifugoNodeInfo$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>;
 }
 /**
- * Presence result wrapper.
+ * Stream position for pagination.
+ *
+ * Response model (includes read-only fields).
+ */
+interface CentrifugoStreamPosition$1 {
+    /** Stream offset */
+    offset: number;
+    /** Stream epoch */
+    epoch: string;
+}
+/**
+ * Presence stats result.
  *
  * Response model (includes read-only fields).
  */
-interface CentrifugoPresenceResult$1 {
-    /** Map of client IDs to client info */
-    presence: Record<string, CentrifugoClientInfo$1>;
+interface CentrifugoPresenceStatsResult$1 {
+    /** Number of connected clients */
+    num_clients: number;
+    /** Number of unique users */
+    num_users: number;
 }
 /**
- * Channels result wrapper.
+ * Single publication (message) in channel history.
  *
  * Response model (includes read-only fields).
  */
-interface CentrifugoChannelsResult$1 {
-    /** Map of channel names to channel info */
-    channels: Record<string, CentrifugoChannelInfo$1>;
+interface CentrifugoPublication$1 {
+    /** Message payload */
+    data: Record<string, any>;
+    info?: CentrifugoClientInfo$1 | null;
+    /** Message offset in channel stream */
+    offset: number;
+    /** Optional message tags */
+    tags?: Record<string, any> | null;
 }
 /**
- * History result wrapper.
+ * Information about connected client.
  *
  * Response model (includes read-only fields).
  */
-interface CentrifugoHistoryResult$1 {
-    /** List of publications */
-    publications: Array<CentrifugoPublication$1>;
-    /** Current stream epoch */
-    epoch: string;
-    /** Latest stream offset */
-    offset: number;
+interface CentrifugoClientInfo$1 {
+    /** User ID */
+    user: string;
+    /** Client UUID */
+    client: string;
+    /** Connection metadata */
+    conn_info?: Record<string, any> | null;
+    /** Channel-specific metadata */
+    chan_info?: Record<string, any> | null;
 }
 /**
  * Information about a single Centrifugo node.
@@ -1460,21 +1489,6 @@ interface CentrifugoNodeInfo$1 {
     metrics?: CentrifugoMetrics$1 | null;
     process?: CentrifugoProcess$1 | null;
 }
-/**
- * Information about connected client.
- *
- * Response model (includes read-only fields).
- */
-interface CentrifugoClientInfo$1 {
-    /** User ID */
-    user: string;
-    /** Client UUID */
-    client: string;
-    /** Connection metadata */
-    conn_info?: Record<string, any> | null;
-    /** Channel-specific metadata */
-    chan_info?: Record<string, any> | null;
-}
 /**
  * Information about a single channel.
  *
@@ -1485,18 +1499,15 @@ interface CentrifugoChannelInfo$1 {
     num_clients: number;
 }
 /**
- * Single publication (message) in channel history.
+ * Server metrics.
  *
  * Response model (includes read-only fields).
  */
-interface CentrifugoPublication$1 {
-    /** Message payload */
-    data: Record<string, any>;
-    info?: CentrifugoClientInfo$1 | null;
-    /** Message offset in channel stream */
-    offset: number;
-    /** Optional message tags */
-    tags?: Record<string, any> | null;
+interface CentrifugoMetrics$1 {
+    /** Metrics collection interval */
+    interval: number;
+    /** Metric name to value mapping */
+    items: Record<string, any>;
 }
 /**
  * Process information.
@@ -1509,17 +1520,6 @@ interface CentrifugoProcess$1 {
     /** Resident set size in bytes */
     rss: number;
 }
-/**
- * Server metrics.
- *
- * Response model (includes read-only fields).
- */
-interface CentrifugoMetrics$1 {
-    /** Metrics collection interval */
-    interval: number;
-    /** Metric name to value mapping */
-    items: Record<string, any>;
-}
 
 /**
  * API endpoints for Centrifugo Admin API.
@@ -1598,6 +1598,16 @@ declare class CentrifugoAuth {
     tokenRetrieve(): Promise<ConnectionTokenResponse$1>;
 }
 
+/**
+ * Timeline response with hourly/daily breakdown for DRF.
+ *
+ * Response model (includes read-only fields).
+ */
+interface TimelineResponse$1 {
+    timeline: Array<TimelineItem$1>;
+    period_hours: number;
+    interval: string;
+}
 /**
  *
  * Response model (includes read-only fields).
@@ -1623,14 +1633,30 @@ interface PaginatedPublishList$1 {
     results: Array<Publish$1>;
 }
 /**
- * Timeline response with hourly/daily breakdown for DRF.
+ * List of channel statistics.
  *
  * Response model (includes read-only fields).
  */
-interface TimelineResponse$1 {
-    timeline: Array<TimelineItem$1>;
-    period_hours: number;
-    interval: string;
+interface ChannelList$1 {
+    /** Channel statistics */
+    channels: Array<ChannelStats$1>;
+    /** Total number of channels */
+    total_channels: number;
+}
+/**
+ * Health check response.
+ *
+ * Response model (includes read-only fields).
+ */
+interface CentrifugoHealthCheck$1 {
+    /** Health status: healthy or unhealthy */
+    status: string;
+    /** Configured wrapper URL */
+    wrapper_url: string;
+    /** Whether API key is configured */
+    has_api_key: boolean;
+    /** Current timestamp */
+    timestamp: string;
 }
 /**
  * Overview statistics for Centrifugo publishes.
@@ -1656,30 +1682,16 @@ interface CentrifugoOverviewStats$1 {
     period_hours: number;
 }
 /**
- * Health check response.
+ * Single timeline data point for DRF.
  *
  * Response model (includes read-only fields).
  */
-interface CentrifugoHealthCheck$1 {
-    /** Health status: healthy or unhealthy */
-    status: string;
-    /** Configured wrapper URL */
-    wrapper_url: string;
-    /** Whether API key is configured */
-    has_api_key: boolean;
-    /** Current timestamp */
+interface TimelineItem$1 {
     timestamp: string;
-}
-/**
- * List of channel statistics.
- *
- * Response model (includes read-only fields).
- */
-interface ChannelList$1 {
-    /** Channel statistics */
-    channels: Array<ChannelStats$1>;
-    /** Total number of channels */
-    total_channels: number;
+    count: number;
+    successful: number;
+    failed: number;
+    timeout: number;
 }
 /**
  * Single publish item for DRF pagination.
@@ -1699,18 +1711,6 @@ interface Publish$1 {
     error_code: string | null;
     error_message: string | null;
 }
-/**
- * Single timeline data point for DRF.
- *
- * Response model (includes read-only fields).
- */
-interface TimelineItem$1 {
-    timestamp: string;
-    count: number;
-    successful: number;
-    failed: number;
-    timeout: number;
-}
 /**
  * Statistics per channel.
  *
@@ -1769,6 +1769,19 @@ declare class CentrifugoMonitoring {
     }): Promise<TimelineResponse$1>;
 }
 
+/**
+ * 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 test message publishing.
  *
@@ -1814,19 +1827,6 @@ interface ManualAckRequestRequest$1 {
     /** Client ID sending the ACK */
     client_id: string;
 }
-/**
- * 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;
-}
 
 /**
  * API endpoints for Centrifugo Testing.
@@ -3196,6 +3196,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;
+}
 /**
  * Response serializer for backup codes regeneration.
  *
@@ -3207,15 +3216,6 @@ 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.
@@ -3245,6 +3245,15 @@ declare enum DeviceListStatus {
     DISABLED = "disabled"
 }
 
+/**
+ * Serializer for completely disabling 2FA.
+ *
+ * Request model (no read-only fields).
+ */
+interface DisableRequest$1 {
+    /** TOTP code for verification */
+    code: string;
+}
 /**
  *
  * Response model (includes read-only fields).
@@ -3269,15 +3278,6 @@ interface PaginatedDeviceListResponseList$1 {
     /** Array of items for current page */
     results: Array<DeviceListResponse$1>;
 }
-/**
- * Serializer for completely disabling 2FA.
- *
- * Request model (no read-only fields).
- */
-interface DisableRequest$1 {
-    /** TOTP code for verification */
-    code: string;
-}
 /**
  * Response serializer for device list endpoint.
  *
@@ -3328,6 +3328,18 @@ declare class TotpManagement {
     totpDisableCreate(data: DisableRequest$1): Promise<any>;
 }
 
+/**
+ * Response serializer for setup confirmation.
+ *
+ * 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;
+}
 /**
  * Response serializer for setup initiation.
  *
@@ -3356,18 +3368,6 @@ interface ConfirmSetupRequest$1 {
     /** 6-digit TOTP code from authenticator app */
     code: string;
 }
-/**
- * Response serializer for setup confirmation.
- *
- * 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;
-}
 /**
  * Serializer for starting 2FA setup.
  *
@@ -3397,15 +3397,15 @@ declare class TotpSetup {
 }
 
 /**
- * Serializer for backup code verification during login.
+ * Serializer for TOTP code verification during login.
  *
  * Request model (no read-only fields).
  */
-interface VerifyBackupRequest$1 {
+interface VerifyRequest$1 {
     /** 2FA session ID from login response */
     session_id: string;
-    /** 8-character backup recovery code */
-    backup_code: string;
+    /** 6-digit TOTP code from authenticator app */
+    code: string;
 }
 /**
  * Response serializer for successful 2FA verification.
@@ -3425,15 +3425,15 @@ interface VerifyResponse$1 {
     warning?: string;
 }
 /**
- * Serializer for TOTP code verification during login.
+ * Serializer for backup code verification during login.
  *
  * Request model (no read-only fields).
  */
-interface VerifyRequest$1 {
+interface VerifyBackupRequest$1 {
     /** 2FA session ID from login response */
     session_id: string;
-    /** 6-digit TOTP code from authenticator app */
-    code: string;
+    /** 8-character backup recovery code */
+    backup_code: string;
 }
 /**
  * User data returned after 2FA verification.