@djangocfg/api 2.1.322 → 2.1.327

package/src/_api/generated/cfg_accounts/types.gen.ts

@@ -0,0 +1,764 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+export type ClientOptions = {
+    baseUrl: 'http://localhost:8000' | (string & {});
+};
+
+/**
+ * Response serializer for account deletion.
+ */
+export type AccountDeleteResponse = {
+    /**
+     * Whether the account was successfully deleted
+     */
+    success: boolean;
+    /**
+     * Human-readable message about the deletion
+     */
+    message: string;
+};
+
+/**
+ * Nested serializer for Centrifugo WebSocket connection token.
+ */
+export type CentrifugoToken = {
+    /**
+     * JWT token for Centrifugo WebSocket connection
+     */
+    token: string;
+    /**
+     * Centrifugo WebSocket URL
+     */
+    centrifugo_url: string;
+    /**
+     * Token expiration time (ISO 8601)
+     */
+    expires_at: string;
+    /**
+     * List of allowed channels for this user
+     */
+    channels: Array<string>;
+};
+
+/**
+ * Serializer for updating user profile.
+ */
+export type CfgUserUpdateRequest = {
+    first_name?: string;
+    last_name?: string;
+    company?: string;
+    phone?: string;
+    position?: string;
+    language?: string;
+};
+
+/**
+ * Request to start OAuth flow.
+ */
+export type OAuthAuthorizeRequestRequest = {
+    /**
+     * 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 OAuth authorization URL.
+ */
+export type OAuthAuthorizeResponse = {
+    /**
+     * 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 complete OAuth flow (callback handler).
+ */
+export type OAuthCallbackRequestRequest = {
+    /**
+     * Authorization code from OAuth provider callback
+     */
+    code: string;
+    /**
+     * State token for CSRF verification (from authorize response)
+     */
+    state: string;
+    /**
+     * Same redirect_uri used in authorize request. If not provided, uses config's site_url + callback_path
+     */
+    redirect_uri?: string;
+};
+
+/**
+ * Serializer for OAuth connection info (user-facing).
+ */
+export type OAuthConnection = {
+    readonly id: number;
+    /**
+     * OAuth provider name (github, google, etc.)
+     *
+     * * `github` - GitHub
+     */
+    readonly provider: ProviderEnum;
+    readonly provider_display: string;
+    /**
+     * Username on the OAuth provider platform
+     */
+    readonly provider_username: string;
+    /**
+     * Email from OAuth provider (may differ from user.email)
+     */
+    readonly provider_email: string;
+    /**
+     * Avatar URL from OAuth provider
+     */
+    readonly provider_avatar_url: string;
+    /**
+     * When this OAuth connection was created
+     */
+    readonly connected_at: string;
+    /**
+     * Last time this OAuth connection was used for login
+     */
+    readonly last_login_at: string;
+};
+
+/**
+ * Request to disconnect OAuth provider.
+ */
+export type OAuthDisconnectRequestRequest = {
+    /**
+     * OAuth provider to disconnect
+     *
+     * * `github` - GitHub
+     */
+    provider: ProviderEnum;
+};
+
+/**
+ * Error response for OAuth endpoints.
+ */
+export type OAuthError = {
+    /**
+     * Error code
+     */
+    error: string;
+    /**
+     * Human-readable error description
+     */
+    error_description?: string;
+};
+
+/**
+ * Response with available OAuth providers.
+ */
+export type OAuthProvidersResponse = {
+    /**
+     * List of available OAuth providers
+     */
+    providers: Array<{
+        [key: string]: unknown;
+    }>;
+};
+
+/**
+ * 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
+ */
+export type OAuthTokenResponse = {
+    /**
+     * 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?: {
+        [key: string]: unknown;
+    } | 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;
+};
+
+/**
+ * Typed error response for OTP operations.
+ *
+ * error_code values:
+ * - invalid_identifier   — malformed email
+ * - cooldown             — too soon after last request (retry_after = seconds)
+ * - hourly_limit         — hourly quota exceeded   (retry_after = seconds until reset)
+ * - daily_limit          — daily quota exceeded    (retry_after = seconds until reset)
+ * - rate_limited         — IP-level rate limit hit (no retry_after)
+ * - user_creation_failed — internal error creating account
+ * - send_failed          — transport error (email / SMS)
+ * - internal_error       — unexpected server error
+ */
+export type OtpErrorResponse = {
+    /**
+     * Human-readable error message
+     */
+    error: string;
+    /**
+     * Machine-readable error code
+     */
+    error_code?: string | null;
+    /**
+     * Seconds until the client may retry (present only for rate-limit errors)
+     */
+    retry_after?: number | null;
+};
+
+/**
+ * Serializer for OTP request.
+ */
+export type OtpRequestRequest = {
+    /**
+     * Email address for OTP delivery
+     */
+    identifier: string;
+    /**
+     * Source URL for tracking registration (e.g., https://my.djangocfg.com)
+     */
+    source_url?: string;
+};
+
+/**
+ * OTP request response.
+ */
+export type OtpRequestResponse = {
+    /**
+     * Success message
+     */
+    message: string;
+};
+
+/**
+ * Serializer for OTP verification.
+ */
+export type OtpVerifyRequest = {
+    /**
+     * 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
+ *
+ * When 2FA is not required:
+ * - requires_2fa: False
+ * - session_id: null
+ * - refresh/access/user: populated
+ */
+export type OtpVerifyResponse = {
+    /**
+     * Whether 2FA verification is required
+     */
+    requires_2fa?: boolean;
+    /**
+     * 2FA session ID (if requires_2fa is True)
+     */
+    session_id?: string | null;
+    /**
+     * JWT refresh token (if requires_2fa is False)
+     */
+    refresh?: string | null;
+    /**
+     * JWT access token (if requires_2fa is False)
+     */
+    access?: string | null;
+    /**
+     * User information (if requires_2fa is False)
+     */
+    user?: User | null;
+    /**
+     * Whether user should be prompted to enable 2FA
+     */
+    should_prompt_2fa?: boolean;
+};
+
+/**
+ * Serializer for updating user profile.
+ */
+export type PatchedCfgUserUpdateRequest = {
+    first_name?: string;
+    last_name?: string;
+    company?: string;
+    phone?: string;
+    position?: string;
+    language?: string;
+};
+
+/**
+ * * `github` - GitHub
+ */
+export enum ProviderEnum {
+    GITHUB = 'github'
+}
+
+export type TokenRefresh = {
+    readonly access: string;
+    refresh: string;
+};
+
+export type TokenRefreshRequest = {
+    refresh: string;
+};
+
+/**
+ * Serializer for user details.
+ */
+export type User = {
+    readonly id: number;
+    readonly email: string;
+    first_name?: string;
+    last_name?: string;
+    /**
+     * Get user's full name.
+     */
+    readonly full_name: string;
+    /**
+     * Get user's initials for avatar fallback.
+     */
+    readonly initials: string;
+    /**
+     * Get formatted username for display.
+     */
+    readonly display_username: string;
+    company?: string;
+    phone?: string;
+    position?: string;
+    language?: string;
+    readonly avatar: string | null;
+    /**
+     * Staff status
+     *
+     * Designates whether the user can log into this admin site.
+     */
+    readonly is_staff: boolean;
+    /**
+     * Superuser status
+     *
+     * Designates that this user has all permissions without explicitly assigning them.
+     */
+    readonly is_superuser: boolean;
+    readonly date_joined: string;
+    readonly last_login: string | null;
+    readonly unanswered_messages_count: number;
+    readonly centrifugo: CentrifugoToken | null;
+};
+
+/**
+ * OTP verification response.
+ *
+ * When 2FA is required:
+ * - requires_2fa: True
+ * - session_id: UUID of 2FA verification session
+ * - refresh/access/user: null
+ *
+ * When 2FA is not required:
+ * - requires_2fa: False
+ * - session_id: null
+ * - refresh/access/user: populated
+ */
+export type OtpVerifyResponseWritable = {
+    /**
+     * Whether 2FA verification is required
+     */
+    requires_2fa?: boolean;
+    /**
+     * 2FA session ID (if requires_2fa is True)
+     */
+    session_id?: string | null;
+    /**
+     * JWT refresh token (if requires_2fa is False)
+     */
+    refresh?: string | null;
+    /**
+     * JWT access token (if requires_2fa is False)
+     */
+    access?: string | null;
+    /**
+     * User information (if requires_2fa is False)
+     */
+    user?: UserWritable | null;
+    /**
+     * Whether user should be prompted to enable 2FA
+     */
+    should_prompt_2fa?: boolean;
+};
+
+export type TokenRefreshWritable = {
+    refresh: string;
+};
+
+/**
+ * Serializer for user details.
+ */
+export type UserWritable = {
+    first_name?: string;
+    last_name?: string;
+    company?: string;
+    phone?: string;
+    position?: string;
+    language?: string;
+};
+
+export type CfgAccountsOauthConnectionsListData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/cfg/accounts/oauth/connections/';
+};
+
+export type CfgAccountsOauthConnectionsListResponses = {
+    200: Array<OAuthConnection>;
+};
+
+export type CfgAccountsOauthConnectionsListResponse = CfgAccountsOauthConnectionsListResponses[keyof CfgAccountsOauthConnectionsListResponses];
+
+export type CfgAccountsOauthDisconnectCreateData = {
+    body: OAuthDisconnectRequestRequest;
+    path?: never;
+    query?: never;
+    url: '/cfg/accounts/oauth/disconnect/';
+};
+
+export type CfgAccountsOauthDisconnectCreateErrors = {
+    400: OAuthError;
+    404: OAuthError;
+};
+
+export type CfgAccountsOauthDisconnectCreateError = CfgAccountsOauthDisconnectCreateErrors[keyof CfgAccountsOauthDisconnectCreateErrors];
+
+export type CfgAccountsOauthDisconnectCreateResponses = {
+    200: {
+        message?: string;
+    };
+};
+
+export type CfgAccountsOauthDisconnectCreateResponse = CfgAccountsOauthDisconnectCreateResponses[keyof CfgAccountsOauthDisconnectCreateResponses];
+
+export type CfgAccountsOauthGithubAuthorizeCreateData = {
+    body?: OAuthAuthorizeRequestRequest;
+    path?: never;
+    query?: never;
+    url: '/cfg/accounts/oauth/github/authorize/';
+};
+
+export type CfgAccountsOauthGithubAuthorizeCreateErrors = {
+    503: OAuthError;
+};
+
+export type CfgAccountsOauthGithubAuthorizeCreateError = CfgAccountsOauthGithubAuthorizeCreateErrors[keyof CfgAccountsOauthGithubAuthorizeCreateErrors];
+
+export type CfgAccountsOauthGithubAuthorizeCreateResponses = {
+    200: OAuthAuthorizeResponse;
+};
+
+export type CfgAccountsOauthGithubAuthorizeCreateResponse = CfgAccountsOauthGithubAuthorizeCreateResponses[keyof CfgAccountsOauthGithubAuthorizeCreateResponses];
+
+export type CfgAccountsOauthGithubCallbackCreateData = {
+    body: OAuthCallbackRequestRequest;
+    path?: never;
+    query?: never;
+    url: '/cfg/accounts/oauth/github/callback/';
+};
+
+export type CfgAccountsOauthGithubCallbackCreateErrors = {
+    400: OAuthError;
+};
+
+export type CfgAccountsOauthGithubCallbackCreateError = CfgAccountsOauthGithubCallbackCreateErrors[keyof CfgAccountsOauthGithubCallbackCreateErrors];
+
+export type CfgAccountsOauthGithubCallbackCreateResponses = {
+    200: OAuthTokenResponse;
+};
+
+export type CfgAccountsOauthGithubCallbackCreateResponse = CfgAccountsOauthGithubCallbackCreateResponses[keyof CfgAccountsOauthGithubCallbackCreateResponses];
+
+export type CfgAccountsOauthProvidersRetrieveData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/cfg/accounts/oauth/providers/';
+};
+
+export type CfgAccountsOauthProvidersRetrieveResponses = {
+    200: OAuthProvidersResponse;
+};
+
+export type CfgAccountsOauthProvidersRetrieveResponse = CfgAccountsOauthProvidersRetrieveResponses[keyof CfgAccountsOauthProvidersRetrieveResponses];
+
+export type CfgAccountsOtpRequestCreateData = {
+    body: OtpRequestRequest;
+    path?: never;
+    query?: never;
+    url: '/cfg/accounts/otp/request/';
+};
+
+export type CfgAccountsOtpRequestCreateErrors = {
+    400: OtpErrorResponse;
+    429: OtpErrorResponse;
+    500: OtpErrorResponse;
+};
+
+export type CfgAccountsOtpRequestCreateError = CfgAccountsOtpRequestCreateErrors[keyof CfgAccountsOtpRequestCreateErrors];
+
+export type CfgAccountsOtpRequestCreateResponses = {
+    200: OtpRequestResponse;
+};
+
+export type CfgAccountsOtpRequestCreateResponse = CfgAccountsOtpRequestCreateResponses[keyof CfgAccountsOtpRequestCreateResponses];
+
+export type CfgAccountsOtpVerifyCreateData = {
+    body: OtpVerifyRequest;
+    path?: never;
+    query?: never;
+    url: '/cfg/accounts/otp/verify/';
+};
+
+export type CfgAccountsOtpVerifyCreateErrors = {
+    401: OtpErrorResponse;
+    429: OtpErrorResponse;
+};
+
+export type CfgAccountsOtpVerifyCreateError = CfgAccountsOtpVerifyCreateErrors[keyof CfgAccountsOtpVerifyCreateErrors];
+
+export type CfgAccountsOtpVerifyCreateResponses = {
+    200: OtpVerifyResponse;
+};
+
+export type CfgAccountsOtpVerifyCreateResponse = CfgAccountsOtpVerifyCreateResponses[keyof CfgAccountsOtpVerifyCreateResponses];
+
+export type CfgAccountsProfileRetrieveData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/cfg/accounts/profile/';
+};
+
+export type CfgAccountsProfileRetrieveErrors = {
+    /**
+     * Authentication credentials were not provided.
+     */
+    401: unknown;
+};
+
+export type CfgAccountsProfileRetrieveResponses = {
+    200: User;
+};
+
+export type CfgAccountsProfileRetrieveResponse = CfgAccountsProfileRetrieveResponses[keyof CfgAccountsProfileRetrieveResponses];
+
+export type CfgAccountsProfileAvatarCreateData = {
+    body?: {
+        /**
+         * Avatar image file (JPEG, PNG, GIF, WebP, max 5MB)
+         */
+        avatar: Blob | File;
+    };
+    path?: never;
+    query?: never;
+    url: '/cfg/accounts/profile/avatar/';
+};
+
+export type CfgAccountsProfileAvatarCreateErrors = {
+    /**
+     * Invalid file or validation error.
+     */
+    400: unknown;
+    /**
+     * Authentication credentials were not provided.
+     */
+    401: unknown;
+};
+
+export type CfgAccountsProfileAvatarCreateResponses = {
+    200: User;
+};
+
+export type CfgAccountsProfileAvatarCreateResponse = CfgAccountsProfileAvatarCreateResponses[keyof CfgAccountsProfileAvatarCreateResponses];
+
+export type CfgAccountsProfileDeleteCreateData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/cfg/accounts/profile/delete/';
+};
+
+export type CfgAccountsProfileDeleteCreateErrors = {
+    /**
+     * Account is already deleted.
+     */
+    400: unknown;
+    /**
+     * Authentication credentials were not provided.
+     */
+    401: unknown;
+};
+
+export type CfgAccountsProfileDeleteCreateResponses = {
+    200: AccountDeleteResponse;
+};
+
+export type CfgAccountsProfileDeleteCreateResponse = CfgAccountsProfileDeleteCreateResponses[keyof CfgAccountsProfileDeleteCreateResponses];
+
+export type CfgAccountsProfilePartialPartialUpdateData = {
+    body?: PatchedCfgUserUpdateRequest;
+    path?: never;
+    query?: never;
+    url: '/cfg/accounts/profile/partial/';
+};
+
+export type CfgAccountsProfilePartialPartialUpdateErrors = {
+    /**
+     * Invalid data provided.
+     */
+    400: unknown;
+    /**
+     * Authentication credentials were not provided.
+     */
+    401: unknown;
+};
+
+export type CfgAccountsProfilePartialPartialUpdateResponses = {
+    200: User;
+};
+
+export type CfgAccountsProfilePartialPartialUpdateResponse = CfgAccountsProfilePartialPartialUpdateResponses[keyof CfgAccountsProfilePartialPartialUpdateResponses];
+
+export type CfgAccountsProfilePartialUpdateData = {
+    body?: CfgUserUpdateRequest;
+    path?: never;
+    query?: never;
+    url: '/cfg/accounts/profile/partial/';
+};
+
+export type CfgAccountsProfilePartialUpdateErrors = {
+    /**
+     * Invalid data provided.
+     */
+    400: unknown;
+    /**
+     * Authentication credentials were not provided.
+     */
+    401: unknown;
+};
+
+export type CfgAccountsProfilePartialUpdateResponses = {
+    200: User;
+};
+
+export type CfgAccountsProfilePartialUpdateResponse = CfgAccountsProfilePartialUpdateResponses[keyof CfgAccountsProfilePartialUpdateResponses];
+
+export type CfgAccountsProfileUpdatePartialUpdateData = {
+    body?: PatchedCfgUserUpdateRequest;
+    path?: never;
+    query?: never;
+    url: '/cfg/accounts/profile/update/';
+};
+
+export type CfgAccountsProfileUpdatePartialUpdateErrors = {
+    /**
+     * Invalid data provided.
+     */
+    400: unknown;
+    /**
+     * Authentication credentials were not provided.
+     */
+    401: unknown;
+};
+
+export type CfgAccountsProfileUpdatePartialUpdateResponses = {
+    200: User;
+};
+
+export type CfgAccountsProfileUpdatePartialUpdateResponse = CfgAccountsProfileUpdatePartialUpdateResponses[keyof CfgAccountsProfileUpdatePartialUpdateResponses];
+
+export type CfgAccountsProfileUpdateUpdateData = {
+    body?: CfgUserUpdateRequest;
+    path?: never;
+    query?: never;
+    url: '/cfg/accounts/profile/update/';
+};
+
+export type CfgAccountsProfileUpdateUpdateErrors = {
+    /**
+     * Invalid data provided.
+     */
+    400: unknown;
+    /**
+     * Authentication credentials were not provided.
+     */
+    401: unknown;
+};
+
+export type CfgAccountsProfileUpdateUpdateResponses = {
+    200: User;
+};
+
+export type CfgAccountsProfileUpdateUpdateResponse = CfgAccountsProfileUpdateUpdateResponses[keyof CfgAccountsProfileUpdateUpdateResponses];
+
+export type CfgAccountsTokenRefreshCreateData = {
+    body: TokenRefreshRequest;
+    path?: never;
+    query?: never;
+    url: '/cfg/accounts/token/refresh/';
+};
+
+export type CfgAccountsTokenRefreshCreateResponses = {
+    200: TokenRefresh;
+};
+
+export type CfgAccountsTokenRefreshCreateResponse = CfgAccountsTokenRefreshCreateResponses[keyof CfgAccountsTokenRefreshCreateResponses];