update for contacts and webhooks

Author: thedevtoni

CHANGELOG.md

@@ -5,11 +5,18 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/).
 
-## [2.3.6] - 2024-05-10
+## [2.13.0] - 2024-08-03
 
 ### Added
 
-- When `environments` property is set on the `context` the global `environment` value is overwriten.
+- Added support for webhooks signature verification
+- Added support for the `contacts` API
+
+## [2.12.0] - 2024-07-09
+
+### Added
+
+- Added support for `prefix_messages` in deployments
 
 ## [2.11.0] - 2024-06-30
 
@@ -22,8 +29,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
 
 - Centralize the `api_key` in the `Store` object to reuse it in all the API calls
 
-## [2.12.0] - 2024-07-09
+
+
+
+## [2.3.6] - 2024-05-10
 
 ### Added
 
-- Added support for `prefix_messages` in deployments
+- When `environments` property is set on the `context` the global `environment` value is overwriten.
+

orq_ai_sdk/api_resources/async_deployments.py

@@ -7,10 +7,10 @@
 
 from orq_ai_sdk.http_client import post_async, stream_async
 
-DEPLOYMENTS_API = "{}/deployments".format(BASE_URL)
+DEPLOYMENTS_API = "{}/v2/deployments".format(BASE_URL)
 
-GET_CONFIG_URL = "{}/get_config".format(DEPLOYMENTS_API)
-INVOKE_URL = "{}/invoke".format(DEPLOYMENTS_API)
+GET_CONFIG_URL = "{}/v2/get_config".format(DEPLOYMENTS_API)
+INVOKE_URL = "{}/v2/invoke".format(DEPLOYMENTS_API)
 
 from typing import Optional, TypedDict
 
@@ -306,11 +306,6 @@ def __validate_params(
         if extra_params is not None:
             self.body_params["extra_params"] = extra_params
 
-        user_info = Store.get("user_info")
-
-        if user_info is not None and isinstance(user_info, dict):
-            self.body_params["user_id"] = user_info.get("id")
-
     async def get_config(self, key: str, context=None, inputs=None, metadata=None):
         self.__validate_params(
             key=key, context=context, inputs=inputs, metadata=metadata

orq_ai_sdk/api_resources/contacts/README.md

@@ -0,0 +1,105 @@
+# Contacts
+
+The Contacts API allows you to create and manage contact information in the orq.ai API. This is useful for associating
+user data with AI interactions.
+
+## Set the contact using the client
+
+To set a contact ID in the store and create a contact simultaneously, use the exposed `set_contact` method from the
+client:
+
+```python:
+client.set_contact(
+    id="user123",
+    display_name="John Doe",
+    email="john@example.com",
+    avatar_url="https://example.com/avatar.jpg",
+    metadata={"role": "admin"}
+)
+```
+
+This method combines setting the contact ID in the store and creating a contact in one operation.
+
+## Creating a Contact
+
+To create a contact, use the `create` method of the `client.contacts`:
+
+```python
+contact = client.contacts.create(
+    external_id="user123",
+    display_name="John Doe",
+    email="john@example.com",
+    avatar_url="https://example.com/avatar.jpg",
+    metadata={"role": "admin"}
+)
+```
+
+## Asynchronous Creation
+
+For asynchronous operations, use the `acreate` method:
+
+```python
+contact = await client.contacts.acreate(
+    external_id="user123",
+    display_name="John Doe",
+    email="john@example.com",
+    avatar_url="https://example.com/avatar.jpg",
+    metadata={"role": "admin"}
+)
+```
+
+## Best Practices
+
+1. Always provide a unique `external_id` for each contact. This helps in identifying and managing contacts in your
+   system.
+
+2. Handle errors appropriately when creating contacts, as network issues or validation errors may occur.
+
+3. Use the asynchronous `acreate` method for better performance in asynchronous applications.
+
+4. Ensure that the `email` and `avatar_url` fields, if provided, are in valid formats to avoid validation errors.
+
+5. Use the `metadata` field to store additional information about the contact that doesn't fit into the standard fields.
+
+## API Reference
+
+### `create(external_id: str, display_name: str | None = None, email: str | None = None, avatar_url: str | None = None, metadata: dict | None = None) -> Contact`
+
+Creates a new contact in the orq.ai API.
+
+- `external_id`: str - Required. An external identifier for the user.
+- `display_name`: str | None - Optional. The user's display name or full name.
+- `email`: str | None - Optional. The user's email address.
+- `avatar_url`: str | None - Optional. URL to the user's avatar image.
+- `metadata`: dict | None - Optional. Additional key-value pairs for storing extra user information.
+
+Returns a `Contact` object.
+
+### `acreate(external_id: str, display_name: str | None = None, email: str | None = None, avatar_url: str | None = None, metadata: dict | None = None) -> Contact`
+
+Asynchronously creates a new contact in the orq.ai API. Parameters are the same as `create`.
+
+Returns a `Contact` object.
+
+## Error Handling
+
+- If `external_id` is not provided, a `ValueError` will be raised.
+- If the API request fails, an HTTP error will be raised. You should handle these exceptions in your code.
+
+## Example
+
+```python
+try:
+    contact = client.contacts.create(
+        external_id="user123",
+        display_name="John Doe",
+        email="john@example.com",
+        avatar_url="https://example.com/avatar.jpg",
+        metadata={"role": "admin", "department": "IT"}
+    )
+    print(f"Contact created: {contact.id}")
+except ValueError as e:
+    print(f"Validation error: {e}")
+except Exception as e:
+    print(f"An error occurred: {e}")
+```

orq_ai_sdk/api_resources/contacts/__init__.py

@@ -0,0 +1,91 @@
+from typing import Dict, Any, Union
+
+from pydantic import BaseModel
+
+from orq_ai_sdk.constants import BASE_URL
+from orq_ai_sdk.http_client import post, post_async
+
+CONTACTS_API = '{}{}'.format(BASE_URL, '/v2/contacts')
+
+
+class Contact(BaseModel):
+    id: str
+    external_id: str
+    display_name: Union[str, None] = None
+    email: Union[str, None] = None
+    avatar_url: Union[str, None] = None
+    metadata: Dict[str, Any] = dict
+
+
+class Contacts:
+    def create(
+            self,
+            external_id: str,
+            display_name: None,
+            email: None,
+            avatar_url: None,
+            metadata=None
+    ):
+        """
+        Attributes:
+        :param external_id: An external identifier for the user
+        :param display_name: The user's display name or full name
+        :param email: The user's email address (validated format)
+        :param avatar_url: URL to the user's avatar image (validated URL format)
+        :param metadata: Additional key-value pairs for storing extra contact information
+        :return:
+        """
+
+        if not external_id:
+            raise ValueError("External ID is required.")
+
+        response = post(
+            url=CONTACTS_API,
+            body={
+                "external_id": external_id,
+                "display_name": display_name,
+                "email": email,
+                "avatar_url": avatar_url,
+                "metadata": metadata
+            }
+        )
+
+        response.raise_for_status()
+
+        return Contact(**response.json())
+
+    async def acreate(
+            self,
+            external_id: str,
+            display_name: None,
+            email: None,
+            avatar_url: None,
+            metadata=dict
+    ):
+        """
+        Attributes:
+        :param external_id: An external identifier for the user
+        :param display_name: The user's display name or full name
+        :param email: The user's email address (validated format)
+        :param avatar_url: URL to the user's avatar image (validated URL format)
+        :param metadata: Additional key-value pairs for storing extra contact information
+        :return:
+        """
+
+        if not external_id:
+            raise ValueError("External ID is required.")
+
+        response = await post_async(
+            url=CONTACTS_API,
+            body={
+                "external_id": external_id,
+                "display_name": display_name,
+                "email": email,
+                "avatar_url": avatar_url,
+                "metadata": metadata
+            }
+        )
+
+        response.raise_for_status()
+
+        return Contact(**response.json())