@djangocfg/api 2.1.228 → 2.1.230

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.230",
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.230",
88
88
  "next": "^16.0.10",
89
89
  "react": "^19.1.0",
90
90
  "tsup": "^8.5.0",
@@ -1,48 +1,5 @@
1
1
  // @ts-nocheck
2
2
  // Auto-generated by DjangoCFG - see CLAUDE.md
3
- /**
4
- * Serializer for OTP request.
5
- *
6
- * Request model (no read-only fields).
7
- */
8
- export interface OTPRequestRequest {
9
- /** Email address for OTP delivery */
10
- identifier: string;
11
- /** Source URL for tracking registration (e.g., https://my.djangocfg.com) */
12
- source_url?: string;
13
- }
14
-
15
- /**
16
- * Typed error response for OTP operations. error_code values: -
17
- * invalid_identifier — malformed email - cooldown — too soon after last
18
- * request (retry_after = seconds) - hourly_limit — hourly quota exceeded
19
- * (retry_after = seconds until reset) - daily_limit — daily quota exceeded
20
- * (retry_after = seconds until reset) - rate_limited — IP-level rate limit hit
21
- * (no retry_after) - user_creation_failed — internal error creating account -
22
- * send_failed — transport error (email / SMS) - internal_error — unexpected
23
- * server error
24
- *
25
- * Response model (includes read-only fields).
26
- */
27
- export interface OTPErrorResponse {
28
- /** Human-readable error message */
29
- error: string;
30
- /** Machine-readable error code */
31
- error_code?: string | null;
32
- /** Seconds until the client may retry (present only for rate-limit errors) */
33
- retry_after?: number | null;
34
- }
35
-
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
3
  /**
47
4
  * OTP verification response. When 2FA is required: - requires_2fa: True -
48
5
  * session_id: UUID of 2FA verification session - refresh/access/user: null
@@ -78,6 +35,49 @@ export interface OTPVerifyRequest {
78
35
  source_url?: string;
79
36
  }
80
37
 
38
+ /**
39
+ * Serializer for OTP request.
40
+ *
41
+ * Request model (no read-only fields).
42
+ */
43
+ export interface OTPRequestRequest {
44
+ /** Email address for OTP delivery */
45
+ identifier: string;
46
+ /** Source URL for tracking registration (e.g., https://my.djangocfg.com) */
47
+ source_url?: string;
48
+ }
49
+
50
+ /**
51
+ * OTP request response.
52
+ *
53
+ * Response model (includes read-only fields).
54
+ */
55
+ export interface OTPRequestResponse {
56
+ /** Success message */
57
+ message: string;
58
+ }
59
+
60
+ /**
61
+ * Typed error response for OTP operations. error_code values: -
62
+ * invalid_identifier — malformed email - cooldown — too soon after last
63
+ * request (retry_after = seconds) - hourly_limit — hourly quota exceeded
64
+ * (retry_after = seconds until reset) - daily_limit — daily quota exceeded
65
+ * (retry_after = seconds until reset) - rate_limited — IP-level rate limit hit
66
+ * (no retry_after) - user_creation_failed — internal error creating account -
67
+ * send_failed — transport error (email / SMS) - internal_error — unexpected
68
+ * server error
69
+ *
70
+ * Response model (includes read-only fields).
71
+ */
72
+ export interface OTPErrorResponse {
73
+ /** Human-readable error message */
74
+ error: string;
75
+ /** Machine-readable error code */
76
+ error_code?: string | null;
77
+ /** Seconds until the client may retry (present only for rate-limit errors) */
78
+ retry_after?: number | null;
79
+ }
80
+
81
81
  /**
82
82
  * Serializer for user details.
83
83
  *
@@ -3,25 +3,15 @@
3
3
  import * as Enums from "../enums";
4
4
 
5
5
  /**
6
- * Response with available OAuth providers.
7
- *
8
- * Response model (includes read-only fields).
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.
6
+ * Request to start OAuth flow.
17
7
  *
18
8
  * Request model (no read-only fields).
19
9
  */
20
- export interface OAuthDisconnectRequestRequest {
21
- /** OAuth provider to disconnect
22
-
23
- * `github` - GitHub */
24
- provider: Enums.OAuthConnectionProvider;
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;
25
15
  }
26
16
 
27
17
  /**
@@ -37,15 +27,25 @@ export interface OAuthError {
37
27
  }
38
28
 
39
29
  /**
40
- * Request to start OAuth flow.
30
+ * Request to disconnect OAuth provider.
41
31
  *
42
32
  * Request model (no read-only fields).
43
33
  */
44
- export interface OAuthAuthorizeRequestRequest {
45
- /** URL to redirect after OAuth authorization. If not provided, uses config's site_url + callback_path */
46
- redirect_uri?: string;
47
- /** Optional source URL for registration tracking */
48
- source_url?: string;
34
+ export interface OAuthDisconnectRequestRequest {
35
+ /** OAuth provider to disconnect
36
+
37
+ * `github` - GitHub */
38
+ provider: Enums.OAuthConnectionProvider;
39
+ }
40
+
41
+ /**
42
+ * Response with available OAuth providers.
43
+ *
44
+ * Response model (includes read-only fields).
45
+ */
46
+ export interface OAuthProvidersResponse {
47
+ /** List of available OAuth providers */
48
+ providers: Array<Record<string, any>>;
49
49
  }
50
50
 
51
51
  /**
@@ -1,17 +1,5 @@
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
  *
@@ -27,17 +15,12 @@ export interface UserProfileUpdateRequest {
27
15
  }
28
16
 
29
17
  /**
30
- * Serializer for updating user profile.
31
18
  *
32
19
  * Request model (no read-only fields).
33
20
  */
34
- export interface PatchedUserProfileUpdateRequest {
35
- first_name?: string;
36
- last_name?: string;
37
- company?: string;
38
- phone?: string;
39
- position?: string;
40
- language?: string;
21
+ export interface CfgAccountsProfileAvatarCreateRequest {
22
+ /** Avatar image file (JPEG, PNG, GIF, WebP, max 5MB) */
23
+ avatar: File | Blob;
41
24
  }
42
25
 
43
26
  /**
@@ -72,12 +55,29 @@ export interface User {
72
55
  }
73
56
 
74
57
  /**
58
+ * Serializer for updating user profile.
75
59
  *
76
60
  * Request model (no read-only fields).
77
61
  */
78
- export interface CfgAccountsProfileAvatarCreateRequest {
79
- /** Avatar image file (JPEG, PNG, GIF, WebP, max 5MB) */
80
- avatar: File | Blob;
62
+ export interface PatchedUserProfileUpdateRequest {
63
+ first_name?: string;
64
+ last_name?: string;
65
+ company?: string;
66
+ phone?: string;
67
+ position?: string;
68
+ language?: string;
69
+ }
70
+
71
+ /**
72
+ * Response serializer for account deletion.
73
+ *
74
+ * Response model (includes read-only fields).
75
+ */
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,5 +1,30 @@
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
+
18
+ /**
19
+ * Request to list active channels.
20
+ *
21
+ * Request model (no read-only fields).
22
+ */
23
+ export interface CentrifugoChannelsRequestRequest {
24
+ /** Pattern to filter channels (e.g., 'user:*') */
25
+ pattern?: string | null;
26
+ }
27
+
3
28
  /**
4
29
  * Channel presence response.
5
30
  *
@@ -11,88 +36,85 @@ export interface CentrifugoPresenceResponse {
11
36
  }
12
37
 
13
38
  /**
14
- * Request to get channel presence.
39
+ * Request to get channel presence statistics.
15
40
  *
16
41
  * Request model (no read-only fields).
17
42
  */
18
- export interface CentrifugoPresenceRequestRequest {
43
+ export interface CentrifugoPresenceStatsRequestRequest {
19
44
  /** Channel name */
20
45
  channel: string;
21
46
  }
22
47
 
23
48
  /**
24
- * Channel history response.
49
+ * Channel presence stats response.
25
50
  *
26
51
  * Response model (includes read-only fields).
27
52
  */
28
- export interface CentrifugoHistoryResponse {
53
+ export interface CentrifugoPresenceStatsResponse {
29
54
  error?: CentrifugoError | null;
30
- result?: CentrifugoHistoryResult | null;
55
+ result?: CentrifugoPresenceStatsResult | null;
31
56
  }
32
57
 
33
58
  /**
34
- * Server info response.
59
+ * List of active channels response.
35
60
  *
36
61
  * Response model (includes read-only fields).
37
62
  */
38
- export interface CentrifugoInfoResponse {
63
+ export interface CentrifugoChannelsResponse {
39
64
  error?: CentrifugoError | null;
40
- result?: CentrifugoInfoResult | null;
65
+ result?: CentrifugoChannelsResult | null;
41
66
  }
42
67
 
43
68
  /**
44
- * Request to get channel presence statistics.
69
+ * Server info response.
45
70
  *
46
- * Request model (no read-only fields).
71
+ * Response model (includes read-only fields).
47
72
  */
48
- export interface CentrifugoPresenceStatsRequestRequest {
49
- /** Channel name */
50
- channel: string;
73
+ export interface CentrifugoInfoResponse {
74
+ error?: CentrifugoError | null;
75
+ result?: CentrifugoInfoResult | null;
51
76
  }
52
77
 
53
78
  /**
54
- * Request to get channel history.
79
+ * Channel history response.
55
80
  *
56
- * Request model (no read-only fields).
81
+ * Response model (includes read-only fields).
57
82
  */
58
- export interface CentrifugoHistoryRequestRequest {
59
- /** Channel name */
60
- 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;
83
+ export interface CentrifugoHistoryResponse {
84
+ error?: CentrifugoError | null;
85
+ result?: CentrifugoHistoryResult | null;
66
86
  }
67
87
 
68
88
  /**
69
- * Request to list active channels.
89
+ * Request to get channel presence.
70
90
  *
71
91
  * Request model (no read-only fields).
72
92
  */
73
- export interface CentrifugoChannelsRequestRequest {
74
- /** Pattern to filter channels (e.g., 'user:*') */
75
- pattern?: string | null;
93
+ export interface CentrifugoPresenceRequestRequest {
94
+ /** Channel name */
95
+ channel: string;
76
96
  }
77
97
 
78
98
  /**
79
- * List of active channels response.
99
+ * Stream position for pagination.
80
100
  *
81
101
  * Response model (includes read-only fields).
82
102
  */
83
- export interface CentrifugoChannelsResponse {
84
- error?: CentrifugoError | null;
85
- result?: CentrifugoChannelsResult | null;
103
+ export interface CentrifugoStreamPosition {
104
+ /** Stream offset */
105
+ offset: number;
106
+ /** Stream epoch */
107
+ epoch: string;
86
108
  }
87
109
 
88
110
  /**
89
- * Channel presence stats response.
111
+ * Presence result wrapper.
90
112
  *
91
113
  * Response model (includes read-only fields).
92
114
  */
93
- export interface CentrifugoPresenceStatsResponse {
94
- error?: CentrifugoError | null;
95
- result?: CentrifugoPresenceStatsResult | null;
115
+ export interface CentrifugoPresenceResult {
116
+ /** Map of client IDs to client info */
117
+ presence: Record<string, CentrifugoClientInfo>;
96
118
  }
97
119
 
98
120
  /**
@@ -108,27 +130,25 @@ export interface CentrifugoError {
108
130
  }
109
131
 
110
132
  /**
111
- * Presence result wrapper.
133
+ * Presence stats result.
112
134
  *
113
135
  * Response model (includes read-only fields).
114
136
  */
115
- export interface CentrifugoPresenceResult {
116
- /** Map of client IDs to client info */
117
- presence: Record<string, CentrifugoClientInfo>;
137
+ export interface CentrifugoPresenceStatsResult {
138
+ /** Number of connected clients */
139
+ num_clients: number;
140
+ /** Number of unique users */
141
+ num_users: number;
118
142
  }
119
143
 
120
144
  /**
121
- * History result wrapper.
145
+ * Channels result wrapper.
122
146
  *
123
147
  * Response model (includes read-only fields).
124
148
  */
125
- export interface CentrifugoHistoryResult {
126
- /** List of publications */
127
- publications: Array<CentrifugoPublication>;
128
- /** Current stream epoch */
129
- epoch: string;
130
- /** Latest stream offset */
131
- offset: number;
149
+ export interface CentrifugoChannelsResult {
150
+ /** Map of channel names to channel info */
151
+ channels: Record<string, CentrifugoChannelInfo>;
132
152
  }
133
153
 
134
154
  /**
@@ -142,37 +162,17 @@ export interface CentrifugoInfoResult {
142
162
  }
143
163
 
144
164
  /**
145
- * Stream position for pagination.
165
+ * History result wrapper.
146
166
  *
147
167
  * Response model (includes read-only fields).
148
168
  */
149
- export interface CentrifugoStreamPosition {
150
- /** Stream offset */
151
- offset: number;
152
- /** Stream epoch */
169
+ export interface CentrifugoHistoryResult {
170
+ /** List of publications */
171
+ publications: Array<CentrifugoPublication>;
172
+ /** Current stream epoch */
153
173
  epoch: string;
154
- }
155
-
156
- /**
157
- * Channels result wrapper.
158
- *
159
- * Response model (includes read-only fields).
160
- */
161
- export interface CentrifugoChannelsResult {
162
- /** Map of channel names to channel info */
163
- channels: Record<string, CentrifugoChannelInfo>;
164
- }
165
-
166
- /**
167
- * Presence stats result.
168
- *
169
- * Response model (includes read-only fields).
170
- */
171
- export interface CentrifugoPresenceStatsResult {
172
- /** Number of connected clients */
173
- num_clients: number;
174
- /** Number of unique users */
175
- num_users: number;
174
+ /** Latest stream offset */
175
+ offset: number;
176
176
  }
177
177
 
178
178
  /**
@@ -192,18 +192,13 @@ export interface CentrifugoClientInfo {
192
192
  }
193
193
 
194
194
  /**
195
- * Single publication (message) in channel history.
195
+ * Information about a single channel.
196
196
  *
197
197
  * Response model (includes read-only fields).
198
198
  */
199
- export interface CentrifugoPublication {
200
- /** Message payload */
201
- data: Record<string, any>;
202
- info?: CentrifugoClientInfo | null;
203
- /** Message offset in channel stream */
204
- offset: number;
205
- /** Optional message tags */
206
- tags?: Record<string, any> | null;
199
+ export interface CentrifugoChannelInfo {
200
+ /** Number of connected clients in channel */
201
+ num_clients: number;
207
202
  }
208
203
 
209
204
  /**
@@ -233,25 +228,18 @@ export interface CentrifugoNodeInfo {
233
228
  }
234
229
 
235
230
  /**
236
- * Information about a single channel.
237
- *
238
- * Response model (includes read-only fields).
239
- */
240
- export interface CentrifugoChannelInfo {
241
- /** Number of connected clients in channel */
242
- num_clients: number;
243
- }
244
-
245
- /**
246
- * Server metrics.
231
+ * Single publication (message) in channel history.
247
232
  *
248
233
  * Response model (includes read-only fields).
249
234
  */
250
- export interface CentrifugoMetrics {
251
- /** Metrics collection interval */
252
- interval: number;
253
- /** Metric name to value mapping */
254
- items: Record<string, any>;
235
+ export interface CentrifugoPublication {
236
+ /** Message payload */
237
+ data: Record<string, any>;
238
+ info?: CentrifugoClientInfo | null;
239
+ /** Message offset in channel stream */
240
+ offset: number;
241
+ /** Optional message tags */
242
+ tags?: Record<string, any> | null;
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
+
@@ -11,6 +11,22 @@ export interface TimelineResponse {
11
11
  interval: string;
12
12
  }
13
13
 
14
+ /**
15
+ * Health check response.
16
+ *
17
+ * Response model (includes read-only fields).
18
+ */
19
+ export interface CentrifugoHealthCheck {
20
+ /** Health status: healthy or unhealthy */
21
+ status: string;
22
+ /** Configured wrapper URL */
23
+ wrapper_url: string;
24
+ /** Whether API key is configured */
25
+ has_api_key: boolean;
26
+ /** Current timestamp */
27
+ timestamp: string;
28
+ }
29
+
14
30
  /**
15
31
  *
16
32
  * Response model (includes read-only fields).
@@ -36,6 +52,18 @@ export interface PaginatedPublishList {
36
52
  results: Array<Publish>;
37
53
  }
38
54
 
55
+ /**
56
+ * List of channel statistics.
57
+ *
58
+ * Response model (includes read-only fields).
59
+ */
60
+ export interface ChannelList {
61
+ /** Channel statistics */
62
+ channels: Array<ChannelStats>;
63
+ /** Total number of channels */
64
+ total_channels: number;
65
+ }
66
+
39
67
  /**
40
68
  * Overview statistics for Centrifugo publishes.
41
69
  *
@@ -60,34 +88,6 @@ export interface CentrifugoOverviewStats {
60
88
  period_hours: number;
61
89
  }
62
90
 
63
- /**
64
- * Health check response.
65
- *
66
- * Response model (includes read-only fields).
67
- */
68
- export interface CentrifugoHealthCheck {
69
- /** Health status: healthy or unhealthy */
70
- status: string;
71
- /** Configured wrapper URL */
72
- wrapper_url: string;
73
- /** Whether API key is configured */
74
- has_api_key: boolean;
75
- /** Current timestamp */
76
- timestamp: string;
77
- }
78
-
79
- /**
80
- * List of channel statistics.
81
- *
82
- * Response model (includes read-only fields).
83
- */
84
- export interface ChannelList {
85
- /** Channel statistics */
86
- channels: Array<ChannelStats>;
87
- /** Total number of channels */
88
- total_channels: number;
89
- }
90
-
91
91
  /**
92
92
  * Single timeline data point for DRF.
93
93
  *
@@ -1,21 +1,5 @@
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
-
19
3
  /**
20
4
  * Response model for test message publishing.
21
5
  *
@@ -62,3 +46,19 @@ export interface ManualAckRequestRequest {
62
46
  client_id: string;
63
47
  }
64
48
 
49
+ /**
50
+ * Request model for test message publishing.
51
+ *
52
+ * Request model (no read-only fields).
53
+ */
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;
63
+ }
64
+