python-zendesk-sdk 0.1.2__tar.gz → 0.1.3__tar.gz

{python_zendesk_sdk-0.1.2 → python_zendesk_sdk-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-zendesk-sdk
-Version: 0.1.2
+Version: 0.1.3
 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
@@ -42,7 +42,8 @@ Modern Python SDK for Zendesk API with async support, full type safety, and comp
 ## 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, and Comments
+- **Type Safety**: Full Pydantic v2 models for Users, Organizations, Tickets, Comments, and Help Center
+- **Help Center**: Full CRUD for Categories, Sections, and Articles
 - **Pagination**: Both offset-based and cursor-based pagination support
 - **Search**: Zendesk search API support
 - **Configuration**: Flexible configuration with environment variable support
@@ -216,6 +217,84 @@ await client.add_ticket_comment(
 - `search_tickets(query)` - Search tickets
 - `search_organizations(query)` - Search organizations
 
+### Help Center
+
+Access Help Center (Guide) via `client.help_center` namespace:
+
+#### Categories
+- `get_categories()` - List categories with pagination
+- `get_category(category_id)` - Get category by ID
+- `create_category(name, description, position)` - Create category
+- `update_category(category_id, ...)` - Update category
+- `delete_category(category_id, force=True)` - Delete category (cascade deletes sections/articles)
+
+#### Sections
+- `get_sections()` - List all sections with pagination
+- `get_category_sections(category_id)` - List sections in a category
+- `get_section(section_id)` - Get section by ID
+- `create_section(category_id, name, description, position)` - Create section
+- `update_section(section_id, ...)` - Update section
+- `delete_section(section_id, force=True)` - Delete section (cascade deletes articles)
+
+#### Articles
+- `get_articles()` - List all articles with pagination
+- `get_section_articles(section_id)` - List articles in a section
+- `get_category_articles(category_id)` - List articles in a category
+- `get_article(article_id)` - Get article by ID
+- `create_article(section_id, title, body, ...)` - Create article
+- `update_article(article_id, ...)` - Update article
+- `delete_article(article_id)` - Delete article
+- `search_articles(query, ...)` - Full-text search with snippets
+
+```python
+async with ZendeskClient(config) as client:
+    hc = client.help_center
+
+    # Create category -> section -> article hierarchy
+    category = await hc.create_category(
+        name="Product Documentation",
+        description="Help articles for our product"
+    )
+
+    section = await hc.create_section(
+        category_id=category.id,
+        name="Getting Started"
+    )
+
+    article = await hc.create_article(
+        section_id=section.id,
+        title="Installation Guide",
+        body="<h1>Installation</h1><p>Follow these steps...</p>",
+        permission_group_id=252606,  # Required
+        draft=False,  # Publish immediately
+        label_names=["installation", "guide"],
+    )
+
+    # Search articles (useful for AI assistants)
+    results = await hc.search_articles("password reset")
+    for article in results:
+        print(f"{article.title}")
+        print(f"Snippet: {article.snippet}")  # Matching text with <em> tags
+
+    # Paginate through all articles
+    paginator = await hc.get_articles(per_page=50)
+    async for article_data in paginator:
+        print(article_data["title"])
+
+    # Update article
+    await hc.update_article(
+        article.id,
+        title="Updated Title",
+        promoted=True,
+        label_names=["updated", "featured"],
+    )
+
+    # Cascade delete (removes category + all sections + all articles)
+    await hc.delete_category(category.id, force=True)
+```
+
+> **Note**: `delete_category()` and `delete_section()` require `force=True` as a safety measure since they cascade delete all child content.
+
 ## Error Handling
 
 The SDK provides specific exception classes for different error types:
@@ -271,6 +350,7 @@ See the `examples/` directory for complete usage examples:
 - `pagination_example.py` - Working with paginated results
 - `error_handling.py` - Error handling patterns
 - `enriched_tickets.py` - Loading tickets with related data
+- `help_center.py` - Help Center categories, sections, and articles
 
 ## Requirements
 

{python_zendesk_sdk-0.1.2 → python_zendesk_sdk-0.1.3}/README.md

@@ -5,7 +5,8 @@ Modern Python SDK for Zendesk API with async support, full type safety, and comp
 ## 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, and Comments
+- **Type Safety**: Full Pydantic v2 models for Users, Organizations, Tickets, Comments, and Help Center
+- **Help Center**: Full CRUD for Categories, Sections, and Articles
 - **Pagination**: Both offset-based and cursor-based pagination support
 - **Search**: Zendesk search API support
 - **Configuration**: Flexible configuration with environment variable support
@@ -179,6 +180,84 @@ await client.add_ticket_comment(
 - `search_tickets(query)` - Search tickets
 - `search_organizations(query)` - Search organizations
 
+### Help Center
+
+Access Help Center (Guide) via `client.help_center` namespace:
+
+#### Categories
+- `get_categories()` - List categories with pagination
+- `get_category(category_id)` - Get category by ID
+- `create_category(name, description, position)` - Create category
+- `update_category(category_id, ...)` - Update category
+- `delete_category(category_id, force=True)` - Delete category (cascade deletes sections/articles)
+
+#### Sections
+- `get_sections()` - List all sections with pagination
+- `get_category_sections(category_id)` - List sections in a category
+- `get_section(section_id)` - Get section by ID
+- `create_section(category_id, name, description, position)` - Create section
+- `update_section(section_id, ...)` - Update section
+- `delete_section(section_id, force=True)` - Delete section (cascade deletes articles)
+
+#### Articles
+- `get_articles()` - List all articles with pagination
+- `get_section_articles(section_id)` - List articles in a section
+- `get_category_articles(category_id)` - List articles in a category
+- `get_article(article_id)` - Get article by ID
+- `create_article(section_id, title, body, ...)` - Create article
+- `update_article(article_id, ...)` - Update article
+- `delete_article(article_id)` - Delete article
+- `search_articles(query, ...)` - Full-text search with snippets
+
+```python
+async with ZendeskClient(config) as client:
+    hc = client.help_center
+
+    # Create category -> section -> article hierarchy
+    category = await hc.create_category(
+        name="Product Documentation",
+        description="Help articles for our product"
+    )
+
+    section = await hc.create_section(
+        category_id=category.id,
+        name="Getting Started"
+    )
+
+    article = await hc.create_article(
+        section_id=section.id,
+        title="Installation Guide",
+        body="<h1>Installation</h1><p>Follow these steps...</p>",
+        permission_group_id=252606,  # Required
+        draft=False,  # Publish immediately
+        label_names=["installation", "guide"],
+    )
+
+    # Search articles (useful for AI assistants)
+    results = await hc.search_articles("password reset")
+    for article in results:
+        print(f"{article.title}")
+        print(f"Snippet: {article.snippet}")  # Matching text with <em> tags
+
+    # Paginate through all articles
+    paginator = await hc.get_articles(per_page=50)
+    async for article_data in paginator:
+        print(article_data["title"])
+
+    # Update article
+    await hc.update_article(
+        article.id,
+        title="Updated Title",
+        promoted=True,
+        label_names=["updated", "featured"],
+    )
+
+    # Cascade delete (removes category + all sections + all articles)
+    await hc.delete_category(category.id, force=True)
+```
+
+> **Note**: `delete_category()` and `delete_section()` require `force=True` as a safety measure since they cascade delete all child content.
+
 ## Error Handling
 
 The SDK provides specific exception classes for different error types:
@@ -234,6 +313,7 @@ See the `examples/` directory for complete usage examples:
 - `pagination_example.py` - Working with paginated results
 - `error_handling.py` - Error handling patterns
 - `enriched_tickets.py` - Loading tickets with related data
+- `help_center.py` - Help Center categories, sections, and articles
 
 ## Requirements
 

python_zendesk_sdk-0.1.3/examples/help_center.py

@@ -0,0 +1,141 @@
+"""Help Center example for Zendesk SDK.
+
+This example demonstrates:
+- Help Center hierarchy (Categories -> Sections -> Articles)
+- CRUD operations for categories, sections, and articles
+- Article search with snippets
+- Pagination through Help Center content
+- Cascade deletion with force parameter
+"""
+
+import asyncio
+
+from zendesk_sdk import ZendeskClient, ZendeskConfig
+
+
+async def main() -> None:
+    # Configuration
+    config = ZendeskConfig(
+        subdomain="your-subdomain",
+        email="your-email@example.com",
+        token="your-api-token",
+    )
+
+    async with ZendeskClient(config) as client:
+        hc = client.help_center
+
+        # ==================== Reading Content ====================
+
+        # List categories with pagination
+        print("--- Categories ---")
+        categories_paginator = await hc.get_categories(per_page=10)
+        categories = await categories_paginator.get_page()
+        for cat in categories[:5]:
+            print(f"Category: {cat['name']} (ID: {cat['id']})")
+
+        # Get specific category
+        if categories:
+            category = await hc.get_category(categories[0]["id"])
+            print(f"\nCategory details: {category.name}")
+            print(f"Description: {category.description}")
+
+        # List sections (all or by category)
+        print("\n--- Sections ---")
+        sections_paginator = await hc.get_sections(per_page=10)
+        sections = await sections_paginator.get_page()
+        for sec in sections[:5]:
+            print(f"Section: {sec['name']} (Category: {sec['category_id']})")
+
+        # List articles in a section
+        if sections:
+            section_id = sections[0]["id"]
+            articles_paginator = await hc.get_section_articles(section_id, per_page=10)
+            articles = await articles_paginator.get_page()
+            print(f"\nArticles in section {section_id}:")
+            for art in articles[:5]:
+                print(f"  - {art['title']}")
+
+        # ==================== Search ====================
+
+        # Search articles (useful for AI assistants)
+        print("\n--- Article Search ---")
+        search_results = await hc.search_articles("password reset", per_page=5)
+        for article in search_results:
+            print(f"Found: {article.title}")
+            if article.snippet:
+                print(f"  Snippet: {article.snippet[:100]}...")
+
+        # ==================== CRUD Operations ====================
+
+        # Create a category
+        print("\n--- Creating Content ---")
+        new_category = await hc.create_category(
+            name="API Documentation",
+            description="Documentation for our REST API",
+        )
+        print(f"Created category: {new_category.name} (ID: {new_category.id})")
+
+        # Create a section in the category
+        new_section = await hc.create_section(
+            category_id=new_category.id,
+            name="Getting Started",
+            description="Quick start guides",
+        )
+        print(f"Created section: {new_section.name} (ID: {new_section.id})")
+
+        # Create an article in the section
+        new_article = await hc.create_article(
+            section_id=new_section.id,
+            title="Authentication Guide",
+            body="<h1>Authentication</h1><p>Use API tokens to authenticate...</p>",
+            draft=True,  # Create as draft first
+            permission_group_id=252606,  # Required - get from existing articles
+            label_names=["api", "authentication", "getting-started"],
+        )
+        print(f"Created article: {new_article.title} (draft: {new_article.draft})")
+
+        # Update the article
+        updated_article = await hc.update_article(
+            new_article.id,
+            title="Authentication Guide - Updated",
+            draft=False,  # Publish the article
+            promoted=True,  # Feature it
+        )
+        print(f"Updated article: {updated_article.title} (promoted: {updated_article.promoted})")
+
+        # Delete individual article
+        await hc.delete_article(new_article.id)
+        print("Deleted article")
+
+        # Create another article for cascade delete demo
+        demo_article = await hc.create_article(
+            section_id=new_section.id,
+            title="Demo Article",
+            body="<p>This will be deleted with the category</p>",
+            draft=True,
+            permission_group_id=252606,
+        )
+        print(f"Created demo article: {demo_article.title}")
+
+        # Cascade delete - removes category, section, and all articles
+        # force=True is required as a safety measure
+        await hc.delete_category(new_category.id, force=True)
+        print("Deleted category (cascade deleted section and article)")
+
+        # ==================== Pagination ====================
+
+        # Iterate through all articles with async for
+        print("\n--- Pagination Example ---")
+        all_articles_paginator = await hc.get_articles(per_page=10)
+        count = 0
+        async for article_data in all_articles_paginator:
+            count += 1
+            if count <= 3:
+                print(f"Article {count}: {article_data['title'][:40]}...")
+            if count >= 10:
+                print(f"... and more (stopped at {count})")
+                break
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

{python_zendesk_sdk-0.1.2 → python_zendesk_sdk-0.1.3}/pyproject.toml

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

{python_zendesk_sdk-0.1.2 → python_zendesk_sdk-0.1.3}/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.1.2"
+__version__ = "0.1.3"
 
 from .client import ZendeskClient
 from .config import ZendeskConfig
@@ -16,12 +16,19 @@ from .exceptions import (
     ZendeskPaginationException,
     ZendeskRateLimitException,
 )
-from .models import EnrichedTicket
+from .help_center_client import HelpCenterClient
+from .models import Article, Category, EnrichedTicket, Section
 
 __all__ = [
     "ZendeskClient",
     "ZendeskConfig",
+    "HelpCenterClient",
     "EnrichedTicket",
+    # Help Center models
+    "Category",
+    "Section",
+    "Article",
+    # Exceptions
     "ZendeskBaseException",
     "ZendeskHTTPException",
     "ZendeskAuthException",

{python_zendesk_sdk-0.1.2 → python_zendesk_sdk-0.1.3}/src/zendesk_sdk/client.py

@@ -11,6 +11,7 @@ from .models import Comment, EnrichedTicket, Organization, Ticket, User
 from .pagination import ZendeskPaginator
 
 if TYPE_CHECKING:
+    from .help_center_client import HelpCenterClient
     from .pagination import Paginator
 
 
@@ -30,6 +31,7 @@ class ZendeskClient:
         """
         self.config = config
         self._http_client: Optional[HTTPClient] = None
+        self._help_center_client: Optional["HelpCenterClient"] = None
 
     def __repr__(self) -> str:
         """String representation of the client."""
@@ -42,6 +44,37 @@ class ZendeskClient:
             self._http_client = HTTPClient(self.config)
         return self._http_client
 
+    @property
+    def help_center(self) -> "HelpCenterClient":
+        """Get Help Center client for accessing Help Center API.
+
+        The Help Center client provides access to categories, sections,
+        and articles in your Zendesk Help Center / Guide.
+
+        Returns:
+            HelpCenterClient instance
+
+        Example:
+            async with ZendeskClient(config) as client:
+                # Get a category
+                category = await client.help_center.get_category(123)
+
+                # Search articles
+                articles = await client.help_center.search_articles("password reset")
+
+                # Create an article
+                article = await client.help_center.create_article(
+                    section_id=456,
+                    title="How to Reset Password",
+                    body="<p>Follow these steps...</p>"
+                )
+        """
+        if self._help_center_client is None:
+            from .help_center_client import HelpCenterClient
+
+            self._help_center_client = HelpCenterClient(self.http_client)
+        return self._help_center_client
+
     async def get(
         self,
         path: str,