python-zendesk-sdk 0.11.0__tar.gz → 0.12.0__tar.gz

{python_zendesk_sdk-0.11.0 → python_zendesk_sdk-0.12.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-zendesk-sdk
-Version: 0.11.0
+Version: 0.12.0
 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
@@ -266,6 +266,17 @@ count = await client.groups.count()              # Get total number of groups
 paginator = client.groups.list()                 # List all groups (paginator)
 paginator = client.groups.list_assignable()      # List assignable groups (paginator)
 
+# Memberships — find which agents belong to a group
+paginator = client.groups.list_memberships()              # All memberships (paginator)
+paginator = client.groups.list_group_members(group_id)    # Members of specific group (paginator)
+membership = await client.groups.get_membership(membership_id)  # Get specific membership
+
+# Example: get all agents in a group
+members = await client.groups.list_group_members(group_id).collect()
+for m in members:
+    user = await client.users.get(m.user_id)
+    print(f"  {user.name} (default={m.default})")
+
 # Create
 group = await client.groups.create(
     name="Support Team",

{python_zendesk_sdk-0.11.0 → python_zendesk_sdk-0.12.0}/README.md

@@ -228,6 +228,17 @@ count = await client.groups.count()              # Get total number of groups
 paginator = client.groups.list()                 # List all groups (paginator)
 paginator = client.groups.list_assignable()      # List assignable groups (paginator)
 
+# Memberships — find which agents belong to a group
+paginator = client.groups.list_memberships()              # All memberships (paginator)
+paginator = client.groups.list_group_members(group_id)    # Members of specific group (paginator)
+membership = await client.groups.get_membership(membership_id)  # Get specific membership
+
+# Example: get all agents in a group
+members = await client.groups.list_group_members(group_id).collect()
+for m in members:
+    user = await client.users.get(m.user_id)
+    print(f"  {user.name} (default={m.default})")
+
 # Create
 group = await client.groups.create(
     name="Support Team",

{python_zendesk_sdk-0.11.0 → python_zendesk_sdk-0.12.0}/examples/groups.py

@@ -6,6 +6,7 @@ This example demonstrates:
 - Updating groups
 - Deleting groups
 - Listing assignable groups
+- Group memberships (list members of a group)
 """
 
 import asyncio
@@ -97,6 +98,25 @@ async def main() -> None:
         await client.groups.delete(detailed_group.id)
         print(f"Deleted group: {detailed_group.id}")
 
+        # ==================== Membership Operations ====================
+
+        print("\n=== Membership Operations ===")
+
+        # List all memberships across all groups
+        print("All memberships:")
+        async for membership in client.groups.list_memberships(limit=10):
+            print(f"  User {membership.user_id} -> Group {membership.group_id} (default={membership.default})")
+
+        # List members of a specific group
+        print("\nMembers of first group:")
+        first_group = groups[0] if groups else None
+        if first_group:
+            members = await client.groups.list_group_members(first_group.id).collect()
+            for m in members:
+                user = await client.users.get(m.user_id)
+                default_str = " [DEFAULT]" if m.default else ""
+                print(f"  {user.name}{default_str}")
+
         # ==================== Caching Example ====================
 
         print("\n=== Caching Example ===")

{python_zendesk_sdk-0.11.0 → python_zendesk_sdk-0.12.0}/pyproject.toml

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

{python_zendesk_sdk-0.11.0 → python_zendesk_sdk-0.12.0}/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.11.0"
+__version__ = "0.12.0"
 
 from .client import ZendeskClient
 from .clients import (
@@ -38,6 +38,7 @@ from .models import (
     Category,
     EnrichedTicket,
     Group,
+    GroupMembership,
     PasswordRequirements,
     SearchQueryConfig,
     SearchType,
@@ -76,6 +77,7 @@ __all__ = [
     "ArticlesClient",
     # Models
     "Group",
+    "GroupMembership",
     "EnrichedTicket",
     "TicketField",
     "Category",

{python_zendesk_sdk-0.11.0 → python_zendesk_sdk-0.12.0}/src/zendesk_sdk/clients/groups.py

@@ -2,7 +2,7 @@
 
 from typing import TYPE_CHECKING, Any, Callable, Dict, Optional
 
-from ..models import Group
+from ..models import Group, GroupMembership
 from ..pagination import ZendeskPaginator
 from .base import BaseClient
 
@@ -300,3 +300,68 @@ class GroupsClient(BaseClient):
         """
         await self._delete(f"groups/{group_id}.json")
         return True
+
+    # ==================== Membership Operations ====================
+
+    def list_memberships(self, per_page: int = 100, limit: Optional[int] = None) -> "Paginator[GroupMembership]":
+        """Get paginated list of all group memberships.
+
+        Returns all group membership records across the entire account.
+
+        Args:
+            per_page: Number of memberships per API request (max 100).
+            limit: Maximum total memberships to return. None for no limit.
+
+        Returns:
+            Paginator[GroupMembership] for iterating through all memberships
+
+        Example:
+            async for membership in client.groups.list_memberships():
+                print(f"User {membership.user_id} in Group {membership.group_id}")
+        """
+        return ZendeskPaginator.create_group_memberships_paginator(self._http, per_page=per_page, limit=limit)
+
+    def list_group_members(
+        self, group_id: int, per_page: int = 100, limit: Optional[int] = None
+    ) -> "Paginator[GroupMembership]":
+        """Get paginated list of memberships for a specific group.
+
+        Returns membership records for agents in the given group.
+        Use this to find out which agents belong to a group.
+
+        Args:
+            group_id: The group's ID
+            per_page: Number of memberships per API request (max 100).
+            limit: Maximum total memberships to return. None for no limit.
+
+        Returns:
+            Paginator[GroupMembership] for iterating through group's memberships
+
+        Example:
+            # List all agents in a group
+            async for membership in client.groups.list_group_members(12345):
+                print(f"Agent {membership.user_id}, default={membership.default}")
+
+            # Collect all members
+            members = await client.groups.list_group_members(12345).collect()
+            user_ids = [m.user_id for m in members]
+        """
+        return ZendeskPaginator.create_group_memberships_by_group_paginator(
+            self._http, group_id, per_page=per_page, limit=limit
+        )
+
+    async def get_membership(self, membership_id: int) -> GroupMembership:
+        """Get a specific group membership by ID.
+
+        Args:
+            membership_id: The membership's ID
+
+        Returns:
+            GroupMembership object
+
+        Example:
+            membership = await client.groups.get_membership(99999)
+            print(f"User {membership.user_id} in Group {membership.group_id}")
+        """
+        response = await self._get(f"group_memberships/{membership_id}.json")
+        return GroupMembership(**response["group_membership"])

{python_zendesk_sdk-0.11.0 → python_zendesk_sdk-0.12.0}/src/zendesk_sdk/models/__init__.py

@@ -4,6 +4,7 @@ from .base import ZendeskModel
 from .comment import Comment, CommentAttachment, CommentMetadata, CommentVia
 from .enriched_ticket import EnrichedTicket
 from .group import Group
+from .group_membership import GroupMembership
 from .help_center import Article, Category, Section
 from .organization import Organization, OrganizationField, OrganizationSubscription
 from .search import (
@@ -43,6 +44,7 @@ __all__ = [
     "PasswordRequirements",
     # Group models
     "Group",
+    "GroupMembership",
     # Organization models
     "Organization",
     "OrganizationField",

python_zendesk_sdk-0.12.0/src/zendesk_sdk/models/group_membership.py

@@ -0,0 +1,31 @@
+"""Group Membership model for Zendesk API."""
+
+from datetime import datetime
+from typing import Optional
+
+from pydantic import Field
+
+from .base import ZendeskModel
+
+
+class GroupMembership(ZendeskModel):
+    """Zendesk Group Membership model.
+
+    Represents the association between a user (agent) and a group.
+    Agents can be members of multiple groups, and one group is marked
+    as their default group for ticket assignment.
+    """
+
+    # Read-only fields
+    id: Optional[int] = Field(None, description="Automatically assigned when creating memberships")
+    url: Optional[str] = Field(None, description="The API url of the membership")
+    user_id: int = Field(..., description="The ID of the agent")
+    group_id: int = Field(..., description="The ID of the group")
+    default: Optional[bool] = Field(None, description="If true, tickets assigned directly to the agent use this group")
+    created_at: Optional[datetime] = Field(None, description="The time the membership was created")
+    updated_at: Optional[datetime] = Field(None, description="The time of the last update")
+
+    def __str__(self) -> str:
+        """Human-readable string representation."""
+        default_str = " (default)" if self.default else ""
+        return f"User {self.user_id} -> Group {self.group_id}{default_str} (id={self.id})"

{python_zendesk_sdk-0.11.0 → python_zendesk_sdk-0.12.0}/src/zendesk_sdk/pagination.py

@@ -5,7 +5,7 @@ from abc import ABC, abstractmethod
 from typing import Any, AsyncIterator, Dict, Generic, List, Optional, TypeVar
 
 from .exceptions import ZendeskPaginationException
-from .models import Article, Category, Comment, Group, Organization, Section, Ticket, TicketField, User
+from .models import Article, Category, Comment, Group, GroupMembership, Organization, Section, Ticket, TicketField, User
 
 logger = logging.getLogger(__name__)
 
@@ -557,6 +557,32 @@ class ZendeskPaginator:
 
         return AssignableGroupsPaginator(http_client, "groups/assignable.json", per_page=per_page, limit=limit)
 
+    @staticmethod
+    def create_group_memberships_paginator(
+        http_client: Any, per_page: int = 100, limit: Optional[int] = None
+    ) -> OffsetPaginator[GroupMembership]:
+        """Create paginator for all group memberships endpoint."""
+
+        class GroupMembershipsPaginator(OffsetPaginator[GroupMembership]):
+            def _extract_items(self, response: Dict[str, Any]) -> List[GroupMembership]:
+                return [GroupMembership(**m) for m in response.get("group_memberships", [])]
+
+        return GroupMembershipsPaginator(http_client, "group_memberships.json", per_page=per_page, limit=limit)
+
+    @staticmethod
+    def create_group_memberships_by_group_paginator(
+        http_client: Any, group_id: int, per_page: int = 100, limit: Optional[int] = None
+    ) -> OffsetPaginator[GroupMembership]:
+        """Create paginator for memberships of a specific group."""
+
+        class GroupMembershipsByGroupPaginator(OffsetPaginator[GroupMembership]):
+            def _extract_items(self, response: Dict[str, Any]) -> List[GroupMembership]:
+                return [GroupMembership(**m) for m in response.get("group_memberships", [])]
+
+        return GroupMembershipsByGroupPaginator(
+            http_client, f"groups/{group_id}/memberships.json", per_page=per_page, limit=limit
+        )
+
     @staticmethod
     def create_ticket_fields_paginator(
         http_client: Any, per_page: int = 100, limit: Optional[int] = None

{python_zendesk_sdk-0.11.0 → python_zendesk_sdk-0.12.0}/tests/test_package_import.py

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