amigo_sdk 0.62.0__py3-none-any.whl

amigo_sdk/sdk_client.py

@@ -0,0 +1,187 @@
+from typing import Any, Optional
+
+from amigo_sdk.config import AmigoConfig
+from amigo_sdk.http_client import AmigoAsyncHttpClient, AmigoHttpClient
+from amigo_sdk.resources.conversation import (
+    AsyncConversationResource,
+    ConversationResource,
+)
+from amigo_sdk.resources.organization import (
+    AsyncOrganizationResource,
+    OrganizationResource,
+)
+from amigo_sdk.resources.service import AsyncServiceResource, ServiceResource
+from amigo_sdk.resources.user import AsyncUserResource, UserResource
+
+
+class AsyncAmigoClient:
+    """Amigo API client (asynchronous)."""
+
+    def __init__(
+        self,
+        *,
+        api_key: Optional[str] = None,
+        api_key_id: Optional[str] = None,
+        user_id: Optional[str] = None,
+        organization_id: Optional[str] = None,
+        base_url: Optional[str] = None,
+        config: Optional[AmigoConfig] = None,
+        **httpx_kwargs: Any,
+    ):
+        """
+        Initialize the Amigo SDK client.
+
+        Args:
+            api_key: API key for authentication (or set AMIGO_API_KEY env var)
+            api_key_id: API key ID for authentication (or set AMIGO_API_KEY_ID env var)
+            user_id: User ID for API requests (or set AMIGO_USER_ID env var)
+            organization_id: Organization ID for API requests (or set AMIGO_ORGANIZATION_ID env var)
+            base_url: Base URL for the API (or set AMIGO_BASE_URL env var)
+            config: Pre-configured AmigoConfig instance (overrides individual params)
+            **httpx_kwargs: Additional arguments passed to httpx.AsyncClient
+        """
+        if config:
+            self._cfg = config
+        else:
+            # Build config from individual parameters, falling back to env vars
+            cfg_dict: dict[str, Any] = {
+                k: v
+                for k, v in [
+                    ("api_key", api_key),
+                    ("api_key_id", api_key_id),
+                    ("user_id", user_id),
+                    ("organization_id", organization_id),
+                    ("base_url", base_url),
+                ]
+                if v is not None
+            }
+
+            try:
+                self._cfg = AmigoConfig(**cfg_dict)
+            except Exception as e:
+                raise ValueError(
+                    "AmigoClient configuration incomplete. "
+                    "Provide api_key, api_key_id, user_id, organization_id, base_url "
+                    "either as kwargs or environment variables."
+                ) from e
+
+        # Initialize HTTP client and resources
+        self._http = AmigoAsyncHttpClient(self._cfg, **httpx_kwargs)
+        self._organization = AsyncOrganizationResource(
+            self._http, self._cfg.organization_id
+        )
+        self._service = AsyncServiceResource(self._http, self._cfg.organization_id)
+        self._conversation = AsyncConversationResource(
+            self._http, self._cfg.organization_id
+        )
+        self._users = AsyncUserResource(self._http, self._cfg.organization_id)
+
+    @property
+    def config(self) -> AmigoConfig:
+        """Access the configuration object."""
+        return self._cfg
+
+    @property
+    def organization(self) -> AsyncOrganizationResource:
+        """Access organization resource."""
+        return self._organization
+
+    @property
+    def service(self) -> AsyncServiceResource:
+        """Access service resource."""
+        return self._service
+
+    @property
+    def conversation(self) -> AsyncConversationResource:
+        """Access conversation resource."""
+        return self._conversation
+
+    @property
+    def users(self) -> AsyncUserResource:
+        """Access user resource."""
+        return self._users
+
+    async def aclose(self) -> None:
+        """Close the HTTP client."""
+        await self._http.aclose()
+
+    # async-context-manager sugar
+    async def __aenter__(self):
+        return self
+
+    async def __aexit__(self, *_):
+        await self.aclose()
+
+
+class AmigoClient:
+    """Amigo API client (synchronous)."""
+
+    def __init__(
+        self,
+        *,
+        api_key: Optional[str] = None,
+        api_key_id: Optional[str] = None,
+        user_id: Optional[str] = None,
+        organization_id: Optional[str] = None,
+        base_url: Optional[str] = None,
+        config: Optional[AmigoConfig] = None,
+        **httpx_kwargs: Any,
+    ):
+        if config:
+            self._cfg = config
+        else:
+            cfg_dict: dict[str, Any] = {
+                k: v
+                for k, v in [
+                    ("api_key", api_key),
+                    ("api_key_id", api_key_id),
+                    ("user_id", user_id),
+                    ("organization_id", organization_id),
+                    ("base_url", base_url),
+                ]
+                if v is not None
+            }
+
+            try:
+                self._cfg = AmigoConfig(**cfg_dict)
+            except Exception as e:
+                raise ValueError(
+                    "AmigoClient configuration incomplete. "
+                    "Provide api_key, api_key_id, user_id, organization_id, base_url "
+                    "either as kwargs or environment variables."
+                ) from e
+
+        self._http = AmigoHttpClient(self._cfg, **httpx_kwargs)
+        self._organization = OrganizationResource(self._http, self._cfg.organization_id)
+        self._service = ServiceResource(self._http, self._cfg.organization_id)
+        self._conversation = ConversationResource(self._http, self._cfg.organization_id)
+        self._users = UserResource(self._http, self._cfg.organization_id)
+
+    @property
+    def config(self) -> AmigoConfig:
+        return self._cfg
+
+    @property
+    def organization(self) -> OrganizationResource:
+        return self._organization
+
+    @property
+    def service(self) -> ServiceResource:
+        return self._service
+
+    @property
+    def conversation(self) -> ConversationResource:
+        return self._conversation
+
+    @property
+    def users(self) -> UserResource:
+        return self._users
+
+    def aclose(self) -> None:
+        self._http.aclose()
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, *_):
+        self.aclose()

amigo_sdk-0.62.0.dist-info/METADATA

@@ -0,0 +1,260 @@
+Metadata-Version: 2.4
+Name: amigo_sdk
+Version: 0.62.0
+Summary: Amigo AI Python SDK
+Author: Amigo AI
+License-File: LICENSE
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.9
+Requires-Dist: email-validator<3.0,>=2.0
+Requires-Dist: httpx<1.0,>=0.25
+Requires-Dist: pydantic-settings<3.0,>=2.0
+Requires-Dist: pydantic<3.0,>=2.7
+Provides-Extra: dev
+Requires-Dist: datamodel-code-generator[http]<1.0,>=0.21; extra == 'dev'
+Requires-Dist: pytest-asyncio<1.0,>=0.21; extra == 'dev'
+Requires-Dist: pytest-cov<6.0,>=4.0; extra == 'dev'
+Requires-Dist: pytest-httpx<1.0,>=0.30; extra == 'dev'
+Requires-Dist: pytest<9.0,>=7.0; extra == 'dev'
+Requires-Dist: python-dotenv<2.0,>=1.0; extra == 'dev'
+Requires-Dist: ruff<1.0,>=0.1; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Amigo Python SDK
+
+[![Tests](https://github.com/amigo-ai/amigo-python-sdk/actions/workflows/test.yml/badge.svg)](https://github.com/amigo-ai/amigo-python-sdk/actions/workflows/test.yml)
+[![codecov](https://codecov.io/gh/amigo-ai/amigo-python-sdk/graph/badge.svg?token=1A7KVPV9ZR)](https://codecov.io/gh/amigo-ai/amigo-python-sdk)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+The official Python SDK for the Amigo API, providing a simple and intuitive interface to interact with Amigo's AI services.
+
+## Installation
+
+Install the SDK using pip:
+
+```bash
+pip install amigo_sdk
+```
+
+Or add it to your requirements.txt:
+
+```txt
+amigo_sdk
+```
+
+### API compatibility
+
+This SDK auto-generates its types from the latest [Amigo OpenAPI schema](https://api.amigo.ai/v1/openapi.json). As a result, only the latest published SDK version is guaranteed to match the current API. If you pin to an older version, it may not include the newest endpoints or fields.
+
+## Quick Start (sync)
+
+```python
+from amigo_sdk import AmigoClient
+from amigo_sdk.models import GetConversationsParametersQuery
+
+# Initialize and use the client synchronously
+with AmigoClient(
+    api_key="your-api-key",
+    api_key_id="your-api-key-id",
+    user_id="user-id",
+    organization_id="your-organization-id",
+) as client:
+    conversations = client.conversation.get_conversations(
+        GetConversationsParametersQuery(limit=10, sort_by=["-created_at"])
+    )
+    print("Conversations:", conversations)
+```
+
+## Quick Start (async)
+
+```python
+import asyncio
+
+from amigo_sdk import AsyncAmigoClient
+from amigo_sdk.models import GetConversationsParametersQuery
+
+
+async def main():
+    async with AsyncAmigoClient(
+        api_key="your-api-key",
+        api_key_id="your-api-key-id",
+        user_id="user-id",
+        organization_id="your-organization-id",
+    ) as client:
+        conversations = await client.conversation.get_conversations(
+            GetConversationsParametersQuery(limit=10, sort_by=["-created_at"])
+        )
+        print("Conversations:", conversations)
+
+
+asyncio.run(main())
+```
+
+## Examples
+
+For more SDK usage examples see the [examples overview](examples/README.md). Direct links:
+
+- **Conversation (sync)**: [examples/conversation/conversation.py](examples/conversation/conversation.py)
+- **Conversation (async)**: [examples/conversation/conversation_async.py](examples/conversation/conversation_async.py)
+- **User management (sync)**: [examples/user/user-management.py](examples/user/user-management.py)
+
+## Configuration
+
+The SDK requires the following configuration parameters:
+
+| Parameter         | Type | Required | Description                                                    |
+| ----------------- | ---- | -------- | -------------------------------------------------------------- |
+| `api_key`         | str  | ✅       | API key from Amigo dashboard                                   |
+| `api_key_id`      | str  | ✅       | API key ID from Amigo dashboard                                |
+| `user_id`         | str  | ✅       | User ID on whose behalf the request is made                    |
+| `organization_id` | str  | ✅       | Your organization ID                                           |
+| `base_url`        | str  | ❌       | Base URL of the Amigo API (defaults to `https://api.amigo.ai`) |
+
+### Environment Variables
+
+You can also configure the SDK using environment variables:
+
+```bash
+export AMIGO_API_KEY="your-api-key"
+export AMIGO_API_KEY_ID="your-api-key-id"
+export AMIGO_USER_ID="user-id"
+export AMIGO_ORGANIZATION_ID="your-organization-id"
+export AMIGO_BASE_URL="https://api.amigo.ai"  # optional
+```
+
+Then initialize the client without parameters:
+
+```python
+from amigo_sdk import AmigoClient
+
+# Automatically loads from environment variables
+with AmigoClient() as client:
+    ...
+```
+
+### Using .env Files
+
+Create a `.env` file in your project root:
+
+```env
+AMIGO_API_KEY=your-api-key
+AMIGO_API_KEY_ID=your-api-key-id
+AMIGO_USER_ID=user-id
+AMIGO_ORG_ID=your-organization-id
+```
+
+The SDK will automatically load these variables.
+
+### Getting Your API Credentials
+
+1. **API Key & API Key ID**: Generate these from your Amigo admin dashboard or programmatically using the API
+2. **Organization ID**: Found in your Amigo dashboard URL or organization settings
+3. **User ID**: The ID of the user you want to impersonate for API calls
+
+For detailed instructions on generating API keys, see the [Authentication Guide](https://docs.amigo.ai/developer-guide).
+
+## Available Resources
+
+The SDK provides access to the following resources:
+
+- **Organizations**: Get Organization info
+- **Services**: Get available services
+- **Conversation**: Manage conversations
+- **User**: Manage users
+
+## Generated types
+
+The SDK ships with Pydantic models generated from the latest OpenAPI schema.
+
+- **Importing types**: Import directly from `amigo_sdk.models`
+
+  ```python
+  from amigo_sdk.models import (
+      GetConversationsParametersQuery,
+      ConversationCreateConversationRequest,
+      GetUsersParametersQuery,
+  )
+  ```
+
+- **Using types when calling SDK functions**: Pass request/query models to resource methods.
+
+  ```python
+  from amigo_sdk import AmigoClient
+  from amigo_sdk.models import GetConversationsParametersQuery
+
+  with AmigoClient() as client:
+     conversations = client.conversation.get_conversations(
+         GetConversationsParametersQuery(limit=20, sort_by=["-created_at"])
+     )
+  ```
+
+- **Parsing returned objects**: Responses are Pydantic models. Access fields directly or convert to dict/JSON.
+
+  ```python
+  # Access fields
+  first = conversations.conversations[0]
+  print(first.id, first.created_at)
+
+  # Convert to plain dict for logging/serialization
+  print(first.model_dump(mode="json"))
+  ```
+
+## Error Handling
+
+The SDK provides typed error handling:
+
+```python
+from amigo_sdk import AmigoClient
+from amigo_sdk.errors import (
+    AuthenticationError,
+    NotFoundError,
+    BadRequestError,
+    ValidationError,
+)
+
+try:
+    with AmigoClient() as client:
+        org = client.organization.get()
+        print("Organization:", org)
+except AuthenticationError as error:
+    print("Authentication failed:", error)
+except NotFoundError as error:
+    print("Resource not found:", error)
+except BadRequestError as error:
+    print("Bad request:", error)
+except ValidationError as error:
+    print("Validation error:", error)
+except Exception as error:
+    print("Unexpected error:", error)
+```
+
+## Retries
+
+The HTTP client includes sensible, configurable retries:
+
+- **Defaults**:
+
+  - max attempts: 3
+  - backoff base: 0.25s (exponential with full jitter)
+  - max delay per attempt: 30s
+  - retry on status: {408, 429, 500, 502, 503, 504}
+  - retry on methods: {"GET"}
+  - special-case: POST is retried on 429 when `Retry-After` is present
+  - 401 triggers a one-time token refresh and immediate retry
+
+## Development
+
+For detailed development setup, testing, and contribution guidelines, see [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## Documentation
+
+- **Developer Guide**: [https://docs.amigo.ai/developer-guide](https://docs.amigo.ai/developer-guide)
+- **API Reference**: [https://docs.amigo.ai/api-reference](https://docs.amigo.ai/api-reference)
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Support
+
+For questions, issues, or feature requests, please visit our [GitHub repository](https://github.com/amigo-ai/amigo-python-sdk) or contact support through the Amigo dashboard.

amigo_sdk-0.62.0.dist-info/RECORD

@@ -0,0 +1,18 @@
+amigo_sdk/__init__.py,sha256=GZ5tgkehgZLTftN7G8oWMY409UKDEoyw5Ov15xnGrhA,139
+amigo_sdk/_retry_utils.py,sha256=kFjw9Wqye6MB5-B4rjLxsbSNcfYBIztcollIoncd1hY,2142
+amigo_sdk/auth.py,sha256=WaM9PcEcnaC6CzNsgRKueHkdSAxNbRylzpR_3Q6guQ0,1765
+amigo_sdk/config.py,sha256=0eZIo-hcJ8ODftKAr-mwB-FGJxGO5PT5T4dRpyWPqAg,1491
+amigo_sdk/errors.py,sha256=RkRyF5eAASd8fIOS6YvL9rLDvLAYWqHfpHSCR7jqvl4,4840
+amigo_sdk/http_client.py,sha256=v25UoUbXcMeHTnfJMcrl8RSSwCVkKUL1Jv-0HoXP1B4,13507
+amigo_sdk/models.py,sha256=V-G6iL43_ZNOPDcatCJCSszGWGz-nzp_RSyGNm-rBAc,45
+amigo_sdk/sdk_client.py,sha256=Kr9M9o66pOLu0T2VDvqdYMmPZzgKJyTELu7BSPgGrYQ,6152
+amigo_sdk/generated/model.py,sha256=ENsXrhwNVu19tI4sm0olpu-IHnNKPIoeZNwlgWS6uug,453904
+amigo_sdk/resources/conversation.py,sha256=5PkJOvLKqnriSS9K9hKw2VRPxRLTuABEbCyPy1fz1r0,14817
+amigo_sdk/resources/organization.py,sha256=yX4UlOHNegRzFW4gCJrCxjiLCAGnGegasjviR1yad_Q,1211
+amigo_sdk/resources/service.py,sha256=SiwEHXCQk4r1b_tGv47M08VuB7RALDHJQzWlpuD937g,1571
+amigo_sdk/resources/user.py,sha256=vZPCw8i-xvcDQik8ouJbm8qVHucRbfxCWI3yYMDj8hg,3517
+amigo_sdk-0.62.0.dist-info/METADATA,sha256=YJO7UIpXJOjK9ow0s8tRVDjuzo1OKMXgdUkK2QR8l1o,8350
+amigo_sdk-0.62.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+amigo_sdk-0.62.0.dist-info/entry_points.txt,sha256=ivKZ8S9W6SH796zUDHeM-qHodrwmkmUItophi-jJWK0,82
+amigo_sdk-0.62.0.dist-info/licenses/LICENSE,sha256=tx3FiTVbGxwBUOxQbNh05AAQlC2jd5hGvNpIkSfVbCo,1062
+amigo_sdk-0.62.0.dist-info/RECORD,,

amigo_sdk-0.62.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

amigo_sdk-0.62.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+check = scripts.check:main
+gen-models = scripts.gen_models:main

amigo_sdk-0.62.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Amigo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.