qodev-apollo-api 0.2.2__tar.gz → 0.3.1__tar.gz

{qodev_apollo_api-0.2.2 → qodev_apollo_api-0.3.1}/CHANGELOG.md

@@ -7,6 +7,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.3.1] - 2026-07-08
+
+### Changed
+
+- `update_opportunity_roles(...)` now types its `roles` parameter as `list[RoleAssignment]` (a `TypedDict` with a required `contact_id` and optional `opportunity_contact_role_type_id` / `is_primary`) instead of the loose `list[dict]`, giving callers type checking and autocomplete. `RoleAssignment` is exported from the package root. Non-breaking — plain dicts still satisfy it structurally.
+
+## [0.3.0] - 2026-07-08
+
+### Added
+
+- `ApolloClient.update_opportunity_roles(opportunity_id, roles)` — `POST /opportunities/update_roles`. Sets the contact roles on a deal (replaces the full set; read the current roles from `get_deal(...).opportunity_contact_roles` and modify). Returns the updated `Deal`. Surfaces the previously curl-only role-management endpoint.
+- `ApolloClient.list_custom_fields()` — `GET /typed_custom_fields`. Returns the account/contact/opportunity custom field definitions as a new `CustomField` model (`id`, `modality`, `name`, `type`, `picklist_options`, `mapped_crm_field`).
+- `CustomField` model, exported from the package root.
+
 ## [0.2.1] - 2026-07-01
 
 ### Fixed

{qodev_apollo_api-0.2.2 → qodev_apollo_api-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: qodev-apollo-api
-Version: 0.2.2
+Version: 0.3.1
 Summary: Async Python client for Apollo.io CRM API
 Project-URL: Homepage, https://github.com/qodevai/apollo-api
 Project-URL: Repository, https://github.com/qodevai/apollo-api

{qodev_apollo_api-0.2.2 → qodev_apollo_api-0.3.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "qodev-apollo-api"
-version = "0.2.2"
+version = "0.3.1"
 description = "Async Python client for Apollo.io CRM API"
 readme = "README.md"
 authors = [

{qodev_apollo_api-0.2.2 → qodev_apollo_api-0.3.1}/src/qodev_apollo_api/__init__.py

@@ -35,6 +35,7 @@ from .models import (
     CrmJob,
     CrmNote,
     Currency,
+    CustomField,
     Deal,
     Email,
     EmailerMessage,
@@ -62,6 +63,7 @@ from .models import (
     PaginatedResponse,
     PhoneEntry,
     Pipeline,
+    RoleAssignment,
     SortOrder,
     Stage,
     Task,
@@ -111,6 +113,7 @@ __all__ = [
     "CrmJob",
     "CrmNote",
     "Currency",
+    "CustomField",
     "Deal",
     "Email",
     "EmailParticipant",
@@ -139,6 +142,7 @@ __all__ = [
     "PhoneEntry",
     "Pipeline",
     "RateLimitError",
+    "RoleAssignment",
     "SortOrder",
     "Stage",
     "Task",

{qodev_apollo_api-0.2.2 → qodev_apollo_api-0.3.1}/src/qodev_apollo_api/client.py

@@ -22,6 +22,7 @@ from .models import (
     ContactDetail,
     Conversation,
     ConversationDetail,
+    CustomField,
     Deal,
     Email,
     EmailerMessage,
@@ -32,6 +33,7 @@ from .models import (
     OpportunityContactRoleType,
     PaginatedResponse,
     Pipeline,
+    RoleAssignment,
     SortOrder,
     Stage,
     Task,
@@ -520,6 +522,49 @@ class ApolloClient:
             page=1,
         )
 
+    async def update_opportunity_roles(
+        self, opportunity_id: str, roles: list[RoleAssignment]
+    ) -> Deal:
+        """Set the contact roles on a deal/opportunity (undocumented endpoint).
+
+        This **replaces** the full set of contact roles on the opportunity, so
+        callers should pass the complete desired set (read the current roles from
+        ``get_deal(...).opportunity_contact_roles`` and modify them). Each entry is
+        a dict with ``contact_id`` and, optionally, ``opportunity_contact_role_type_id``
+        and ``is_primary``::
+
+            roles = [
+                {"contact_id": "abc", "opportunity_contact_role_type_id": "t1", "is_primary": True},
+                {"contact_id": "def", "is_primary": False},
+            ]
+
+        Args:
+            opportunity_id: The opportunity/deal ID.
+            roles: The complete list of contact-role entries to set.
+
+        Returns:
+            The updated Deal.
+        """
+        data = {"opportunity_id": opportunity_id, "roles": roles}
+        result = await self._post("/opportunities/update_roles", data)
+        return Deal.model_validate(result.get("opportunity", result))
+
+    # ========================================================================
+    # CUSTOM FIELDS
+    # ========================================================================
+
+    async def list_custom_fields(self) -> list[CustomField]:
+        """List all typed custom field definitions (undocumented endpoint).
+
+        Returns definitions for custom fields across every modality (contact,
+        account, opportunity). Use ``modality`` to filter client-side.
+
+        Returns:
+            List of CustomField definitions.
+        """
+        result = await self._get("/typed_custom_fields")
+        return [CustomField.model_validate(f) for f in result.get("typed_custom_fields", [])]
+
     # ========================================================================
     # ENRICHMENT
     # ========================================================================

{qodev_apollo_api-0.2.2 → qodev_apollo_api-0.3.1}/src/qodev_apollo_api/models.py

@@ -9,7 +9,7 @@ from __future__ import annotations
 from datetime import date, datetime
 from decimal import Decimal
 from enum import StrEnum
-from typing import Annotated, Any, Generic, Literal, TypeAlias, TypeVar
+from typing import Annotated, Any, Generic, Literal, NotRequired, TypeAlias, TypedDict, TypeVar
 
 from pydantic import BaseModel, ConfigDict, Discriminator, Field, TypeAdapter, ValidationError
 
@@ -183,6 +183,18 @@ class OpportunityContactRole(ApolloModel):
     updated_at: datetime | None = None
 
 
+class RoleAssignment(TypedDict):
+    """A single contact-role entry accepted by ``update_opportunity_roles``.
+
+    ``contact_id`` is required; ``opportunity_contact_role_type_id`` and
+    ``is_primary`` are optional.
+    """
+
+    contact_id: str
+    opportunity_contact_role_type_id: NotRequired[str | None]
+    is_primary: NotRequired[bool]
+
+
 class OpportunityContactRoleType(ApolloModel):
     """Role type definition for opportunity contact roles (e.g., Decision Maker, Buyer)."""
 
@@ -640,6 +652,21 @@ class Stage(ApolloModel):
     team_id: str | None = None
 
 
+class CustomField(ApolloModel):
+    """A typed custom field definition (from GET /typed_custom_fields).
+
+    ``modality`` is the entity the field belongs to (e.g. "contact", "account",
+    "opportunity"); ``type`` is the value type (e.g. "text", "date", "picklist").
+    """
+
+    id: str
+    modality: str | None = None
+    name: str | None = None
+    type: str | None = None
+    picklist_options: list[str] = Field(default_factory=list)
+    mapped_crm_field: str | None = None
+
+
 # ============================================================================
 # ACTIVITY MODELS
 # ============================================================================

{qodev_apollo_api-0.2.2 → qodev_apollo_api-0.3.1}/tests/test_client.py

@@ -21,6 +21,7 @@ from qodev_apollo_api.models import (
     ContactDetail,
     Conversation,
     ConversationDetail,
+    CustomField,
     Deal,
     Email,
     EmailerMessage,
@@ -618,6 +619,53 @@ async def test_list_opportunity_contact_role_types(client: ApolloClient):
     assert call_args[1]["json"] == {}
 
 
+async def test_update_opportunity_roles(client: ApolloClient):
+    """Test POST /opportunities/update_roles returns the updated Deal with the roles body."""
+    client._client.request.return_value = _make_response(
+        {"opportunity": {"id": "d1", "name": "Big Deal"}}
+    )
+
+    roles = [
+        {"contact_id": "c1", "opportunity_contact_role_type_id": "rt1", "is_primary": True},
+        {"contact_id": "c2", "is_primary": False},
+    ]
+    result = await client.update_opportunity_roles("d1", roles)
+
+    assert isinstance(result, Deal)
+    assert result.id == "d1"
+
+    call_args = client._client.request.call_args
+    assert call_args[0] == ("POST", "/opportunities/update_roles")
+    assert call_args[1]["json"] == {"opportunity_id": "d1", "roles": roles}
+
+
+async def test_list_custom_fields(client: ApolloClient):
+    """Test GET /typed_custom_fields returns list[CustomField]."""
+    client._client.request.return_value = _make_response(
+        {
+            "typed_custom_fields": [
+                {"id": "f1", "modality": "contact", "name": "First Message", "type": "date"},
+                {
+                    "id": "f2",
+                    "modality": "opportunity",
+                    "name": "Region",
+                    "type": "picklist",
+                    "picklist_options": ["EU", "US"],
+                },
+            ]
+        }
+    )
+
+    result = await client.list_custom_fields()
+
+    assert len(result) == 2
+    assert all(isinstance(f, CustomField) for f in result)
+    assert result[0].name == "First Message"
+    assert result[1].picklist_options == ["EU", "US"]
+
+    assert client._client.request.call_args[0] == ("GET", "/typed_custom_fields")
+
+
 async def test_get_contact_stages(client: ApolloClient):
     """Test GET /contact_stages returns list[dict]."""
     client._client.request.return_value = _make_response(

{qodev_apollo_api-0.2.2 → qodev_apollo_api-0.3.1}/uv.lock

@@ -407,7 +407,7 @@ wheels = [
 
 [[package]]
 name = "qodev-apollo-api"
-version = "0.2.2"
+version = "0.3.1"
 source = { editable = "." }
 dependencies = [
     { name = "httpx" },