@djangocfg/api 2.1.223 → 2.1.225

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@djangocfg/api",
3
- "version": "2.1.223",
3
+ "version": "2.1.225",
4
4
  "description": "Auto-generated TypeScript API client with React hooks, SWR integration, and Zod validation for Django REST Framework backends",
5
5
  "keywords": [
6
6
  "django",
@@ -84,7 +84,7 @@
84
84
  "devDependencies": {
85
85
  "@types/node": "^24.7.2",
86
86
  "@types/react": "^19.1.0",
87
- "@djangocfg/typescript-config": "^2.1.223",
87
+ "@djangocfg/typescript-config": "^2.1.225",
88
88
  "next": "^16.0.10",
89
89
  "react": "^19.1.0",
90
90
  "tsup": "^8.5.0",
@@ -2,6 +2,28 @@
2
2
  // Auto-generated by DjangoCFG - see CLAUDE.md
3
3
  import * as Enums from "../enums";
4
4
 
5
+ /**
6
+ * OTP verification response. When 2FA is required: - requires_2fa: True -
7
+ * session_id: UUID of 2FA verification session - refresh/access/user: null
8
+ * When 2FA is not required: - requires_2fa: False - session_id: null -
9
+ * refresh/access/user: populated
10
+ *
11
+ * Response model (includes read-only fields).
12
+ */
13
+ export interface OTPVerifyResponse {
14
+ /** Whether 2FA verification is required */
15
+ requires_2fa?: boolean;
16
+ /** 2FA session ID (if requires_2fa is True) */
17
+ session_id?: string | null;
18
+ /** JWT refresh token (if requires_2fa is False) */
19
+ refresh?: string | null;
20
+ /** JWT access token (if requires_2fa is False) */
21
+ access?: string | null;
22
+ user?: User | null;
23
+ /** Whether user should be prompted to enable 2FA */
24
+ should_prompt_2fa?: boolean;
25
+ }
26
+
5
27
  /**
6
28
  * Serializer for OTP request.
7
29
  *
@@ -30,25 +52,13 @@ export interface OTPRequestResponse {
30
52
  }
31
53
 
32
54
  /**
33
- * OTP verification response. When 2FA is required: - requires_2fa: True -
34
- * session_id: UUID of 2FA verification session - refresh/access/user: null
35
- * When 2FA is not required: - requires_2fa: False - session_id: null -
36
- * refresh/access/user: populated
55
+ * Error response for OTP operations.
37
56
  *
38
57
  * Response model (includes read-only fields).
39
58
  */
40
- export interface OTPVerifyResponse {
41
- /** Whether 2FA verification is required */
42
- requires_2fa?: boolean;
43
- /** 2FA session ID (if requires_2fa is True) */
44
- session_id?: string | null;
45
- /** JWT refresh token (if requires_2fa is False) */
46
- refresh?: string | null;
47
- /** JWT access token (if requires_2fa is False) */
48
- access?: string | null;
49
- user?: User | null;
50
- /** Whether user should be prompted to enable 2FA */
51
- should_prompt_2fa?: boolean;
59
+ export interface OTPErrorResponse {
60
+ /** Error message */
61
+ error: string;
52
62
  }
53
63
 
54
64
  /**
@@ -69,16 +79,6 @@ export interface OTPVerifyRequest {
69
79
  source_url?: string;
70
80
  }
71
81
 
72
- /**
73
- * Error response for OTP operations.
74
- *
75
- * Response model (includes read-only fields).
76
- */
77
- export interface OTPErrorResponse {
78
- /** Error message */
79
- error: string;
80
- }
81
-
82
82
  /**
83
83
  * Serializer for user details.
84
84
  *
@@ -2,18 +2,18 @@
2
2
  // Auto-generated by DjangoCFG - see CLAUDE.md
3
3
  /**
4
4
  *
5
- * Response model (includes read-only fields).
5
+ * Request model (no read-only fields).
6
6
  */
7
- export interface TokenRefresh {
8
- access: string;
7
+ export interface TokenRefreshRequest {
9
8
  refresh: string;
10
9
  }
11
10
 
12
11
  /**
13
12
  *
14
- * Request model (no read-only fields).
13
+ * Response model (includes read-only fields).
15
14
  */
16
- export interface TokenRefreshRequest {
15
+ export interface TokenRefresh {
16
+ access: string;
17
17
  refresh: string;
18
18
  }
19
19
 
@@ -2,6 +2,28 @@
2
2
  // Auto-generated by DjangoCFG - see CLAUDE.md
3
3
  import * as Enums from "../enums";
4
4
 
5
+ /**
6
+ * Request to start OAuth flow.
7
+ *
8
+ * Request model (no read-only fields).
9
+ */
10
+ export interface OAuthAuthorizeRequestRequest {
11
+ /** URL to redirect after OAuth authorization. If not provided, uses config's site_url + callback_path */
12
+ redirect_uri?: string;
13
+ /** Optional source URL for registration tracking */
14
+ source_url?: string;
15
+ }
16
+
17
+ /**
18
+ * Response with available OAuth providers.
19
+ *
20
+ * Response model (includes read-only fields).
21
+ */
22
+ export interface OAuthProvidersResponse {
23
+ /** List of available OAuth providers */
24
+ providers: Array<Record<string, any>>;
25
+ }
26
+
5
27
  /**
6
28
  * Error response for OAuth endpoints.
7
29
  *
@@ -29,37 +51,39 @@ export interface OAuthCallbackRequestRequest {
29
51
  }
30
52
 
31
53
  /**
32
- * Request to start OAuth flow.
33
- *
34
- * Request model (no read-only fields).
35
- */
36
- export interface OAuthAuthorizeRequestRequest {
37
- /** URL to redirect after OAuth authorization. If not provided, uses config's site_url + callback_path */
38
- redirect_uri?: string;
39
- /** Optional source URL for registration tracking */
40
- source_url?: string;
41
- }
42
-
43
- /**
44
- * Response with OAuth authorization URL.
54
+ * Serializer for OAuth connection info (user-facing).
45
55
  *
46
56
  * Response model (includes read-only fields).
47
57
  */
48
- export interface OAuthAuthorizeResponse {
49
- /** Full URL to redirect user to OAuth provider */
50
- authorization_url: string;
51
- /** State token for CSRF protection. Store this and verify on callback. */
52
- state: string;
58
+ export interface OAuthConnection {
59
+ id: number;
60
+ /** OAuth provider name (github, google, etc.)
61
+
62
+ * `github` - GitHub */
63
+ provider: Enums.OAuthConnectionProvider;
64
+ provider_display: string;
65
+ /** Username on the OAuth provider platform */
66
+ provider_username: string;
67
+ /** Email from OAuth provider (may differ from user.email) */
68
+ provider_email: string;
69
+ /** Avatar URL from OAuth provider */
70
+ provider_avatar_url: string;
71
+ /** When this OAuth connection was created */
72
+ connected_at: string;
73
+ /** Last time this OAuth connection was used for login */
74
+ last_login_at: string;
53
75
  }
54
76
 
55
77
  /**
56
- * Response with available OAuth providers.
78
+ * Request to disconnect OAuth provider.
57
79
  *
58
- * Response model (includes read-only fields).
80
+ * Request model (no read-only fields).
59
81
  */
60
- export interface OAuthProvidersResponse {
61
- /** List of available OAuth providers */
62
- providers: Array<Record<string, any>>;
82
+ export interface OAuthDisconnectRequestRequest {
83
+ /** OAuth provider to disconnect
84
+
85
+ * `github` - GitHub */
86
+ provider: Enums.OAuthConnectionProvider;
63
87
  }
64
88
 
65
89
  /**
@@ -90,38 +114,14 @@ export interface OAuthTokenResponse {
90
114
  }
91
115
 
92
116
  /**
93
- * Request to disconnect OAuth provider.
94
- *
95
- * Request model (no read-only fields).
96
- */
97
- export interface OAuthDisconnectRequestRequest {
98
- /** OAuth provider to disconnect
99
-
100
- * `github` - GitHub */
101
- provider: Enums.OAuthConnectionProvider;
102
- }
103
-
104
- /**
105
- * Serializer for OAuth connection info (user-facing).
117
+ * Response with OAuth authorization URL.
106
118
  *
107
119
  * Response model (includes read-only fields).
108
120
  */
109
- export interface OAuthConnection {
110
- id: number;
111
- /** OAuth provider name (github, google, etc.)
112
-
113
- * `github` - GitHub */
114
- provider: Enums.OAuthConnectionProvider;
115
- provider_display: string;
116
- /** Username on the OAuth provider platform */
117
- provider_username: string;
118
- /** Email from OAuth provider (may differ from user.email) */
119
- provider_email: string;
120
- /** Avatar URL from OAuth provider */
121
- provider_avatar_url: string;
122
- /** When this OAuth connection was created */
123
- connected_at: string;
124
- /** Last time this OAuth connection was used for login */
125
- last_login_at: string;
121
+ export interface OAuthAuthorizeResponse {
122
+ /** Full URL to redirect user to OAuth provider */
123
+ authorization_url: string;
124
+ /** State token for CSRF protection. Store this and verify on callback. */
125
+ state: string;
126
126
  }
127
127
 
@@ -45,6 +45,15 @@ export interface UserProfileUpdateRequest {
45
45
  language?: string;
46
46
  }
47
47
 
48
+ /**
49
+ *
50
+ * Request model (no read-only fields).
51
+ */
52
+ export interface CfgAccountsProfileAvatarCreateRequest {
53
+ /** Avatar image file (JPEG, PNG, GIF, WebP, max 5MB) */
54
+ avatar: File | Blob;
55
+ }
56
+
48
57
  /**
49
58
  * Response serializer for account deletion.
50
59
  *
@@ -71,15 +80,6 @@ export interface PatchedUserProfileUpdateRequest {
71
80
  language?: string;
72
81
  }
73
82
 
74
- /**
75
- *
76
- * Request model (no read-only fields).
77
- */
78
- export interface CfgAccountsProfileAvatarCreateRequest {
79
- /** Avatar image file (JPEG, PNG, GIF, WebP, max 5MB) */
80
- avatar: File | Blob;
81
- }
82
-
83
83
  /**
84
84
  * Nested serializer for Centrifugo WebSocket connection token.
85
85
  *
@@ -1,5 +1,20 @@
1
1
  // @ts-nocheck
2
2
  // Auto-generated by DjangoCFG - see CLAUDE.md
3
+ /**
4
+ * Request to get channel history.
5
+ *
6
+ * Request model (no read-only fields).
7
+ */
8
+ export interface CentrifugoHistoryRequestRequest {
9
+ /** Channel name */
10
+ channel: string;
11
+ /** Maximum number of messages to return */
12
+ limit?: number | null;
13
+ since?: CentrifugoStreamPosition | null;
14
+ /** Reverse message order (newest first) */
15
+ reverse?: boolean | null;
16
+ }
17
+
3
18
  /**
4
19
  * Request to get channel presence statistics.
5
20
  *
@@ -21,18 +36,13 @@ export interface CentrifugoInfoResponse {
21
36
  }
22
37
 
23
38
  /**
24
- * Request to get channel history.
39
+ * Channel presence stats response.
25
40
  *
26
- * Request model (no read-only fields).
41
+ * Response model (includes read-only fields).
27
42
  */
28
- export interface CentrifugoHistoryRequestRequest {
29
- /** Channel name */
30
- channel: string;
31
- /** Maximum number of messages to return */
32
- limit?: number | null;
33
- since?: CentrifugoStreamPosition | null;
34
- /** Reverse message order (newest first) */
35
- reverse?: boolean | null;
43
+ export interface CentrifugoPresenceStatsResponse {
44
+ error?: CentrifugoError | null;
45
+ result?: CentrifugoPresenceStatsResult | null;
36
46
  }
37
47
 
38
48
  /**
@@ -56,13 +66,13 @@ export interface CentrifugoPresenceResponse {
56
66
  }
57
67
 
58
68
  /**
59
- * Channel presence stats response.
69
+ * List of active channels response.
60
70
  *
61
71
  * Response model (includes read-only fields).
62
72
  */
63
- export interface CentrifugoPresenceStatsResponse {
73
+ export interface CentrifugoChannelsResponse {
64
74
  error?: CentrifugoError | null;
65
- result?: CentrifugoPresenceStatsResult | null;
75
+ result?: CentrifugoChannelsResult | null;
66
76
  }
67
77
 
68
78
  /**
@@ -75,16 +85,6 @@ export interface CentrifugoHistoryResponse {
75
85
  result?: CentrifugoHistoryResult | null;
76
86
  }
77
87
 
78
- /**
79
- * List of active channels response.
80
- *
81
- * Response model (includes read-only fields).
82
- */
83
- export interface CentrifugoChannelsResponse {
84
- error?: CentrifugoError | null;
85
- result?: CentrifugoChannelsResult | null;
86
- }
87
-
88
88
  /**
89
89
  * Request to get channel presence.
90
90
  *
@@ -96,13 +96,15 @@ export interface CentrifugoPresenceRequestRequest {
96
96
  }
97
97
 
98
98
  /**
99
- * Info result wrapper.
99
+ * Stream position for pagination.
100
100
  *
101
101
  * Response model (includes read-only fields).
102
102
  */
103
- export interface CentrifugoInfoResult {
104
- /** List of Centrifugo nodes */
105
- nodes: Array<CentrifugoNodeInfo>;
103
+ export interface CentrifugoStreamPosition {
104
+ /** Stream offset */
105
+ offset: number;
106
+ /** Stream epoch */
107
+ epoch: string;
106
108
  }
107
109
 
108
110
  /**
@@ -118,15 +120,25 @@ export interface CentrifugoError {
118
120
  }
119
121
 
120
122
  /**
121
- * Stream position for pagination.
123
+ * Info result wrapper.
122
124
  *
123
125
  * Response model (includes read-only fields).
124
126
  */
125
- export interface CentrifugoStreamPosition {
126
- /** Stream offset */
127
- offset: number;
128
- /** Stream epoch */
129
- epoch: string;
127
+ export interface CentrifugoInfoResult {
128
+ /** List of Centrifugo nodes */
129
+ nodes: Array<CentrifugoNodeInfo>;
130
+ }
131
+
132
+ /**
133
+ * Presence stats result.
134
+ *
135
+ * Response model (includes read-only fields).
136
+ */
137
+ export interface CentrifugoPresenceStatsResult {
138
+ /** Number of connected clients */
139
+ num_clients: number;
140
+ /** Number of unique users */
141
+ num_users: number;
130
142
  }
131
143
 
132
144
  /**
@@ -140,15 +152,13 @@ export interface CentrifugoPresenceResult {
140
152
  }
141
153
 
142
154
  /**
143
- * Presence stats result.
155
+ * Channels result wrapper.
144
156
  *
145
157
  * Response model (includes read-only fields).
146
158
  */
147
- export interface CentrifugoPresenceStatsResult {
148
- /** Number of connected clients */
149
- num_clients: number;
150
- /** Number of unique users */
151
- num_users: number;
159
+ export interface CentrifugoChannelsResult {
160
+ /** Map of channel names to channel info */
161
+ channels: Record<string, CentrifugoChannelInfo>;
152
162
  }
153
163
 
154
164
  /**
@@ -165,16 +175,6 @@ export interface CentrifugoHistoryResult {
165
175
  offset: number;
166
176
  }
167
177
 
168
- /**
169
- * Channels result wrapper.
170
- *
171
- * Response model (includes read-only fields).
172
- */
173
- export interface CentrifugoChannelsResult {
174
- /** Map of channel names to channel info */
175
- channels: Record<string, CentrifugoChannelInfo>;
176
- }
177
-
178
178
  /**
179
179
  * Information about a single Centrifugo node.
180
180
  *
@@ -217,6 +217,16 @@ export interface CentrifugoClientInfo {
217
217
  chan_info?: Record<string, any> | null;
218
218
  }
219
219
 
220
+ /**
221
+ * Information about a single channel.
222
+ *
223
+ * Response model (includes read-only fields).
224
+ */
225
+ export interface CentrifugoChannelInfo {
226
+ /** Number of connected clients in channel */
227
+ num_clients: number;
228
+ }
229
+
220
230
  /**
221
231
  * Single publication (message) in channel history.
222
232
  *
@@ -233,13 +243,15 @@ export interface CentrifugoPublication {
233
243
  }
234
244
 
235
245
  /**
236
- * Information about a single channel.
246
+ * Process information.
237
247
  *
238
248
  * Response model (includes read-only fields).
239
249
  */
240
- export interface CentrifugoChannelInfo {
241
- /** Number of connected clients in channel */
242
- num_clients: number;
250
+ export interface CentrifugoProcess {
251
+ /** CPU usage percentage */
252
+ cpu: number;
253
+ /** Resident set size in bytes */
254
+ rss: number;
243
255
  }
244
256
 
245
257
  /**
@@ -254,15 +266,3 @@ export interface CentrifugoMetrics {
254
266
  items: Record<string, any>;
255
267
  }
256
268
 
257
- /**
258
- * Process information.
259
- *
260
- * Response model (includes read-only fields).
261
- */
262
- export interface CentrifugoProcess {
263
- /** CPU usage percentage */
264
- cpu: number;
265
- /** Resident set size in bytes */
266
- rss: number;
267
- }
268
-
@@ -36,6 +36,30 @@ export interface TimelineResponse {
36
36
  interval: string;
37
37
  }
38
38
 
39
+ /**
40
+ * Overview statistics for Centrifugo publishes.
41
+ *
42
+ * Response model (includes read-only fields).
43
+ */
44
+ export interface CentrifugoOverviewStats {
45
+ /** Total publishes in period */
46
+ total: number;
47
+ /** Successful publishes */
48
+ successful: number;
49
+ /** Failed publishes */
50
+ failed: number;
51
+ /** Timeout publishes */
52
+ timeout: number;
53
+ /** Success rate percentage */
54
+ success_rate: number;
55
+ /** Average duration in milliseconds */
56
+ avg_duration_ms: number;
57
+ /** Average ACKs received */
58
+ avg_acks_received: number;
59
+ /** Statistics period in hours */
60
+ period_hours: number;
61
+ }
62
+
39
63
  /**
40
64
  * Health check response.
41
65
  *
@@ -64,30 +88,6 @@ export interface ChannelList {
64
88
  total_channels: number;
65
89
  }
66
90
 
67
- /**
68
- * Overview statistics for Centrifugo publishes.
69
- *
70
- * Response model (includes read-only fields).
71
- */
72
- export interface CentrifugoOverviewStats {
73
- /** Total publishes in period */
74
- total: number;
75
- /** Successful publishes */
76
- successful: number;
77
- /** Failed publishes */
78
- failed: number;
79
- /** Timeout publishes */
80
- timeout: number;
81
- /** Success rate percentage */
82
- success_rate: number;
83
- /** Average duration in milliseconds */
84
- avg_duration_ms: number;
85
- /** Average ACKs received */
86
- avg_acks_received: number;
87
- /** Statistics period in hours */
88
- period_hours: number;
89
- }
90
-
91
91
  /**
92
92
  * Single publish item for DRF pagination.
93
93
  *
@@ -1,5 +1,21 @@
1
1
  // @ts-nocheck
2
2
  // Auto-generated by DjangoCFG - see CLAUDE.md
3
+ /**
4
+ * Request model for test message publishing.
5
+ *
6
+ * Request model (no read-only fields).
7
+ */
8
+ export interface PublishTestRequestRequest {
9
+ /** Target channel name */
10
+ channel: string;
11
+ /** Message data (any JSON object) */
12
+ data: Record<string, any>;
13
+ /** Wait for client acknowledgment */
14
+ wait_for_ack?: boolean;
15
+ /** ACK timeout in seconds */
16
+ ack_timeout?: number;
17
+ }
18
+
3
19
  /**
4
20
  * Response model for test message publishing.
5
21
  *
@@ -20,20 +36,6 @@ export interface PublishTestResponse {
20
36
  error?: string | null;
21
37
  }
22
38
 
23
- /**
24
- * Response model for manual ACK.
25
- *
26
- * Response model (includes read-only fields).
27
- */
28
- export interface ManualAckResponse {
29
- /** Whether ACK was sent successfully */
30
- success: boolean;
31
- /** Message ID that was acknowledged */
32
- message_id: string;
33
- /** Error message if failed */
34
- error?: string | null;
35
- }
36
-
37
39
  /**
38
40
  * Request model for manual ACK sending.
39
41
  *
@@ -47,18 +49,16 @@ export interface ManualAckRequestRequest {
47
49
  }
48
50
 
49
51
  /**
50
- * Request model for test message publishing.
52
+ * Response model for manual ACK.
51
53
  *
52
- * Request model (no read-only fields).
54
+ * Response model (includes read-only fields).
53
55
  */
54
- export interface PublishTestRequestRequest {
55
- /** Target channel name */
56
- channel: string;
57
- /** Message data (any JSON object) */
58
- data: Record<string, any>;
59
- /** Wait for client acknowledgment */
60
- wait_for_ack?: boolean;
61
- /** ACK timeout in seconds */
62
- ack_timeout?: number;
56
+ export interface ManualAckResponse {
57
+ /** Whether ACK was sent successfully */
58
+ success: boolean;
59
+ /** Message ID that was acknowledged */
60
+ message_id: string;
61
+ /** Error message if failed */
62
+ error?: string | null;
63
63
  }
64
64
 
@@ -14,16 +14,6 @@ export interface BackupCodesStatus {
14
14
  warning?: string | null;
15
15
  }
16
16
 
17
- /**
18
- * Serializer for regenerating backup codes.
19
- *
20
- * Request model (no read-only fields).
21
- */
22
- export interface BackupCodesRegenerateRequest {
23
- /** TOTP code for verification */
24
- code: string;
25
- }
26
-
27
17
  /**
28
18
  * Response serializer for backup codes regeneration.
29
19
  *
@@ -36,3 +26,13 @@ export interface BackupCodesRegenerateResponse {
36
26
  warning: string;
37
27
  }
38
28
 
29
+ /**
30
+ * Serializer for regenerating backup codes.
31
+ *
32
+ * Request model (no read-only fields).
33
+ */
34
+ export interface BackupCodesRegenerateRequest {
35
+ /** TOTP code for verification */
36
+ code: string;
37
+ }
38
+