chore(client): prepare release 1.2.4

Author: vrtcode

CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [1.2.4] - 2025-09-19
+
+### Added
+- Поддержан новый статус задач `submitted` в `TaskStatus`.
+
+### Changed
+- Логи больше не содержат открытого `apiKey`: в debug‑логах ключ маскируется.
+- Ретраи при `429` сохраняют `task_id` для корректной диагностики ошибок.
+- Сообщение `RateLimitError` обобщено (без фиксированного значения 50 rps) — лимиты управляются на стороне провайдера.
+- Документация и примеры обновлены: убран вывод токена из ответа создания задачи (нужно получать через `getStatus`/`wait_for_result`).
+
+### Fixed
+- Тексты в README/примерaх приведены в соответствие текущим параметрам и ответам Key API.
+
 ## [1.2.3] - 2025-01-13
 
 ### Improved

README.md

@@ -1,7 +1,7 @@
 # REGHelp Python Client / REGHelp Python Client (Русская версия ниже)
 
 ![Python](https://img.shields.io/badge/python-3.8%2B-blue.svg)
-![Version](https://img.shields.io/badge/version-1.2.3-green.svg)
+![Version](https://img.shields.io/badge/version-1.2.4-green.svg)
 ![License](https://img.shields.io/badge/license-MIT-blue.svg)
 
 ---
@@ -11,7 +11,7 @@
 1. [Features](#-features)
 2. [Installation](#-installation)
 3. [Quick start](#-quick-start)
-4. [What's new](#-whats-new-in-123)
+4. [What's new](#-whats-new-in-124)
 5. [Environment variables](#-environment-variables)
 6. [Testing](#-testing)
 7. [Contributing](#-contributing)
@@ -29,12 +29,20 @@ Modern asynchronous Python library for interacting with the REGHelp Key API. It
 * **Asynchronous first** – full `async`/`await` support powered by `httpx`.
 * **Type-safe** – strict typing with Pydantic data models.
 * **Retries with exponential back-off** built-in.
-* **Smart rate-limit handling** (50 requests per second).
+* **Smart rate-limit handling** (provider-configurable).
 * **Async context-manager** for automatic resource management.
 * **Webhook support** out of the box.
 * **Comprehensive error handling** with dedicated exception classes.
 
-### 🆕 What's new in 1.2.3
+### 🆕 What's new in 1.2.4
+
+* Added `submitted` task status support in client models
+* Masked `apiKey` in debug logs
+* Preserved `task_id` across 429 retries for better error context
+* Generalized rate-limit messaging (provider-configurable limits)
+* Quick start fixed to not read token from create response
+
+### What was new in 1.2.3
 
 * **Improved error handling for TASK_NOT_FOUND** – when task ID is known, returns TaskNotFoundError with specific ID; when unknown, returns generic RegHelpError instead of confusing "unknown" message.
 
@@ -84,7 +92,7 @@ async def main():
             app_name="tgiOS",
             app_device=AppDevice.IOS
         )
-        print(f"Push token: {task.token}")
+        print(f"Task created: {task.id}")
 
         # Wait for result
         result = await client.wait_for_result(task.id, "push")
@@ -105,7 +113,7 @@ if __name__ == "__main__":
 - **Асинхронность**: Полная поддержка async/await
 - **Типизация**: Полная типизация с Pydantic моделями
 - **Retry логика**: Автоматические повторы с exponential backoff
-- **Rate limiting**: Умная обработка rate limits (50 rps)
+- **Rate limiting**: Умная обработка rate limits (динамические лимиты провайдера)
 - **Context manager**: Поддержка async context manager
 - **Webhook support**: Поддержка webhook уведомлений
 - **Comprehensive error handling**: Детальная обработка всех ошибок API
@@ -384,7 +392,7 @@ from reghelp_client import (
 try:
     task = await client.get_push_token("tgiOS", AppDevice.IOS)
 except RateLimitError:
-    print("Превышен лимит запросов (50/сек)")
+    print("Превышен лимит запросов")
 except UnauthorizedError:
     print("Неверный API ключ")
 except TaskNotFoundError as e:

basic_usage.py

@@ -15,21 +15,17 @@
 from typing import Optional
 
 from reghelp_client import (
-    RegHelpClient,
     AppDevice,
     EmailType,
-    ProxyConfig,
-    ProxyType,
-    RegHelpError,
     RateLimitError,
+    RegHelpClient,
+    RegHelpError,
     UnauthorizedError,
 )
 
-
 # Setup logging
 logging.basicConfig(
-    level=logging.INFO,
-    format='%(asctime)s - %(name)s - %(levelname)s - %(message)s'
+    level=logging.INFO, format="%(asctime)s - %(name)s - %(levelname)s - %(message)s"
 )
 logger = logging.getLogger(__name__)
 
@@ -39,10 +35,10 @@ async def check_balance(client: RegHelpClient) -> None:
     try:
         balance = await client.get_balance()
         logger.info(f"💰 Current balance: {balance.balance} {balance.currency}")
-        
+
         if balance.balance < 10:
             logger.warning("⚠️ Low balance! Consider topping up your account")
-        
+
     except Exception as e:
         logger.error(f"❌ Error getting balance: {e}")
 
@@ -51,31 +47,29 @@ async def get_telegram_push_token(client: RegHelpClient) -> Optional[str]:
     """Get push token for Telegram iOS."""
     try:
         logger.info("📱 Creating task for Telegram iOS push token...")
-        
+
         # Create task
         task = await client.get_push_token(
-            app_name="tgiOS",
-            app_device=AppDevice.IOS,
-            ref="demo_example"
+            app_name="tgiOS", app_device=AppDevice.IOS, ref="demo_example"
         )
-        
+
         logger.info(f"✅ Task created: {task.id} (price: {task.price} RUB)")
-        
+
         # Wait for result with automatic polling
         result = await client.wait_for_result(
             task_id=task.id,
             service="push",
             timeout=60.0,  # 1 minute
-            poll_interval=3.0  # check every 3 seconds
+            poll_interval=3.0,  # check every 3 seconds
         )
-        
+
         if result.token:
             logger.info(f"🎉 Push token received: {result.token[:50]}...")
             return result.token
         else:
             logger.error("❌ Token not received")
             return None
-            
+
     except Exception as e:
         logger.error(f"❌ Error getting push token: {e}")
         return None
@@ -85,36 +79,34 @@ async def get_temporary_email(client: RegHelpClient) -> Optional[str]:
     """Get temporary email address."""
     try:
         logger.info("📧 Getting temporary email address...")
-        
+
         # Get email
         email_task = await client.get_email(
             app_name="tg",
             app_device=AppDevice.IOS,
             phone="+15551234567",  # Test number
-            email_type=EmailType.ICLOUD
+            email_type=EmailType.ICLOUD,
         )
-        
+
         logger.info(f"✅ Email received: {email_task.email}")
-        
+
         # Can wait for verification code
         logger.info("⏳ Waiting for verification code (30 sec)...")
-        
+
         try:
             email_result = await client.wait_for_result(
-                task_id=email_task.id,
-                service="email",
-                timeout=30.0
+                task_id=email_task.id, service="email", timeout=30.0
             )
-            
+
             if email_result.code:
                 logger.info(f"📬 Verification code: {email_result.code}")
                 return email_result.code
-                
+
         except asyncio.TimeoutError:
             logger.info("⏰ Verification code not received within 30 seconds")
-        
+
         return email_task.email
-        
+
     except Exception as e:
         logger.error(f"❌ Error getting email: {e}")
         return None
@@ -124,26 +116,22 @@ async def demonstrate_turnstile(client: RegHelpClient) -> Optional[str]:
     """Demonstrate Turnstile challenge solving."""
     try:
         logger.info("🔐 Solving Cloudflare Turnstile...")
-        
+
         task = await client.get_turnstile_token(
             url="https://demo.example.com",
             site_key="0x4AAAA-demo-site-key",
             action="demo",
         )
-        
+
         logger.info(f"✅ Turnstile task created: {task.id}")
-        
+
         # Wait for result
-        result = await client.wait_for_result(
-            task_id=task.id,
-            service="turnstile",
-            timeout=120.0
-        )
-        
+        result = await client.wait_for_result(task_id=task.id, service="turnstile", timeout=120.0)
+
         if result.token:
             logger.info(f"🎉 Turnstile token: {result.token[:50]}...")
             return result.token
-        
+
     except Exception as e:
         logger.error(f"❌ Turnstile error: {e}")
         return None
@@ -152,15 +140,15 @@ async def demonstrate_turnstile(client: RegHelpClient) -> Optional[str]:
 async def demonstrate_error_handling(client: RegHelpClient) -> None:
     """Demonstrate various error handling."""
     logger.info("🚨 Demonstrating error handling...")
-    
+
     try:
         # Try to get status of non-existent task
         await client.get_push_status("invalid_task_id")
-        
+
     except UnauthorizedError:
         logger.error("🔑 Authorization error: invalid API key")
     except RateLimitError:
-        logger.error("🚦 Rate limit exceeded (50/sec)")
+        logger.error("🚦 Rate limit exceeded")
     except RegHelpError as e:
         logger.error(f"🔴 API error: {e}")
     except Exception as e:
@@ -170,29 +158,32 @@ async def demonstrate_error_handling(client: RegHelpClient) -> None:
 async def parallel_tasks_example(client: RegHelpClient) -> None:
     """Example of parallel task execution."""
     logger.info("🔄 Demonstrating parallel execution...")
-    
+
     try:
         # Create multiple tasks in parallel
-        tasks = await asyncio.gather(*[
-            client.get_push_token("tgiOS", AppDevice.IOS, ref=f"parallel_{i}")
-            for i in range(3)
-        ], return_exceptions=True)
-        
+        tasks = await asyncio.gather(
+            *[client.get_push_token("tgiOS", AppDevice.IOS, ref=f"parallel_{i}") for i in range(3)],
+            return_exceptions=True,
+        )
+
         # Filter successful tasks
         successful_tasks = [task for task in tasks if not isinstance(task, Exception)]
-        
+
         logger.info(f"✅ Created {len(successful_tasks)} tasks in parallel")
-        
+
         # Can wait for results in parallel
         if successful_tasks:
-            results = await asyncio.gather(*[
-                client.get_push_status(task.id) 
-                for task in successful_tasks
-                if hasattr(task, 'id')
-            ], return_exceptions=True)
-            
+            results = await asyncio.gather(
+                *[
+                    client.get_push_status(task.id)
+                    for task in successful_tasks
+                    if hasattr(task, "id")
+                ],
+                return_exceptions=True,
+            )
+
             logger.info(f"📊 Received {len(results)} statuses")
-        
+
     except Exception as e:
         logger.error(f"❌ Parallel execution error: {e}")
 
@@ -205,26 +196,22 @@ async def main() -> None:
         logger.error("❌ API key not found in REGHELP_API_KEY environment variable")
         logger.info("💡 Set the variable: export REGHELP_API_KEY=your_api_key")
         return
-    
+
     logger.info("🚀 Starting REGHelp Python Client demonstration")
-    
+
     # Use context manager for automatic connection cleanup
-    async with RegHelpClient(
-        api_key=api_key,
-        timeout=30.0,
-        max_retries=3
-    ) as client:
-        
+    async with RegHelpClient(api_key=api_key, timeout=30.0, max_retries=3) as client:
+
         # Check API availability
         if await client.health_check():
             logger.info("✅ API is available")
         else:
             logger.error("❌ API is unavailable")
             return
-        
+
         # Demonstrate various functions
         await check_balance(client)
-        
+
         # Only if balance allows
         balance = await client.get_balance()
         if balance.balance > 1:
@@ -234,13 +221,13 @@ async def main() -> None:
             await parallel_tasks_example(client)
         else:
             logger.warning("⚠️ Insufficient funds to demonstrate paid functions")
-        
+
         # Demonstrate error handling
         await demonstrate_error_handling(client)
-    
+
     logger.info("🏁 Demonstration completed")
 
 
 if __name__ == "__main__":
     # Run async function
-    asyncio.run(main()) 
+    asyncio.run(main())

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "reghelp-client"
-version = "1.2.3"
+version = "1.2.4"
 description = "Современная асинхронная Python библиотека для работы с REGHelp Key API"
 readme = "README.md"
 license = {file = "LICENSE"}