@djangocfg/api 2.1.227 → 2.1.229

package/dist/index.d.cts

@@ -40,35 +40,13 @@ declare class Auth {
 declare enum OAuthConnectionProvider {
     GITHUB = "github"
 }
-/**
- * Delivery channel: 'email' or 'phone'. Auto-detected if not provided.
- * * `email` - Email
- * * `phone` - Phone
- */
-declare enum OTPRequestRequestChannel {
-    EMAIL = "email",
-    PHONE = "phone"
-}
 
 type enums_OAuthConnectionProvider = OAuthConnectionProvider;
 declare const enums_OAuthConnectionProvider: typeof OAuthConnectionProvider;
-type enums_OTPRequestRequestChannel = OTPRequestRequestChannel;
-declare const enums_OTPRequestRequestChannel: typeof OTPRequestRequestChannel;
 declare namespace enums {
-  export { enums_OAuthConnectionProvider as OAuthConnectionProvider, enums_OTPRequestRequestChannel as OTPRequestRequestChannel };
+  export { enums_OAuthConnectionProvider as OAuthConnectionProvider };
 }
 
-/**
- * Request to disconnect OAuth provider.
- *
- * Request model (no read-only fields).
- */
-interface OAuthDisconnectRequestRequest$1 {
-    /** OAuth provider to disconnect
-  
-    * `github` - GitHub */
-    provider: OAuthConnectionProvider;
-}
 /**
  * Response with OAuth authorization URL.
  *
@@ -81,15 +59,15 @@ interface OAuthAuthorizeResponse$1 {
     state: string;
 }
 /**
- * Request to start OAuth flow.
+ * Error response for OAuth endpoints.
  *
- * Request model (no read-only fields).
+ * Response model (includes 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;
+interface OAuthError$1 {
+    /** Error code */
+    error: string;
+    /** Human-readable error description */
+    error_description?: string;
 }
 /**
  * Response with JWT tokens after OAuth authentication. When 2FA is required: -
@@ -118,13 +96,15 @@ interface OAuthTokenResponse$1 {
     should_prompt_2fa?: boolean;
 }
 /**
- * Response with available OAuth providers.
+ * Request to start OAuth flow.
  *
- * Response model (includes read-only fields).
+ * Request model (no read-only fields).
  */
-interface OAuthProvidersResponse$1 {
-    /** List of available OAuth providers */
-    providers: Array<Record<string, any>>;
+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).
@@ -139,6 +119,26 @@ interface OAuthCallbackRequestRequest$1 {
     /** Same redirect_uri used in authorize request. If not provided, uses config's site_url + callback_path */
     redirect_uri?: string;
 }
+/**
+ * Request to disconnect OAuth provider.
+ *
+ * Request model (no read-only fields).
+ */
+interface OAuthDisconnectRequestRequest$1 {
+    /** OAuth provider to disconnect
+  
+    * `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>>;
+}
 /**
  * Serializer for OAuth connection info (user-facing).
  *
@@ -162,17 +162,6 @@ interface OAuthConnection$1 {
     /** Last time this OAuth connection was used for login */
     last_login_at: string;
 }
-/**
- * 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 };
@@ -223,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;
@@ -239,6 +228,19 @@ interface CfgAccountsProfileAvatarCreateRequest$1 {
     /** Avatar image file (JPEG, PNG, GIF, WebP, max 5MB) */
     avatar: File | Blob;
 }
+/**
+ * Serializer for updating user profile.
+ *
+ * Request model (no read-only fields).
+ */
+interface UserProfileUpdateRequest$1 {
+    first_name?: string;
+    last_name?: string;
+    company?: string;
+    phone?: string;
+    position?: string;
+    language?: string;
+}
 /**
  * Serializer for user details.
  *
@@ -269,19 +271,6 @@ interface User$2 {
     unanswered_messages_count: number;
     centrifugo: CentrifugoToken$2 | null;
 }
-/**
- * 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;
-}
 /**
  * Response serializer for account deletion.
  *
@@ -376,24 +365,51 @@ declare class UserProfile {
  * Request model (no read-only fields).
  */
 interface OTPRequestRequest$1 {
-    /** Email address or phone number for OTP delivery */
+    /** Email address for OTP delivery */
     identifier: string;
-    /** Delivery channel: 'email' or 'phone'. Auto-detected if not provided.
-  
-    * `email` - Email
-    * `phone` - Phone */
-    channel?: OTPRequestRequestChannel;
     /** Source URL for tracking registration (e.g., https://my.djangocfg.com) */
     source_url?: string;
 }
 /**
- * Error response for OTP operations.
+ * 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 request response.
+ *
+ * Response model (includes read-only fields).
+ */
+interface OTPRequestResponse$1 {
+    /** Success message */
+    message: string;
+}
+/**
+ * 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
  *
  * Response model (includes read-only fields).
  */
 interface OTPErrorResponse$1 {
-    /** Error message */
+    /** 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;
 }
 /**
  * OTP verification response. When 2FA is required: - requires_2fa: True -
@@ -416,32 +432,6 @@ interface OTPVerifyResponse$1 {
     /** Whether user should be prompted to enable 2FA */
     should_prompt_2fa?: boolean;
 }
-/**
- * OTP request response.
- *
- * Response model (includes read-only fields).
- */
-interface OTPRequestResponse$1 {
-    /** Success message */
-    message: string;
-}
-/**
- * Serializer for OTP verification.
- *
- * Request model (no read-only fields).
- */
-interface OTPVerifyRequest$1 {
-    /** Email address or phone number used for OTP request */
-    identifier: string;
-    otp: string;
-    /** Delivery channel: 'email' or 'phone'. Auto-detected if not provided.
-  
-    * `email` - Email
-    * `phone` - Phone */
-    channel?: OTPRequestRequestChannel;
-    /** Source URL for tracking login (e.g., https://my.djangocfg.com) */
-    source_url?: string;
-}
 /**
  * Serializer for user details.
  *
@@ -499,7 +489,7 @@ declare class Accounts {
     private client;
     constructor(client: any);
     /**
-     * Request OTP code to email or phone.
+     * Request OTP code to email.
      */
     otpRequestCreate(data: OTPRequestRequest$1): Promise<OTPRequestResponse$1>;
     /**
@@ -1135,14 +1125,36 @@ type OAuthTokenResponse = z.infer<typeof OAuthTokenResponseSchema>;
  * Zod schema for OTPErrorResponse
  *
  * This schema provides runtime validation and type inference.
- *  * Error response for OTP operations.
+ *  * 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
  *  */
 
 /**
- * Error response for OTP operations.
+ * 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
  */
 declare const OTPErrorResponseSchema: z.ZodObject<{
     error: z.ZodString;
+    error_code: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    retry_after: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
 }, z.core.$strip>;
 /**
  * Infer TypeScript type from Zod schema
@@ -1161,7 +1173,6 @@ type OTPErrorResponse = z.infer<typeof OTPErrorResponseSchema>;
  */
 declare const OTPRequestRequestSchema: z.ZodObject<{
     identifier: z.ZodString;
-    channel: z.ZodOptional<z.ZodEnum<typeof OTPRequestRequestChannel>>;
     source_url: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 /**
@@ -1200,7 +1211,6 @@ type OTPRequestResponse = z.infer<typeof OTPRequestResponseSchema>;
 declare const OTPVerifyRequestSchema: z.ZodObject<{
     identifier: z.ZodString;
     otp: z.ZodString;
-    channel: z.ZodOptional<z.ZodEnum<typeof OTPRequestRequestChannel>>;
     source_url: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 /**

package/dist/index.d.ts

@@ -40,35 +40,13 @@ declare class Auth {
 declare enum OAuthConnectionProvider {
     GITHUB = "github"
 }
-/**
- * Delivery channel: 'email' or 'phone'. Auto-detected if not provided.
- * * `email` - Email
- * * `phone` - Phone
- */
-declare enum OTPRequestRequestChannel {
-    EMAIL = "email",
-    PHONE = "phone"
-}
 
 type enums_OAuthConnectionProvider = OAuthConnectionProvider;
 declare const enums_OAuthConnectionProvider: typeof OAuthConnectionProvider;
-type enums_OTPRequestRequestChannel = OTPRequestRequestChannel;
-declare const enums_OTPRequestRequestChannel: typeof OTPRequestRequestChannel;
 declare namespace enums {
-  export { enums_OAuthConnectionProvider as OAuthConnectionProvider, enums_OTPRequestRequestChannel as OTPRequestRequestChannel };
+  export { enums_OAuthConnectionProvider as OAuthConnectionProvider };
 }
 
-/**
- * Request to disconnect OAuth provider.
- *
- * Request model (no read-only fields).
- */
-interface OAuthDisconnectRequestRequest$1 {
-    /** OAuth provider to disconnect
-  
-    * `github` - GitHub */
-    provider: OAuthConnectionProvider;
-}
 /**
  * Response with OAuth authorization URL.
  *
@@ -81,15 +59,15 @@ interface OAuthAuthorizeResponse$1 {
     state: string;
 }
 /**
- * Request to start OAuth flow.
+ * Error response for OAuth endpoints.
  *
- * Request model (no read-only fields).
+ * Response model (includes 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;
+interface OAuthError$1 {
+    /** Error code */
+    error: string;
+    /** Human-readable error description */
+    error_description?: string;
 }
 /**
  * Response with JWT tokens after OAuth authentication. When 2FA is required: -
@@ -118,13 +96,15 @@ interface OAuthTokenResponse$1 {
     should_prompt_2fa?: boolean;
 }
 /**
- * Response with available OAuth providers.
+ * Request to start OAuth flow.
  *
- * Response model (includes read-only fields).
+ * Request model (no read-only fields).
  */
-interface OAuthProvidersResponse$1 {
-    /** List of available OAuth providers */
-    providers: Array<Record<string, any>>;
+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).
@@ -139,6 +119,26 @@ interface OAuthCallbackRequestRequest$1 {
     /** Same redirect_uri used in authorize request. If not provided, uses config's site_url + callback_path */
     redirect_uri?: string;
 }
+/**
+ * Request to disconnect OAuth provider.
+ *
+ * Request model (no read-only fields).
+ */
+interface OAuthDisconnectRequestRequest$1 {
+    /** OAuth provider to disconnect
+  
+    * `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>>;
+}
 /**
  * Serializer for OAuth connection info (user-facing).
  *
@@ -162,17 +162,6 @@ interface OAuthConnection$1 {
     /** Last time this OAuth connection was used for login */
     last_login_at: string;
 }
-/**
- * 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 };
@@ -223,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;
@@ -239,6 +228,19 @@ interface CfgAccountsProfileAvatarCreateRequest$1 {
     /** Avatar image file (JPEG, PNG, GIF, WebP, max 5MB) */
     avatar: File | Blob;
 }
+/**
+ * Serializer for updating user profile.
+ *
+ * Request model (no read-only fields).
+ */
+interface UserProfileUpdateRequest$1 {
+    first_name?: string;
+    last_name?: string;
+    company?: string;
+    phone?: string;
+    position?: string;
+    language?: string;
+}
 /**
  * Serializer for user details.
  *
@@ -269,19 +271,6 @@ interface User$2 {
     unanswered_messages_count: number;
     centrifugo: CentrifugoToken$2 | null;
 }
-/**
- * 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;
-}
 /**
  * Response serializer for account deletion.
  *
@@ -376,24 +365,51 @@ declare class UserProfile {
  * Request model (no read-only fields).
  */
 interface OTPRequestRequest$1 {
-    /** Email address or phone number for OTP delivery */
+    /** Email address for OTP delivery */
     identifier: string;
-    /** Delivery channel: 'email' or 'phone'. Auto-detected if not provided.
-  
-    * `email` - Email
-    * `phone` - Phone */
-    channel?: OTPRequestRequestChannel;
     /** Source URL for tracking registration (e.g., https://my.djangocfg.com) */
     source_url?: string;
 }
 /**
- * Error response for OTP operations.
+ * 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 request response.
+ *
+ * Response model (includes read-only fields).
+ */
+interface OTPRequestResponse$1 {
+    /** Success message */
+    message: string;
+}
+/**
+ * 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
  *
  * Response model (includes read-only fields).
  */
 interface OTPErrorResponse$1 {
-    /** Error message */
+    /** 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;
 }
 /**
  * OTP verification response. When 2FA is required: - requires_2fa: True -
@@ -416,32 +432,6 @@ interface OTPVerifyResponse$1 {
     /** Whether user should be prompted to enable 2FA */
     should_prompt_2fa?: boolean;
 }
-/**
- * OTP request response.
- *
- * Response model (includes read-only fields).
- */
-interface OTPRequestResponse$1 {
-    /** Success message */
-    message: string;
-}
-/**
- * Serializer for OTP verification.
- *
- * Request model (no read-only fields).
- */
-interface OTPVerifyRequest$1 {
-    /** Email address or phone number used for OTP request */
-    identifier: string;
-    otp: string;
-    /** Delivery channel: 'email' or 'phone'. Auto-detected if not provided.
-  
-    * `email` - Email
-    * `phone` - Phone */
-    channel?: OTPRequestRequestChannel;
-    /** Source URL for tracking login (e.g., https://my.djangocfg.com) */
-    source_url?: string;
-}
 /**
  * Serializer for user details.
  *
@@ -499,7 +489,7 @@ declare class Accounts {
     private client;
     constructor(client: any);
     /**
-     * Request OTP code to email or phone.
+     * Request OTP code to email.
      */
     otpRequestCreate(data: OTPRequestRequest$1): Promise<OTPRequestResponse$1>;
     /**
@@ -1135,14 +1125,36 @@ type OAuthTokenResponse = z.infer<typeof OAuthTokenResponseSchema>;
  * Zod schema for OTPErrorResponse
  *
  * This schema provides runtime validation and type inference.
- *  * Error response for OTP operations.
+ *  * 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
  *  */
 
 /**
- * Error response for OTP operations.
+ * 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
  */
 declare const OTPErrorResponseSchema: z.ZodObject<{
     error: z.ZodString;
+    error_code: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    retry_after: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
 }, z.core.$strip>;
 /**
  * Infer TypeScript type from Zod schema
@@ -1161,7 +1173,6 @@ type OTPErrorResponse = z.infer<typeof OTPErrorResponseSchema>;
  */
 declare const OTPRequestRequestSchema: z.ZodObject<{
     identifier: z.ZodString;
-    channel: z.ZodOptional<z.ZodEnum<typeof OTPRequestRequestChannel>>;
     source_url: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 /**
@@ -1200,7 +1211,6 @@ type OTPRequestResponse = z.infer<typeof OTPRequestResponseSchema>;
 declare const OTPVerifyRequestSchema: z.ZodObject<{
     identifier: z.ZodString;
     otp: z.ZodString;
-    channel: z.ZodOptional<z.ZodEnum<typeof OTPRequestRequestChannel>>;
     source_url: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 /**