python-zendesk-sdk 0.3.0__tar.gz → 0.3.1__tar.gz

{python_zendesk_sdk-0.3.0 → python_zendesk_sdk-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-zendesk-sdk
-Version: 0.3.0
+Version: 0.3.1
 Summary: Modern Python SDK for Zendesk API
 Project-URL: Homepage, https://github.com/bormog/python-zendesk-sdk
 Project-URL: Repository, https://github.com/bormog/python-zendesk-sdk
@@ -48,6 +48,27 @@ Description-Content-Type: text/markdown
 
 Modern Python SDK for Zendesk API, designed for automation and AI agents.
 
+## Table of Contents
+
+- [Why This SDK?](#why-this-sdk)
+- [Features](#features)
+- [Installation](#installation)
+- [Quick Start](#quick-start)
+- [Configuration](#configuration)
+- [API Methods](#api-methods)
+  - [Users](#users)
+  - [Organizations](#organizations)
+  - [Tickets](#tickets)
+  - [Comments](#comments-nested-under-tickets)
+  - [Tags](#tags-nested-under-tickets)
+  - [Enriched Tickets](#enriched-tickets)
+  - [Attachments](#attachments)
+  - [Search](#search)
+  - [Help Center](#help-center)
+- [Error Handling](#error-handling)
+- [Caching](#caching)
+- [Examples](#examples)
+
 ## Why This SDK?
 
 Zendesk has a powerful REST API, but using it directly is painful:
@@ -59,28 +80,27 @@ Zendesk has a powerful REST API, but using it directly is painful:
 **This SDK solves these problems** with a clean, typed interface optimized for:
 
 - **Support automation** — workflows, triggers, integrations
-- **LLM agents** — Claude Code, Codex, custom AI assistants that need structured Zendesk access
 - **Internal tools** — dashboards, reports, bulk operations
+- **LLM agents** — Claude Code, Codex, custom AI assistants that need structured Zendesk access
 
-### Built for AI Agents
+### Developer Experience
 
-When an LLM agent needs to work with Zendesk, it needs:
-- **Predictable structure** — typed models instead of arbitrary dicts
+- **Predictable structure** — typed Pydantic models instead of arbitrary dicts
 - **Complete context in one call** — `get_enriched()` returns ticket + all comments + all users
-- **Minimal API calls** — built-in caching reduces redundant requests
+- **No boilerplate** — pagination, caching, and object loading handled automatically
+- **Minimal API calls** — built-in caching and batching reduce redundant requests
 - **Clear namespaces** — `client.tickets.comments.add()` is self-documenting
 
 ## Features
 
-- **Async HTTP Client**: Built on httpx with retry logic, rate limiting, and exponential backoff
-- **Type Safety**: Full Pydantic v2 models for Users, Organizations, Tickets, Comments, and Help Center
-- **Namespace Pattern**: Clean API organization (`client.users`, `client.tickets`, `client.help_center`)
-- **Caching**: Built-in TTL-based caching for users, organizations, and Help Center content
+- **Type Safety**: Full Pydantic v2 models for all Zendesk entities
+- **Namespace Pattern**: Clean API — `client.users`, `client.tickets`, `client.help_center`
+- **Search**: Raw queries + type-safe SearchQueryConfig, export methods for large datasets
+- **Pagination**: Offset-based and cursor-based (export) with async iterators
+- **Caching**: TTL-based caching for users, organizations, and Help Center
 - **Help Center**: Full CRUD for Categories, Sections, and Articles
-- **Pagination**: Both offset-based and cursor-based (export) pagination support
-- **Search**: Type-safe SearchQueryConfig + raw query strings, with export methods for stable pagination
-- **Human-readable output**: All models have `__str__` methods for easy printing
-- **Configuration**: Flexible configuration with environment variable support
+- **Async HTTP**: Built on httpx with retry logic, rate limiting, exponential backoff
+- **Configuration**: Environment variables or direct instantiation
 
 ## Installation
 
@@ -150,14 +170,12 @@ user = await client.users.get(user_id)           # Get user by ID
 paginator = await client.users.list()            # List users with pagination
 user = await client.users.by_email(email)        # Get user by email
 users = await client.users.get_many([id1, id2])  # Get multiple users
-# For search use client.search.users() - see Search section below
 ```
 
 ### Organizations
 ```python
 org = await client.organizations.get(org_id)     # Get organization by ID
 paginator = await client.organizations.list()    # List organizations
-# For search use client.search.organizations() - see Search section below
 ```
 
 ### Tickets
@@ -166,7 +184,6 @@ ticket = await client.tickets.get(ticket_id)           # Get ticket by ID
 paginator = await client.tickets.list()                # List tickets
 tickets = await client.tickets.for_user(user_id)       # Get user's tickets
 tickets = await client.tickets.for_organization(org_id) # Get org's tickets
-# For search use client.search.tickets() - see Search section below
 ```
 
 ### Comments (nested under tickets)

{python_zendesk_sdk-0.3.0 → python_zendesk_sdk-0.3.1}/README.md

@@ -10,6 +10,27 @@
 
 Modern Python SDK for Zendesk API, designed for automation and AI agents.
 
+## Table of Contents
+
+- [Why This SDK?](#why-this-sdk)
+- [Features](#features)
+- [Installation](#installation)
+- [Quick Start](#quick-start)
+- [Configuration](#configuration)
+- [API Methods](#api-methods)
+  - [Users](#users)
+  - [Organizations](#organizations)
+  - [Tickets](#tickets)
+  - [Comments](#comments-nested-under-tickets)
+  - [Tags](#tags-nested-under-tickets)
+  - [Enriched Tickets](#enriched-tickets)
+  - [Attachments](#attachments)
+  - [Search](#search)
+  - [Help Center](#help-center)
+- [Error Handling](#error-handling)
+- [Caching](#caching)
+- [Examples](#examples)
+
 ## Why This SDK?
 
 Zendesk has a powerful REST API, but using it directly is painful:
@@ -21,28 +42,27 @@ Zendesk has a powerful REST API, but using it directly is painful:
 **This SDK solves these problems** with a clean, typed interface optimized for:
 
 - **Support automation** — workflows, triggers, integrations
-- **LLM agents** — Claude Code, Codex, custom AI assistants that need structured Zendesk access
 - **Internal tools** — dashboards, reports, bulk operations
+- **LLM agents** — Claude Code, Codex, custom AI assistants that need structured Zendesk access
 
-### Built for AI Agents
+### Developer Experience
 
-When an LLM agent needs to work with Zendesk, it needs:
-- **Predictable structure** — typed models instead of arbitrary dicts
+- **Predictable structure** — typed Pydantic models instead of arbitrary dicts
 - **Complete context in one call** — `get_enriched()` returns ticket + all comments + all users
-- **Minimal API calls** — built-in caching reduces redundant requests
+- **No boilerplate** — pagination, caching, and object loading handled automatically
+- **Minimal API calls** — built-in caching and batching reduce redundant requests
 - **Clear namespaces** — `client.tickets.comments.add()` is self-documenting
 
 ## Features
 
-- **Async HTTP Client**: Built on httpx with retry logic, rate limiting, and exponential backoff
-- **Type Safety**: Full Pydantic v2 models for Users, Organizations, Tickets, Comments, and Help Center
-- **Namespace Pattern**: Clean API organization (`client.users`, `client.tickets`, `client.help_center`)
-- **Caching**: Built-in TTL-based caching for users, organizations, and Help Center content
+- **Type Safety**: Full Pydantic v2 models for all Zendesk entities
+- **Namespace Pattern**: Clean API — `client.users`, `client.tickets`, `client.help_center`
+- **Search**: Raw queries + type-safe SearchQueryConfig, export methods for large datasets
+- **Pagination**: Offset-based and cursor-based (export) with async iterators
+- **Caching**: TTL-based caching for users, organizations, and Help Center
 - **Help Center**: Full CRUD for Categories, Sections, and Articles
-- **Pagination**: Both offset-based and cursor-based (export) pagination support
-- **Search**: Type-safe SearchQueryConfig + raw query strings, with export methods for stable pagination
-- **Human-readable output**: All models have `__str__` methods for easy printing
-- **Configuration**: Flexible configuration with environment variable support
+- **Async HTTP**: Built on httpx with retry logic, rate limiting, exponential backoff
+- **Configuration**: Environment variables or direct instantiation
 
 ## Installation
 
@@ -112,14 +132,12 @@ user = await client.users.get(user_id)           # Get user by ID
 paginator = await client.users.list()            # List users with pagination
 user = await client.users.by_email(email)        # Get user by email
 users = await client.users.get_many([id1, id2])  # Get multiple users
-# For search use client.search.users() - see Search section below
 ```
 
 ### Organizations
 ```python
 org = await client.organizations.get(org_id)     # Get organization by ID
 paginator = await client.organizations.list()    # List organizations
-# For search use client.search.organizations() - see Search section below
 ```
 
 ### Tickets
@@ -128,7 +146,6 @@ ticket = await client.tickets.get(ticket_id)           # Get ticket by ID
 paginator = await client.tickets.list()                # List tickets
 tickets = await client.tickets.for_user(user_id)       # Get user's tickets
 tickets = await client.tickets.for_organization(org_id) # Get org's tickets
-# For search use client.search.tickets() - see Search section below
 ```
 
 ### Comments (nested under tickets)

{python_zendesk_sdk-0.3.0 → python_zendesk_sdk-0.3.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-zendesk-sdk"
-version = "0.3.0"
+version = "0.3.1"
 description = "Modern Python SDK for Zendesk API"
 authors = [
     {name = "bormog"}

{python_zendesk_sdk-0.3.0 → python_zendesk_sdk-0.3.1}/src/zendesk_sdk/__init__.py

@@ -5,7 +5,7 @@ This package provides a clean, async-first interface to the Zendesk API
 with full type safety and comprehensive error handling.
 """
 
-__version__ = "0.3.0"
+__version__ = "0.3.1"
 
 from .client import ZendeskClient
 from .clients import (

{python_zendesk_sdk-0.3.0 → python_zendesk_sdk-0.3.1}/src/zendesk_sdk/clients/organizations.py

@@ -1,6 +1,6 @@
 """Organizations API client."""
 
-from typing import TYPE_CHECKING, Any, Callable, Dict, List, Optional
+from typing import TYPE_CHECKING, Any, Callable, Dict, Optional
 
 from ..models import Organization
 from ..pagination import ZendeskPaginator
@@ -66,4 +66,3 @@ class OrganizationsClient(BaseClient):
             Paginator for iterating through all organizations
         """
         return ZendeskPaginator.create_organizations_paginator(self._http, per_page=per_page)
-

{python_zendesk_sdk-0.3.0 → python_zendesk_sdk-0.3.1}/src/zendesk_sdk/clients/tickets.py

@@ -421,9 +421,7 @@ class TicketsClient(BaseClient):
             enriched = [e async for e in client.tickets.search_enriched(config)]
         """
         full_query = self._resolve_query(query)
-        paginator = ZendeskPaginator.create_search_paginator(
-            self._http, query=full_query, per_page=per_page
-        )
+        paginator = ZendeskPaginator.create_search_paginator(self._http, query=full_query, per_page=per_page)
 
         count = 0
         async for page_data in self._paginate_enriched(paginator):
@@ -444,9 +442,7 @@ class TicketsClient(BaseClient):
                 if limit and count >= limit:
                     return
 
-    async def _paginate_enriched(
-        self, paginator: "Paginator[Dict[str, Any]]"
-    ) -> AsyncIterator[List[Dict[str, Any]]]:
+    async def _paginate_enriched(self, paginator: "Paginator[Dict[str, Any]]") -> AsyncIterator[List[Dict[str, Any]]]:
         """Yield pages of raw ticket data for batch enrichment."""
         while True:
             try:

{python_zendesk_sdk-0.3.0 → python_zendesk_sdk-0.3.1}/src/zendesk_sdk/config.py

@@ -1,7 +1,7 @@
 """Configuration management for Zendesk SDK."""
 
 import os
-from typing import Any, Optional
+from typing import Any
 
 from pydantic import BaseModel, Field, computed_field, field_validator
 

{python_zendesk_sdk-0.3.0 → python_zendesk_sdk-0.3.1}/src/zendesk_sdk/models/search.py

@@ -129,15 +129,11 @@ class SearchQueryConfig(BaseModel):
     exclude_tags: Optional[List[str]] = Field(None, description="Exclude items with these tags")
 
     # === Ticket-specific fields ===
-    status: Optional[List[Union[TicketStatus, str]]] = Field(
-        None, description="Ticket statuses to search (OR logic)"
-    )
+    status: Optional[List[Union[TicketStatus, str]]] = Field(None, description="Ticket statuses to search (OR logic)")
     priority: Optional[List[Union[TicketPriority, str]]] = Field(
         None, description="Ticket priorities to search (OR logic)"
     )
-    ticket_type: Optional[List[Union[TicketType, str]]] = Field(
-        None, description="Ticket types to search (OR logic)"
-    )
+    ticket_type: Optional[List[Union[TicketType, str]]] = Field(None, description="Ticket types to search (OR logic)")
     organization_id: Optional[int] = Field(None, description="Filter by organization ID")
     requester_id: Optional[Union[int, Literal["me", "none"]]] = Field(
         None, description="Filter by requester ID, 'me', or 'none'"
@@ -150,32 +146,20 @@ class SearchQueryConfig(BaseModel):
     )
     group_id: Optional[int] = Field(None, description="Filter by group ID")
     brand_id: Optional[int] = Field(None, description="Filter by brand ID (Enterprise)")
-    via: Optional[List[Union[TicketChannel, str]]] = Field(
-        None, description="Filter by channel (OR logic)"
-    )
+    via: Optional[List[Union[TicketChannel, str]]] = Field(None, description="Filter by channel (OR logic)")
     subject: Optional[str] = Field(None, description="Search in ticket subject")
     description: Optional[str] = Field(None, description="Search in ticket description/comments")
-    solved_after: Optional[Union[date, datetime, str]] = Field(
-        None, description="Tickets solved after this date"
-    )
-    solved_before: Optional[Union[date, datetime, str]] = Field(
-        None, description="Tickets solved before this date"
-    )
-    due_date_after: Optional[Union[date, datetime, str]] = Field(
-        None, description="Task tickets due after this date"
-    )
-    due_date_before: Optional[Union[date, datetime, str]] = Field(
-        None, description="Task tickets due before this date"
-    )
+    solved_after: Optional[Union[date, datetime, str]] = Field(None, description="Tickets solved after this date")
+    solved_before: Optional[Union[date, datetime, str]] = Field(None, description="Tickets solved before this date")
+    due_date_after: Optional[Union[date, datetime, str]] = Field(None, description="Task tickets due after this date")
+    due_date_before: Optional[Union[date, datetime, str]] = Field(None, description="Task tickets due before this date")
     has_attachment: Optional[bool] = Field(None, description="Filter tickets with/without attachments")
     custom_fields: Optional[Dict[int, Any]] = Field(
         None, description="Search by custom field values: {field_id: value}"
     )
 
     # === User-specific fields ===
-    role: Optional[List[Union[UserRole, str]]] = Field(
-        None, description="User roles to search (OR logic)"
-    )
+    role: Optional[List[Union[UserRole, str]]] = Field(None, description="User roles to search (OR logic)")
     email: Optional[str] = Field(None, description="Search by user email")
     name: Optional[str] = Field(None, description="Search by user/organization name")
     phone: Optional[str] = Field(None, description="Search by user phone number")
@@ -192,9 +176,7 @@ class SearchQueryConfig(BaseModel):
     sort: Optional[SortOrder] = Field(None, description="Sort order (asc, desc)")
 
     # === Query limit ===
-    raw_query: Optional[str] = Field(
-        None, description="Append raw query string for advanced use cases"
-    )
+    raw_query: Optional[str] = Field(None, description="Append raw query string for advanced use cases")
 
     @model_validator(mode="after")
     def validate_type_specific_fields(self) -> "SearchQueryConfig":

{python_zendesk_sdk-0.3.0 → python_zendesk_sdk-0.3.1}/tests/test_clients.py

@@ -83,7 +83,6 @@ class TestUsersClient:
 
             assert result is None
 
-
     @pytest.mark.asyncio
     async def test_get_many(self):
         """Test get multiple users."""

{python_zendesk_sdk-0.3.0 → python_zendesk_sdk-0.3.1}/tests/test_package_import.py

@@ -9,7 +9,7 @@ class TestPackageImport:
         import zendesk_sdk
 
         assert hasattr(zendesk_sdk, "__version__")
-        assert zendesk_sdk.__version__ == "0.3.0"
+        assert zendesk_sdk.__version__ == "0.3.1"
 
     def test_client_import(self):
         """Test importing ZendeskClient."""

{python_zendesk_sdk-0.3.0 → python_zendesk_sdk-0.3.1}/tests/test_search_query_config.py

@@ -7,8 +7,6 @@ https://support.zendesk.com/hc/en-us/articles/203663226
 
 from datetime import date, datetime
 
-import pytest
-
 from zendesk_sdk.models.search import (
     SearchQueryConfig,
     SearchType,