mirror of
https://github.com/andwati/telecom-platform.git
synced 2026-10-18 11:02:54 +00:00
docs: Add Go SDK README with comprehensive API documentation and implement modular architecture with authentication provider
- Add README.md with installation instructions, architecture overview, and API examples for all SDK modules - Add AuthProvider class with API key and JWT token support (GenerateJWTToken, ValidateJWTToken, GetHeaders, ClearTokenCache methods) - Add HTTPClient base class with retry logic, error handling, and timeout management - Add GraphQLAPI, PaymentsAPI, RatingPlansAPI
This commit is contained in:
@@ -4,6 +4,7 @@ Async Python SDK for the Telecom Platform with full type hints and modern async/
|
||||
|
||||
## Features
|
||||
|
||||
- **Modular Architecture**: Separate modules for authentication, API clients, and WebSocket
|
||||
- **Async/Await Support**: Full async/await support with aiohttp
|
||||
- **Type Safety**: Complete type hints with Pydantic models
|
||||
- **WebSocket Support**: Real-time updates via WebSocket
|
||||
@@ -32,6 +33,15 @@ pip install -r requirements.txt
|
||||
pip install -e .
|
||||
```
|
||||
|
||||
## Architecture
|
||||
|
||||
The SDK is organized into modular components:
|
||||
|
||||
- `auth.py` - Authentication provider handling API keys and JWT tokens
|
||||
- `api.py` - Main API client with HTTP request handling and retry logic
|
||||
- `websocket.py` - WebSocket client for real-time updates
|
||||
- `types.py` - Type definitions and Pydantic models
|
||||
|
||||
## Quick Start
|
||||
|
||||
```python
|
||||
|
||||
Reference in New Issue
Block a user