@djangocfg/api 2.1.228 → 2.1.230

package/dist/clients.d.cts

@@ -45,13 +45,15 @@ declare namespace enums {
 }
 
 /**
- * Response with available OAuth providers.
+ * Request to start OAuth flow.
  *
- * 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 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 disconnect OAuth provider.
@@ -65,15 +67,13 @@ interface OAuthDisconnectRequestRequest$1 {
     provider: OAuthConnectionProvider;
 }
 /**
- * Request to start OAuth flow.
+ * Response with available OAuth providers.
  *
- * Request model (no read-only fields).
+ * Response model (includes 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 OAuthProvidersResponse$1 {
+    /** List of available OAuth providers */
+    providers: Array<Record<string, any>>;
 }
 /**
  * Request to complete OAuth flow (callback handler).
@@ -166,17 +166,6 @@ 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.
  *
@@ -191,17 +180,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;
 }
 /**
  * Serializer for user details.
@@ -234,12 +218,28 @@ 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 PatchedUserProfileUpdateRequest$1 {
+    first_name?: string;
+    last_name?: string;
+    company?: string;
+    phone?: string;
+    position?: string;
+    language?: string;
+}
+/**
+ * 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;
 }
 /**
  * Nested serializer for Centrifugo WebSocket connection token.
@@ -314,26 +314,6 @@ 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 for OTP delivery */
-    identifier: string;
-    /** Source URL for tracking registration (e.g., https://my.djangocfg.com) */
-    source_url?: string;
-}
-/**
- * OTP request response.
- *
- * Response model (includes read-only fields).
- */
-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
@@ -367,6 +347,26 @@ interface OTPVerifyRequest$1 {
     /** Source URL for tracking login (e.g., https://my.djangocfg.com) */
     source_url?: string;
 }
+/**
+ * Serializer for OTP request.
+ *
+ * Request model (no read-only fields).
+ */
+interface OTPRequestRequest$1 {
+    /** Email address for OTP delivery */
+    identifier: string;
+    /** Source URL for tracking registration (e.g., https://my.djangocfg.com) */
+    source_url?: string;
+}
+/**
+ * OTP request response.
+ *
+ * Response model (includes read-only fields).
+ */
+interface OTPRequestResponse$1 {
+    /** Success message */
+    message: string;
+}
 /**
  * Serializer for user details.
  *
@@ -1275,6 +1275,29 @@ 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 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.
  *
@@ -1285,22 +1308,31 @@ interface CentrifugoPresenceResponse$1 {
     result?: CentrifugoPresenceResult$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.
+ * Channel presence stats response.
  *
  * Response model (includes read-only fields).
  */
-interface CentrifugoHistoryResponse$1 {
+interface CentrifugoPresenceStatsResponse$1 {
     error?: CentrifugoError$1 | null;
-    result?: CentrifugoHistoryResult$1 | null;
+    result?: CentrifugoPresenceStatsResult$1 | null;
+}
+/**
+ * List of active channels response.
+ *
+ * Response model (includes read-only fields).
+ */
+interface CentrifugoChannelsResponse$1 {
+    error?: CentrifugoError$1 | null;
+    result?: CentrifugoChannelsResult$1 | null;
 }
 /**
  * Server info response.
@@ -1312,54 +1344,42 @@ interface CentrifugoInfoResponse$1 {
     result?: CentrifugoInfoResult$1 | null;
 }
 /**
- * Request to get channel presence statistics.
+ * Channel history response.
  *
- * Request model (no read-only fields).
+ * Response model (includes read-only fields).
  */
-interface CentrifugoPresenceStatsRequestRequest$1 {
-    /** Channel name */
-    channel: string;
+interface CentrifugoHistoryResponse$1 {
+    error?: CentrifugoError$1 | null;
+    result?: CentrifugoHistoryResult$1 | null;
 }
 /**
- * Request to get channel history.
+ * 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.
- *
- * Request model (no read-only fields).
- */
-interface CentrifugoChannelsRequestRequest$1 {
-    /** Pattern to filter channels (e.g., 'user:*') */
-    pattern?: string | null;
-}
-/**
- * List of active channels response.
+ * Stream position for pagination.
  *
  * Response model (includes read-only fields).
  */
-interface CentrifugoChannelsResponse$1 {
-    error?: CentrifugoError$1 | null;
-    result?: CentrifugoChannelsResult$1 | null;
+interface CentrifugoStreamPosition$1 {
+    /** Stream offset */
+    offset: number;
+    /** Stream epoch */
+    epoch: string;
 }
 /**
- * Channel presence stats response.
+ * Presence result wrapper.
  *
  * Response model (includes read-only fields).
  */
-interface CentrifugoPresenceStatsResponse$1 {
-    error?: CentrifugoError$1 | null;
-    result?: CentrifugoPresenceStatsResult$1 | null;
+interface CentrifugoPresenceResult$1 {
+    /** Map of client IDs to client info */
+    presence: Record<string, CentrifugoClientInfo$1>;
 }
 /**
  * Centrifugo API error structure.
@@ -1373,26 +1393,24 @@ interface CentrifugoError$1 {
     message?: string;
 }
 /**
- * Presence result wrapper.
+ * 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;
 }
 /**
- * History result wrapper.
+ * Channels 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;
+interface CentrifugoChannelsResult$1 {
+    /** Map of channel names to channel info */
+    channels: Record<string, CentrifugoChannelInfo$1>;
 }
 /**
  * Info result wrapper.
@@ -1404,35 +1422,17 @@ interface CentrifugoInfoResult$1 {
     nodes: Array<CentrifugoNodeInfo$1>;
 }
 /**
- * Stream position for pagination.
+ * History result wrapper.
  *
  * Response model (includes read-only fields).
  */
-interface CentrifugoStreamPosition$1 {
-    /** Stream offset */
-    offset: number;
-    /** Stream epoch */
+interface CentrifugoHistoryResult$1 {
+    /** List of publications */
+    publications: Array<CentrifugoPublication$1>;
+    /** Current stream epoch */
     epoch: 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>;
-}
-/**
- * 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;
+    /** Latest stream offset */
+    offset: number;
 }
 /**
  * Information about connected client.
@@ -1450,18 +1450,13 @@ interface CentrifugoClientInfo$1 {
     chan_info?: Record<string, any> | null;
 }
 /**
- * Single publication (message) in channel history.
+ * Information about a single channel.
  *
  * 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 CentrifugoChannelInfo$1 {
+    /** Number of connected clients in channel */
+    num_clients: number;
 }
 /**
  * Information about a single Centrifugo node.
@@ -1489,24 +1484,18 @@ interface CentrifugoNodeInfo$1 {
     process?: CentrifugoProcess$1 | 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.
+ * Single publication (message) in channel history.
  *
  * Response model (includes read-only fields).
  */
-interface CentrifugoMetrics$1 {
-    /** Metrics collection interval */
-    interval: number;
-    /** Metric name to value mapping */
-    items: Record<string, any>;
+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;
 }
 /**
  * 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.
@@ -1607,6 +1607,21 @@ interface TimelineResponse$1 {
     period_hours: number;
     interval: string;
 }
+/**
+ * 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;
+}
 /**
  *
  * Response model (includes read-only fields).
@@ -1631,6 +1646,17 @@ interface PaginatedPublishList$1 {
     /** Array of items for current page */
     results: Array<Publish$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;
+}
 /**
  * Overview statistics for Centrifugo publishes.
  *
@@ -1654,32 +1680,6 @@ interface CentrifugoOverviewStats$1 {
     /** Statistics period in hours */
     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.
- *
- * Response model (includes read-only fields).
- */
-interface ChannelList$1 {
-    /** Channel statistics */
-    channels: Array<ChannelStats$1>;
-    /** Total number of channels */
-    total_channels: number;
-}
 /**
  * Single timeline data point for DRF.
  *
@@ -1768,21 +1768,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.
  *
@@ -1826,6 +1811,21 @@ interface ManualAckRequestRequest$1 {
     /** Client ID sending the ACK */
     client_id: string;
 }
+/**
+ * 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;
+}
 
 /**
  * API endpoints for Centrifugo Testing.
@@ -3182,15 +3182,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.
  *
@@ -3202,6 +3193,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;
+}
 /**
  * Serializer for backup codes status.
  *
@@ -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.
  *
@@ -3328,16 +3328,15 @@ declare class TotpManagement {
 }
 
 /**
- * Response serializer for setup confirmation.
+ * Serializer for confirming 2FA setup with first code.
  *
- * Response model (includes read-only fields).
+ * Request model (no 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 ConfirmSetupRequest$1 {
+    /** Device ID from setup response */
+    device_id: string;
+    /** 6-digit TOTP code from authenticator app */
+    code: string;
 }
 /**
  * Response serializer for setup initiation.
@@ -3366,15 +3365,16 @@ interface SetupRequest$1 {
     device_name?: string;
 }
 /**
- * Serializer for confirming 2FA setup with first code.
+ * Response serializer for setup confirmation.
  *
- * Request model (no read-only fields).
+ * Response model (includes read-only fields).
  */
-interface ConfirmSetupRequest$1 {
-    /** Device ID from setup response */
-    device_id: string;
-    /** 6-digit TOTP code from authenticator app */
-    code: string;
+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;
 }
 
 /**
@@ -3395,6 +3395,17 @@ 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.
  *
@@ -3423,17 +3434,6 @@ 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.
  *