@djangocfg/api 2.1.309 → 2.1.312

package/dist/index.d.cts

@@ -48,35 +48,15 @@ declare namespace enums {
 }
 
 /**
- * Error response for OAuth endpoints.
- *
- * Response model (includes read-only fields).
- */
-interface OAuthError$1 {
-    /** Error code */
-    error: string;
-    /** Human-readable error description */
-    error_description?: string;
-}
-/**
- * Response with available OAuth providers.
- *
- * Response model (includes read-only fields).
- */
-interface OAuthProvidersResponse$1 {
-    /** List of available OAuth providers */
-    providers: Array<Record<string, any>>;
-}
-/**
- * Response with OAuth authorization URL.
+ * Request to start OAuth flow.
  *
- * Response model (includes read-only fields).
+ * Request model (no read-only fields).
  */
-interface OAuthAuthorizeResponse$1 {
-    /** Full URL to redirect user to OAuth provider */
-    authorization_url: string;
-    /** State token for CSRF protection. Store this and verify on callback. */
-    state: string;
+interface OAuthAuthorizeRequestRequest$1 {
+    /** URL to redirect after OAuth authorization. If not provided, uses config's site_url + callback_path */
+    redirect_uri?: string;
+    /** Optional source URL for registration tracking */
+    source_url?: string;
 }
 /**
  * Request to complete OAuth flow (callback handler).
@@ -91,6 +71,32 @@ interface OAuthCallbackRequestRequest$1 {
     /** Same redirect_uri used in authorize request. If not provided, uses config's site_url + callback_path */
     redirect_uri?: string;
 }
+/**
+ * Response with JWT tokens after OAuth authentication. When 2FA is required: -
+ * requires_2fa: True - session_id: UUID of 2FA verification session -
+ * access/refresh/user: null When 2FA is not required: - requires_2fa: False -
+ * session_id: null - access/refresh/user: populated
+ *
+ * Response model (includes read-only fields).
+ */
+interface OAuthTokenResponse$1 {
+    /** True if 2FA verification is required */
+    requires_2fa?: boolean;
+    /** 2FA session ID (only when requires_2fa=True) */
+    session_id?: string | null;
+    /** JWT access token (null when requires_2fa=True) */
+    access?: string | null;
+    /** JWT refresh token (null when requires_2fa=True) */
+    refresh?: string | null;
+    /** Authenticated user info (null when requires_2fa=True) */
+    user?: Record<string, any> | null;
+    /** True if a new user was created during this OAuth flow */
+    is_new_user: boolean;
+    /** True if a new OAuth connection was created */
+    is_new_connection: boolean;
+    /** True if user should be prompted to enable 2FA */
+    should_prompt_2fa?: boolean;
+}
 /**
  * Serializer for OAuth connection info (user-facing).
  *
@@ -115,41 +121,15 @@ interface OAuthConnection$1 {
     last_login_at: string;
 }
 /**
- * Request to start OAuth flow.
- *
- * Request model (no read-only fields).
- */
-interface OAuthAuthorizeRequestRequest$1 {
-    /** URL to redirect after OAuth authorization. If not provided, uses config's site_url + callback_path */
-    redirect_uri?: string;
-    /** Optional source URL for registration tracking */
-    source_url?: string;
-}
-/**
- * Response with JWT tokens after OAuth authentication. When 2FA is required: -
- * requires_2fa: True - session_id: UUID of 2FA verification session -
- * access/refresh/user: null When 2FA is not required: - requires_2fa: False -
- * session_id: null - access/refresh/user: populated
+ * Response with OAuth authorization URL.
  *
  * Response model (includes read-only fields).
  */
-interface OAuthTokenResponse$1 {
-    /** True if 2FA verification is required */
-    requires_2fa?: boolean;
-    /** 2FA session ID (only when requires_2fa=True) */
-    session_id?: string | null;
-    /** JWT access token (null when requires_2fa=True) */
-    access?: string | null;
-    /** JWT refresh token (null when requires_2fa=True) */
-    refresh?: string | null;
-    /** Authenticated user info (null when requires_2fa=True) */
-    user?: Record<string, any> | null;
-    /** True if a new user was created during this OAuth flow */
-    is_new_user: boolean;
-    /** True if a new OAuth connection was created */
-    is_new_connection: boolean;
-    /** True if user should be prompted to enable 2FA */
-    should_prompt_2fa?: boolean;
+interface OAuthAuthorizeResponse$1 {
+    /** Full URL to redirect user to OAuth provider */
+    authorization_url: string;
+    /** State token for CSRF protection. Store this and verify on callback. */
+    state: string;
 }
 /**
  * Request to disconnect OAuth provider.
@@ -162,6 +142,26 @@ interface OAuthDisconnectRequestRequest$1 {
     * `github` - GitHub */
     provider: OAuthConnectionProvider;
 }
+/**
+ * Response with available OAuth providers.
+ *
+ * Response model (includes read-only fields).
+ */
+interface OAuthProvidersResponse$1 {
+    /** List of available OAuth providers */
+    providers: Array<Record<string, any>>;
+}
+/**
+ * Error response for OAuth endpoints.
+ *
+ * Response model (includes read-only fields).
+ */
+interface OAuthError$1 {
+    /** Error code */
+    error: string;
+    /** Human-readable error description */
+    error_description?: string;
+}
 
 declare namespace models$2 {
   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 };
@@ -212,7 +212,7 @@ declare class Oauth {
  *
  * Request model (no read-only fields).
  */
-interface UserProfileUpdateRequest$1 {
+interface PatchedUserProfileUpdateRequest$1 {
     first_name?: string;
     last_name?: string;
     company?: string;
@@ -221,17 +221,23 @@ interface UserProfileUpdateRequest$1 {
     language?: string;
 }
 /**
- * Serializer for updating user profile.
  *
  * Request model (no read-only fields).
  */
-interface PatchedUserProfileUpdateRequest$1 {
-    first_name?: string;
-    last_name?: string;
-    company?: string;
-    phone?: string;
-    position?: string;
-    language?: string;
+interface CfgAccountsProfileAvatarCreateRequest$1 {
+    /** Avatar image file (JPEG, PNG, GIF, WebP, max 5MB) */
+    avatar: File | Blob;
+}
+/**
+ * Response serializer for account deletion.
+ *
+ * Response model (includes read-only fields).
+ */
+interface AccountDeleteResponse$1 {
+    /** Whether the account was successfully deleted */
+    success: boolean;
+    /** Human-readable message about the deletion */
+    message: string;
 }
 /**
  * Serializer for user details.
@@ -264,23 +270,17 @@ interface User$2 {
     centrifugo: CentrifugoToken$2 | null;
 }
 /**
- * Response serializer for account deletion.
- *
- * Response model (includes read-only fields).
- */
-interface AccountDeleteResponse$1 {
-    /** Whether the account was successfully deleted */
-    success: boolean;
-    /** Human-readable message about the deletion */
-    message: string;
-}
-/**
+ * Serializer for updating user profile.
  *
  * Request model (no read-only fields).
  */
-interface CfgAccountsProfileAvatarCreateRequest$1 {
-    /** Avatar image file (JPEG, PNG, GIF, WebP, max 5MB) */
-    avatar: File | Blob;
+interface UserProfileUpdateRequest$1 {
+    first_name?: string;
+    last_name?: string;
+    company?: string;
+    phone?: string;
+    position?: string;
+    language?: string;
 }
 /**
  * Nested serializer for Centrifugo WebSocket connection token.
@@ -359,18 +359,6 @@ declare class UserProfile {
     accountsProfileUpdatePartialUpdate(data?: PatchedUserProfileUpdateRequest$1): Promise<User$2>;
 }
 
-/**
- * Serializer for OTP verification.
- *
- * Request model (no read-only fields).
- */
-interface OTPVerifyRequest$1 {
-    /** Email address used for OTP request */
-    identifier: string;
-    otp: string;
-    /** Source URL for tracking login (e.g., https://my.djangocfg.com) */
-    source_url?: string;
-}
 /**
  * OTP verification response. When 2FA is required: - requires_2fa: True -
  * session_id: UUID of 2FA verification session - refresh/access/user: null
@@ -392,17 +380,6 @@ interface OTPVerifyResponse$1 {
     /** Whether user should be prompted to enable 2FA */
     should_prompt_2fa?: boolean;
 }
-/**
- * Serializer for OTP request.
- *
- * Request model (no read-only fields).
- */
-interface OTPRequestRequest$1 {
-    /** Email address for OTP delivery */
-    identifier: string;
-    /** Source URL for tracking registration (e.g., https://my.djangocfg.com) */
-    source_url?: string;
-}
 /**
  * OTP request response.
  *
@@ -432,6 +409,29 @@ interface OTPErrorResponse$1 {
     /** Seconds until the client may retry (present only for rate-limit errors) */
     retry_after?: number | null;
 }
+/**
+ * Serializer for OTP verification.
+ *
+ * Request model (no read-only fields).
+ */
+interface OTPVerifyRequest$1 {
+    /** Email address used for OTP request */
+    identifier: string;
+    otp: string;
+    /** Source URL for tracking login (e.g., https://my.djangocfg.com) */
+    source_url?: string;
+}
+/**
+ * Serializer for OTP request.
+ *
+ * Request model (no read-only fields).
+ */
+interface OTPRequestRequest$1 {
+    /** Email address for OTP delivery */
+    identifier: string;
+    /** Source URL for tracking registration (e.g., https://my.djangocfg.com) */
+    source_url?: string;
+}
 /**
  * Serializer for user details.
  *
@@ -517,6 +517,11 @@ interface HttpRequest {
     formData?: FormData;
     /** Binary data for octet-stream uploads */
     binaryBody?: Blob | ArrayBuffer;
+    /**
+     * Force a specific response parser. When set, overrides Content-Type sniffing.
+     * Generated for endpoints whose primary response is binary (file downloads).
+     */
+    responseType?: 'json' | 'text' | 'blob';
 }
 interface HttpResponse<T = any> {
     data: T;
@@ -821,6 +826,7 @@ declare class APIClient {
         formData?: FormData;
         binaryBody?: Blob | ArrayBuffer;
         headers?: Record<string, string>;
+        responseType?: 'json' | 'text' | 'blob';
     }): Promise<T>;
     /**
      * Internal request method (without retry wrapper).

package/dist/index.d.ts

@@ -48,35 +48,15 @@ declare namespace enums {
 }
 
 /**
- * Error response for OAuth endpoints.
- *
- * Response model (includes read-only fields).
- */
-interface OAuthError$1 {
-    /** Error code */
-    error: string;
-    /** Human-readable error description */
-    error_description?: string;
-}
-/**
- * Response with available OAuth providers.
- *
- * Response model (includes read-only fields).
- */
-interface OAuthProvidersResponse$1 {
-    /** List of available OAuth providers */
-    providers: Array<Record<string, any>>;
-}
-/**
- * Response with OAuth authorization URL.
+ * Request to start OAuth flow.
  *
- * Response model (includes read-only fields).
+ * Request model (no read-only fields).
  */
-interface OAuthAuthorizeResponse$1 {
-    /** Full URL to redirect user to OAuth provider */
-    authorization_url: string;
-    /** State token for CSRF protection. Store this and verify on callback. */
-    state: string;
+interface OAuthAuthorizeRequestRequest$1 {
+    /** URL to redirect after OAuth authorization. If not provided, uses config's site_url + callback_path */
+    redirect_uri?: string;
+    /** Optional source URL for registration tracking */
+    source_url?: string;
 }
 /**
  * Request to complete OAuth flow (callback handler).
@@ -91,6 +71,32 @@ interface OAuthCallbackRequestRequest$1 {
     /** Same redirect_uri used in authorize request. If not provided, uses config's site_url + callback_path */
     redirect_uri?: string;
 }
+/**
+ * Response with JWT tokens after OAuth authentication. When 2FA is required: -
+ * requires_2fa: True - session_id: UUID of 2FA verification session -
+ * access/refresh/user: null When 2FA is not required: - requires_2fa: False -
+ * session_id: null - access/refresh/user: populated
+ *
+ * Response model (includes read-only fields).
+ */
+interface OAuthTokenResponse$1 {
+    /** True if 2FA verification is required */
+    requires_2fa?: boolean;
+    /** 2FA session ID (only when requires_2fa=True) */
+    session_id?: string | null;
+    /** JWT access token (null when requires_2fa=True) */
+    access?: string | null;
+    /** JWT refresh token (null when requires_2fa=True) */
+    refresh?: string | null;
+    /** Authenticated user info (null when requires_2fa=True) */
+    user?: Record<string, any> | null;
+    /** True if a new user was created during this OAuth flow */
+    is_new_user: boolean;
+    /** True if a new OAuth connection was created */
+    is_new_connection: boolean;
+    /** True if user should be prompted to enable 2FA */
+    should_prompt_2fa?: boolean;
+}
 /**
  * Serializer for OAuth connection info (user-facing).
  *
@@ -115,41 +121,15 @@ interface OAuthConnection$1 {
     last_login_at: string;
 }
 /**
- * Request to start OAuth flow.
- *
- * Request model (no read-only fields).
- */
-interface OAuthAuthorizeRequestRequest$1 {
-    /** URL to redirect after OAuth authorization. If not provided, uses config's site_url + callback_path */
-    redirect_uri?: string;
-    /** Optional source URL for registration tracking */
-    source_url?: string;
-}
-/**
- * Response with JWT tokens after OAuth authentication. When 2FA is required: -
- * requires_2fa: True - session_id: UUID of 2FA verification session -
- * access/refresh/user: null When 2FA is not required: - requires_2fa: False -
- * session_id: null - access/refresh/user: populated
+ * Response with OAuth authorization URL.
  *
  * Response model (includes read-only fields).
  */
-interface OAuthTokenResponse$1 {
-    /** True if 2FA verification is required */
-    requires_2fa?: boolean;
-    /** 2FA session ID (only when requires_2fa=True) */
-    session_id?: string | null;
-    /** JWT access token (null when requires_2fa=True) */
-    access?: string | null;
-    /** JWT refresh token (null when requires_2fa=True) */
-    refresh?: string | null;
-    /** Authenticated user info (null when requires_2fa=True) */
-    user?: Record<string, any> | null;
-    /** True if a new user was created during this OAuth flow */
-    is_new_user: boolean;
-    /** True if a new OAuth connection was created */
-    is_new_connection: boolean;
-    /** True if user should be prompted to enable 2FA */
-    should_prompt_2fa?: boolean;
+interface OAuthAuthorizeResponse$1 {
+    /** Full URL to redirect user to OAuth provider */
+    authorization_url: string;
+    /** State token for CSRF protection. Store this and verify on callback. */
+    state: string;
 }
 /**
  * Request to disconnect OAuth provider.
@@ -162,6 +142,26 @@ interface OAuthDisconnectRequestRequest$1 {
     * `github` - GitHub */
     provider: OAuthConnectionProvider;
 }
+/**
+ * Response with available OAuth providers.
+ *
+ * Response model (includes read-only fields).
+ */
+interface OAuthProvidersResponse$1 {
+    /** List of available OAuth providers */
+    providers: Array<Record<string, any>>;
+}
+/**
+ * Error response for OAuth endpoints.
+ *
+ * Response model (includes read-only fields).
+ */
+interface OAuthError$1 {
+    /** Error code */
+    error: string;
+    /** Human-readable error description */
+    error_description?: string;
+}
 
 declare namespace models$2 {
   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 };
@@ -212,7 +212,7 @@ declare class Oauth {
  *
  * Request model (no read-only fields).
  */
-interface UserProfileUpdateRequest$1 {
+interface PatchedUserProfileUpdateRequest$1 {
     first_name?: string;
     last_name?: string;
     company?: string;
@@ -221,17 +221,23 @@ interface UserProfileUpdateRequest$1 {
     language?: string;
 }
 /**
- * Serializer for updating user profile.
  *
  * Request model (no read-only fields).
  */
-interface PatchedUserProfileUpdateRequest$1 {
-    first_name?: string;
-    last_name?: string;
-    company?: string;
-    phone?: string;
-    position?: string;
-    language?: string;
+interface CfgAccountsProfileAvatarCreateRequest$1 {
+    /** Avatar image file (JPEG, PNG, GIF, WebP, max 5MB) */
+    avatar: File | Blob;
+}
+/**
+ * Response serializer for account deletion.
+ *
+ * Response model (includes read-only fields).
+ */
+interface AccountDeleteResponse$1 {
+    /** Whether the account was successfully deleted */
+    success: boolean;
+    /** Human-readable message about the deletion */
+    message: string;
 }
 /**
  * Serializer for user details.
@@ -264,23 +270,17 @@ interface User$2 {
     centrifugo: CentrifugoToken$2 | null;
 }
 /**
- * Response serializer for account deletion.
- *
- * Response model (includes read-only fields).
- */
-interface AccountDeleteResponse$1 {
-    /** Whether the account was successfully deleted */
-    success: boolean;
-    /** Human-readable message about the deletion */
-    message: string;
-}
-/**
+ * Serializer for updating user profile.
  *
  * Request model (no read-only fields).
  */
-interface CfgAccountsProfileAvatarCreateRequest$1 {
-    /** Avatar image file (JPEG, PNG, GIF, WebP, max 5MB) */
-    avatar: File | Blob;
+interface UserProfileUpdateRequest$1 {
+    first_name?: string;
+    last_name?: string;
+    company?: string;
+    phone?: string;
+    position?: string;
+    language?: string;
 }
 /**
  * Nested serializer for Centrifugo WebSocket connection token.
@@ -359,18 +359,6 @@ declare class UserProfile {
     accountsProfileUpdatePartialUpdate(data?: PatchedUserProfileUpdateRequest$1): Promise<User$2>;
 }
 
-/**
- * Serializer for OTP verification.
- *
- * Request model (no read-only fields).
- */
-interface OTPVerifyRequest$1 {
-    /** Email address used for OTP request */
-    identifier: string;
-    otp: string;
-    /** Source URL for tracking login (e.g., https://my.djangocfg.com) */
-    source_url?: string;
-}
 /**
  * OTP verification response. When 2FA is required: - requires_2fa: True -
  * session_id: UUID of 2FA verification session - refresh/access/user: null
@@ -392,17 +380,6 @@ interface OTPVerifyResponse$1 {
     /** Whether user should be prompted to enable 2FA */
     should_prompt_2fa?: boolean;
 }
-/**
- * Serializer for OTP request.
- *
- * Request model (no read-only fields).
- */
-interface OTPRequestRequest$1 {
-    /** Email address for OTP delivery */
-    identifier: string;
-    /** Source URL for tracking registration (e.g., https://my.djangocfg.com) */
-    source_url?: string;
-}
 /**
  * OTP request response.
  *
@@ -432,6 +409,29 @@ interface OTPErrorResponse$1 {
     /** Seconds until the client may retry (present only for rate-limit errors) */
     retry_after?: number | null;
 }
+/**
+ * Serializer for OTP verification.
+ *
+ * Request model (no read-only fields).
+ */
+interface OTPVerifyRequest$1 {
+    /** Email address used for OTP request */
+    identifier: string;
+    otp: string;
+    /** Source URL for tracking login (e.g., https://my.djangocfg.com) */
+    source_url?: string;
+}
+/**
+ * Serializer for OTP request.
+ *
+ * Request model (no read-only fields).
+ */
+interface OTPRequestRequest$1 {
+    /** Email address for OTP delivery */
+    identifier: string;
+    /** Source URL for tracking registration (e.g., https://my.djangocfg.com) */
+    source_url?: string;
+}
 /**
  * Serializer for user details.
  *
@@ -517,6 +517,11 @@ interface HttpRequest {
     formData?: FormData;
     /** Binary data for octet-stream uploads */
     binaryBody?: Blob | ArrayBuffer;
+    /**
+     * Force a specific response parser. When set, overrides Content-Type sniffing.
+     * Generated for endpoints whose primary response is binary (file downloads).
+     */
+    responseType?: 'json' | 'text' | 'blob';
 }
 interface HttpResponse<T = any> {
     data: T;
@@ -821,6 +826,7 @@ declare class APIClient {
         formData?: FormData;
         binaryBody?: Blob | ArrayBuffer;
         headers?: Record<string, string>;
+        responseType?: 'json' | 'text' | 'blob';
     }): Promise<T>;
     /**
      * Internal request method (without retry wrapper).