@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/dist/index.d.cts CHANGED
@@ -48,24 +48,15 @@ declare namespace enums {
48
48
  }
49
49
 
50
50
  /**
51
- * Response with available OAuth providers.
52
- *
53
- * Response model (includes read-only fields).
54
- */
55
- interface OAuthProvidersResponse$1 {
56
- /** List of available OAuth providers */
57
- providers: Array<Record<string, any>>;
58
- }
59
- /**
60
- * Request to disconnect OAuth provider.
51
+ * Request to start OAuth flow.
61
52
  *
62
53
  * Request model (no read-only fields).
63
54
  */
64
- interface OAuthDisconnectRequestRequest$1 {
65
- /** OAuth provider to disconnect
66
-
67
- * `github` - GitHub */
68
- provider: OAuthConnectionProvider;
55
+ interface OAuthAuthorizeRequestRequest$1 {
56
+ /** URL to redirect after OAuth authorization. If not provided, uses config's site_url + callback_path */
57
+ redirect_uri?: string;
58
+ /** Optional source URL for registration tracking */
59
+ source_url?: string;
69
60
  }
70
61
  /**
71
62
  * Error response for OAuth endpoints.
@@ -79,15 +70,24 @@ interface OAuthError$1 {
79
70
  error_description?: string;
80
71
  }
81
72
  /**
82
- * Request to start OAuth flow.
73
+ * Request to disconnect OAuth provider.
83
74
  *
84
75
  * Request model (no read-only fields).
85
76
  */
86
- interface OAuthAuthorizeRequestRequest$1 {
87
- /** URL to redirect after OAuth authorization. If not provided, uses config's site_url + callback_path */
88
- redirect_uri?: string;
89
- /** Optional source URL for registration tracking */
90
- source_url?: string;
77
+ interface OAuthDisconnectRequestRequest$1 {
78
+ /** OAuth provider to disconnect
79
+
80
+ * `github` - GitHub */
81
+ provider: OAuthConnectionProvider;
82
+ }
83
+ /**
84
+ * Response with available OAuth providers.
85
+ *
86
+ * Response model (includes read-only fields).
87
+ */
88
+ interface OAuthProvidersResponse$1 {
89
+ /** List of available OAuth providers */
90
+ providers: Array<Record<string, any>>;
91
91
  }
92
92
  /**
93
93
  * Request to complete OAuth flow (callback handler).
@@ -207,17 +207,6 @@ declare class Oauth {
207
207
  accountsOauthProvidersRetrieve(): Promise<OAuthProvidersResponse$1>;
208
208
  }
209
209
 
210
- /**
211
- * Response serializer for account deletion.
212
- *
213
- * Response model (includes read-only fields).
214
- */
215
- interface AccountDeleteResponse$1 {
216
- /** Whether the account was successfully deleted */
217
- success: boolean;
218
- /** Human-readable message about the deletion */
219
- message: string;
220
- }
221
210
  /**
222
211
  * Serializer for updating user profile.
223
212
  *
@@ -232,17 +221,12 @@ interface UserProfileUpdateRequest$1 {
232
221
  language?: string;
233
222
  }
234
223
  /**
235
- * Serializer for updating user profile.
236
224
  *
237
225
  * Request model (no read-only fields).
238
226
  */
239
- interface PatchedUserProfileUpdateRequest$1 {
240
- first_name?: string;
241
- last_name?: string;
242
- company?: string;
243
- phone?: string;
244
- position?: string;
245
- language?: string;
227
+ interface CfgAccountsProfileAvatarCreateRequest$1 {
228
+ /** Avatar image file (JPEG, PNG, GIF, WebP, max 5MB) */
229
+ avatar: File | Blob;
246
230
  }
247
231
  /**
248
232
  * Serializer for user details.
@@ -275,12 +259,28 @@ interface User$2 {
275
259
  centrifugo: CentrifugoToken$2 | null;
276
260
  }
277
261
  /**
262
+ * Serializer for updating user profile.
278
263
  *
279
264
  * Request model (no read-only fields).
280
265
  */
281
- interface CfgAccountsProfileAvatarCreateRequest$1 {
282
- /** Avatar image file (JPEG, PNG, GIF, WebP, max 5MB) */
283
- avatar: File | Blob;
266
+ interface PatchedUserProfileUpdateRequest$1 {
267
+ first_name?: string;
268
+ last_name?: string;
269
+ company?: string;
270
+ phone?: string;
271
+ position?: string;
272
+ language?: string;
273
+ }
274
+ /**
275
+ * Response serializer for account deletion.
276
+ *
277
+ * Response model (includes read-only fields).
278
+ */
279
+ interface AccountDeleteResponse$1 {
280
+ /** Whether the account was successfully deleted */
281
+ success: boolean;
282
+ /** Human-readable message about the deletion */
283
+ message: string;
284
284
  }
285
285
  /**
286
286
  * Nested serializer for Centrifugo WebSocket connection token.
@@ -359,46 +359,6 @@ declare class UserProfile {
359
359
  accountsProfileUpdatePartialUpdate(data?: PatchedUserProfileUpdateRequest$1): Promise<User$2>;
360
360
  }
361
361
 
362
- /**
363
- * Serializer for OTP request.
364
- *
365
- * Request model (no read-only fields).
366
- */
367
- interface OTPRequestRequest$1 {
368
- /** Email address for OTP delivery */
369
- identifier: string;
370
- /** Source URL for tracking registration (e.g., https://my.djangocfg.com) */
371
- source_url?: string;
372
- }
373
- /**
374
- * Typed error response for OTP operations. error_code values: -
375
- * invalid_identifier — malformed email - cooldown — too soon after last
376
- * request (retry_after = seconds) - hourly_limit — hourly quota exceeded
377
- * (retry_after = seconds until reset) - daily_limit — daily quota exceeded
378
- * (retry_after = seconds until reset) - rate_limited — IP-level rate limit hit
379
- * (no retry_after) - user_creation_failed — internal error creating account -
380
- * send_failed — transport error (email / SMS) - internal_error — unexpected
381
- * server error
382
- *
383
- * Response model (includes read-only fields).
384
- */
385
- interface OTPErrorResponse$1 {
386
- /** Human-readable error message */
387
- error: string;
388
- /** Machine-readable error code */
389
- error_code?: string | null;
390
- /** Seconds until the client may retry (present only for rate-limit errors) */
391
- retry_after?: number | null;
392
- }
393
- /**
394
- * OTP request response.
395
- *
396
- * Response model (includes read-only fields).
397
- */
398
- interface OTPRequestResponse$1 {
399
- /** Success message */
400
- message: string;
401
- }
402
362
  /**
403
363
  * OTP verification response. When 2FA is required: - requires_2fa: True -
404
364
  * session_id: UUID of 2FA verification session - refresh/access/user: null
@@ -432,6 +392,46 @@ interface OTPVerifyRequest$1 {
432
392
  /** Source URL for tracking login (e.g., https://my.djangocfg.com) */
433
393
  source_url?: string;
434
394
  }
395
+ /**
396
+ * Serializer for OTP request.
397
+ *
398
+ * Request model (no read-only fields).
399
+ */
400
+ interface OTPRequestRequest$1 {
401
+ /** Email address for OTP delivery */
402
+ identifier: string;
403
+ /** Source URL for tracking registration (e.g., https://my.djangocfg.com) */
404
+ source_url?: string;
405
+ }
406
+ /**
407
+ * OTP request response.
408
+ *
409
+ * Response model (includes read-only fields).
410
+ */
411
+ interface OTPRequestResponse$1 {
412
+ /** Success message */
413
+ message: string;
414
+ }
415
+ /**
416
+ * Typed error response for OTP operations. error_code values: -
417
+ * invalid_identifier — malformed email - cooldown — too soon after last
418
+ * request (retry_after = seconds) - hourly_limit — hourly quota exceeded
419
+ * (retry_after = seconds until reset) - daily_limit — daily quota exceeded
420
+ * (retry_after = seconds until reset) - rate_limited — IP-level rate limit hit
421
+ * (no retry_after) - user_creation_failed — internal error creating account -
422
+ * send_failed — transport error (email / SMS) - internal_error — unexpected
423
+ * server error
424
+ *
425
+ * Response model (includes read-only fields).
426
+ */
427
+ interface OTPErrorResponse$1 {
428
+ /** Human-readable error message */
429
+ error: string;
430
+ /** Machine-readable error code */
431
+ error_code?: string | null;
432
+ /** Seconds until the client may retry (present only for rate-limit errors) */
433
+ retry_after?: number | null;
434
+ }
435
435
  /**
436
436
  * Serializer for user details.
437
437
  *
package/dist/index.d.ts CHANGED
@@ -48,24 +48,15 @@ declare namespace enums {
48
48
  }
49
49
 
50
50
  /**
51
- * Response with available OAuth providers.
52
- *
53
- * Response model (includes read-only fields).
54
- */
55
- interface OAuthProvidersResponse$1 {
56
- /** List of available OAuth providers */
57
- providers: Array<Record<string, any>>;
58
- }
59
- /**
60
- * Request to disconnect OAuth provider.
51
+ * Request to start OAuth flow.
61
52
  *
62
53
  * Request model (no read-only fields).
63
54
  */
64
- interface OAuthDisconnectRequestRequest$1 {
65
- /** OAuth provider to disconnect
66
-
67
- * `github` - GitHub */
68
- provider: OAuthConnectionProvider;
55
+ interface OAuthAuthorizeRequestRequest$1 {
56
+ /** URL to redirect after OAuth authorization. If not provided, uses config's site_url + callback_path */
57
+ redirect_uri?: string;
58
+ /** Optional source URL for registration tracking */
59
+ source_url?: string;
69
60
  }
70
61
  /**
71
62
  * Error response for OAuth endpoints.
@@ -79,15 +70,24 @@ interface OAuthError$1 {
79
70
  error_description?: string;
80
71
  }
81
72
  /**
82
- * Request to start OAuth flow.
73
+ * Request to disconnect OAuth provider.
83
74
  *
84
75
  * Request model (no read-only fields).
85
76
  */
86
- interface OAuthAuthorizeRequestRequest$1 {
87
- /** URL to redirect after OAuth authorization. If not provided, uses config's site_url + callback_path */
88
- redirect_uri?: string;
89
- /** Optional source URL for registration tracking */
90
- source_url?: string;
77
+ interface OAuthDisconnectRequestRequest$1 {
78
+ /** OAuth provider to disconnect
79
+
80
+ * `github` - GitHub */
81
+ provider: OAuthConnectionProvider;
82
+ }
83
+ /**
84
+ * Response with available OAuth providers.
85
+ *
86
+ * Response model (includes read-only fields).
87
+ */
88
+ interface OAuthProvidersResponse$1 {
89
+ /** List of available OAuth providers */
90
+ providers: Array<Record<string, any>>;
91
91
  }
92
92
  /**
93
93
  * Request to complete OAuth flow (callback handler).
@@ -207,17 +207,6 @@ declare class Oauth {
207
207
  accountsOauthProvidersRetrieve(): Promise<OAuthProvidersResponse$1>;
208
208
  }
209
209
 
210
- /**
211
- * Response serializer for account deletion.
212
- *
213
- * Response model (includes read-only fields).
214
- */
215
- interface AccountDeleteResponse$1 {
216
- /** Whether the account was successfully deleted */
217
- success: boolean;
218
- /** Human-readable message about the deletion */
219
- message: string;
220
- }
221
210
  /**
222
211
  * Serializer for updating user profile.
223
212
  *
@@ -232,17 +221,12 @@ interface UserProfileUpdateRequest$1 {
232
221
  language?: string;
233
222
  }
234
223
  /**
235
- * Serializer for updating user profile.
236
224
  *
237
225
  * Request model (no read-only fields).
238
226
  */
239
- interface PatchedUserProfileUpdateRequest$1 {
240
- first_name?: string;
241
- last_name?: string;
242
- company?: string;
243
- phone?: string;
244
- position?: string;
245
- language?: string;
227
+ interface CfgAccountsProfileAvatarCreateRequest$1 {
228
+ /** Avatar image file (JPEG, PNG, GIF, WebP, max 5MB) */
229
+ avatar: File | Blob;
246
230
  }
247
231
  /**
248
232
  * Serializer for user details.
@@ -275,12 +259,28 @@ interface User$2 {
275
259
  centrifugo: CentrifugoToken$2 | null;
276
260
  }
277
261
  /**
262
+ * Serializer for updating user profile.
278
263
  *
279
264
  * Request model (no read-only fields).
280
265
  */
281
- interface CfgAccountsProfileAvatarCreateRequest$1 {
282
- /** Avatar image file (JPEG, PNG, GIF, WebP, max 5MB) */
283
- avatar: File | Blob;
266
+ interface PatchedUserProfileUpdateRequest$1 {
267
+ first_name?: string;
268
+ last_name?: string;
269
+ company?: string;
270
+ phone?: string;
271
+ position?: string;
272
+ language?: string;
273
+ }
274
+ /**
275
+ * Response serializer for account deletion.
276
+ *
277
+ * Response model (includes read-only fields).
278
+ */
279
+ interface AccountDeleteResponse$1 {
280
+ /** Whether the account was successfully deleted */
281
+ success: boolean;
282
+ /** Human-readable message about the deletion */
283
+ message: string;
284
284
  }
285
285
  /**
286
286
  * Nested serializer for Centrifugo WebSocket connection token.
@@ -359,46 +359,6 @@ declare class UserProfile {
359
359
  accountsProfileUpdatePartialUpdate(data?: PatchedUserProfileUpdateRequest$1): Promise<User$2>;
360
360
  }
361
361
 
362
- /**
363
- * Serializer for OTP request.
364
- *
365
- * Request model (no read-only fields).
366
- */
367
- interface OTPRequestRequest$1 {
368
- /** Email address for OTP delivery */
369
- identifier: string;
370
- /** Source URL for tracking registration (e.g., https://my.djangocfg.com) */
371
- source_url?: string;
372
- }
373
- /**
374
- * Typed error response for OTP operations. error_code values: -
375
- * invalid_identifier — malformed email - cooldown — too soon after last
376
- * request (retry_after = seconds) - hourly_limit — hourly quota exceeded
377
- * (retry_after = seconds until reset) - daily_limit — daily quota exceeded
378
- * (retry_after = seconds until reset) - rate_limited — IP-level rate limit hit
379
- * (no retry_after) - user_creation_failed — internal error creating account -
380
- * send_failed — transport error (email / SMS) - internal_error — unexpected
381
- * server error
382
- *
383
- * Response model (includes read-only fields).
384
- */
385
- interface OTPErrorResponse$1 {
386
- /** Human-readable error message */
387
- error: string;
388
- /** Machine-readable error code */
389
- error_code?: string | null;
390
- /** Seconds until the client may retry (present only for rate-limit errors) */
391
- retry_after?: number | null;
392
- }
393
- /**
394
- * OTP request response.
395
- *
396
- * Response model (includes read-only fields).
397
- */
398
- interface OTPRequestResponse$1 {
399
- /** Success message */
400
- message: string;
401
- }
402
362
  /**
403
363
  * OTP verification response. When 2FA is required: - requires_2fa: True -
404
364
  * session_id: UUID of 2FA verification session - refresh/access/user: null
@@ -432,6 +392,46 @@ interface OTPVerifyRequest$1 {
432
392
  /** Source URL for tracking login (e.g., https://my.djangocfg.com) */
433
393
  source_url?: string;
434
394
  }
395
+ /**
396
+ * Serializer for OTP request.
397
+ *
398
+ * Request model (no read-only fields).
399
+ */
400
+ interface OTPRequestRequest$1 {
401
+ /** Email address for OTP delivery */
402
+ identifier: string;
403
+ /** Source URL for tracking registration (e.g., https://my.djangocfg.com) */
404
+ source_url?: string;
405
+ }
406
+ /**
407
+ * OTP request response.
408
+ *
409
+ * Response model (includes read-only fields).
410
+ */
411
+ interface OTPRequestResponse$1 {
412
+ /** Success message */
413
+ message: string;
414
+ }
415
+ /**
416
+ * Typed error response for OTP operations. error_code values: -
417
+ * invalid_identifier — malformed email - cooldown — too soon after last
418
+ * request (retry_after = seconds) - hourly_limit — hourly quota exceeded
419
+ * (retry_after = seconds until reset) - daily_limit — daily quota exceeded
420
+ * (retry_after = seconds until reset) - rate_limited — IP-level rate limit hit
421
+ * (no retry_after) - user_creation_failed — internal error creating account -
422
+ * send_failed — transport error (email / SMS) - internal_error — unexpected
423
+ * server error
424
+ *
425
+ * Response model (includes read-only fields).
426
+ */
427
+ interface OTPErrorResponse$1 {
428
+ /** Human-readable error message */
429
+ error: string;
430
+ /** Machine-readable error code */
431
+ error_code?: string | null;
432
+ /** Seconds until the client may retry (present only for rate-limit errors) */
433
+ retry_after?: number | null;
434
+ }
435
435
  /**
436
436
  * Serializer for user details.
437
437
  *