@djangocfg/api 2.1.228 → 2.1.229

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.228",
3
+ "version": "2.1.229",
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.228",
87
+ "@djangocfg/typescript-config": "^2.1.229",
88
88
  "next": "^16.0.10",
89
89
  "react": "^19.1.0",
90
90
  "tsup": "^8.5.0",
@@ -12,6 +12,29 @@ export interface OTPRequestRequest {
12
12
  source_url?: string;
13
13
  }
14
14
 
15
+ /**
16
+ * Serializer for OTP verification.
17
+ *
18
+ * Request model (no read-only fields).
19
+ */
20
+ export interface OTPVerifyRequest {
21
+ /** Email address used for OTP request */
22
+ identifier: string;
23
+ otp: string;
24
+ /** Source URL for tracking login (e.g., https://my.djangocfg.com) */
25
+ source_url?: string;
26
+ }
27
+
28
+ /**
29
+ * OTP request response.
30
+ *
31
+ * Response model (includes read-only fields).
32
+ */
33
+ export interface OTPRequestResponse {
34
+ /** Success message */
35
+ message: string;
36
+ }
37
+
15
38
  /**
16
39
  * Typed error response for OTP operations. error_code values: -
17
40
  * invalid_identifier — malformed email - cooldown — too soon after last
@@ -33,16 +56,6 @@ export interface OTPErrorResponse {
33
56
  retry_after?: number | null;
34
57
  }
35
58
 
36
- /**
37
- * OTP request response.
38
- *
39
- * Response model (includes read-only fields).
40
- */
41
- export interface OTPRequestResponse {
42
- /** Success message */
43
- message: string;
44
- }
45
-
46
59
  /**
47
60
  * OTP verification response. When 2FA is required: - requires_2fa: True -
48
61
  * session_id: UUID of 2FA verification session - refresh/access/user: null
@@ -65,19 +78,6 @@ export interface OTPVerifyResponse {
65
78
  should_prompt_2fa?: boolean;
66
79
  }
67
80
 
68
- /**
69
- * Serializer for OTP verification.
70
- *
71
- * Request model (no read-only fields).
72
- */
73
- export interface OTPVerifyRequest {
74
- /** Email address used for OTP request */
75
- identifier: string;
76
- otp: string;
77
- /** Source URL for tracking login (e.g., https://my.djangocfg.com) */
78
- source_url?: string;
79
- }
80
-
81
81
  /**
82
82
  * Serializer for user details.
83
83
  *
@@ -2,18 +2,18 @@
2
2
  // Auto-generated by DjangoCFG - see CLAUDE.md
3
3
  /**
4
4
  *
5
- * Request model (no read-only fields).
5
+ * Response model (includes read-only fields).
6
6
  */
7
- export interface TokenRefreshRequest {
7
+ export interface TokenRefresh {
8
+ access: string;
8
9
  refresh: string;
9
10
  }
10
11
 
11
12
  /**
12
13
  *
13
- * Response model (includes read-only fields).
14
+ * Request model (no read-only fields).
14
15
  */
15
- export interface TokenRefresh {
16
- access: string;
16
+ export interface TokenRefreshRequest {
17
17
  refresh: string;
18
18
  }
19
19
 
@@ -3,25 +3,15 @@
3
3
  import * as Enums from "../enums";
4
4
 
5
5
  /**
6
- * Response with available OAuth providers.
6
+ * Response with OAuth authorization URL.
7
7
  *
8
8
  * Response model (includes read-only fields).
9
9
  */
10
- export interface OAuthProvidersResponse {
11
- /** List of available OAuth providers */
12
- providers: Array<Record<string, any>>;
13
- }
14
-
15
- /**
16
- * Request to disconnect OAuth provider.
17
- *
18
- * Request model (no read-only fields).
19
- */
20
- export interface OAuthDisconnectRequestRequest {
21
- /** OAuth provider to disconnect
22
-
23
- * `github` - GitHub */
24
- provider: Enums.OAuthConnectionProvider;
10
+ export interface OAuthAuthorizeResponse {
11
+ /** Full URL to redirect user to OAuth provider */
12
+ authorization_url: string;
13
+ /** State token for CSRF protection. Store this and verify on callback. */
14
+ state: string;
25
15
  }
26
16
 
27
17
  /**
@@ -36,6 +26,33 @@ export interface OAuthError {
36
26
  error_description?: string;
37
27
  }
38
28
 
29
+ /**
30
+ * Response with JWT tokens after OAuth authentication. When 2FA is required: -
31
+ * requires_2fa: True - session_id: UUID of 2FA verification session -
32
+ * access/refresh/user: null When 2FA is not required: - requires_2fa: False -
33
+ * session_id: null - access/refresh/user: populated
34
+ *
35
+ * Response model (includes read-only fields).
36
+ */
37
+ export interface OAuthTokenResponse {
38
+ /** True if 2FA verification is required */
39
+ requires_2fa?: boolean;
40
+ /** 2FA session ID (only when requires_2fa=True) */
41
+ session_id?: string | null;
42
+ /** JWT access token (null when requires_2fa=True) */
43
+ access?: string | null;
44
+ /** JWT refresh token (null when requires_2fa=True) */
45
+ refresh?: string | null;
46
+ /** Authenticated user info (null when requires_2fa=True) */
47
+ user?: Record<string, any> | null;
48
+ /** True if a new user was created during this OAuth flow */
49
+ is_new_user: boolean;
50
+ /** True if a new OAuth connection was created */
51
+ is_new_connection: boolean;
52
+ /** True if user should be prompted to enable 2FA */
53
+ should_prompt_2fa?: boolean;
54
+ }
55
+
39
56
  /**
40
57
  * Request to start OAuth flow.
41
58
  *
@@ -63,42 +80,25 @@ export interface OAuthCallbackRequestRequest {
63
80
  }
64
81
 
65
82
  /**
66
- * Response with OAuth authorization URL.
83
+ * Request to disconnect OAuth provider.
67
84
  *
68
- * Response model (includes read-only fields).
85
+ * Request model (no read-only fields).
69
86
  */
70
- export interface OAuthAuthorizeResponse {
71
- /** Full URL to redirect user to OAuth provider */
72
- authorization_url: string;
73
- /** State token for CSRF protection. Store this and verify on callback. */
74
- state: string;
87
+ export interface OAuthDisconnectRequestRequest {
88
+ /** OAuth provider to disconnect
89
+
90
+ * `github` - GitHub */
91
+ provider: Enums.OAuthConnectionProvider;
75
92
  }
76
93
 
77
94
  /**
78
- * Response with JWT tokens after OAuth authentication. When 2FA is required: -
79
- * requires_2fa: True - session_id: UUID of 2FA verification session -
80
- * access/refresh/user: null When 2FA is not required: - requires_2fa: False -
81
- * session_id: null - access/refresh/user: populated
95
+ * Response with available OAuth providers.
82
96
  *
83
97
  * Response model (includes read-only fields).
84
98
  */
85
- export interface OAuthTokenResponse {
86
- /** True if 2FA verification is required */
87
- requires_2fa?: boolean;
88
- /** 2FA session ID (only when requires_2fa=True) */
89
- session_id?: string | null;
90
- /** JWT access token (null when requires_2fa=True) */
91
- access?: string | null;
92
- /** JWT refresh token (null when requires_2fa=True) */
93
- refresh?: string | null;
94
- /** Authenticated user info (null when requires_2fa=True) */
95
- user?: Record<string, any> | null;
96
- /** True if a new user was created during this OAuth flow */
97
- is_new_user: boolean;
98
- /** True if a new OAuth connection was created */
99
- is_new_connection: boolean;
100
- /** True if user should be prompted to enable 2FA */
101
- should_prompt_2fa?: boolean;
99
+ export interface OAuthProvidersResponse {
100
+ /** List of available OAuth providers */
101
+ providers: Array<Record<string, any>>;
102
102
  }
103
103
 
104
104
  /**
@@ -1,23 +1,11 @@
1
1
  // @ts-nocheck
2
2
  // Auto-generated by DjangoCFG - see CLAUDE.md
3
- /**
4
- * Response serializer for account deletion.
5
- *
6
- * Response model (includes read-only fields).
7
- */
8
- export interface AccountDeleteResponse {
9
- /** Whether the account was successfully deleted */
10
- success: boolean;
11
- /** Human-readable message about the deletion */
12
- message: string;
13
- }
14
-
15
3
  /**
16
4
  * Serializer for updating user profile.
17
5
  *
18
6
  * Request model (no read-only fields).
19
7
  */
20
- export interface UserProfileUpdateRequest {
8
+ export interface PatchedUserProfileUpdateRequest {
21
9
  first_name?: string;
22
10
  last_name?: string;
23
11
  company?: string;
@@ -26,12 +14,21 @@ export interface UserProfileUpdateRequest {
26
14
  language?: string;
27
15
  }
28
16
 
17
+ /**
18
+ *
19
+ * Request model (no read-only fields).
20
+ */
21
+ export interface CfgAccountsProfileAvatarCreateRequest {
22
+ /** Avatar image file (JPEG, PNG, GIF, WebP, max 5MB) */
23
+ avatar: File | Blob;
24
+ }
25
+
29
26
  /**
30
27
  * Serializer for updating user profile.
31
28
  *
32
29
  * Request model (no read-only fields).
33
30
  */
34
- export interface PatchedUserProfileUpdateRequest {
31
+ export interface UserProfileUpdateRequest {
35
32
  first_name?: string;
36
33
  last_name?: string;
37
34
  company?: string;
@@ -72,12 +69,15 @@ export interface User {
72
69
  }
73
70
 
74
71
  /**
72
+ * Response serializer for account deletion.
75
73
  *
76
- * Request model (no read-only fields).
74
+ * Response model (includes read-only fields).
77
75
  */
78
- export interface CfgAccountsProfileAvatarCreateRequest {
79
- /** Avatar image file (JPEG, PNG, GIF, WebP, max 5MB) */
80
- avatar: File | Blob;
76
+ export interface AccountDeleteResponse {
77
+ /** Whether the account was successfully deleted */
78
+ success: boolean;
79
+ /** Human-readable message about the deletion */
80
+ message: string;
81
81
  }
82
82
 
83
83
  /**
@@ -1,68 +1,73 @@
1
1
  // @ts-nocheck
2
2
  // Auto-generated by DjangoCFG - see CLAUDE.md
3
3
  /**
4
- * Channel presence response.
4
+ * Channel history response.
5
5
  *
6
6
  * Response model (includes read-only fields).
7
7
  */
8
- export interface CentrifugoPresenceResponse {
8
+ export interface CentrifugoHistoryResponse {
9
9
  error?: CentrifugoError | null;
10
- result?: CentrifugoPresenceResult | null;
10
+ result?: CentrifugoHistoryResult | null;
11
11
  }
12
12
 
13
13
  /**
14
- * Request to get channel presence.
14
+ * Request to get channel presence statistics.
15
15
  *
16
16
  * Request model (no read-only fields).
17
17
  */
18
- export interface CentrifugoPresenceRequestRequest {
18
+ export interface CentrifugoPresenceStatsRequestRequest {
19
19
  /** Channel name */
20
20
  channel: string;
21
21
  }
22
22
 
23
23
  /**
24
- * Channel history response.
24
+ * Server info response.
25
25
  *
26
26
  * Response model (includes read-only fields).
27
27
  */
28
- export interface CentrifugoHistoryResponse {
28
+ export interface CentrifugoInfoResponse {
29
29
  error?: CentrifugoError | null;
30
- result?: CentrifugoHistoryResult | null;
30
+ result?: CentrifugoInfoResult | null;
31
31
  }
32
32
 
33
33
  /**
34
- * Server info response.
34
+ * Channel presence response.
35
35
  *
36
36
  * Response model (includes read-only fields).
37
37
  */
38
- export interface CentrifugoInfoResponse {
38
+ export interface CentrifugoPresenceResponse {
39
39
  error?: CentrifugoError | null;
40
- result?: CentrifugoInfoResult | null;
40
+ result?: CentrifugoPresenceResult | null;
41
41
  }
42
42
 
43
43
  /**
44
- * Request to get channel presence statistics.
44
+ * Channel presence stats response.
45
45
  *
46
- * Request model (no read-only fields).
46
+ * Response model (includes read-only fields).
47
47
  */
48
- export interface CentrifugoPresenceStatsRequestRequest {
49
- /** Channel name */
50
- channel: string;
48
+ export interface CentrifugoPresenceStatsResponse {
49
+ error?: CentrifugoError | null;
50
+ result?: CentrifugoPresenceStatsResult | null;
51
51
  }
52
52
 
53
53
  /**
54
- * Request to get channel history.
54
+ * List of active channels response.
55
+ *
56
+ * Response model (includes read-only fields).
57
+ */
58
+ export interface CentrifugoChannelsResponse {
59
+ error?: CentrifugoError | null;
60
+ result?: CentrifugoChannelsResult | null;
61
+ }
62
+
63
+ /**
64
+ * Request to get channel presence.
55
65
  *
56
66
  * Request model (no read-only fields).
57
67
  */
58
- export interface CentrifugoHistoryRequestRequest {
68
+ export interface CentrifugoPresenceRequestRequest {
59
69
  /** Channel name */
60
70
  channel: string;
61
- /** Maximum number of messages to return */
62
- limit?: number | null;
63
- since?: CentrifugoStreamPosition | null;
64
- /** Reverse message order (newest first) */
65
- reverse?: boolean | null;
66
71
  }
67
72
 
68
73
  /**
@@ -76,23 +81,18 @@ export interface CentrifugoChannelsRequestRequest {
76
81
  }
77
82
 
78
83
  /**
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
- /**
89
- * Channel presence stats response.
84
+ * Request to get channel history.
90
85
  *
91
- * Response model (includes read-only fields).
86
+ * Request model (no read-only fields).
92
87
  */
93
- export interface CentrifugoPresenceStatsResponse {
94
- error?: CentrifugoError | null;
95
- result?: CentrifugoPresenceStatsResult | null;
88
+ export interface CentrifugoHistoryRequestRequest {
89
+ /** Channel name */
90
+ channel: string;
91
+ /** Maximum number of messages to return */
92
+ limit?: number | null;
93
+ since?: CentrifugoStreamPosition | null;
94
+ /** Reverse message order (newest first) */
95
+ reverse?: boolean | null;
96
96
  }
97
97
 
98
98
  /**
@@ -107,16 +107,6 @@ export interface CentrifugoError {
107
107
  message?: string;
108
108
  }
109
109
 
110
- /**
111
- * Presence result wrapper.
112
- *
113
- * Response model (includes read-only fields).
114
- */
115
- export interface CentrifugoPresenceResult {
116
- /** Map of client IDs to client info */
117
- presence: Record<string, CentrifugoClientInfo>;
118
- }
119
-
120
110
  /**
121
111
  * History result wrapper.
122
112
  *
@@ -142,25 +132,13 @@ export interface CentrifugoInfoResult {
142
132
  }
143
133
 
144
134
  /**
145
- * Stream position for pagination.
146
- *
147
- * Response model (includes read-only fields).
148
- */
149
- export interface CentrifugoStreamPosition {
150
- /** Stream offset */
151
- offset: number;
152
- /** Stream epoch */
153
- epoch: string;
154
- }
155
-
156
- /**
157
- * Channels result wrapper.
135
+ * Presence result wrapper.
158
136
  *
159
137
  * Response model (includes read-only fields).
160
138
  */
161
- export interface CentrifugoChannelsResult {
162
- /** Map of channel names to channel info */
163
- channels: Record<string, CentrifugoChannelInfo>;
139
+ export interface CentrifugoPresenceResult {
140
+ /** Map of client IDs to client info */
141
+ presence: Record<string, CentrifugoClientInfo>;
164
142
  }
165
143
 
166
144
  /**
@@ -176,19 +154,25 @@ export interface CentrifugoPresenceStatsResult {
176
154
  }
177
155
 
178
156
  /**
179
- * Information about connected client.
157
+ * Channels result wrapper.
180
158
  *
181
159
  * Response model (includes read-only fields).
182
160
  */
183
- export interface CentrifugoClientInfo {
184
- /** User ID */
185
- user: string;
186
- /** Client UUID */
187
- client: string;
188
- /** Connection metadata */
189
- conn_info?: Record<string, any> | null;
190
- /** Channel-specific metadata */
191
- chan_info?: Record<string, any> | null;
161
+ export interface CentrifugoChannelsResult {
162
+ /** Map of channel names to channel info */
163
+ channels: Record<string, CentrifugoChannelInfo>;
164
+ }
165
+
166
+ /**
167
+ * Stream position for pagination.
168
+ *
169
+ * Response model (includes read-only fields).
170
+ */
171
+ export interface CentrifugoStreamPosition {
172
+ /** Stream offset */
173
+ offset: number;
174
+ /** Stream epoch */
175
+ epoch: string;
192
176
  }
193
177
 
194
178
  /**
@@ -233,25 +217,29 @@ export interface CentrifugoNodeInfo {
233
217
  }
234
218
 
235
219
  /**
236
- * Information about a single channel.
220
+ * Information about connected client.
237
221
  *
238
222
  * Response model (includes read-only fields).
239
223
  */
240
- export interface CentrifugoChannelInfo {
241
- /** Number of connected clients in channel */
242
- num_clients: number;
224
+ export interface CentrifugoClientInfo {
225
+ /** User ID */
226
+ user: string;
227
+ /** Client UUID */
228
+ client: string;
229
+ /** Connection metadata */
230
+ conn_info?: Record<string, any> | null;
231
+ /** Channel-specific metadata */
232
+ chan_info?: Record<string, any> | null;
243
233
  }
244
234
 
245
235
  /**
246
- * Server metrics.
236
+ * Information about a single channel.
247
237
  *
248
238
  * Response model (includes read-only fields).
249
239
  */
250
- export interface CentrifugoMetrics {
251
- /** Metrics collection interval */
252
- interval: number;
253
- /** Metric name to value mapping */
254
- items: Record<string, any>;
240
+ export interface CentrifugoChannelInfo {
241
+ /** Number of connected clients in channel */
242
+ num_clients: number;
255
243
  }
256
244
 
257
245
  /**
@@ -266,3 +254,15 @@ export interface CentrifugoProcess {
266
254
  rss: number;
267
255
  }
268
256
 
257
+ /**
258
+ * Server metrics.
259
+ *
260
+ * Response model (includes read-only fields).
261
+ */
262
+ export interface CentrifugoMetrics {
263
+ /** Metrics collection interval */
264
+ interval: number;
265
+ /** Metric name to value mapping */
266
+ items: Record<string, any>;
267
+ }
268
+