@djangocfg/api 2.1.226 → 2.1.228

package/dist/clients.d.cts

@@ -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;
 }
 
@@ -37,24 +37,22 @@ declare class Auth {
 declare enum OAuthConnectionProvider {
     GITHUB = "github"
 }
-/**
- * Delivery channel: 'email' or 'phone'. Auto-detected if not provided.
- * * `email` - Email
- * * `phone` - Phone
- */
-declare enum OTPRequestRequestChannel {
-    EMAIL = "email",
-    PHONE = "phone"
-}
 
 type enums_OAuthConnectionProvider = OAuthConnectionProvider;
 declare const enums_OAuthConnectionProvider: typeof OAuthConnectionProvider;
-type enums_OTPRequestRequestChannel = OTPRequestRequestChannel;
-declare const enums_OTPRequestRequestChannel: typeof OTPRequestRequestChannel;
 declare namespace enums {
-  export { enums_OAuthConnectionProvider as OAuthConnectionProvider, enums_OTPRequestRequestChannel as OTPRequestRequestChannel };
+  export { enums_OAuthConnectionProvider as OAuthConnectionProvider };
 }
 
+/**
+ * Response with available OAuth providers.
+ *
+ * Response model (includes read-only fields).
+ */
+interface OAuthProvidersResponse$1 {
+    /** List of available OAuth providers */
+    providers: Array<Record<string, any>>;
+}
 /**
  * Request to disconnect OAuth provider.
  *
@@ -66,17 +64,6 @@ interface OAuthDisconnectRequestRequest$1 {
     * `github` - GitHub */
     provider: OAuthConnectionProvider;
 }
-/**
- * Response with OAuth authorization URL.
- *
- * 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. */
-    state: string;
-}
 /**
  * Request to start OAuth flow.
  *
@@ -88,6 +75,30 @@ interface OAuthAuthorizeRequestRequest$1 {
     /** Optional source URL for registration tracking */
     source_url?: string;
 }
+/**
+ * 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 OAuth authorization URL.
+ *
+ * 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. */
+    state: string;
+}
 /**
  * Response with JWT tokens after OAuth authentication. When 2FA is required: -
  * requires_2fa: True - session_id: UUID of 2FA verification session -
@@ -114,28 +125,6 @@ interface OAuthTokenResponse$1 {
     /** True if user should be prompted to enable 2FA */
     should_prompt_2fa?: boolean;
 }
-/**
- * Response with available OAuth providers.
- *
- * 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) */
-    state: string;
-    /** Same redirect_uri used in authorize request. If not provided, uses config's site_url + callback_path */
-    redirect_uri?: string;
-}
 
 /**
  * API endpoints for Oauth.
@@ -177,6 +166,17 @@ 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,12 +191,17 @@ interface UserProfileUpdateRequest$1 {
     language?: string;
 }
 /**
+ * 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;
 }
 /**
  * Serializer for user details.
@@ -229,28 +234,12 @@ interface User$2 {
     centrifugo: CentrifugoToken$2 | null;
 }
 /**
- * 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;
-}
-/**
- * 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;
+interface CfgAccountsProfileAvatarCreateRequest$1 {
+    /** Avatar image file (JPEG, PNG, GIF, WebP, max 5MB) */
+    avatar: File | Blob;
 }
 /**
  * Nested serializer for Centrifugo WebSocket connection token.
@@ -331,16 +320,20 @@ declare class UserProfile {
  * Request model (no read-only fields).
  */
 interface OTPRequestRequest$1 {
-    /** Email address or phone number for OTP delivery */
+    /** Email address 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.
+ *
+ * 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
@@ -362,29 +355,15 @@ interface OTPVerifyResponse$1 {
     /** Whether user should be prompted to enable 2FA */
     should_prompt_2fa?: boolean;
 }
-/**
- * OTP request response.
- *
- * Response model (includes read-only fields).
- */
-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 */
+    /** Email address 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;
 }
@@ -441,7 +420,7 @@ declare class Accounts {
     private client;
     constructor(client: any);
     /**
-     * Request OTP code to email or phone.
+     * Request OTP code to email.
      */
     otpRequestCreate(data: OTPRequestRequest$1): Promise<OTPRequestResponse$1>;
     /**
@@ -795,14 +774,36 @@ type OAuthTokenResponse = z.infer<typeof OAuthTokenResponseSchema>;
  * Zod schema for OTPErrorResponse
  *
  * This schema provides runtime validation and type inference.
- *  * Error response for OTP operations.
+ *  * Typed error response for OTP operations.
+
+error_code values:
+  - invalid_identifier   — malformed email
+  - cooldown             — too soon after last request (retry_after = seconds)
+  - hourly_limit         — hourly quota exceeded   (retry_after = seconds until reset)
+  - daily_limit          — daily quota exceeded    (retry_after = seconds until reset)
+  - rate_limited         — IP-level rate limit hit (no retry_after)
+  - user_creation_failed — internal error creating account
+  - send_failed          — transport error (email / SMS)
+  - internal_error       — unexpected server error
  *  */
 
 /**
- * Error response for OTP operations.
+ * Typed error response for OTP operations.
+
+error_code values:
+  - invalid_identifier   — malformed email
+  - cooldown             — too soon after last request (retry_after = seconds)
+  - hourly_limit         — hourly quota exceeded   (retry_after = seconds until reset)
+  - daily_limit          — daily quota exceeded    (retry_after = seconds until reset)
+  - rate_limited         — IP-level rate limit hit (no retry_after)
+  - user_creation_failed — internal error creating account
+  - send_failed          — transport error (email / SMS)
+  - internal_error       — unexpected server error
  */
 declare const OTPErrorResponseSchema: z.ZodObject<{
     error: z.ZodString;
+    error_code: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    retry_after: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
 }, z.core.$strip>;
 /**
  * Infer TypeScript type from Zod schema
@@ -821,7 +822,6 @@ type OTPErrorResponse = z.infer<typeof OTPErrorResponseSchema>;
  */
 declare const OTPRequestRequestSchema: z.ZodObject<{
     identifier: z.ZodString;
-    channel: z.ZodOptional<z.ZodEnum<typeof OTPRequestRequestChannel>>;
     source_url: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 /**
@@ -860,7 +860,6 @@ type OTPRequestResponse = z.infer<typeof OTPRequestResponseSchema>;
 declare const OTPVerifyRequestSchema: z.ZodObject<{
     identifier: z.ZodString;
     otp: z.ZodString;
-    channel: z.ZodOptional<z.ZodEnum<typeof OTPRequestRequestChannel>>;
     source_url: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 /**
@@ -1276,15 +1275,6 @@ declare class API$2 {
     getSchemaPath(): string;
 }
 
-/**
- * Channel history response.
- *
- * Response model (includes read-only fields).
- */
-interface CentrifugoHistoryResponse$1 {
-    error?: CentrifugoError$1 | null;
-    result?: CentrifugoHistoryResult$1 | null;
-}
 /**
  * Channel presence response.
  *
@@ -1294,15 +1284,6 @@ interface CentrifugoPresenceResponse$1 {
     error?: CentrifugoError$1 | null;
     result?: CentrifugoPresenceResult$1 | null;
 }
-/**
- * Server info response.
- *
- * Response model (includes read-only fields).
- */
-interface CentrifugoInfoResponse$1 {
-    error?: CentrifugoError$1 | null;
-    result?: CentrifugoInfoResult$1 | null;
-}
 /**
  * Request to get channel presence.
  *
@@ -1313,13 +1294,22 @@ interface CentrifugoPresenceRequestRequest$1 {
     channel: string;
 }
 /**
- * List of active channels response.
+ * Channel history response.
  *
  * Response model (includes read-only fields).
  */
-interface CentrifugoChannelsResponse$1 {
+interface CentrifugoHistoryResponse$1 {
     error?: CentrifugoError$1 | null;
-    result?: CentrifugoChannelsResult$1 | null;
+    result?: CentrifugoHistoryResult$1 | null;
+}
+/**
+ * Server info response.
+ *
+ * Response model (includes read-only fields).
+ */
+interface CentrifugoInfoResponse$1 {
+    error?: CentrifugoError$1 | null;
+    result?: CentrifugoInfoResult$1 | null;
 }
 /**
  * Request to get channel presence statistics.
@@ -1354,26 +1344,22 @@ interface CentrifugoChannelsRequestRequest$1 {
     pattern?: string | 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;
 }
 /**
- * History result wrapper.
+ * Channel presence stats response.
  *
  * 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 CentrifugoPresenceStatsResponse$1 {
+    error?: CentrifugoError$1 | null;
+    result?: CentrifugoPresenceStatsResult$1 | null;
 }
 /**
  * Centrifugo API error structure.
@@ -1396,22 +1382,26 @@ interface CentrifugoPresenceResult$1 {
     presence: Record<string, CentrifugoClientInfo$1>;
 }
 /**
- * Info result wrapper.
+ * History result wrapper.
  *
  * Response model (includes read-only fields).
  */
-interface CentrifugoInfoResult$1 {
-    /** List of Centrifugo nodes */
-    nodes: Array<CentrifugoNodeInfo$1>;
+interface CentrifugoHistoryResult$1 {
+    /** List of publications */
+    publications: Array<CentrifugoPublication$1>;
+    /** Current stream epoch */
+    epoch: string;
+    /** Latest stream offset */
+    offset: number;
 }
 /**
- * Channels result wrapper.
+ * Info result wrapper.
  *
  * Response model (includes read-only fields).
  */
-interface CentrifugoChannelsResult$1 {
-    /** Map of channel names to channel info */
-    channels: Record<string, CentrifugoChannelInfo$1>;
+interface CentrifugoInfoResult$1 {
+    /** List of Centrifugo nodes */
+    nodes: Array<CentrifugoNodeInfo$1>;
 }
 /**
  * Stream position for pagination.
@@ -1424,6 +1414,15 @@ interface CentrifugoStreamPosition$1 {
     /** 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.
  *
@@ -1435,20 +1434,6 @@ interface CentrifugoPresenceStatsResult$1 {
     /** Number of unique users */
     num_users: number;
 }
-/**
- * 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 connected client.
  *
@@ -1464,6 +1449,20 @@ 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 Centrifugo node.
  *
@@ -1633,15 +1632,27 @@ interface PaginatedPublishList$1 {
     results: Array<Publish$1>;
 }
 /**
- * List of channel statistics.
+ * Overview statistics for Centrifugo publishes.
  *
  * Response model (includes read-only fields).
  */
-interface ChannelList$1 {
-    /** Channel statistics */
-    channels: Array<ChannelStats$1>;
-    /** Total number of channels */
-    total_channels: number;
+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.
@@ -1659,27 +1670,15 @@ interface CentrifugoHealthCheck$1 {
     timestamp: string;
 }
 /**
- * Overview statistics for Centrifugo publishes.
+ * List of channel statistics.
  *
  * 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;
+interface ChannelList$1 {
+    /** Channel statistics */
+    channels: Array<ChannelStats$1>;
+    /** Total number of channels */
+    total_channels: number;
 }
 /**
  * Single timeline data point for DRF.
@@ -1769,19 +1768,6 @@ 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.
  *
@@ -1816,6 +1802,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.
  *
@@ -3183,19 +3182,6 @@ 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.
  *
@@ -3216,6 +3202,19 @@ 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.
@@ -3357,6 +3356,15 @@ 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.
  *
@@ -3368,15 +3376,6 @@ interface ConfirmSetupRequest$1 {
     /** 6-digit TOTP code from authenticator app */
     code: string;
 }
-/**
- * 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;
-}
 
 /**
  * API endpoints for TOTP Setup.
@@ -3397,15 +3396,15 @@ declare class TotpSetup {
 }
 
 /**
- * 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;
 }
 /**
  * Response serializer for successful 2FA verification.
@@ -3425,15 +3424,15 @@ interface VerifyResponse$1 {
     warning?: string;
 }
 /**
- * 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;
 }
 /**
  * User data returned after 2FA verification.