@djangocfg/api 2.1.225 → 2.1.227

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/dist/index.d.cts CHANGED
@@ -3,17 +3,17 @@ import { z, ZodError } from 'zod';
3
3
 
4
4
  /**
5
5
  *
6
- * Request model (no read-only fields).
6
+ * Response model (includes read-only fields).
7
7
  */
8
- interface TokenRefreshRequest$1 {
8
+ interface TokenRefresh$1 {
9
+ access: string;
9
10
  refresh: string;
10
11
  }
11
12
  /**
12
13
  *
13
- * Response model (includes read-only fields).
14
+ * Request model (no read-only fields).
14
15
  */
15
- interface TokenRefresh$1 {
16
- access: string;
16
+ interface TokenRefreshRequest$1 {
17
17
  refresh: string;
18
18
  }
19
19
 
@@ -58,6 +58,28 @@ declare namespace enums {
58
58
  export { enums_OAuthConnectionProvider as OAuthConnectionProvider, enums_OTPRequestRequestChannel as OTPRequestRequestChannel };
59
59
  }
60
60
 
61
+ /**
62
+ * Request to disconnect OAuth provider.
63
+ *
64
+ * Request model (no read-only fields).
65
+ */
66
+ interface OAuthDisconnectRequestRequest$1 {
67
+ /** OAuth provider to disconnect
68
+
69
+ * `github` - GitHub */
70
+ provider: OAuthConnectionProvider;
71
+ }
72
+ /**
73
+ * Response with OAuth authorization URL.
74
+ *
75
+ * Response model (includes read-only fields).
76
+ */
77
+ interface OAuthAuthorizeResponse$1 {
78
+ /** Full URL to redirect user to OAuth provider */
79
+ authorization_url: string;
80
+ /** State token for CSRF protection. Store this and verify on callback. */
81
+ state: string;
82
+ }
61
83
  /**
62
84
  * Request to start OAuth flow.
63
85
  *
@@ -70,24 +92,39 @@ interface OAuthAuthorizeRequestRequest$1 {
70
92
  source_url?: string;
71
93
  }
72
94
  /**
73
- * Response with available OAuth providers.
95
+ * Response with JWT tokens after OAuth authentication. When 2FA is required: -
96
+ * requires_2fa: True - session_id: UUID of 2FA verification session -
97
+ * access/refresh/user: null When 2FA is not required: - requires_2fa: False -
98
+ * session_id: null - access/refresh/user: populated
74
99
  *
75
100
  * Response model (includes read-only fields).
76
101
  */
77
- interface OAuthProvidersResponse$1 {
78
- /** List of available OAuth providers */
79
- providers: Array<Record<string, any>>;
102
+ interface OAuthTokenResponse$1 {
103
+ /** True if 2FA verification is required */
104
+ requires_2fa?: boolean;
105
+ /** 2FA session ID (only when requires_2fa=True) */
106
+ session_id?: string | null;
107
+ /** JWT access token (null when requires_2fa=True) */
108
+ access?: string | null;
109
+ /** JWT refresh token (null when requires_2fa=True) */
110
+ refresh?: string | null;
111
+ /** Authenticated user info (null when requires_2fa=True) */
112
+ user?: Record<string, any> | null;
113
+ /** True if a new user was created during this OAuth flow */
114
+ is_new_user: boolean;
115
+ /** True if a new OAuth connection was created */
116
+ is_new_connection: boolean;
117
+ /** True if user should be prompted to enable 2FA */
118
+ should_prompt_2fa?: boolean;
80
119
  }
81
120
  /**
82
- * Error response for OAuth endpoints.
121
+ * Response with available OAuth providers.
83
122
  *
84
123
  * Response model (includes read-only fields).
85
124
  */
86
- interface OAuthError$1 {
87
- /** Error code */
88
- error: string;
89
- /** Human-readable error description */
90
- error_description?: string;
125
+ interface OAuthProvidersResponse$1 {
126
+ /** List of available OAuth providers */
127
+ providers: Array<Record<string, any>>;
91
128
  }
92
129
  /**
93
130
  * Request to complete OAuth flow (callback handler).
@@ -126,52 +163,15 @@ interface OAuthConnection$1 {
126
163
  last_login_at: string;
127
164
  }
128
165
  /**
129
- * Request to disconnect OAuth provider.
130
- *
131
- * Request model (no read-only fields).
132
- */
133
- interface OAuthDisconnectRequestRequest$1 {
134
- /** OAuth provider to disconnect
135
-
136
- * `github` - GitHub */
137
- provider: OAuthConnectionProvider;
138
- }
139
- /**
140
- * Response with JWT tokens after OAuth authentication. When 2FA is required: -
141
- * requires_2fa: True - session_id: UUID of 2FA verification session -
142
- * access/refresh/user: null When 2FA is not required: - requires_2fa: False -
143
- * session_id: null - access/refresh/user: populated
144
- *
145
- * Response model (includes read-only fields).
146
- */
147
- interface OAuthTokenResponse$1 {
148
- /** True if 2FA verification is required */
149
- requires_2fa?: boolean;
150
- /** 2FA session ID (only when requires_2fa=True) */
151
- session_id?: string | null;
152
- /** JWT access token (null when requires_2fa=True) */
153
- access?: string | null;
154
- /** JWT refresh token (null when requires_2fa=True) */
155
- refresh?: string | null;
156
- /** Authenticated user info (null when requires_2fa=True) */
157
- user?: Record<string, any> | null;
158
- /** True if a new user was created during this OAuth flow */
159
- is_new_user: boolean;
160
- /** True if a new OAuth connection was created */
161
- is_new_connection: boolean;
162
- /** True if user should be prompted to enable 2FA */
163
- should_prompt_2fa?: boolean;
164
- }
165
- /**
166
- * Response with OAuth authorization URL.
166
+ * Error response for OAuth endpoints.
167
167
  *
168
168
  * Response model (includes read-only fields).
169
169
  */
170
- interface OAuthAuthorizeResponse$1 {
171
- /** Full URL to redirect user to OAuth provider */
172
- authorization_url: string;
173
- /** State token for CSRF protection. Store this and verify on callback. */
174
- state: string;
170
+ interface OAuthError$1 {
171
+ /** Error code */
172
+ error: string;
173
+ /** Human-readable error description */
174
+ error_description?: string;
175
175
  }
176
176
 
177
177
  declare namespace models$2 {
@@ -218,6 +218,27 @@ declare class Oauth {
218
218
  accountsOauthProvidersRetrieve(): Promise<OAuthProvidersResponse$1>;
219
219
  }
220
220
 
221
+ /**
222
+ * Serializer for updating user profile.
223
+ *
224
+ * Request model (no read-only fields).
225
+ */
226
+ interface UserProfileUpdateRequest$1 {
227
+ first_name?: string;
228
+ last_name?: string;
229
+ company?: string;
230
+ phone?: string;
231
+ position?: string;
232
+ language?: string;
233
+ }
234
+ /**
235
+ *
236
+ * Request model (no read-only fields).
237
+ */
238
+ interface CfgAccountsProfileAvatarCreateRequest$1 {
239
+ /** Avatar image file (JPEG, PNG, GIF, WebP, max 5MB) */
240
+ avatar: File | Blob;
241
+ }
221
242
  /**
222
243
  * Serializer for user details.
223
244
  *
@@ -253,7 +274,7 @@ interface User$2 {
253
274
  *
254
275
  * Request model (no read-only fields).
255
276
  */
256
- interface UserProfileUpdateRequest$1 {
277
+ interface PatchedUserProfileUpdateRequest$1 {
257
278
  first_name?: string;
258
279
  last_name?: string;
259
280
  company?: string;
@@ -261,14 +282,6 @@ interface UserProfileUpdateRequest$1 {
261
282
  position?: string;
262
283
  language?: string;
263
284
  }
264
- /**
265
- *
266
- * Request model (no read-only fields).
267
- */
268
- interface CfgAccountsProfileAvatarCreateRequest$1 {
269
- /** Avatar image file (JPEG, PNG, GIF, WebP, max 5MB) */
270
- avatar: File | Blob;
271
- }
272
285
  /**
273
286
  * Response serializer for account deletion.
274
287
  *
@@ -280,19 +293,6 @@ interface AccountDeleteResponse$1 {
280
293
  /** Human-readable message about the deletion */
281
294
  message: string;
282
295
  }
283
- /**
284
- * Serializer for updating user profile.
285
- *
286
- * Request model (no read-only fields).
287
- */
288
- interface PatchedUserProfileUpdateRequest$1 {
289
- first_name?: string;
290
- last_name?: string;
291
- company?: string;
292
- phone?: string;
293
- position?: string;
294
- language?: string;
295
- }
296
296
  /**
297
297
  * Nested serializer for Centrifugo WebSocket connection token.
298
298
  *
@@ -370,6 +370,31 @@ declare class UserProfile {
370
370
  accountsProfileUpdatePartialUpdate(data?: PatchedUserProfileUpdateRequest$1): Promise<User$2>;
371
371
  }
372
372
 
373
+ /**
374
+ * Serializer for OTP request.
375
+ *
376
+ * Request model (no read-only fields).
377
+ */
378
+ interface OTPRequestRequest$1 {
379
+ /** Email address or phone number for OTP delivery */
380
+ identifier: string;
381
+ /** Delivery channel: 'email' or 'phone'. Auto-detected if not provided.
382
+
383
+ * `email` - Email
384
+ * `phone` - Phone */
385
+ channel?: OTPRequestRequestChannel;
386
+ /** Source URL for tracking registration (e.g., https://my.djangocfg.com) */
387
+ source_url?: string;
388
+ }
389
+ /**
390
+ * Error response for OTP operations.
391
+ *
392
+ * Response model (includes read-only fields).
393
+ */
394
+ interface OTPErrorResponse$1 {
395
+ /** Error message */
396
+ error: string;
397
+ }
373
398
  /**
374
399
  * OTP verification response. When 2FA is required: - requires_2fa: True -
375
400
  * session_id: UUID of 2FA verification session - refresh/access/user: null
@@ -391,22 +416,6 @@ interface OTPVerifyResponse$1 {
391
416
  /** Whether user should be prompted to enable 2FA */
392
417
  should_prompt_2fa?: boolean;
393
418
  }
394
- /**
395
- * Serializer for OTP request.
396
- *
397
- * Request model (no read-only fields).
398
- */
399
- interface OTPRequestRequest$1 {
400
- /** Email address or phone number for OTP delivery */
401
- identifier: string;
402
- /** Delivery channel: 'email' or 'phone'. Auto-detected if not provided.
403
-
404
- * `email` - Email
405
- * `phone` - Phone */
406
- channel?: OTPRequestRequestChannel;
407
- /** Source URL for tracking registration (e.g., https://my.djangocfg.com) */
408
- source_url?: string;
409
- }
410
419
  /**
411
420
  * OTP request response.
412
421
  *
@@ -416,15 +425,6 @@ interface OTPRequestResponse$1 {
416
425
  /** Success message */
417
426
  message: string;
418
427
  }
419
- /**
420
- * Error response for OTP operations.
421
- *
422
- * Response model (includes read-only fields).
423
- */
424
- interface OTPErrorResponse$1 {
425
- /** Error message */
426
- error: string;
427
- }
428
428
  /**
429
429
  * Serializer for OTP verification.
430
430
  *
package/dist/index.d.ts CHANGED
@@ -3,17 +3,17 @@ import { z, ZodError } from 'zod';
3
3
 
4
4
  /**
5
5
  *
6
- * Request model (no read-only fields).
6
+ * Response model (includes read-only fields).
7
7
  */
8
- interface TokenRefreshRequest$1 {
8
+ interface TokenRefresh$1 {
9
+ access: string;
9
10
  refresh: string;
10
11
  }
11
12
  /**
12
13
  *
13
- * Response model (includes read-only fields).
14
+ * Request model (no read-only fields).
14
15
  */
15
- interface TokenRefresh$1 {
16
- access: string;
16
+ interface TokenRefreshRequest$1 {
17
17
  refresh: string;
18
18
  }
19
19
 
@@ -58,6 +58,28 @@ declare namespace enums {
58
58
  export { enums_OAuthConnectionProvider as OAuthConnectionProvider, enums_OTPRequestRequestChannel as OTPRequestRequestChannel };
59
59
  }
60
60
 
61
+ /**
62
+ * Request to disconnect OAuth provider.
63
+ *
64
+ * Request model (no read-only fields).
65
+ */
66
+ interface OAuthDisconnectRequestRequest$1 {
67
+ /** OAuth provider to disconnect
68
+
69
+ * `github` - GitHub */
70
+ provider: OAuthConnectionProvider;
71
+ }
72
+ /**
73
+ * Response with OAuth authorization URL.
74
+ *
75
+ * Response model (includes read-only fields).
76
+ */
77
+ interface OAuthAuthorizeResponse$1 {
78
+ /** Full URL to redirect user to OAuth provider */
79
+ authorization_url: string;
80
+ /** State token for CSRF protection. Store this and verify on callback. */
81
+ state: string;
82
+ }
61
83
  /**
62
84
  * Request to start OAuth flow.
63
85
  *
@@ -70,24 +92,39 @@ interface OAuthAuthorizeRequestRequest$1 {
70
92
  source_url?: string;
71
93
  }
72
94
  /**
73
- * Response with available OAuth providers.
95
+ * Response with JWT tokens after OAuth authentication. When 2FA is required: -
96
+ * requires_2fa: True - session_id: UUID of 2FA verification session -
97
+ * access/refresh/user: null When 2FA is not required: - requires_2fa: False -
98
+ * session_id: null - access/refresh/user: populated
74
99
  *
75
100
  * Response model (includes read-only fields).
76
101
  */
77
- interface OAuthProvidersResponse$1 {
78
- /** List of available OAuth providers */
79
- providers: Array<Record<string, any>>;
102
+ interface OAuthTokenResponse$1 {
103
+ /** True if 2FA verification is required */
104
+ requires_2fa?: boolean;
105
+ /** 2FA session ID (only when requires_2fa=True) */
106
+ session_id?: string | null;
107
+ /** JWT access token (null when requires_2fa=True) */
108
+ access?: string | null;
109
+ /** JWT refresh token (null when requires_2fa=True) */
110
+ refresh?: string | null;
111
+ /** Authenticated user info (null when requires_2fa=True) */
112
+ user?: Record<string, any> | null;
113
+ /** True if a new user was created during this OAuth flow */
114
+ is_new_user: boolean;
115
+ /** True if a new OAuth connection was created */
116
+ is_new_connection: boolean;
117
+ /** True if user should be prompted to enable 2FA */
118
+ should_prompt_2fa?: boolean;
80
119
  }
81
120
  /**
82
- * Error response for OAuth endpoints.
121
+ * Response with available OAuth providers.
83
122
  *
84
123
  * Response model (includes read-only fields).
85
124
  */
86
- interface OAuthError$1 {
87
- /** Error code */
88
- error: string;
89
- /** Human-readable error description */
90
- error_description?: string;
125
+ interface OAuthProvidersResponse$1 {
126
+ /** List of available OAuth providers */
127
+ providers: Array<Record<string, any>>;
91
128
  }
92
129
  /**
93
130
  * Request to complete OAuth flow (callback handler).
@@ -126,52 +163,15 @@ interface OAuthConnection$1 {
126
163
  last_login_at: string;
127
164
  }
128
165
  /**
129
- * Request to disconnect OAuth provider.
130
- *
131
- * Request model (no read-only fields).
132
- */
133
- interface OAuthDisconnectRequestRequest$1 {
134
- /** OAuth provider to disconnect
135
-
136
- * `github` - GitHub */
137
- provider: OAuthConnectionProvider;
138
- }
139
- /**
140
- * Response with JWT tokens after OAuth authentication. When 2FA is required: -
141
- * requires_2fa: True - session_id: UUID of 2FA verification session -
142
- * access/refresh/user: null When 2FA is not required: - requires_2fa: False -
143
- * session_id: null - access/refresh/user: populated
144
- *
145
- * Response model (includes read-only fields).
146
- */
147
- interface OAuthTokenResponse$1 {
148
- /** True if 2FA verification is required */
149
- requires_2fa?: boolean;
150
- /** 2FA session ID (only when requires_2fa=True) */
151
- session_id?: string | null;
152
- /** JWT access token (null when requires_2fa=True) */
153
- access?: string | null;
154
- /** JWT refresh token (null when requires_2fa=True) */
155
- refresh?: string | null;
156
- /** Authenticated user info (null when requires_2fa=True) */
157
- user?: Record<string, any> | null;
158
- /** True if a new user was created during this OAuth flow */
159
- is_new_user: boolean;
160
- /** True if a new OAuth connection was created */
161
- is_new_connection: boolean;
162
- /** True if user should be prompted to enable 2FA */
163
- should_prompt_2fa?: boolean;
164
- }
165
- /**
166
- * Response with OAuth authorization URL.
166
+ * Error response for OAuth endpoints.
167
167
  *
168
168
  * Response model (includes read-only fields).
169
169
  */
170
- interface OAuthAuthorizeResponse$1 {
171
- /** Full URL to redirect user to OAuth provider */
172
- authorization_url: string;
173
- /** State token for CSRF protection. Store this and verify on callback. */
174
- state: string;
170
+ interface OAuthError$1 {
171
+ /** Error code */
172
+ error: string;
173
+ /** Human-readable error description */
174
+ error_description?: string;
175
175
  }
176
176
 
177
177
  declare namespace models$2 {
@@ -218,6 +218,27 @@ declare class Oauth {
218
218
  accountsOauthProvidersRetrieve(): Promise<OAuthProvidersResponse$1>;
219
219
  }
220
220
 
221
+ /**
222
+ * Serializer for updating user profile.
223
+ *
224
+ * Request model (no read-only fields).
225
+ */
226
+ interface UserProfileUpdateRequest$1 {
227
+ first_name?: string;
228
+ last_name?: string;
229
+ company?: string;
230
+ phone?: string;
231
+ position?: string;
232
+ language?: string;
233
+ }
234
+ /**
235
+ *
236
+ * Request model (no read-only fields).
237
+ */
238
+ interface CfgAccountsProfileAvatarCreateRequest$1 {
239
+ /** Avatar image file (JPEG, PNG, GIF, WebP, max 5MB) */
240
+ avatar: File | Blob;
241
+ }
221
242
  /**
222
243
  * Serializer for user details.
223
244
  *
@@ -253,7 +274,7 @@ interface User$2 {
253
274
  *
254
275
  * Request model (no read-only fields).
255
276
  */
256
- interface UserProfileUpdateRequest$1 {
277
+ interface PatchedUserProfileUpdateRequest$1 {
257
278
  first_name?: string;
258
279
  last_name?: string;
259
280
  company?: string;
@@ -261,14 +282,6 @@ interface UserProfileUpdateRequest$1 {
261
282
  position?: string;
262
283
  language?: string;
263
284
  }
264
- /**
265
- *
266
- * Request model (no read-only fields).
267
- */
268
- interface CfgAccountsProfileAvatarCreateRequest$1 {
269
- /** Avatar image file (JPEG, PNG, GIF, WebP, max 5MB) */
270
- avatar: File | Blob;
271
- }
272
285
  /**
273
286
  * Response serializer for account deletion.
274
287
  *
@@ -280,19 +293,6 @@ interface AccountDeleteResponse$1 {
280
293
  /** Human-readable message about the deletion */
281
294
  message: string;
282
295
  }
283
- /**
284
- * Serializer for updating user profile.
285
- *
286
- * Request model (no read-only fields).
287
- */
288
- interface PatchedUserProfileUpdateRequest$1 {
289
- first_name?: string;
290
- last_name?: string;
291
- company?: string;
292
- phone?: string;
293
- position?: string;
294
- language?: string;
295
- }
296
296
  /**
297
297
  * Nested serializer for Centrifugo WebSocket connection token.
298
298
  *
@@ -370,6 +370,31 @@ declare class UserProfile {
370
370
  accountsProfileUpdatePartialUpdate(data?: PatchedUserProfileUpdateRequest$1): Promise<User$2>;
371
371
  }
372
372
 
373
+ /**
374
+ * Serializer for OTP request.
375
+ *
376
+ * Request model (no read-only fields).
377
+ */
378
+ interface OTPRequestRequest$1 {
379
+ /** Email address or phone number for OTP delivery */
380
+ identifier: string;
381
+ /** Delivery channel: 'email' or 'phone'. Auto-detected if not provided.
382
+
383
+ * `email` - Email
384
+ * `phone` - Phone */
385
+ channel?: OTPRequestRequestChannel;
386
+ /** Source URL for tracking registration (e.g., https://my.djangocfg.com) */
387
+ source_url?: string;
388
+ }
389
+ /**
390
+ * Error response for OTP operations.
391
+ *
392
+ * Response model (includes read-only fields).
393
+ */
394
+ interface OTPErrorResponse$1 {
395
+ /** Error message */
396
+ error: string;
397
+ }
373
398
  /**
374
399
  * OTP verification response. When 2FA is required: - requires_2fa: True -
375
400
  * session_id: UUID of 2FA verification session - refresh/access/user: null
@@ -391,22 +416,6 @@ interface OTPVerifyResponse$1 {
391
416
  /** Whether user should be prompted to enable 2FA */
392
417
  should_prompt_2fa?: boolean;
393
418
  }
394
- /**
395
- * Serializer for OTP request.
396
- *
397
- * Request model (no read-only fields).
398
- */
399
- interface OTPRequestRequest$1 {
400
- /** Email address or phone number for OTP delivery */
401
- identifier: string;
402
- /** Delivery channel: 'email' or 'phone'. Auto-detected if not provided.
403
-
404
- * `email` - Email
405
- * `phone` - Phone */
406
- channel?: OTPRequestRequestChannel;
407
- /** Source URL for tracking registration (e.g., https://my.djangocfg.com) */
408
- source_url?: string;
409
- }
410
419
  /**
411
420
  * OTP request response.
412
421
  *
@@ -416,15 +425,6 @@ interface OTPRequestResponse$1 {
416
425
  /** Success message */
417
426
  message: string;
418
427
  }
419
- /**
420
- * Error response for OTP operations.
421
- *
422
- * Response model (includes read-only fields).
423
- */
424
- interface OTPErrorResponse$1 {
425
- /** Error message */
426
- error: string;
427
- }
428
428
  /**
429
429
  * Serializer for OTP verification.
430
430
  *