@djangocfg/api 2.1.228 → 2.1.229

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;
 }
 
@@ -45,24 +45,41 @@ declare namespace enums {
 }
 
 /**
- * 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>>;
+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.
+ * 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
  *
- * Request model (no read-only fields).
+ * Response model (includes read-only fields).
  */
-interface OAuthDisconnectRequestRequest$1 {
-    /** OAuth provider to disconnect
-  
-    * `github` - GitHub */
-    provider: OAuthConnectionProvider;
+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;
 }
 /**
  * Request to start OAuth flow.
@@ -89,41 +106,24 @@ interface OAuthCallbackRequestRequest$1 {
     redirect_uri?: string;
 }
 /**
- * Response with OAuth authorization URL.
+ * Request to disconnect OAuth provider.
  *
- * 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 OAuthDisconnectRequestRequest$1 {
+    /** OAuth provider to disconnect
+  
+    * `github` - GitHub */
+    provider: OAuthConnectionProvider;
 }
 /**
- * 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 available OAuth providers.
  *
  * 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 OAuthProvidersResponse$1 {
+    /** List of available OAuth providers */
+    providers: Array<Record<string, any>>;
 }
 
 /**
@@ -166,23 +166,12 @@ declare class Oauth {
     accountsOauthProvidersRetrieve(): Promise<OAuthProvidersResponse$1>;
 }
 
-/**
- * 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 UserProfileUpdateRequest$1 {
+interface PatchedUserProfileUpdateRequest$1 {
     first_name?: string;
     last_name?: string;
     company?: string;
@@ -190,12 +179,20 @@ 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;
+}
 /**
  * Serializer for updating user profile.
  *
  * Request model (no read-only fields).
  */
-interface PatchedUserProfileUpdateRequest$1 {
+interface UserProfileUpdateRequest$1 {
     first_name?: string;
     last_name?: string;
     company?: string;
@@ -234,12 +231,15 @@ interface User$2 {
     centrifugo: CentrifugoToken$2 | null;
 }
 /**
+ * Response serializer for account deletion.
  *
- * Request model (no read-only fields).
+ * Response model (includes read-only fields).
  */
-interface CfgAccountsProfileAvatarCreateRequest$1 {
-    /** Avatar image file (JPEG, PNG, GIF, WebP, max 5MB) */
-    avatar: File | Blob;
+interface AccountDeleteResponse$1 {
+    /** Whether the account was successfully deleted */
+    success: boolean;
+    /** Human-readable message about the deletion */
+    message: string;
 }
 /**
  * Nested serializer for Centrifugo WebSocket connection token.
@@ -325,6 +325,18 @@ interface OTPRequestRequest$1 {
     /** Source URL for tracking registration (e.g., https://my.djangocfg.com) */
     source_url?: string;
 }
+/**
+ * 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 request response.
  *
@@ -355,18 +367,6 @@ interface OTPVerifyResponse$1 {
     /** Whether user should be prompted to enable 2FA */
     should_prompt_2fa?: boolean;
 }
-/**
- * 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;
-}
 /**
  * Serializer for user details.
  *
@@ -1276,63 +1276,67 @@ declare class API$2 {
 }
 
 /**
- * Channel presence response.
+ * Channel history response.
  *
  * Response model (includes read-only fields).
  */
-interface CentrifugoPresenceResponse$1 {
+interface CentrifugoHistoryResponse$1 {
     error?: CentrifugoError$1 | null;
-    result?: CentrifugoPresenceResult$1 | null;
+    result?: CentrifugoHistoryResult$1 | null;
 }
 /**
- * Request to get channel presence.
+ * Request to get channel presence statistics.
  *
  * Request model (no read-only fields).
  */
-interface CentrifugoPresenceRequestRequest$1 {
+interface CentrifugoPresenceStatsRequestRequest$1 {
     /** Channel name */
     channel: string;
 }
 /**
- * Channel history response.
+ * Server info response.
  *
  * Response model (includes read-only fields).
  */
-interface CentrifugoHistoryResponse$1 {
+interface CentrifugoInfoResponse$1 {
     error?: CentrifugoError$1 | null;
-    result?: CentrifugoHistoryResult$1 | null;
+    result?: CentrifugoInfoResult$1 | null;
 }
 /**
- * Server info response.
+ * Channel presence response.
  *
  * Response model (includes read-only fields).
  */
-interface CentrifugoInfoResponse$1 {
+interface CentrifugoPresenceResponse$1 {
     error?: CentrifugoError$1 | null;
-    result?: CentrifugoInfoResult$1 | null;
+    result?: CentrifugoPresenceResult$1 | null;
 }
 /**
- * Request to get channel presence statistics.
+ * Channel presence stats response.
  *
- * Request model (no read-only fields).
+ * Response model (includes read-only fields).
  */
-interface CentrifugoPresenceStatsRequestRequest$1 {
-    /** Channel name */
-    channel: string;
+interface CentrifugoPresenceStatsResponse$1 {
+    error?: CentrifugoError$1 | null;
+    result?: CentrifugoPresenceStatsResult$1 | null;
 }
 /**
- * Request to get channel history.
+ * 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.
  *
  * Request model (no read-only fields).
  */
-interface CentrifugoHistoryRequestRequest$1 {
+interface CentrifugoPresenceRequestRequest$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 list active channels.
@@ -1344,22 +1348,18 @@ interface CentrifugoChannelsRequestRequest$1 {
     pattern?: string | null;
 }
 /**
- * List of active channels response.
- *
- * Response model (includes read-only fields).
- */
-interface CentrifugoChannelsResponse$1 {
-    error?: CentrifugoError$1 | null;
-    result?: CentrifugoChannelsResult$1 | null;
-}
-/**
- * Channel presence stats response.
+ * Request to get channel history.
  *
- * Response model (includes read-only fields).
+ * Request model (no read-only fields).
  */
-interface CentrifugoPresenceStatsResponse$1 {
-    error?: CentrifugoError$1 | null;
-    result?: CentrifugoPresenceStatsResult$1 | null;
+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;
 }
 /**
  * Centrifugo API error structure.
@@ -1372,15 +1372,6 @@ 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>;
-}
 /**
  * History result wrapper.
  *
@@ -1404,24 +1395,13 @@ interface CentrifugoInfoResult$1 {
     nodes: Array<CentrifugoNodeInfo$1>;
 }
 /**
- * Stream position for pagination.
- *
- * Response model (includes read-only fields).
- */
-interface CentrifugoStreamPosition$1 {
-    /** Stream offset */
-    offset: number;
-    /** Stream epoch */
-    epoch: string;
-}
-/**
- * Channels result wrapper.
+ * Presence result wrapper.
  *
  * Response model (includes read-only fields).
  */
-interface CentrifugoChannelsResult$1 {
-    /** Map of channel names to channel info */
-    channels: Record<string, CentrifugoChannelInfo$1>;
+interface CentrifugoPresenceResult$1 {
+    /** Map of client IDs to client info */
+    presence: Record<string, CentrifugoClientInfo$1>;
 }
 /**
  * Presence stats result.
@@ -1435,19 +1415,24 @@ interface CentrifugoPresenceStatsResult$1 {
     num_users: number;
 }
 /**
- * Information about connected client.
+ * Channels result wrapper.
  *
  * 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;
+interface CentrifugoChannelsResult$1 {
+    /** Map of channel names to channel info */
+    channels: Record<string, CentrifugoChannelInfo$1>;
+}
+/**
+ * Stream position for pagination.
+ *
+ * Response model (includes read-only fields).
+ */
+interface CentrifugoStreamPosition$1 {
+    /** Stream offset */
+    offset: number;
+    /** Stream epoch */
+    epoch: string;
 }
 /**
  * Single publication (message) in channel history.
@@ -1489,24 +1474,28 @@ interface CentrifugoNodeInfo$1 {
     process?: CentrifugoProcess$1 | null;
 }
 /**
- * Information about a single channel.
+ * Information about connected client.
  *
  * Response model (includes read-only fields).
  */
-interface CentrifugoChannelInfo$1 {
-    /** Number of connected clients in channel */
-    num_clients: 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;
 }
 /**
- * Server metrics.
+ * Information about a single channel.
  *
  * Response model (includes read-only fields).
  */
-interface CentrifugoMetrics$1 {
-    /** Metrics collection interval */
-    interval: number;
-    /** Metric name to value mapping */
-    items: Record<string, any>;
+interface CentrifugoChannelInfo$1 {
+    /** Number of connected clients in channel */
+    num_clients: number;
 }
 /**
  * Process information.
@@ -1519,6 +1508,17 @@ 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,14 +1598,15 @@ declare class CentrifugoAuth {
 }
 
 /**
- * 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;
 }
 /**
  *
@@ -1631,6 +1632,21 @@ interface PaginatedPublishList$1 {
     /** Array of items for current page */
     results: Array<Publish$1>;
 }
+/**
+ * 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.
  *
@@ -1655,42 +1671,35 @@ interface CentrifugoOverviewStats$1 {
     period_hours: 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;
-}
-/**
- * List of channel statistics.
+ * Timeline response with hourly/daily breakdown for DRF.
  *
  * Response model (includes read-only fields).
  */
-interface ChannelList$1 {
-    /** Channel statistics */
-    channels: Array<ChannelStats$1>;
-    /** Total number of channels */
-    total_channels: number;
+interface TimelineResponse$1 {
+    timeline: Array<TimelineItem$1>;
+    period_hours: number;
+    interval: string;
 }
 /**
- * Single timeline data point for DRF.
+ * Statistics per channel.
  *
  * Response model (includes read-only fields).
  */
-interface TimelineItem$1 {
-    timestamp: string;
-    count: number;
+interface ChannelStats$1 {
+    /** Channel name */
+    channel: string;
+    /** Total publishes to this channel */
+    total: number;
+    /** Successful publishes */
     successful: number;
+    /** Failed publishes */
     failed: number;
-    timeout: number;
+    /** Average duration */
+    avg_duration_ms: number;
+    /** Average ACKs received */
+    avg_acks: number;
+    /** Last activity timestamp (ISO format) */
+    last_activity_at: string | null;
 }
 /**
  * Single publish item for DRF pagination.
@@ -1711,25 +1720,16 @@ interface Publish$1 {
     error_message: string | null;
 }
 /**
- * Statistics per channel.
+ * Single timeline data point for DRF.
  *
  * Response model (includes read-only fields).
  */
-interface ChannelStats$1 {
-    /** Channel name */
-    channel: string;
-    /** Total publishes to this channel */
-    total: number;
-    /** Successful publishes */
+interface TimelineItem$1 {
+    timestamp: string;
+    count: number;
     successful: number;
-    /** Failed publishes */
     failed: number;
-    /** Average duration */
-    avg_duration_ms: number;
-    /** Average ACKs received */
-    avg_acks: number;
-    /** Last activity timestamp (ISO format) */
-    last_activity_at: string | null;
+    timeout: number;
 }
 
 /**
@@ -1783,25 +1783,6 @@ interface PublishTestRequestRequest$1 {
     /** ACK timeout in seconds */
     ack_timeout?: number;
 }
-/**
- * Response model for test message publishing.
- *
- * Response model (includes read-only fields).
- */
-interface PublishTestResponse$1 {
-    /** Whether publish succeeded */
-    success: boolean;
-    /** Unique message ID */
-    message_id: string;
-    /** Target channel */
-    channel: string;
-    /** Number of ACKs received */
-    acks_received?: number;
-    /** Whether message was delivered */
-    delivered?: boolean;
-    /** Error message if failed */
-    error?: string | null;
-}
 /**
  * Response model for manual ACK.
  *
@@ -1826,6 +1807,25 @@ interface ManualAckRequestRequest$1 {
     /** Client ID sending the ACK */
     client_id: string;
 }
+/**
+ * Response model for test message publishing.
+ *
+ * Response model (includes read-only fields).
+ */
+interface PublishTestResponse$1 {
+    /** Whether publish succeeded */
+    success: boolean;
+    /** Unique message ID */
+    message_id: string;
+    /** Target channel */
+    channel: string;
+    /** Number of ACKs received */
+    acks_received?: number;
+    /** Whether message was delivered */
+    delivered?: boolean;
+    /** Error message if failed */
+    error?: string | null;
+}
 
 /**
  * API endpoints for Centrifugo Testing.
@@ -3182,6 +3182,19 @@ declare class API$1 {
     getSchemaPath(): string;
 }
 
+/**
+ * Serializer for backup codes status.
+ *
+ * Response model (includes read-only fields).
+ */
+interface BackupCodesStatus$1 {
+    /** 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 regenerating backup codes.
  *
@@ -3202,19 +3215,6 @@ interface BackupCodesRegenerateResponse$1 {
     /** Warning about previous codes being invalidated */
     warning: string;
 }
-/**
- * Serializer for backup codes status.
- *
- * Response model (includes read-only fields).
- */
-interface BackupCodesStatus$1 {
-    /** 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;
-}
 
 /**
  * API endpoints for Backup Codes.
@@ -3244,15 +3244,6 @@ 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).
@@ -3277,6 +3268,15 @@ 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.
  *
@@ -3327,6 +3327,15 @@ declare class TotpManagement {
     totpDisableCreate(data: DisableRequest$1): Promise<any>;
 }
 
+/**
+ * Serializer for starting 2FA setup.
+ *
+ * Request model (no read-only fields).
+ */
+interface SetupRequest$1 {
+    /** Device name for identification (e.g., 'My iPhone') */
+    device_name?: string;
+}
 /**
  * Response serializer for setup confirmation.
  *
@@ -3339,6 +3348,17 @@ interface ConfirmSetupResponse$1 {
     /** Warning message about backup codes */
     backup_codes_warning: string;
 }
+/**
+ * Serializer for confirming 2FA setup with first code.
+ *
+ * Request model (no read-only fields).
+ */
+interface ConfirmSetupRequest$1 {
+    /** Device ID from setup response */
+    device_id: string;
+    /** 6-digit TOTP code from authenticator app */
+    code: string;
+}
 /**
  * Response serializer for setup initiation.
  *
@@ -3356,26 +3376,6 @@ interface SetupResponse$1 {
     /** Seconds until setup expires (typically 600 = 10 minutes) */
     expires_in: number;
 }
-/**
- * Serializer for starting 2FA setup.
- *
- * Request model (no read-only fields).
- */
-interface SetupRequest$1 {
-    /** Device name for identification (e.g., 'My iPhone') */
-    device_name?: string;
-}
-/**
- * Serializer for confirming 2FA setup with first code.
- *
- * Request model (no read-only fields).
- */
-interface ConfirmSetupRequest$1 {
-    /** Device ID from setup response */
-    device_id: string;
-    /** 6-digit TOTP code from authenticator app */
-    code: string;
-}
 
 /**
  * API endpoints for TOTP Setup.