@djangocfg/api 2.1.229 → 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/hooks.d.cts CHANGED
@@ -4,17 +4,17 @@ import useSWR from 'swr';
4
4
 
5
5
  /**
6
6
  *
7
- * Response model (includes read-only fields).
7
+ * Request model (no read-only fields).
8
8
  */
9
- interface TokenRefresh$1 {
10
- access: string;
9
+ interface TokenRefreshRequest$1 {
11
10
  refresh: string;
12
11
  }
13
12
  /**
14
13
  *
15
- * Request model (no read-only fields).
14
+ * Response model (includes read-only fields).
16
15
  */
17
- interface TokenRefreshRequest$1 {
16
+ interface TokenRefresh$1 {
17
+ access: string;
18
18
  refresh: string;
19
19
  }
20
20
 
@@ -38,6 +38,50 @@ declare enum OAuthConnectionProvider {
38
38
  GITHUB = "github"
39
39
  }
40
40
 
41
+ /**
42
+ * Request to start OAuth flow.
43
+ *
44
+ * Request model (no read-only fields).
45
+ */
46
+ interface OAuthAuthorizeRequestRequest$1 {
47
+ /** URL to redirect after OAuth authorization. If not provided, uses config's site_url + callback_path */
48
+ redirect_uri?: string;
49
+ /** Optional source URL for registration tracking */
50
+ source_url?: string;
51
+ }
52
+ /**
53
+ * Request to disconnect OAuth provider.
54
+ *
55
+ * Request model (no read-only fields).
56
+ */
57
+ interface OAuthDisconnectRequestRequest$1 {
58
+ /** OAuth provider to disconnect
59
+
60
+ * `github` - GitHub */
61
+ provider: OAuthConnectionProvider;
62
+ }
63
+ /**
64
+ * Response with available OAuth providers.
65
+ *
66
+ * Response model (includes read-only fields).
67
+ */
68
+ interface OAuthProvidersResponse {
69
+ /** List of available OAuth providers */
70
+ providers: Array<Record<string, any>>;
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
+ }
41
85
  /**
42
86
  * Response with OAuth authorization URL.
43
87
  *
@@ -75,50 +119,6 @@ interface OAuthTokenResponse$1 {
75
119
  /** True if user should be prompted to enable 2FA */
76
120
  should_prompt_2fa?: boolean;
77
121
  }
78
- /**
79
- * Request to start OAuth flow.
80
- *
81
- * Request model (no read-only fields).
82
- */
83
- interface OAuthAuthorizeRequestRequest$1 {
84
- /** URL to redirect after OAuth authorization. If not provided, uses config's site_url + callback_path */
85
- redirect_uri?: string;
86
- /** Optional source URL for registration tracking */
87
- source_url?: string;
88
- }
89
- /**
90
- * Request to complete OAuth flow (callback handler).
91
- *
92
- * Request model (no read-only fields).
93
- */
94
- interface OAuthCallbackRequestRequest$1 {
95
- /** Authorization code from OAuth provider callback */
96
- code: string;
97
- /** State token for CSRF verification (from authorize response) */
98
- state: string;
99
- /** Same redirect_uri used in authorize request. If not provided, uses config's site_url + callback_path */
100
- redirect_uri?: string;
101
- }
102
- /**
103
- * Request to disconnect OAuth provider.
104
- *
105
- * Request model (no read-only fields).
106
- */
107
- interface OAuthDisconnectRequestRequest$1 {
108
- /** OAuth provider to disconnect
109
-
110
- * `github` - GitHub */
111
- provider: OAuthConnectionProvider;
112
- }
113
- /**
114
- * Response with available OAuth providers.
115
- *
116
- * Response model (includes read-only fields).
117
- */
118
- interface OAuthProvidersResponse {
119
- /** List of available OAuth providers */
120
- providers: Array<Record<string, any>>;
121
- }
122
122
 
123
123
  /**
124
124
  * API endpoints for Oauth.
@@ -165,7 +165,7 @@ declare class Oauth {
165
165
  *
166
166
  * Request model (no read-only fields).
167
167
  */
168
- interface PatchedUserProfileUpdateRequest$1 {
168
+ interface UserProfileUpdateRequest$1 {
169
169
  first_name?: string;
170
170
  last_name?: string;
171
171
  company?: string;
@@ -181,19 +181,6 @@ interface CfgAccountsProfileAvatarCreateRequest$1 {
181
181
  /** Avatar image file (JPEG, PNG, GIF, WebP, max 5MB) */
182
182
  avatar: File | Blob;
183
183
  }
184
- /**
185
- * Serializer for updating user profile.
186
- *
187
- * Request model (no read-only fields).
188
- */
189
- interface UserProfileUpdateRequest$1 {
190
- first_name?: string;
191
- last_name?: string;
192
- company?: string;
193
- phone?: string;
194
- position?: string;
195
- language?: string;
196
- }
197
184
  /**
198
185
  * Serializer for user details.
199
186
  *
@@ -224,6 +211,19 @@ interface User$2 {
224
211
  unanswered_messages_count: number;
225
212
  centrifugo: CentrifugoToken$1 | null;
226
213
  }
214
+ /**
215
+ * Serializer for updating user profile.
216
+ *
217
+ * Request model (no read-only fields).
218
+ */
219
+ interface PatchedUserProfileUpdateRequest$1 {
220
+ first_name?: string;
221
+ last_name?: string;
222
+ company?: string;
223
+ phone?: string;
224
+ position?: string;
225
+ language?: string;
226
+ }
227
227
  /**
228
228
  * Response serializer for account deletion.
229
229
  *
@@ -309,15 +309,25 @@ declare class UserProfile {
309
309
  }
310
310
 
311
311
  /**
312
- * Serializer for OTP request.
312
+ * OTP verification response. When 2FA is required: - requires_2fa: True -
313
+ * session_id: UUID of 2FA verification session - refresh/access/user: null
314
+ * When 2FA is not required: - requires_2fa: False - session_id: null -
315
+ * refresh/access/user: populated
313
316
  *
314
- * Request model (no read-only fields).
317
+ * Response model (includes read-only fields).
315
318
  */
316
- interface OTPRequestRequest$1 {
317
- /** Email address for OTP delivery */
318
- identifier: string;
319
- /** Source URL for tracking registration (e.g., https://my.djangocfg.com) */
320
- source_url?: string;
319
+ interface OTPVerifyResponse$1 {
320
+ /** Whether 2FA verification is required */
321
+ requires_2fa?: boolean;
322
+ /** 2FA session ID (if requires_2fa is True) */
323
+ session_id?: string | null;
324
+ /** JWT refresh token (if requires_2fa is False) */
325
+ refresh?: string | null;
326
+ /** JWT access token (if requires_2fa is False) */
327
+ access?: string | null;
328
+ user?: User$1 | null;
329
+ /** Whether user should be prompted to enable 2FA */
330
+ should_prompt_2fa?: boolean;
321
331
  }
322
332
  /**
323
333
  * Serializer for OTP verification.
@@ -332,34 +342,24 @@ interface OTPVerifyRequest$1 {
332
342
  source_url?: string;
333
343
  }
334
344
  /**
335
- * OTP request response.
345
+ * Serializer for OTP request.
336
346
  *
337
- * Response model (includes read-only fields).
347
+ * Request model (no read-only fields).
338
348
  */
339
- interface OTPRequestResponse$1 {
340
- /** Success message */
341
- message: string;
349
+ interface OTPRequestRequest$1 {
350
+ /** Email address for OTP delivery */
351
+ identifier: string;
352
+ /** Source URL for tracking registration (e.g., https://my.djangocfg.com) */
353
+ source_url?: string;
342
354
  }
343
355
  /**
344
- * OTP verification response. When 2FA is required: - requires_2fa: True -
345
- * session_id: UUID of 2FA verification session - refresh/access/user: null
346
- * When 2FA is not required: - requires_2fa: False - session_id: null -
347
- * refresh/access/user: populated
356
+ * OTP request response.
348
357
  *
349
358
  * Response model (includes read-only fields).
350
359
  */
351
- interface OTPVerifyResponse$1 {
352
- /** Whether 2FA verification is required */
353
- requires_2fa?: boolean;
354
- /** 2FA session ID (if requires_2fa is True) */
355
- session_id?: string | null;
356
- /** JWT refresh token (if requires_2fa is False) */
357
- refresh?: string | null;
358
- /** JWT access token (if requires_2fa is False) */
359
- access?: string | null;
360
- user?: User$1 | null;
361
- /** Whether user should be prompted to enable 2FA */
362
- should_prompt_2fa?: boolean;
360
+ interface OTPRequestResponse$1 {
361
+ /** Success message */
362
+ message: string;
363
363
  }
364
364
  /**
365
365
  * Serializer for user details.
package/dist/hooks.d.ts CHANGED
@@ -4,17 +4,17 @@ import useSWR from 'swr';
4
4
 
5
5
  /**
6
6
  *
7
- * Response model (includes read-only fields).
7
+ * Request model (no read-only fields).
8
8
  */
9
- interface TokenRefresh$1 {
10
- access: string;
9
+ interface TokenRefreshRequest$1 {
11
10
  refresh: string;
12
11
  }
13
12
  /**
14
13
  *
15
- * Request model (no read-only fields).
14
+ * Response model (includes read-only fields).
16
15
  */
17
- interface TokenRefreshRequest$1 {
16
+ interface TokenRefresh$1 {
17
+ access: string;
18
18
  refresh: string;
19
19
  }
20
20
 
@@ -38,6 +38,50 @@ declare enum OAuthConnectionProvider {
38
38
  GITHUB = "github"
39
39
  }
40
40
 
41
+ /**
42
+ * Request to start OAuth flow.
43
+ *
44
+ * Request model (no read-only fields).
45
+ */
46
+ interface OAuthAuthorizeRequestRequest$1 {
47
+ /** URL to redirect after OAuth authorization. If not provided, uses config's site_url + callback_path */
48
+ redirect_uri?: string;
49
+ /** Optional source URL for registration tracking */
50
+ source_url?: string;
51
+ }
52
+ /**
53
+ * Request to disconnect OAuth provider.
54
+ *
55
+ * Request model (no read-only fields).
56
+ */
57
+ interface OAuthDisconnectRequestRequest$1 {
58
+ /** OAuth provider to disconnect
59
+
60
+ * `github` - GitHub */
61
+ provider: OAuthConnectionProvider;
62
+ }
63
+ /**
64
+ * Response with available OAuth providers.
65
+ *
66
+ * Response model (includes read-only fields).
67
+ */
68
+ interface OAuthProvidersResponse {
69
+ /** List of available OAuth providers */
70
+ providers: Array<Record<string, any>>;
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
+ }
41
85
  /**
42
86
  * Response with OAuth authorization URL.
43
87
  *
@@ -75,50 +119,6 @@ interface OAuthTokenResponse$1 {
75
119
  /** True if user should be prompted to enable 2FA */
76
120
  should_prompt_2fa?: boolean;
77
121
  }
78
- /**
79
- * Request to start OAuth flow.
80
- *
81
- * Request model (no read-only fields).
82
- */
83
- interface OAuthAuthorizeRequestRequest$1 {
84
- /** URL to redirect after OAuth authorization. If not provided, uses config's site_url + callback_path */
85
- redirect_uri?: string;
86
- /** Optional source URL for registration tracking */
87
- source_url?: string;
88
- }
89
- /**
90
- * Request to complete OAuth flow (callback handler).
91
- *
92
- * Request model (no read-only fields).
93
- */
94
- interface OAuthCallbackRequestRequest$1 {
95
- /** Authorization code from OAuth provider callback */
96
- code: string;
97
- /** State token for CSRF verification (from authorize response) */
98
- state: string;
99
- /** Same redirect_uri used in authorize request. If not provided, uses config's site_url + callback_path */
100
- redirect_uri?: string;
101
- }
102
- /**
103
- * Request to disconnect OAuth provider.
104
- *
105
- * Request model (no read-only fields).
106
- */
107
- interface OAuthDisconnectRequestRequest$1 {
108
- /** OAuth provider to disconnect
109
-
110
- * `github` - GitHub */
111
- provider: OAuthConnectionProvider;
112
- }
113
- /**
114
- * Response with available OAuth providers.
115
- *
116
- * Response model (includes read-only fields).
117
- */
118
- interface OAuthProvidersResponse {
119
- /** List of available OAuth providers */
120
- providers: Array<Record<string, any>>;
121
- }
122
122
 
123
123
  /**
124
124
  * API endpoints for Oauth.
@@ -165,7 +165,7 @@ declare class Oauth {
165
165
  *
166
166
  * Request model (no read-only fields).
167
167
  */
168
- interface PatchedUserProfileUpdateRequest$1 {
168
+ interface UserProfileUpdateRequest$1 {
169
169
  first_name?: string;
170
170
  last_name?: string;
171
171
  company?: string;
@@ -181,19 +181,6 @@ interface CfgAccountsProfileAvatarCreateRequest$1 {
181
181
  /** Avatar image file (JPEG, PNG, GIF, WebP, max 5MB) */
182
182
  avatar: File | Blob;
183
183
  }
184
- /**
185
- * Serializer for updating user profile.
186
- *
187
- * Request model (no read-only fields).
188
- */
189
- interface UserProfileUpdateRequest$1 {
190
- first_name?: string;
191
- last_name?: string;
192
- company?: string;
193
- phone?: string;
194
- position?: string;
195
- language?: string;
196
- }
197
184
  /**
198
185
  * Serializer for user details.
199
186
  *
@@ -224,6 +211,19 @@ interface User$2 {
224
211
  unanswered_messages_count: number;
225
212
  centrifugo: CentrifugoToken$1 | null;
226
213
  }
214
+ /**
215
+ * Serializer for updating user profile.
216
+ *
217
+ * Request model (no read-only fields).
218
+ */
219
+ interface PatchedUserProfileUpdateRequest$1 {
220
+ first_name?: string;
221
+ last_name?: string;
222
+ company?: string;
223
+ phone?: string;
224
+ position?: string;
225
+ language?: string;
226
+ }
227
227
  /**
228
228
  * Response serializer for account deletion.
229
229
  *
@@ -309,15 +309,25 @@ declare class UserProfile {
309
309
  }
310
310
 
311
311
  /**
312
- * Serializer for OTP request.
312
+ * OTP verification response. When 2FA is required: - requires_2fa: True -
313
+ * session_id: UUID of 2FA verification session - refresh/access/user: null
314
+ * When 2FA is not required: - requires_2fa: False - session_id: null -
315
+ * refresh/access/user: populated
313
316
  *
314
- * Request model (no read-only fields).
317
+ * Response model (includes read-only fields).
315
318
  */
316
- interface OTPRequestRequest$1 {
317
- /** Email address for OTP delivery */
318
- identifier: string;
319
- /** Source URL for tracking registration (e.g., https://my.djangocfg.com) */
320
- source_url?: string;
319
+ interface OTPVerifyResponse$1 {
320
+ /** Whether 2FA verification is required */
321
+ requires_2fa?: boolean;
322
+ /** 2FA session ID (if requires_2fa is True) */
323
+ session_id?: string | null;
324
+ /** JWT refresh token (if requires_2fa is False) */
325
+ refresh?: string | null;
326
+ /** JWT access token (if requires_2fa is False) */
327
+ access?: string | null;
328
+ user?: User$1 | null;
329
+ /** Whether user should be prompted to enable 2FA */
330
+ should_prompt_2fa?: boolean;
321
331
  }
322
332
  /**
323
333
  * Serializer for OTP verification.
@@ -332,34 +342,24 @@ interface OTPVerifyRequest$1 {
332
342
  source_url?: string;
333
343
  }
334
344
  /**
335
- * OTP request response.
345
+ * Serializer for OTP request.
336
346
  *
337
- * Response model (includes read-only fields).
347
+ * Request model (no read-only fields).
338
348
  */
339
- interface OTPRequestResponse$1 {
340
- /** Success message */
341
- message: string;
349
+ interface OTPRequestRequest$1 {
350
+ /** Email address for OTP delivery */
351
+ identifier: string;
352
+ /** Source URL for tracking registration (e.g., https://my.djangocfg.com) */
353
+ source_url?: string;
342
354
  }
343
355
  /**
344
- * OTP verification response. When 2FA is required: - requires_2fa: True -
345
- * session_id: UUID of 2FA verification session - refresh/access/user: null
346
- * When 2FA is not required: - requires_2fa: False - session_id: null -
347
- * refresh/access/user: populated
356
+ * OTP request response.
348
357
  *
349
358
  * Response model (includes read-only fields).
350
359
  */
351
- interface OTPVerifyResponse$1 {
352
- /** Whether 2FA verification is required */
353
- requires_2fa?: boolean;
354
- /** 2FA session ID (if requires_2fa is True) */
355
- session_id?: string | null;
356
- /** JWT refresh token (if requires_2fa is False) */
357
- refresh?: string | null;
358
- /** JWT access token (if requires_2fa is False) */
359
- access?: string | null;
360
- user?: User$1 | null;
361
- /** Whether user should be prompted to enable 2FA */
362
- should_prompt_2fa?: boolean;
360
+ interface OTPRequestResponse$1 {
361
+ /** Success message */
362
+ message: string;
363
363
  }
364
364
  /**
365
365
  * Serializer for user details.