@djangocfg/api 2.1.224 → 2.1.226

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
@@ -59,39 +59,15 @@ declare namespace enums {
59
59
  }
60
60
 
61
61
  /**
62
- * Error response for OAuth endpoints.
63
- *
64
- * Response model (includes read-only fields).
65
- */
66
- interface OAuthError$1 {
67
- /** Error code */
68
- error: string;
69
- /** Human-readable error description */
70
- error_description?: string;
71
- }
72
- /**
73
- * Request to complete OAuth flow (callback handler).
74
- *
75
- * Request model (no read-only fields).
76
- */
77
- interface OAuthCallbackRequestRequest$1 {
78
- /** Authorization code from OAuth provider callback */
79
- code: string;
80
- /** State token for CSRF verification (from authorize response) */
81
- state: string;
82
- /** Same redirect_uri used in authorize request. If not provided, uses config's site_url + callback_path */
83
- redirect_uri?: string;
84
- }
85
- /**
86
- * Request to start OAuth flow.
62
+ * Request to disconnect OAuth provider.
87
63
  *
88
64
  * Request model (no read-only fields).
89
65
  */
90
- interface OAuthAuthorizeRequestRequest$1 {
91
- /** URL to redirect after OAuth authorization. If not provided, uses config's site_url + callback_path */
92
- redirect_uri?: string;
93
- /** Optional source URL for registration tracking */
94
- source_url?: string;
66
+ interface OAuthDisconnectRequestRequest$1 {
67
+ /** OAuth provider to disconnect
68
+
69
+ * `github` - GitHub */
70
+ provider: OAuthConnectionProvider;
95
71
  }
96
72
  /**
97
73
  * Response with OAuth authorization URL.
@@ -105,13 +81,15 @@ interface OAuthAuthorizeResponse$1 {
105
81
  state: string;
106
82
  }
107
83
  /**
108
- * Response with available OAuth providers.
84
+ * Request to start OAuth flow.
109
85
  *
110
- * Response model (includes read-only fields).
86
+ * Request model (no read-only fields).
111
87
  */
112
- interface OAuthProvidersResponse$1 {
113
- /** List of available OAuth providers */
114
- providers: Array<Record<string, any>>;
88
+ interface OAuthAuthorizeRequestRequest$1 {
89
+ /** URL to redirect after OAuth authorization. If not provided, uses config's site_url + callback_path */
90
+ redirect_uri?: string;
91
+ /** Optional source URL for registration tracking */
92
+ source_url?: string;
115
93
  }
116
94
  /**
117
95
  * Response with JWT tokens after OAuth authentication. When 2FA is required: -
@@ -140,15 +118,26 @@ interface OAuthTokenResponse$1 {
140
118
  should_prompt_2fa?: boolean;
141
119
  }
142
120
  /**
143
- * Request to disconnect OAuth provider.
121
+ * Response with available OAuth providers.
122
+ *
123
+ * Response model (includes read-only fields).
124
+ */
125
+ interface OAuthProvidersResponse$1 {
126
+ /** List of available OAuth providers */
127
+ providers: Array<Record<string, any>>;
128
+ }
129
+ /**
130
+ * Request to complete OAuth flow (callback handler).
144
131
  *
145
132
  * Request model (no read-only fields).
146
133
  */
147
- interface OAuthDisconnectRequestRequest$1 {
148
- /** OAuth provider to disconnect
149
-
150
- * `github` - GitHub */
151
- provider: OAuthConnectionProvider;
134
+ interface OAuthCallbackRequestRequest$1 {
135
+ /** Authorization code from OAuth provider callback */
136
+ code: string;
137
+ /** State token for CSRF verification (from authorize response) */
138
+ state: string;
139
+ /** Same redirect_uri used in authorize request. If not provided, uses config's site_url + callback_path */
140
+ redirect_uri?: string;
152
141
  }
153
142
  /**
154
143
  * Serializer for OAuth connection info (user-facing).
@@ -173,6 +162,17 @@ interface OAuthConnection$1 {
173
162
  /** Last time this OAuth connection was used for login */
174
163
  last_login_at: string;
175
164
  }
165
+ /**
166
+ * Error response for OAuth endpoints.
167
+ *
168
+ * Response model (includes read-only fields).
169
+ */
170
+ interface OAuthError$1 {
171
+ /** Error code */
172
+ error: string;
173
+ /** Human-readable error description */
174
+ error_description?: string;
175
+ }
176
176
 
177
177
  declare namespace models$2 {
178
178
  export type { OAuthAuthorizeRequestRequest$1 as OAuthAuthorizeRequestRequest, OAuthAuthorizeResponse$1 as OAuthAuthorizeResponse, OAuthCallbackRequestRequest$1 as OAuthCallbackRequestRequest, OAuthConnection$1 as OAuthConnection, OAuthDisconnectRequestRequest$1 as OAuthDisconnectRequestRequest, OAuthError$1 as OAuthError, OAuthProvidersResponse$1 as OAuthProvidersResponse, OAuthTokenResponse$1 as OAuthTokenResponse };
@@ -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;
@@ -272,27 +293,6 @@ interface AccountDeleteResponse$1 {
272
293
  /** Human-readable message about the deletion */
273
294
  message: string;
274
295
  }
275
- /**
276
- * Serializer for updating user profile.
277
- *
278
- * Request model (no read-only fields).
279
- */
280
- interface PatchedUserProfileUpdateRequest$1 {
281
- first_name?: string;
282
- last_name?: string;
283
- company?: string;
284
- phone?: string;
285
- position?: string;
286
- language?: string;
287
- }
288
- /**
289
- *
290
- * Request model (no read-only fields).
291
- */
292
- interface CfgAccountsProfileAvatarCreateRequest$1 {
293
- /** Avatar image file (JPEG, PNG, GIF, WebP, max 5MB) */
294
- avatar: File | Blob;
295
- }
296
296
  /**
297
297
  * Nested serializer for Centrifugo WebSocket connection token.
298
298
  *
@@ -387,13 +387,13 @@ interface OTPRequestRequest$1 {
387
387
  source_url?: string;
388
388
  }
389
389
  /**
390
- * OTP request response.
390
+ * Error response for OTP operations.
391
391
  *
392
392
  * Response model (includes read-only fields).
393
393
  */
394
- interface OTPRequestResponse$1 {
395
- /** Success message */
396
- message: string;
394
+ interface OTPErrorResponse$1 {
395
+ /** Error message */
396
+ error: string;
397
397
  }
398
398
  /**
399
399
  * OTP verification response. When 2FA is required: - requires_2fa: True -
@@ -416,6 +416,15 @@ interface OTPVerifyResponse$1 {
416
416
  /** Whether user should be prompted to enable 2FA */
417
417
  should_prompt_2fa?: boolean;
418
418
  }
419
+ /**
420
+ * OTP request response.
421
+ *
422
+ * Response model (includes read-only fields).
423
+ */
424
+ interface OTPRequestResponse$1 {
425
+ /** Success message */
426
+ message: string;
427
+ }
419
428
  /**
420
429
  * Serializer for OTP verification.
421
430
  *
@@ -433,15 +442,6 @@ interface OTPVerifyRequest$1 {
433
442
  /** Source URL for tracking login (e.g., https://my.djangocfg.com) */
434
443
  source_url?: string;
435
444
  }
436
- /**
437
- * Error response for OTP operations.
438
- *
439
- * Response model (includes read-only fields).
440
- */
441
- interface OTPErrorResponse$1 {
442
- /** Error message */
443
- error: string;
444
- }
445
445
  /**
446
446
  * Serializer for user details.
447
447
  *
package/dist/index.d.ts CHANGED
@@ -59,39 +59,15 @@ declare namespace enums {
59
59
  }
60
60
 
61
61
  /**
62
- * Error response for OAuth endpoints.
63
- *
64
- * Response model (includes read-only fields).
65
- */
66
- interface OAuthError$1 {
67
- /** Error code */
68
- error: string;
69
- /** Human-readable error description */
70
- error_description?: string;
71
- }
72
- /**
73
- * Request to complete OAuth flow (callback handler).
74
- *
75
- * Request model (no read-only fields).
76
- */
77
- interface OAuthCallbackRequestRequest$1 {
78
- /** Authorization code from OAuth provider callback */
79
- code: string;
80
- /** State token for CSRF verification (from authorize response) */
81
- state: string;
82
- /** Same redirect_uri used in authorize request. If not provided, uses config's site_url + callback_path */
83
- redirect_uri?: string;
84
- }
85
- /**
86
- * Request to start OAuth flow.
62
+ * Request to disconnect OAuth provider.
87
63
  *
88
64
  * Request model (no read-only fields).
89
65
  */
90
- interface OAuthAuthorizeRequestRequest$1 {
91
- /** URL to redirect after OAuth authorization. If not provided, uses config's site_url + callback_path */
92
- redirect_uri?: string;
93
- /** Optional source URL for registration tracking */
94
- source_url?: string;
66
+ interface OAuthDisconnectRequestRequest$1 {
67
+ /** OAuth provider to disconnect
68
+
69
+ * `github` - GitHub */
70
+ provider: OAuthConnectionProvider;
95
71
  }
96
72
  /**
97
73
  * Response with OAuth authorization URL.
@@ -105,13 +81,15 @@ interface OAuthAuthorizeResponse$1 {
105
81
  state: string;
106
82
  }
107
83
  /**
108
- * Response with available OAuth providers.
84
+ * Request to start OAuth flow.
109
85
  *
110
- * Response model (includes read-only fields).
86
+ * Request model (no read-only fields).
111
87
  */
112
- interface OAuthProvidersResponse$1 {
113
- /** List of available OAuth providers */
114
- providers: Array<Record<string, any>>;
88
+ interface OAuthAuthorizeRequestRequest$1 {
89
+ /** URL to redirect after OAuth authorization. If not provided, uses config's site_url + callback_path */
90
+ redirect_uri?: string;
91
+ /** Optional source URL for registration tracking */
92
+ source_url?: string;
115
93
  }
116
94
  /**
117
95
  * Response with JWT tokens after OAuth authentication. When 2FA is required: -
@@ -140,15 +118,26 @@ interface OAuthTokenResponse$1 {
140
118
  should_prompt_2fa?: boolean;
141
119
  }
142
120
  /**
143
- * Request to disconnect OAuth provider.
121
+ * Response with available OAuth providers.
122
+ *
123
+ * Response model (includes read-only fields).
124
+ */
125
+ interface OAuthProvidersResponse$1 {
126
+ /** List of available OAuth providers */
127
+ providers: Array<Record<string, any>>;
128
+ }
129
+ /**
130
+ * Request to complete OAuth flow (callback handler).
144
131
  *
145
132
  * Request model (no read-only fields).
146
133
  */
147
- interface OAuthDisconnectRequestRequest$1 {
148
- /** OAuth provider to disconnect
149
-
150
- * `github` - GitHub */
151
- provider: OAuthConnectionProvider;
134
+ interface OAuthCallbackRequestRequest$1 {
135
+ /** Authorization code from OAuth provider callback */
136
+ code: string;
137
+ /** State token for CSRF verification (from authorize response) */
138
+ state: string;
139
+ /** Same redirect_uri used in authorize request. If not provided, uses config's site_url + callback_path */
140
+ redirect_uri?: string;
152
141
  }
153
142
  /**
154
143
  * Serializer for OAuth connection info (user-facing).
@@ -173,6 +162,17 @@ interface OAuthConnection$1 {
173
162
  /** Last time this OAuth connection was used for login */
174
163
  last_login_at: string;
175
164
  }
165
+ /**
166
+ * Error response for OAuth endpoints.
167
+ *
168
+ * Response model (includes read-only fields).
169
+ */
170
+ interface OAuthError$1 {
171
+ /** Error code */
172
+ error: string;
173
+ /** Human-readable error description */
174
+ error_description?: string;
175
+ }
176
176
 
177
177
  declare namespace models$2 {
178
178
  export type { OAuthAuthorizeRequestRequest$1 as OAuthAuthorizeRequestRequest, OAuthAuthorizeResponse$1 as OAuthAuthorizeResponse, OAuthCallbackRequestRequest$1 as OAuthCallbackRequestRequest, OAuthConnection$1 as OAuthConnection, OAuthDisconnectRequestRequest$1 as OAuthDisconnectRequestRequest, OAuthError$1 as OAuthError, OAuthProvidersResponse$1 as OAuthProvidersResponse, OAuthTokenResponse$1 as OAuthTokenResponse };
@@ -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;
@@ -272,27 +293,6 @@ interface AccountDeleteResponse$1 {
272
293
  /** Human-readable message about the deletion */
273
294
  message: string;
274
295
  }
275
- /**
276
- * Serializer for updating user profile.
277
- *
278
- * Request model (no read-only fields).
279
- */
280
- interface PatchedUserProfileUpdateRequest$1 {
281
- first_name?: string;
282
- last_name?: string;
283
- company?: string;
284
- phone?: string;
285
- position?: string;
286
- language?: string;
287
- }
288
- /**
289
- *
290
- * Request model (no read-only fields).
291
- */
292
- interface CfgAccountsProfileAvatarCreateRequest$1 {
293
- /** Avatar image file (JPEG, PNG, GIF, WebP, max 5MB) */
294
- avatar: File | Blob;
295
- }
296
296
  /**
297
297
  * Nested serializer for Centrifugo WebSocket connection token.
298
298
  *
@@ -387,13 +387,13 @@ interface OTPRequestRequest$1 {
387
387
  source_url?: string;
388
388
  }
389
389
  /**
390
- * OTP request response.
390
+ * Error response for OTP operations.
391
391
  *
392
392
  * Response model (includes read-only fields).
393
393
  */
394
- interface OTPRequestResponse$1 {
395
- /** Success message */
396
- message: string;
394
+ interface OTPErrorResponse$1 {
395
+ /** Error message */
396
+ error: string;
397
397
  }
398
398
  /**
399
399
  * OTP verification response. When 2FA is required: - requires_2fa: True -
@@ -416,6 +416,15 @@ interface OTPVerifyResponse$1 {
416
416
  /** Whether user should be prompted to enable 2FA */
417
417
  should_prompt_2fa?: boolean;
418
418
  }
419
+ /**
420
+ * OTP request response.
421
+ *
422
+ * Response model (includes read-only fields).
423
+ */
424
+ interface OTPRequestResponse$1 {
425
+ /** Success message */
426
+ message: string;
427
+ }
419
428
  /**
420
429
  * Serializer for OTP verification.
421
430
  *
@@ -433,15 +442,6 @@ interface OTPVerifyRequest$1 {
433
442
  /** Source URL for tracking login (e.g., https://my.djangocfg.com) */
434
443
  source_url?: string;
435
444
  }
436
- /**
437
- * Error response for OTP operations.
438
- *
439
- * Response model (includes read-only fields).
440
- */
441
- interface OTPErrorResponse$1 {
442
- /** Error message */
443
- error: string;
444
- }
445
445
  /**
446
446
  * Serializer for user details.
447
447
  *