@djangocfg/api 2.1.213 → 2.1.216

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,15 +56,17 @@ declare namespace enums {
 }
 
 /**
- * Request to disconnect OAuth provider.
+ * Request to complete OAuth flow (callback handler).
  *
  * Request model (no read-only fields).
  */
-interface OAuthDisconnectRequestRequest$1 {
-    /** OAuth provider to disconnect
-  
-    * `github` - GitHub */
-    provider: OAuthConnectionProvider;
+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.
@@ -89,17 +91,13 @@ interface OAuthAuthorizeResponse$1 {
     state: string;
 }
 /**
- * Request to complete OAuth flow (callback handler).
+ * Response with available OAuth providers.
  *
- * Request model (no read-only fields).
+ * Response model (includes 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;
+interface OAuthProvidersResponse$1 {
+    /** List of available OAuth providers */
+    providers: Array<Record<string, any>>;
 }
 /**
  * Response with JWT tokens after OAuth authentication. When 2FA is required: -
@@ -128,13 +126,15 @@ interface OAuthTokenResponse$1 {
     should_prompt_2fa?: boolean;
 }
 /**
- * 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;
 }
 
 /**
@@ -208,12 +208,17 @@ interface User$2 {
     centrifugo: CentrifugoToken$2 | null;
 }
 /**
+ * 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;
 }
 /**
  * Response serializer for account deletion.
@@ -231,7 +236,7 @@ interface AccountDeleteResponse$1 {
  *
  * Request model (no read-only fields).
  */
-interface UserProfileUpdateRequest$1 {
+interface PatchedUserProfileUpdateRequest$1 {
     first_name?: string;
     last_name?: string;
     company?: string;
@@ -240,17 +245,12 @@ 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;
 }
 /**
  * Nested serializer for Centrifugo WebSocket connection token.
@@ -350,23 +350,6 @@ interface OTPRequestResponse$1 {
     /** Success message */
     message: string;
 }
-/**
- * Serializer for OTP verification.
- *
- * Request model (no read-only fields).
- */
-interface OTPVerifyRequest$1 {
-    /** Email address or phone number used for OTP request */
-    identifier: string;
-    otp: string;
-    /** Delivery channel: 'email' or 'phone'. Auto-detected if not provided.
-  
-    * `email` - Email
-    * `phone` - Phone */
-    channel?: OTPRequestRequestChannel;
-    /** 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
@@ -388,6 +371,23 @@ 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 or phone number used for OTP request */
+    identifier: string;
+    otp: string;
+    /** Delivery channel: 'email' or 'phone'. Auto-detected if not provided.
+  
+    * `email` - Email
+    * `phone` - Phone */
+    channel?: OTPRequestRequestChannel;
+    /** Source URL for tracking login (e.g., https://my.djangocfg.com) */
+    source_url?: string;
+}
 /**
  * Serializer for user details.
  *
@@ -1196,6 +1196,8 @@ declare function partialUpdateAccountsProfileUpdatePartialUpdate(data?: PatchedU
 interface APIOptions$2 {
     /** Custom storage adapter (defaults to LocalStorageAdapter) */
     storage?: StorageAdapter$2;
+    /** Custom HTTP client adapter (defaults to FetchAdapter) */
+    httpClient?: HttpClientAdapter;
     /** Retry configuration for failed requests */
     retryConfig?: RetryConfig$2;
     /** Logger configuration */
@@ -1275,22 +1277,22 @@ declare class API$2 {
 }
 
 /**
- * Request to list active channels.
+ * Request to get channel presence statistics.
  *
  * Request model (no read-only fields).
  */
-interface CentrifugoChannelsRequestRequest$1 {
-    /** Pattern to filter channels (e.g., 'user:*') */
-    pattern?: string | null;
+interface CentrifugoPresenceStatsRequestRequest$1 {
+    /** Channel name */
+    channel: string;
 }
 /**
- * List of active channels response.
+ * Server info response.
  *
  * Response model (includes read-only fields).
  */
-interface CentrifugoChannelsResponse$1 {
+interface CentrifugoInfoResponse$1 {
     error?: CentrifugoError$1 | null;
-    result?: CentrifugoChannelsResult$1 | null;
+    result?: CentrifugoInfoResult$1 | null;
 }
 /**
  * Request to get channel history.
@@ -1307,58 +1309,67 @@ interface CentrifugoHistoryRequestRequest$1 {
     reverse?: boolean | null;
 }
 /**
- * Channel history response.
+ * 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 response.
  *
  * Response model (includes read-only fields).
  */
-interface CentrifugoHistoryResponse$1 {
+interface CentrifugoPresenceResponse$1 {
     error?: CentrifugoError$1 | null;
-    result?: CentrifugoHistoryResult$1 | null;
+    result?: CentrifugoPresenceResult$1 | null;
 }
 /**
- * Server info response.
+ * Channel presence stats response.
  *
  * Response model (includes read-only fields).
  */
-interface CentrifugoInfoResponse$1 {
+interface CentrifugoPresenceStatsResponse$1 {
     error?: CentrifugoError$1 | null;
-    result?: CentrifugoInfoResult$1 | null;
+    result?: CentrifugoPresenceStatsResult$1 | null;
 }
 /**
- * Request to get channel presence.
+ * Channel history response.
  *
- * Request model (no read-only fields).
+ * Response model (includes read-only fields).
  */
-interface CentrifugoPresenceRequestRequest$1 {
-    /** Channel name */
-    channel: string;
+interface CentrifugoHistoryResponse$1 {
+    error?: CentrifugoError$1 | null;
+    result?: CentrifugoHistoryResult$1 | null;
 }
 /**
- * Channel presence response.
+ * List of active channels response.
  *
  * Response model (includes read-only fields).
  */
-interface CentrifugoPresenceResponse$1 {
+interface CentrifugoChannelsResponse$1 {
     error?: CentrifugoError$1 | null;
-    result?: CentrifugoPresenceResult$1 | null;
+    result?: CentrifugoChannelsResult$1 | null;
 }
 /**
- * Request to get channel presence statistics.
+ * Request to get channel presence.
  *
  * Request model (no read-only fields).
  */
-interface CentrifugoPresenceStatsRequestRequest$1 {
+interface CentrifugoPresenceRequestRequest$1 {
     /** Channel name */
     channel: string;
 }
 /**
- * Channel presence stats response.
+ * Info result wrapper.
  *
  * Response model (includes read-only fields).
  */
-interface CentrifugoPresenceStatsResponse$1 {
-    error?: CentrifugoError$1 | null;
-    result?: CentrifugoPresenceStatsResult$1 | null;
+interface CentrifugoInfoResult$1 {
+    /** List of Centrifugo nodes */
+    nodes: Array<CentrifugoNodeInfo$1>;
 }
 /**
  * Centrifugo API error structure.
@@ -1371,15 +1382,6 @@ interface CentrifugoError$1 {
     /** Error message */
     message?: string;
 }
-/**
- * Channels result wrapper.
- *
- * Response model (includes read-only fields).
- */
-interface CentrifugoChannelsResult$1 {
-    /** Map of channel names to channel info */
-    channels: Record<string, CentrifugoChannelInfo$1>;
-}
 /**
  * Stream position for pagination.
  *
@@ -1391,28 +1393,6 @@ interface CentrifugoStreamPosition$1 {
     /** Stream epoch */
     epoch: string;
 }
-/**
- * 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;
-}
-/**
- * Info result wrapper.
- *
- * Response model (includes read-only fields).
- */
-interface CentrifugoInfoResult$1 {
-    /** List of Centrifugo nodes */
-    nodes: Array<CentrifugoNodeInfo$1>;
-}
 /**
  * Presence result wrapper.
  *
@@ -1434,27 +1414,26 @@ interface CentrifugoPresenceStatsResult$1 {
     num_users: number;
 }
 /**
- * Information about a single channel.
+ * History result wrapper.
  *
  * Response model (includes read-only fields).
  */
-interface CentrifugoChannelInfo$1 {
-    /** Number of connected clients in channel */
-    num_clients: number;
+interface CentrifugoHistoryResult$1 {
+    /** List of publications */
+    publications: Array<CentrifugoPublication$1>;
+    /** Current stream epoch */
+    epoch: string;
+    /** Latest stream offset */
+    offset: number;
 }
 /**
- * Single publication (message) in channel history.
+ * Channels result wrapper.
  *
  * 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 CentrifugoChannelsResult$1 {
+    /** Map of channel names to channel info */
+    channels: Record<string, CentrifugoChannelInfo$1>;
 }
 /**
  * Information about a single Centrifugo node.
@@ -1496,6 +1475,29 @@ interface CentrifugoClientInfo$1 {
     /** Channel-specific metadata */
     chan_info?: Record<string, any> | null;
 }
+/**
+ * Single publication (message) in channel history.
+ *
+ * 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;
+}
+/**
+ * Information about a single channel.
+ *
+ * Response model (includes read-only fields).
+ */
+interface CentrifugoChannelInfo$1 {
+    /** Number of connected clients in channel */
+    num_clients: number;
+}
 /**
  * Server metrics.
  *
@@ -1596,55 +1598,6 @@ declare class CentrifugoAuth {
     tokenRetrieve(): Promise<ConnectionTokenResponse$1>;
 }
 
-/**
- * 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;
-}
-/**
- * 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.
- *
- * 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;
-}
 /**
  *
  * Response model (includes read-only fields).
@@ -1680,25 +1633,53 @@ interface TimelineResponse$1 {
     interval: string;
 }
 /**
- * Statistics per channel.
+ * Health check response.
  *
  * Response model (includes read-only fields).
  */
-interface ChannelStats$1 {
-    /** Channel name */
-    channel: string;
-    /** Total publishes to this channel */
+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.
+ *
+ * Response model (includes read-only fields).
+ */
+interface ChannelList$1 {
+    /** Channel statistics */
+    channels: Array<ChannelStats$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;
-    /** Average duration */
+    /** Timeout publishes */
+    timeout: number;
+    /** Success rate percentage */
+    success_rate: number;
+    /** Average duration in milliseconds */
     avg_duration_ms: number;
     /** Average ACKs received */
-    avg_acks: number;
-    /** Last activity timestamp (ISO format) */
-    last_activity_at: string | null;
+    avg_acks_received: number;
+    /** Statistics period in hours */
+    period_hours: number;
 }
 /**
  * Single publish item for DRF pagination.
@@ -1730,6 +1711,27 @@ interface TimelineItem$1 {
     failed: number;
     timeout: number;
 }
+/**
+ * Statistics per channel.
+ *
+ * Response model (includes read-only fields).
+ */
+interface ChannelStats$1 {
+    /** Channel name */
+    channel: string;
+    /** Total publishes to this channel */
+    total: number;
+    /** Successful publishes */
+    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;
+}
 
 /**
  * API endpoints for Centrifugo Monitoring.
@@ -1737,10 +1739,10 @@ interface TimelineItem$1 {
 declare class CentrifugoMonitoring {
     private client;
     constructor(client: any);
-    centrifugoMonitorChannelsRetrieve(hours?: number): Promise<ChannelList$1[]>;
+    centrifugoMonitorChannelsRetrieve(hours?: number): Promise<ChannelList$1>;
     centrifugoMonitorChannelsRetrieve(params?: {
         hours?: number;
-    }): Promise<ChannelList$1[]>;
+    }): Promise<ChannelList$1>;
     /**
      * Get Centrifugo health status
      *
@@ -1767,21 +1769,6 @@ 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.
  *
@@ -1801,6 +1788,19 @@ 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,17 +1813,19 @@ interface ManualAckRequestRequest$1 {
     client_id: string;
 }
 /**
- * Response model for manual ACK.
+ * Request model for test message publishing.
  *
- * Response model (includes read-only fields).
+ * Request model (no 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;
+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;
 }
 
 /**
@@ -3101,6 +3103,8 @@ declare namespace index$4 {
 interface APIOptions$1 {
     /** Custom storage adapter (defaults to LocalStorageAdapter) */
     storage?: StorageAdapter$1;
+    /** Custom HTTP client adapter (defaults to FetchAdapter) */
+    httpClient?: HttpClientAdapter;
     /** Retry configuration for failed requests */
     retryConfig?: RetryConfig$1;
     /** Logger configuration */
@@ -3325,13 +3329,27 @@ declare class TotpManagement {
 }
 
 /**
- * Serializer for starting 2FA setup.
+ * 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 confirming 2FA setup with first code.
  *
  * Request model (no read-only fields).
  */
-interface SetupRequest$1 {
-    /** Device name for identification (e.g., 'My iPhone') */
-    device_name?: string;
+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.
@@ -3351,27 +3369,13 @@ interface SetupResponse$1 {
     expires_in: number;
 }
 /**
- * Serializer for confirming 2FA setup with first code.
+ * Serializer for starting 2FA setup.
  *
  * 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 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;
+interface SetupRequest$1 {
+    /** Device name for identification (e.g., 'My iPhone') */
+    device_name?: string;
 }
 
 /**
@@ -3403,6 +3407,17 @@ interface VerifyRequest$1 {
     /** 6-digit TOTP code from authenticator app */
     code: string;
 }
+/**
+ * Serializer for backup code verification during login.
+ *
+ * Request model (no read-only fields).
+ */
+interface VerifyBackupRequest$1 {
+    /** 2FA session ID from login response */
+    session_id: string;
+    /** 8-character backup recovery code */
+    backup_code: string;
+}
 /**
  * Response serializer for successful 2FA verification.
  *
@@ -3420,17 +3435,6 @@ interface VerifyResponse$1 {
     /** Warning message (e.g., low backup codes) */
     warning?: string;
 }
-/**
- * Serializer for backup code verification during login.
- *
- * Request model (no read-only fields).
- */
-interface VerifyBackupRequest$1 {
-    /** 2FA session ID from login response */
-    session_id: string;
-    /** 8-character backup recovery code */
-    backup_code: string;
-}
 /**
  * User data returned after 2FA verification.
  *
@@ -4133,6 +4137,8 @@ declare namespace index$2 {
 interface APIOptions {
     /** Custom storage adapter (defaults to LocalStorageAdapter) */
     storage?: StorageAdapter;
+    /** Custom HTTP client adapter (defaults to FetchAdapter) */
+    httpClient?: HttpClientAdapter;
     /** Retry configuration for failed requests */
     retryConfig?: RetryConfig;
     /** Logger configuration */