zammad_py 3.2.0__py3-none-any.whl → 3.2.1__py3-none-any.whl

zammad_py/__init__.py

@@ -2,6 +2,6 @@
 
 __author__ = """Joe Paul"""
 __email__ = "joeirimpan@gmail.com"
-__version__ = "3.2.0"
+__version__ = "3.2.1"
 
 from .api import ZammadAPI  # noqa: F401

zammad_py/api.py

@@ -8,9 +8,24 @@ from typing import Any, Generator, List, Optional, Tuple
 import requests
 from requests.exceptions import HTTPError
 
-from zammad_py.exceptions import ConfigException
-
-__all__ = ["ZammadAPI"]
+from zammad_py.enums import KnowledgeBaseAnswerPublicity
+from zammad_py.exceptions import (
+    ConfigException,
+    InvalidTypeError,
+    MissingParameterError,
+    UnusedResourceError,
+)
+
+__all__ = [
+    "ZammadAPI",
+    # Exceptions
+    "ConfigException",
+    "UnusedResourceError",
+    "MissingParameterError",
+    "InvalidTypeError",
+    # Enums
+    "KnowledgeBaseAnswerPublicity",
+]
 
 
 class ZammadAPI:
@@ -110,7 +125,7 @@ class ZammadAPI:
         return Ticket(connection=self)
 
     @property
-    def link(self):
+    def link(self) -> "Link":
         """Return a `Link` instance"""
         return Link(connection=self)
 
@@ -150,10 +165,25 @@ class ZammadAPI:
         return TagList(connection=self)
 
     @property
-    def ticket_tag(self):
+    def ticket_tag(self) -> "TicketTag":
         """Return a `TicketTag` instance"""
         return TicketTag(connection=self)
 
+    @property
+    def knowledge_bases(self) -> "KnowledgeBases":
+        """Return a `KnowledgeBases` instance"""
+        return KnowledgeBases(connection=self)
+
+    @property
+    def knowledge_bases_answers(self) -> "KnowledgeBasesAnswers":
+        """Return an `KnowledgeBasesAnswers` instance"""
+        return KnowledgeBasesAnswers(connection=self)
+
+    @property
+    def knowledge_bases_categories(self) -> "KnowledgeBasesCategories":
+        """Return an `KnowledgeBasesCategories` instance"""
+        return KnowledgeBasesCategories(connection=self)
+
 
 class Pagination:
     def __init__(
@@ -312,7 +342,7 @@ class Resource(ABC):
             page=params["page"],
         )
 
-    def find(self, id):
+    def find(self, id: int) -> Any:
         """Return the resource associated with the id
 
         :param id: Resource id
@@ -320,7 +350,7 @@ class Resource(ABC):
         response = self._connection.session.get(self.url + "/%s" % id)
         return self._raise_or_return_json(response)
 
-    def create(self, params):
+    def create(self, params: Any) -> Any:
         """Create the requested resource
 
         :param params: Resource data for creating
@@ -328,7 +358,7 @@ class Resource(ABC):
         response = self._connection.session.post(self.url, json=params)
         return self._raise_or_return_json(response)
 
-    def update(self, id, params):
+    def update(self, id: int, params: Any) -> Any:
         """Update the requested resource
 
         :param id: Resource id
@@ -337,7 +367,7 @@ class Resource(ABC):
         response = self._connection.session.put(self.url + "/%s" % id, json=params)
         return self._raise_or_return_json(response)
 
-    def destroy(self, id):
+    def destroy(self, id: int) -> Any:
         """Delete the resource associated with the id
 
         :param id: Resource id
@@ -361,7 +391,7 @@ class Organization(Resource):
 class Ticket(Resource):
     path_attribute = "tickets"
 
-    def articles(self, id):
+    def articles(self, id: int) -> Any:
         """Returns all the articles associated with the ticket id
 
         :param id: Ticket id
@@ -371,7 +401,7 @@ class Ticket(Resource):
         )
         return self._raise_or_return_json(response)
 
-    def tags(self, id):
+    def tags(self, id: int) -> Any:
         """Returns all the tags associated with the ticket id
 
         :param id: Ticket id
@@ -381,7 +411,7 @@ class Ticket(Resource):
         )
         return self._raise_or_return_json(response)
 
-    def merge(self, id, number):
+    def merge(self, id: int, number: int) -> Any:
         """Merges two tickets, (undocumented in Zammad Docs)
         If the objects are already merged, it will return "Object already exists!"
         Attention: Must use password to authenticate to Zammad, otherwise this will not work!
@@ -400,12 +430,12 @@ class Link(Resource):
 
     def add(
         self,
-        link_object_target_value,
-        link_object_source_number,
-        link_type="normal",
-        link_object_target="Ticket",
-        link_object_source="Ticket",
-    ):
+        link_object_target_value: int,
+        link_object_source_number: int,
+        link_type: str = "normal",
+        link_object_target: str = "Ticket",
+        link_object_source: str = "Ticket",
+    ) -> Any:
         """Create the link
 
         :params link_type: Link type ('normal', 'parent', 'child')
@@ -429,12 +459,12 @@ class Link(Resource):
 
     def remove(
         self,
-        link_object_target_value,
-        link_object_source_number,
-        link_type="normal",
-        link_object_target="Ticket",
-        link_object_source="Ticket",
-    ):
+        link_object_target_value: int,
+        link_object_source_number: int,
+        link_type: str = "normal",
+        link_object_target: str = "Ticket",
+        link_object_source: str = "Ticket",
+    ) -> Any:
         """Remove the Link
 
         :params link_type: Link type ('normal', 'parent', 'child')
@@ -454,7 +484,7 @@ class Link(Resource):
         response = self._connection.session.delete(self.url + "/remove", json=params)
         return self._raise_or_return_json(response)
 
-    def get(self, id):
+    def get(self, id: int) -> Any:
         """Returns all the links associated with the ticket id
 
         :param id: Ticket id
@@ -473,7 +503,7 @@ class TicketArticle(Resource):
 class TicketArticleAttachment(Resource):
     path_attribute = "ticket_attachment"
 
-    def download(self, id, article_id, ticket_id):
+    def download(self, id: int, article_id: int, ticket_id: int) -> Any:
         """Download the ticket attachment associated with the ticket id
 
         :param id: Ticket attachment id
@@ -501,7 +531,7 @@ class TicketState(Resource):
 class User(Resource):
     path_attribute = "users"
 
-    def me(self):
+    def me(self) -> Any:
         """Returns current user information"""
         response = self._connection.session.get(self.url + "/me")
         return self._raise_or_return_json(response)
@@ -510,7 +540,7 @@ class User(Resource):
 class OnlineNotification(Resource):
     path_attribute = "online_notifications"
 
-    def mark_all_read(self):
+    def mark_all_read(self) -> Any:
         """Marks all online notification as read"""
         response = self._connection.session.post(self.url + "/mark_all_as_read")
         return self._raise_or_return_json(response)
@@ -519,7 +549,7 @@ class OnlineNotification(Resource):
 class Object(Resource):
     path_attribute = "object_manager_attributes"
 
-    def execute_migrations(self):
+    def execute_migrations(self) -> Any:
         """Executes all database migrations"""
         response = self._connection.session.post(
             self._connection.url + "object_manager_attributes_execute_migrations"
@@ -538,7 +568,7 @@ class TicketTag(Resource):
 
     path_attribute = "tags"
 
-    def add(self, id, tag, object="Ticket"):
+    def add(self, id: int, tag: str, object: str = "Ticket") -> Any:
         """Add a tag to a ticket
 
         :param id: Ticket id
@@ -555,7 +585,7 @@ class TicketTag(Resource):
         response = self._connection.session.post(self.url + "/add", json=params)
         return self._raise_or_return_json(response)
 
-    def remove(self, id, tag, object="Ticket"):
+    def remove(self, id: int, tag: str, object: str = "Ticket") -> Any:
         """Remove a tag from a ticket.
 
         :param id: Ticket id
@@ -571,3 +601,399 @@ class TicketTag(Resource):
 
         response = self._connection.session.delete(self.url + "/remove", json=params)
         return self._raise_or_return_json(response)
+
+
+class KnowledgeBases(Resource):
+    path_attribute = "knowledge_bases"
+
+    def init(self) -> Any:
+        """Returns a bootstrap object containing the entire structure (settings, categories, and answer IDs) of the knowledge base"""
+        response = self._connection.session.post(
+            self._connection.url + "knowledge_bases/init"
+        )
+        return self._raise_or_return_json(response)
+
+    def manage(self, id: int, settings: dict) -> Any:
+        """Updates specific knowledge base settings like custom URLs, colors, or visibility toggles
+
+        :param id: Knowledge Base ID
+        :param settings: Dictionary of setting to be applied to the knowledge base
+        """
+        response = self._connection.session.patch(
+            self._connection.url + "knowledge_bases/manage/%s" % id, json=settings
+        )
+        return self._raise_or_return_json(response)
+
+    def show_permissions(self, id: int) -> Any:
+        """Returns a list of roles and their associated access levels (reader/editor) for the knowledge base
+
+        :param id: Knowledge Base ID
+        """
+        response = self._connection.session.get(
+            self._connection.url + "knowledge_bases/%s/permissions" % id,
+        )
+        return self._raise_or_return_json(response)
+
+    def change_permissions(self, id: int, permissions: dict) -> Any:
+        """Replaces the current permission set with a new mapping of roles and access levels
+
+        :param id: Knowledge Base ID
+        :param permissions: Dictionary of new permissions to be applied to the knowledge base
+        """
+        response = self._connection.session.put(
+            self._connection.url + "knowledge_bases/%s/permissions" % id,
+            json=permissions,
+        )
+        return self._raise_or_return_json(response)
+
+    def reorder_sub_categories(self, id: int, category_id: int, params: dict) -> Any:
+        """Updates the display order of sub-categories within a specific parent category
+
+        :param id: Knowledge Base ID
+        :param category_id: Knowledge Base Category ID
+        :param params: A dictionary containing 'ordered_ids' (a list of sub-category IDs) in the desired sequence
+        """
+        response = self._connection.session.patch(
+            self._connection.url
+            + f"knowledge_bases/{id}/categories/{category_id}/reorder_categories",
+            json=params,
+        )
+        return self._raise_or_return_json(response)
+
+    def reorder_root_categories(self, id: int, params: dict) -> Any:
+        """Updates the display order of all top-level categories on the knowledge base homepage
+
+        :param id: Knowledge Base ID
+        :param params: A dictionary containing 'ordered_ids' (a list of category IDs) in the desired sequence
+        """
+        response = self._connection.session.patch(
+            self._connection.url
+            + "knowledge_bases/%s/categories/reorder_root_categories" % id,
+            json=params,
+        )
+        return self._raise_or_return_json(response)
+
+    def all(self, page: int = 1, filters=None) -> Pagination:
+        """Disabled: Zammad does not support a flat list of all knowledge bases"""
+        raise UnusedResourceError(self.__class__.__name__, "all")
+
+    def search(self, search_string: str, page: int = 1, filters=None) -> Pagination:
+        """Disabled: Knowledge base search is not supported"""
+        raise UnusedResourceError(self.__class__.__name__, "search")
+
+    def find(self, id: int) -> Any:
+        """Disabled: Knowledge base find is not supported"""
+        raise UnusedResourceError(self.__class__.__name__, "find")
+
+    def create(self, params: Any) -> Any:
+        """Disabled: Creation of new knowledge base instances is typically handled via the init method"""
+        raise UnusedResourceError(self.__class__.__name__, "create")
+
+    def update(self, id: int, params: Any) -> Any:
+        """Disabled: Update of a knowledge base instances is typically handled via the manage method"""
+        raise UnusedResourceError(self.__class__.__name__, "update")
+
+    def destroy(self, id: int) -> Any:
+        """Disabled: Knowledge base destroy is not supported"""
+        raise UnusedResourceError(self.__class__.__name__, "destroy")
+
+
+class KnowledgeBasesAnswers(Resource):
+    path_attribute = "knowledge_bases"
+
+    def all(self, page: int = 1, filters=None) -> Pagination:
+        """Disabled: Zammad does not support a flat list of all answers"""
+        raise UnusedResourceError(self.__class__.__name__, "all")
+
+    def search(self, search_string: str, page: int = 1, filters=None) -> Pagination:
+        """Disabled: Answers search is not supported"""
+        raise UnusedResourceError(self.__class__.__name__, "search")
+
+    def find(self, id: int) -> Any:
+        """Disabled: Retrieving an answer requires both knowledge_base_id and answer_id"""
+        raise UnusedResourceError(self.__class__.__name__, "find")
+
+    def find_answer(
+        self,
+        knowledge_base_id: int,
+        answer_id: int,
+        include_content_id: Optional[int] = None,
+    ) -> Any:
+        """Retrieves a specific answer from a knowledge base, optionally including content details
+
+        :param knowledge_base_id: Knowledge Base ID
+        :param answer_id: Knowledge Base Answer ID
+        :param include_content_id: Optional ID to include specific translated content (localization) in the response
+        """
+        if include_content_id is None:
+            find_answer_url = (
+                self._connection.url
+                + "knowledge_bases/{}/answers/{}".format(
+                    knowledge_base_id,
+                    answer_id,
+                )
+            )
+        else:
+            find_answer_url = (
+                self._connection.url
+                + "knowledge_bases/%s/answers/%s?include_contents=%s"
+                % (knowledge_base_id, answer_id, include_content_id)
+            )
+
+        response = self._connection.session.get(find_answer_url)
+        return self._raise_or_return_json(response)
+
+    def create(self, params: dict) -> Any:
+        """Creates a new answer within a specified knowledge base
+
+        :param params: A dictionary containing all the required details for creating the new answer.
+                       The dictionary must include "knowledge_base_id" field representing the Knowledge Base ID
+        """
+        if not isinstance(params, dict):
+            raise InvalidTypeError("params", dict, type(params))
+
+        if "knowledge_base_id" not in params:
+            raise MissingParameterError(
+                "knowledge_base_id", context="create knowledge base answer"
+            )
+
+        knowledge_base_id = params.pop("knowledge_base_id")
+
+        response = self._connection.session.post(
+            self._connection.url + "knowledge_bases/%s/answers" % knowledge_base_id,
+            json=params,
+        )
+        return self._raise_or_return_json(response)
+
+    def update(self, id: int, params: dict) -> Any:
+        """Updates an existing answer using the knowledge base ID and the answer ID
+
+        :param id: Knowledge Base Answer ID
+        :param params: A dictionary containing all the required details for updating the answer.
+                       The dictionary must include "answer_id" field representing the Knowledge Base Answer ID
+        """
+        if not isinstance(params, dict):
+            raise InvalidTypeError("params", dict, type(params))
+
+        if "answer_id" not in params:
+            raise MissingParameterError(
+                "answer_id", context="update knowledge base answer"
+            )
+
+        answer_id = params.pop("answer_id")
+
+        response = self._connection.session.patch(
+            self._connection.url + f"knowledge_bases/{id}/answers/{answer_id}",
+            json=params,
+        )
+        return self._raise_or_return_json(response)
+
+    def destroy(self, id: int) -> Any:
+        """Disabled: Permanent deletion requires both knowledge_base_id and answer_id
+
+        :param id: Knowledge Base Answer ID
+        """
+        raise UnusedResourceError(self.__class__.__name__, "destroy")
+
+    def destroy_answer(self, knowledge_base_id: int, answer_id: int) -> Any:
+        """Permanently deletes an answer from the knowledge base
+
+        :param knowledge_base_id: Knowledge Base ID
+        :param answer_id: Knowledge Base Answer ID
+        """
+        response = self._connection.session.delete(
+            self._connection.url
+            + f"knowledge_bases/{knowledge_base_id}/answers/{answer_id}"
+        )
+        return self._raise_or_return_json(response)
+
+    def change_answer_visibility(
+        self,
+        knowledge_base_id: int,
+        answer_id: int,
+        answer_visibility: KnowledgeBaseAnswerPublicity,
+    ) -> Any:
+        """Updates the publication state (e.g., draft, public, internal) of a specific answer
+
+        :param knowledge_base_id: Knowledge Base ID
+        :param answer_id: Knowledge Base Answer ID
+        :param answer_visibility: The publication state of the answer (e.g., draft, internal, or public)
+        """
+        response = self._connection.session.post(
+            self._connection.url
+            + "knowledge_bases/%s/answers/%s/%s"
+            % (knowledge_base_id, answer_id, answer_visibility.value)
+        )
+        return self._raise_or_return_json(response)
+
+    def add_attachment(
+        self, knowledge_base_id: int, answer_id: int, attachment: Any
+    ) -> Any:
+        """Uploads a file as an attachment to an answer using multipart/form-data
+
+        :param knowledge_base_id: Knowledge Base ID
+        :param answer_id: Knowledge Base Answer ID
+        :param attachment: The file to be uploaded to the answer as an attachment
+        """
+        response = self._connection.session.post(
+            self._connection.url
+            + "knowledge_bases/%s/answers/%s/attachments"
+            % (knowledge_base_id, answer_id),
+            files={"file": attachment},
+        )
+        return self._raise_or_return_json(response)
+
+    def delete_attachment(
+        self, knowledge_base_id: int, answer_id: int, attachment_id: int
+    ) -> Any:
+        """Removes a specific attachment from an answer by its attachment ID
+
+        :param knowledge_base_id: Knowledge Base ID
+        :param answer_id: Knowledge Base Answer ID
+        :param attachment_id: Attachment ID
+        """
+        response = self._connection.session.delete(
+            self._connection.url
+            + "knowledge_bases/%s/answers/%s/attachments/%s"
+            % (knowledge_base_id, answer_id, attachment_id)
+        )
+        return self._raise_or_return_json(response)
+
+
+class KnowledgeBasesCategories(Resource):
+    path_attribute = "knowledge_bases"
+
+    def all(self, page: int = 1, filters=None) -> Pagination:
+        """Disabled: Zammad does not support a flat list of all knowledge base categories"""
+        raise UnusedResourceError(self.__class__.__name__, "all")
+
+    def search(self, search_string: str, page: int = 1, filters=None) -> Pagination:
+        """Disabled: Knowledge base categories search is not supported"""
+        raise UnusedResourceError(self.__class__.__name__, "search")
+
+    def find(self, id: int) -> Any:
+        """Disabled: Retrieving an answer requires both knowledge_base_id and category_id"""
+        raise UnusedResourceError(self.__class__.__name__, "find")
+
+    def find_category(self, knowledge_base_id: int, category_id: int) -> Any:
+        """Retrieves a specific category from a knowledge base
+
+        :param knowledge_base_id: Knowledge Base ID
+        :param category_id: Knowledge Base Category ID
+        """
+        response = self._connection.session.get(
+            self._connection.url
+            + f"knowledge_bases/{knowledge_base_id}/categories/{category_id}"
+        )
+        return self._raise_or_return_json(response)
+
+    def create(self, params: dict) -> Any:
+        """Creates a new category within a specified knowledge base
+
+        :param params: A dictionary containing all the required details for creating the new knowledge base category.
+                       The dictionary must include "knowledge_base_id" field representing the Knowledge Base ID
+        """
+        if not isinstance(params, dict):
+            raise InvalidTypeError("params", dict, type(params))
+
+        if "knowledge_base_id" not in params:
+            raise MissingParameterError(
+                "knowledge_base_id", context="create knowledge base category"
+            )
+
+        knowledge_base_id = params.pop("knowledge_base_id")
+
+        response = self._connection.session.post(
+            self._connection.url + "knowledge_bases/%s/categories" % knowledge_base_id,
+            json=params,
+        )
+        return self._raise_or_return_json(response)
+
+    def update(self, id: int, params: dict) -> Any:
+        """Updates an existing category using the knowledge base ID and the category ID
+
+        :param id: Knowledge Base ID
+        :param params: A dictionary containing all the required details for updating the knowledge base category.
+                       The dictionary must include "category_id" field representing the Knowledge Base Category ID
+        """
+        if not isinstance(params, dict):
+            raise InvalidTypeError("params", dict, type(params))
+
+        if "category_id" not in params:
+            raise MissingParameterError(
+                "category_id", context="update knowledge base category"
+            )
+
+        category_id = params.pop("category_id")
+
+        response = self._connection.session.patch(
+            self._connection.url + f"knowledge_bases/{id}/categories/{category_id}",
+            json=params,
+        )
+        return self._raise_or_return_json(response)
+
+    def destroy(self, id: int) -> Any:
+        """Disabled: Permanent deletion requires both knowledge_base_id and category_id
+
+        :param id: Knowledge Base Category ID
+        """
+        raise UnusedResourceError(self.__class__.__name__, "destroy")
+
+    def destroy_category(self, knowledge_base_id: int, category_id: int) -> Any:
+        """Permanently deletes a category from the knowledge base
+
+        :param knowledge_base_id: Knowledge Base ID
+        :param category_id: Knowledge Base Category ID
+        """
+        response = self._connection.session.delete(
+            self._connection.url
+            + f"knowledge_bases/{knowledge_base_id}/categories/{category_id}"
+        )
+        return self._raise_or_return_json(response)
+
+    def show_permissions(self, knowledge_base_id: int, category_id: int) -> Any:
+        """Returns a list of roles and their associated access levels (reader/editor) for the knowledge base category
+
+        :param knowledge_base_id: Knowledge Base ID
+        :param category_id: Knowledge Base Category ID
+        """
+        response = self._connection.session.get(
+            self._connection.url
+            + "knowledge_bases/%s/categories/%s/permissions"
+            % (knowledge_base_id, category_id),
+        )
+        return self._raise_or_return_json(response)
+
+    def change_permissions(
+        self, knowledge_base_id: int, category_id: int, permissions: dict
+    ) -> Any:
+        """Replaces the current permission set with a new mapping of roles and access levels
+
+        :param knowledge_base_id: Knowledge Base ID
+        :param category_id: Knowledge Base Category ID
+        :param permissions: Dictionary of new permissions to be applied to the knowledge base category
+        """
+        response = self._connection.session.put(
+            self._connection.url
+            + "knowledge_bases/%s/categories/%s/permissions"
+            % (knowledge_base_id, category_id),
+            json=permissions,
+        )
+        return self._raise_or_return_json(response)
+
+    def reorder_answers(
+        self, knowledge_base_id: int, category_id: int, params: dict
+    ) -> Any:
+        """Updates the display order of answers within a specific category
+
+        :param knowledge_base_id: Knowledge Base ID
+        :param category_id: Knowledge Base Category ID
+        :param params: A dictionary containing 'ordered_ids' (a list of answer IDs) in the desired sequence
+        """
+        response = self._connection.session.patch(
+            self._connection.url
+            + "knowledge_bases/%s/categories/%s/reorder_answers"
+            % (knowledge_base_id, category_id),
+            json=params,
+        )
+        return self._raise_or_return_json(response)

zammad_py/enums.py

@@ -0,0 +1,8 @@
+from enum import Enum
+
+
+class KnowledgeBaseAnswerPublicity(Enum):
+    INTERNALLY = "internal"
+    PUBLICLY = "publish"
+    ARCHIVE = "archive"
+    UNARCHIVE = "unarchive"

zammad_py/exceptions.py

@@ -1,2 +1,36 @@
 class ConfigException(Exception):
     pass
+
+
+class UnusedResourceError(NotImplementedError):
+    """Exception raised when a method is not supported by a specific Zammad resource."""
+
+    def __init__(self, resource_name, method_name):
+        self.message = f"The method '{method_name}' is not available for the {resource_name} resource."
+        super().__init__(self.message)
+
+
+class MissingParameterError(ValueError):
+    """Exception raised when a required field is missing from the parameters."""
+
+    def __init__(self, field_name, context=None):
+        self.field_name = field_name
+        self.context = context
+        message = f"Missing required parameter: '{field_name}'"
+        if context:
+            message += f" in {context}"
+        super().__init__(message)
+
+
+class InvalidTypeError(TypeError):
+    """Exception raised when a variable is not of the expected type."""
+
+    def __init__(self, variable_name, expected_type, actual_type):
+        self.variable_name = variable_name
+        self.expected_type = expected_type
+        self.actual_type = actual_type
+        message = (
+            f"Variable '{variable_name}' must be of type {expected_type.__name__}, "
+            f"but got {actual_type.__name__} instead."
+        )
+        super().__init__(message)

zammad_py-3.2.1.dist-info/AUTHORS.md

@@ -0,0 +1,9 @@
+# Credits
+
+## Development Lead
+
+* Joe Paul <joeirimpan@gmail.com>
+
+## Contributors
+
+* Matthew Frost <matthew@uptic.nl>

zammad_py-3.2.1.dist-info/METADATA

@@ -0,0 +1,182 @@
+Metadata-Version: 2.1
+Name: zammad_py
+Version: 3.2.1
+Summary: Python API client for zammad
+Home-page: https://github.com/joeirimpan/zammad_py
+License: MIT
+Author: Joe Paul
+Author-email: joeirimpan@gmail.com
+Requires-Python: >=3.9,<4.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: requests (>=2.25.1,<3.0.0)
+Project-URL: Documentation, https://zammad-py.readthedocs.io/
+Project-URL: Repository, https://github.com/joeirimpan/zammad_py.git
+Description-Content-Type: text/markdown
+
+# Zammad API Client
+
+[![PyPI version](https://img.shields.io/pypi/v/zammad_py.svg)](https://pypi.python.org/pypi/zammad_py)
+[![Documentation Status](https://readthedocs.org/projects/zammad-py/badge/?version=latest)](https://zammad-py.readthedocs.io/en/latest/?badge=latest)
+
+Python API client for zammad
+
+* Free software: MIT license
+* Documentation: https://zammad-py.readthedocs.io.
+
+## Quickstart
+
+```python
+from zammad_py import ZammadAPI
+
+# Initialize the client with the URL, username, and password
+# Note the Host URL should be in this format: 'https://zammad.example.org/api/v1/'
+client = ZammadAPI(url='<HOST>', username='<USERNAME>', password='<PASSWORD>')
+
+# Example: Access all users
+this_page = client.user.all()
+for user in this_page:
+    print(user)
+
+# Example: Get information about the current user
+print(client.user.me())
+
+# Example: Create a ticket
+params = {
+   "title": "Help me!",
+   "group": "2nd Level",
+   "customer": "david@example.com",
+   "article": {
+      "subject": "My subject",
+      "body": "I am a message!",
+      "type": "note",
+      "internal": False
+   }
+}
+new_ticket = client.ticket.create(params=params)
+```
+
+## General Methods
+
+Most resources support these methods:
+
+- `.all()`: Returns a paginated response with the current page number and a list of elements.
+- `.next_page()`: Returns the next page of the current pagination object.
+- `.prev_page()`: Returns the previous page of the current pagination object.
+- `.search(params)`: Returns a paginated response based on the search parameters.
+- `.find(id)`: Returns a single object with the specified ID.
+- `.create(params)`: Creates a new object with the specified parameters.
+- `.update(params)`: Updates an existing object with the specified parameters.
+- `.destroy(id)`: Deletes an object with the specified ID.
+
+## Available Resources
+
+| Resource | Property |
+|----------|----------|
+| User | `client.user` |
+| Organization | `client.organization` |
+| Group | `client.group` |
+| Role | `client.role` |
+| Ticket | `client.ticket` |
+| Link | `client.link` |
+| TicketArticle | `client.ticket_article` |
+| TicketArticleAttachment | `client.ticket_article_attachment` |
+| TicketArticlePlain | `client.ticket_article_plain` |
+| TicketPriority | `client.ticket_priority` |
+| TicketState | `client.ticket_state` |
+| TagList | `client.taglist` |
+| TicketTag | `client.ticket_tag` |
+| KnowledgeBases | `client.knowledge_bases` |
+| KnowledgeBasesAnswers | `client.knowledge_bases_answers` |
+| KnowledgeBasesCategories | `client.knowledge_bases_categories` |
+
+## Resource-Specific Methods
+
+### User
+- `.me()`: Returns information about the current user.
+
+### Ticket
+- `.articles(id)`: Returns all articles associated with a ticket.
+- `.tags(id)`: Returns all tags associated with a ticket.
+- `.merge(id, number)`: Merges two tickets (requires password auth).
+
+### Link
+- `.get(id)`: Returns all links associated with a ticket.
+- `.add(...)`: Creates a link between two objects.
+- `.remove(...)`: Removes a link between two objects.
+
+### TicketArticleAttachment
+- `.download(id, article_id, ticket_id)`: Downloads a ticket attachment.
+
+### TagList
+- `.all()`: Returns all tags (paginated).
+- `.create(params)`: Creates a new tag.
+- `.destroy(id)`: Deletes a tag.
+
+### TicketTag
+- `.add(id, tag)`: Adds a tag to a ticket.
+- `.remove(id, tag)`: Removes a tag from a ticket.
+
+### KnowledgeBases
+- `.init()`: Returns the entire knowledge base structure.
+- `.manage(id, settings)`: Updates knowledge base settings.
+- `.show_permissions(id)`: Returns permissions for a knowledge base.
+- `.change_permissions(id, permissions)`: Updates permissions.
+- `.reorder_sub_categories(id, category_id, params)`: Reorders sub-categories.
+- `.reorder_root_categories(id, params)`: Reorders root categories.
+
+### KnowledgeBasesAnswers
+- `.find_answer(knowledge_base_id, answer_id)`: Retrieves a specific answer.
+- `.create(params)`: Creates a new answer (requires `knowledge_base_id` in params).
+- `.update(id, params)`: Updates an answer (requires `answer_id` in params).
+- `.destroy_answer(knowledge_base_id, answer_id)`: Deletes an answer.
+- `.change_answer_visibility(knowledge_base_id, answer_id, visibility)`: Updates answer visibility.
+- `.add_attachment(knowledge_base_id, answer_id, attachment)`: Uploads an attachment.
+- `.delete_attachment(knowledge_base_id, answer_id, attachment_id)`: Removes an attachment.
+
+### KnowledgeBasesCategories
+- `.find_category(knowledge_base_id, category_id)`: Retrieves a specific category.
+- `.create(params)`: Creates a new category (requires `knowledge_base_id` in params).
+- `.update(id, params)`: Updates a category (requires `category_id` in params).
+- `.destroy_category(knowledge_base_id, category_id)`: Deletes a category.
+- `.show_permissions(knowledge_base_id, category_id)`: Returns category permissions.
+- `.change_permissions(knowledge_base_id, category_id, permissions)`: Updates permissions.
+- `.reorder_answers(knowledge_base_id, category_id, params)`: Reorders answers.
+
+## On Behalf Of
+
+You can set the `on_behalf_of` attribute to perform actions on behalf of another user:
+
+```python
+client.on_behalf_of = 'user@example.com'
+```
+
+Or use the context manager:
+
+```python
+with client.request_on_behalf_of('user@example.com'):
+    client.ticket.create(params=params)
+```
+
+## Contributing
+
+The Zammad API Client (zammad_py) welcomes contributions.
+
+You can contribute by reporting bugs, fixing bugs, implementing new features, writing documentation, and submitting feedback.
+
+To get started, see the contributing section in the docs!
+
+Please ensure that your changes include tests and updated documentation if necessary.
+
+## Credits
+
+This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the [audreyr/cookiecutter-pypackage](https://github.com/audreyr/cookiecutter-pypackage) project template.
+

zammad_py-3.2.1.dist-info/RECORD

@@ -0,0 +1,9 @@
+zammad_py/__init__.py,sha256=Xu6tdXhuBbsKnzvlTOw11Nx7VvNakukOWC6ViW-3_Wg,175
+zammad_py/api.py,sha256=JfaEMrLpo-F7DpT2hsK37QgK6pT_l8TNpzLHag50fMM,35323
+zammad_py/enums.py,sha256=9mSsJ_GV7aqpzk3awB6ZvFT3xzzTBHgWENiBR4ezh3I,171
+zammad_py/exceptions.py,sha256=-ABU-554T5MY2AI9KaVZm-iroiaXzakb3AIUa35Px9s,1285
+zammad_py-3.2.1.dist-info/AUTHORS.md,sha256=NRpF3uzp7H8H_DqYsNRdopQNCniINZs0Ya3oGPSUOfk,119
+zammad_py-3.2.1.dist-info/LICENSE,sha256=NNe9mRfWIQ3cigyQ1-cBQA5bRPuarc1iWRkfa72jSm0,1065
+zammad_py-3.2.1.dist-info/METADATA,sha256=Me3XXn1fjAYL46mJEiuSDDl_n5EBY-jrYKOIqDECTu4,6786
+zammad_py-3.2.1.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+zammad_py-3.2.1.dist-info/RECORD,,

{zammad_py-3.2.0.dist-info → zammad_py-3.2.1.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 1.8.1
+Generator: poetry-core 1.9.1
 Root-Is-Purelib: true
 Tag: py3-none-any

zammad_py-3.2.0.dist-info/METADATA

@@ -1,138 +0,0 @@
-Metadata-Version: 2.1
-Name: zammad_py
-Version: 3.2.0
-Summary: Python API client for zammad
-Home-page: https://github.com/joeirimpan/zammad_py
-License: MIT
-Author: Joe Paul
-Author-email: joeirimpan@gmail.com
-Requires-Python: >=3.9,<4.0
-Classifier: Development Status :: 4 - Beta
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Natural Language :: English
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: requests (>=2.25.1,<3.0.0)
-Project-URL: Documentation, https://zammad-py.readthedocs.io/
-Project-URL: Repository, https://github.com/joeirimpan/zammad_py.git
-Description-Content-Type: text/x-rst
-
-=================
-Zammad API Client
-=================
-
-
-.. image:: https://img.shields.io/pypi/v/zammad_py.svg
-        :target: https://pypi.python.org/pypi/zammad_py
-
-.. image:: https://img.shields.io/travis/joeirimpan/zammad_py.svg
-        :target: https://travis-ci.org/joeirimpan/zammad_py
-
-.. image:: https://readthedocs.org/projects/zammad-py/badge/?version=latest
-        :target: https://zammad-py.readthedocs.io/en/latest/?badge=latest
-        :alt: Documentation Status
-
-.. image:: https://pyup.io/repos/github/joeirimpan/zammad_py/shield.svg
-     :target: https://pyup.io/repos/github/joeirimpan/zammad_py/
-     :alt: Updates
-
-
-Python API client for zammad
-
-* Free software: MIT license
-* Documentation: https://zammad-py.readthedocs.io.
-
-
-Quickstart
-----------
-
-
-.. code-block:: python
-
-    from zammad_py import ZammadAPI
-
-    # Initialize the client with the URL, username, and password
-    # Note the Host URL should be in this format: 'https://zammad.example.org/api/v1/'
-    client = ZammadAPI(url='<HOST>', username='<USERNAME>', password='<PASSWORD>')
-
-    # Example: Access all users
-    this_page = client.user.all()
-    for user in this_page:
-        print(user)
-
-    # Example: Get information about the current user
-    print(client.user.me())
-
-    # Example: Create a ticket
-    params = {
-       "title": "Help me!",
-       "group": "2nd Level",
-       "customer": "david@example.com",
-       "article": {
-          "subject": "My subject",
-          "body": "I am a message!",
-          "type": "note",
-          "internal": false
-       }
-    }
-    new_ticket = client.ticket.create(params=params)
-
-
-
-General Methods
----------------
-Most resources support these methods:
-
-`.all()`: Returns a paginated response with the current page number and a list of elements.
-
-`.next_page()`: Returns the next page of the current pagination object.
-
-`.prev_page()`: Returns the previous page of the current pagination object.
-
-`.search(params)`: Returns a paginated response based on the search parameters.
-
-`.find(id)`: Returns a single object with the specified ID.
-
-`.create(params)`: Creates a new object with the specified parameters.
-
-`.update(params)`: Updates an existing object with the specified parameters.
-
-`.destroy(id)`: Deletes an object with the specified ID.
-
-Additional Resource Methods
----------------------------
-User resource also has the .me() method to get information about the current user.
-
-Ticket resource also has the .articles() method to get the articles associated with a ticket.
-
-Link resource has methods to list, add, and delete links between objects.
-
-TicketArticleAttachment resource has the .download() method to download a ticket attachment.
-
-Object resource has the .execute_migrations() method to run migrations on an object.
-
-You can set the `on_behalf_of` attribute of the ZammadAPI instance to do actions on behalf of another user.
-
-Contributing
-------------
-The Zammad API Client (zammad_py) welcomes contributions.
-
-You can contribute by reporting bugs, fixing bugs, implementing new features, writing documentation, and submitting feedback.
-
-To get started, see the contributing section in the docs!
-
-Please ensure that your changes include tests and updated documentation if necessary.
-
-Credits
--------
-
-This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
-
-.. _Cookiecutter: https://github.com/audreyr/cookiecutter
-.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
-
-

zammad_py-3.2.0.dist-info/RECORD

@@ -1,7 +0,0 @@
-zammad_py/__init__.py,sha256=DM_s56KwTdX5X4aLsh6nVqKRlMK2zOagjiCcXhx9IaY,175
-zammad_py/api.py,sha256=cNXvdFlQZRMIgx1agdvcVNak29S7fGEmbKwXFA9vYB0,17646
-zammad_py/exceptions.py,sha256=zKJqzIAKcY_2NvbNK-jijycfCkL4vr6qSCGK7bDROfw,43
-zammad_py-3.2.0.dist-info/LICENSE,sha256=NNe9mRfWIQ3cigyQ1-cBQA5bRPuarc1iWRkfa72jSm0,1065
-zammad_py-3.2.0.dist-info/METADATA,sha256=RWeGdLfsStnT9zeLMByJQvBAtXHDUeiGh6H-ItmvzE0,4395
-zammad_py-3.2.0.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
-zammad_py-3.2.0.dist-info/RECORD,,