clappia-api-tools 2.0.3__tar.gz → 2.0.7__tar.gz

{clappia_api_tools-2.0.3 → clappia_api_tools-2.0.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clappia-api-tools
-Version: 2.0.3
+Version: 2.0.7
 Summary: Python client for Clappia API integration
 Author-email: Rishabh Verma <rishabh.v@clappia.com>
 License: MIT

clappia_api_tools-2.0.7/clappia_api_tools/__init__.py

@@ -0,0 +1,35 @@
+"""
+Clappia Tools - LangChain integration for Clappia API
+
+This package provides a unified client for interacting with Clappia APIs.
+"""
+
+from .client.app_definition_client import AppDefinitionClient, AppDefinitionAPIKeyClient, AppDefinitionAuthTokenClient
+from .client.submission_client import SubmissionClient, SubmissionAPIKeyClient, SubmissionAuthTokenClient
+from .client.workflow_definition_client import WorkflowDefinitionClient, WorkflowDefinitionAPIKeyClient, WorkflowDefinitionAuthTokenClient
+from .client.analytics_client import AnalyticsClient, AnalyticsAPIKeyClient, AnalyticsAuthTokenClient
+from .client.workplace_client import WorkplaceClient, WorkplaceAPIKeyClient, WorkplaceAuthTokenClient
+from .client.base_client import BaseClappiaClient
+
+
+__version__ = "1.0.2"
+__all__ = [
+    "AppDefinitionClient",
+    "AppDefinitionAPIKeyClient",
+    "AppDefinitionAuthTokenClient",
+    "SubmissionClient",
+    "SubmissionAPIKeyClient",
+    "SubmissionAuthTokenClient",
+    "WorkflowDefinitionClient",
+    "WorkflowDefinitionAPIKeyClient",
+    "WorkflowDefinitionAuthTokenClient",
+    "AnalyticsClient",
+    "WorkplaceClient",
+    "WorkplaceAPIKeyClient",
+    "WorkplaceAuthTokenClient",
+    "BaseClappiaClient",
+]
+
+
+def __dir__():
+    return __all__

clappia_api_tools-2.0.7/clappia_api_tools/client/__init__.py

@@ -0,0 +1,27 @@
+from .base_client import BaseClappiaClient, BaseAPIKeyClient, BaseAuthTokenClient
+from .submission_client import SubmissionClient, SubmissionAPIKeyClient, SubmissionAuthTokenClient
+from .app_definition_client import AppDefinitionClient, AppDefinitionAPIKeyClient, AppDefinitionAuthTokenClient
+from .workflow_definition_client import WorkflowDefinitionClient, WorkflowDefinitionAPIKeyClient, WorkflowDefinitionAuthTokenClient
+from .analytics_client import AnalyticsClient, AnalyticsAPIKeyClient, AnalyticsAuthTokenClient
+from .workplace_client import WorkplaceClient, WorkplaceAPIKeyClient, WorkplaceAuthTokenClient
+
+__all__ = [
+    "BaseClappiaClient",
+    "BaseAPIKeyClient", 
+    "BaseAuthTokenClient",
+    "SubmissionClient",
+    "SubmissionAPIKeyClient",
+    "SubmissionAuthTokenClient",
+    "AppDefinitionClient",
+    "AppDefinitionAPIKeyClient",
+    "AppDefinitionAuthTokenClient",
+    "WorkflowDefinitionClient",
+    "WorkflowDefinitionAPIKeyClient",
+    "WorkflowDefinitionAuthTokenClient",
+    "AnalyticsClient",
+    "AnalyticsAPIKeyClient",
+    "AnalyticsAuthTokenClient",
+    "WorkplaceClient",
+    "WorkplaceAPIKeyClient",
+    "WorkplaceAuthTokenClient",
+]

{clappia_api_tools-2.0.3 → clappia_api_tools-2.0.7}/clappia_api_tools/client/analytics_client.py

@@ -1,5 +1,6 @@
+from abc import ABC
 from typing import Dict, Any, Optional
-from .base_client import BaseClappiaClient
+from .base_client import BaseClappiaClient, BaseAPIKeyClient, BaseAuthTokenClient
 from clappia_api_tools.utils.logging_utils import get_logger
 from clappia_api_tools.models.request import (
     UpsertSummaryChartDefinitionRequest,
@@ -34,8 +35,8 @@ ChartDefinitionResponseUnion = Union[
 logger = get_logger(__name__)
 
 
-class AnalyticsClient(BaseClappiaClient):
-    """Client for managing Clappia analytics and charts.
+class AnalyticsClient(BaseClappiaClient, ABC):
+    """Abstract client for managing Clappia analytics and charts.
 
     This client handles retrieving and managing analytics configurations, including
     adding charts, removing charts, updating charts, and reordering charts.
@@ -1162,3 +1163,49 @@ class AnalyticsClient(BaseClappiaClient):
             operation="get_charts",
             data=response_data,
         )
+
+
+class AnalyticsAPIKeyClient(BaseAPIKeyClient, AnalyticsClient):
+    """Client for managing Clappia analytics and charts with API key authentication.
+
+    This client combines API key authentication with all analytics business logic.
+    """
+
+    def __init__(
+        self,
+        api_key: str,
+        base_url: Optional[str] = None,
+        timeout: int = 30,
+    ):
+        """Initialize analytics client with API key.
+
+        Args:
+            api_key: Clappia API key.
+            base_url: API base URL.
+            timeout: Request timeout in seconds.
+        """
+        BaseAPIKeyClient.__init__(self, api_key, base_url, timeout)
+
+
+class AnalyticsAuthTokenClient(BaseAuthTokenClient, AnalyticsClient):
+    """Client for managing Clappia analytics and charts with auth token authentication.
+
+    This client combines auth token authentication with all analytics business logic.
+    """
+
+    def __init__(
+        self,
+        auth_token: str,
+        workplace_id: str,
+        base_url: Optional[str] = None,
+        timeout: int = 30,
+    ):
+        """Initialize analytics client with auth token.
+
+        Args:
+            auth_token: Clappia Auth token.
+            workplace_id: Clappia Workplace ID.
+            base_url: API base URL.
+            timeout: Request timeout in seconds.
+        """
+        BaseAuthTokenClient.__init__(self, auth_token, workplace_id, base_url, timeout)

{clappia_api_tools-2.0.3 → clappia_api_tools-2.0.7}/clappia_api_tools/client/app_definition_client.py

@@ -1,5 +1,6 @@
 import json
-from .base_client import BaseClappiaClient
+from abc import ABC
+from .base_client import BaseClappiaClient, BaseAPIKeyClient, BaseAuthTokenClient
 from clappia_api_tools.utils.logging_utils import get_logger
 from typing import List, Dict, Any, Optional, Union
 from clappia_api_tools.models.request import (
@@ -120,13 +121,17 @@ FieldRequestUnion = Union[
 logger = get_logger(__name__)
 
 
-class AppDefinitionClient(BaseClappiaClient):
-    """Client for managing Clappia app definitions.
+class AppDefinitionClient(BaseClappiaClient, ABC):
+    """Abstract client for managing Clappia app definitions.
 
     This client handles retrieving and managing app definitions, including
     getting app definitions, creating apps, adding fields, and updating fields.
+    
+    Note: This is an abstract base class that contains business logic but no authentication.
+    Use AppDefinitionAPIKeyClient or AppDefinitionAuthTokenClient for actual usage.
     """
 
+
     def create_app(self, request: CreateAppRequest) -> AppCreationResponse:
         """Create a new app."""
         env_valid, env_error = self.api_utils.validate_environment()
@@ -151,7 +156,7 @@ class AppDefinitionClient(BaseClappiaClient):
             success=True, message="Successfully created app", data=response_data
         )
 
-    def get_definition(self, app_id: str, extra_headers: Optional[Dict[str, str]] = None) -> AppDefinitionResponse:
+    def get_definition(self, app_id: str) -> AppDefinitionResponse:
         """Retrieve the complete definition for a specific app."""
         params = {"appId": app_id}
 
@@ -159,9 +164,8 @@ class AppDefinitionClient(BaseClappiaClient):
 
         success, error_message, response_data = self.api_utils.make_request(
             method="GET",
-            endpoint="/internal/getAppDefinition",
-            params=params,
-            extra_headers=extra_headers,
+            endpoint="/getAppDefinition",
+            params=params
         )
 
         if not success:
@@ -5800,4 +5804,49 @@ class AppDefinitionClient(BaseClappiaClient):
             operation="update_app_metadata",
             data=response_data,
         )
+
+class AppDefinitionAPIKeyClient(BaseAPIKeyClient, AppDefinitionClient):
+    """Client for managing Clappia app definitions with API key authentication.
+    This client combines API key authentication with all app definition business logic.
+    """
+
+    def __init__(
+        self,
+        api_key: str,
+        base_url: Optional[str] = None,
+        timeout: int = 30,
+    ):
+        """Initialize app definition client with API key.
+
+        Args:
+            api_key: Clappia API key.
+            base_url: API base URL.
+            timeout: Request timeout in seconds.
+        """
+        BaseAPIKeyClient.__init__(self, api_key, base_url, timeout)
+
+class AppDefinitionAuthTokenClient(BaseAuthTokenClient, AppDefinitionClient):
+    """Client for managing Clappia app definitions with auth token authentication.
+
+    This client combines auth token authentication with all app definition business logic.
+    """
+
+    def __init__(
+        self,
+        auth_token: str,
+        workplace_id: str,
+        base_url: Optional[str] = None,
+        timeout: int = 30,
+    ):
+        """Initialize app definition client with auth token.
+
+        Args:
+            auth_token: Clappia Auth token.
+            workplace_id: Clappia Workplace ID.
+            base_url: API base URL.
+            timeout: Request timeout in seconds.
+        """
+        BaseAuthTokenClient.__init__(self, auth_token, workplace_id, base_url, timeout)
+
+
     

clappia_api_tools-2.0.7/clappia_api_tools/client/base_client.py

@@ -0,0 +1,75 @@
+from abc import ABC
+from typing import Optional
+from clappia_api_tools.utils.api_utils import ClappiaAPIKeyUtils, ClappiaAuthTokenUtils
+
+
+class BaseClappiaClient(ABC):
+    """Base client with shared functionality for all Clappia clients.
+
+    This class provides the common initialization and shared utilities
+    that all specialized Clappia clients will inherit from.
+    """
+
+    def __init__(
+        self,
+        base_url: Optional[str] = None,
+        timeout: int = 30,
+    ):
+        """Initialize base Clappia client.
+        Args:
+            base_url: API base URL.
+            timeout: Request timeout in seconds.
+        """
+        self.base_url = base_url
+        self.timeout = timeout
+
+class BaseAPIKeyClient(BaseClappiaClient):
+    """Base client for API key authentication.
+
+    This class provides the common initialization and shared utilities
+    for clients that use API key authentication.
+    """
+
+    def __init__(
+        self,
+        api_key: Optional[str] = None,
+        base_url: Optional[str] = None,
+        timeout: int = 30,
+    ):
+        """Initialize base API key client.
+
+        Args:
+            api_key: Clappia API key.
+            base_url: API base URL.
+            timeout: Request timeout in seconds.
+        """
+        super().__init__(base_url, timeout)
+        self.api_utils = ClappiaAPIKeyUtils(api_key, base_url, timeout)
+
+
+class BaseAuthTokenClient(BaseClappiaClient):
+    """Base client for auth token authentication.
+
+    This class provides the common initialization and shared utilities
+    for clients that use auth token and workplace ID authentication.
+    """
+
+    def __init__(
+        self,
+        auth_token: Optional[str] = None,
+        workplace_id: Optional[str] = None,
+        base_url: Optional[str] = None,
+        timeout: int = 30,
+    ):
+        """Initialize base auth token client.
+
+        Args:
+            auth_token: Clappia Auth token.
+            workplace_id: Clappia Workplace ID.
+            base_url: API base URL.
+            timeout: Request timeout in seconds.
+        """
+        super().__init__(base_url, timeout)
+        self.api_utils = ClappiaAuthTokenUtils(auth_token, workplace_id, base_url, timeout)
+
+

{clappia_api_tools-2.0.3 → clappia_api_tools-2.0.7}/clappia_api_tools/client/submission_client.py

@@ -1,5 +1,6 @@
+from abc import ABC
 from typing import Dict, Any, List, Optional
-from .base_client import BaseClappiaClient
+from .base_client import BaseClappiaClient, BaseAPIKeyClient, BaseAuthTokenClient
 from clappia_api_tools.utils.logging_utils import get_logger
 from clappia_api_tools.models.request import (
     GetSubmissionsRequest,
@@ -27,7 +28,7 @@ from clappia_api_tools.models.response import (
 logger = get_logger(__name__)
 
 
-class SubmissionClient(BaseClappiaClient):
+class SubmissionClient(BaseClappiaClient, ABC):
     """Client for managing Clappia submissions.
 
     This client handles retrieving and managing submissions, including
@@ -35,6 +36,7 @@ class SubmissionClient(BaseClappiaClient):
     editing submissions, updating submission status, updating submission owners.
     """
 
+
     def get_submissions(
         self,
         app_id: str,
@@ -43,6 +45,7 @@ class SubmissionClient(BaseClappiaClient):
         forward: bool = True,
         filters: Optional[SubmissionFilters] = None,
         last_submission_id: Optional[str] = None,
+        requesting_user_email_address: Optional[str] = None,
     ) -> SubmissionsResponse:
         try:
             request = GetSubmissionsRequest(
@@ -52,6 +55,7 @@ class SubmissionClient(BaseClappiaClient):
                 filters=filters,
                 last_submission_id=last_submission_id,
                 fields=fields,
+                requesting_user_email_address=requesting_user_email_address,
             )
         except Exception as e:
             return SubmissionsResponse(success=False, message=str(e), app_id=app_id)
@@ -61,9 +65,11 @@ class SubmissionClient(BaseClappiaClient):
             return SubmissionsResponse(success=False, message=env_error, app_id=app_id)
 
         payload = {
+            "workplaceId": self.workplace_id,
             "appId": request.app_id,
             "pageSize": request.page_size,
             "forward": request.forward,
+            "requestingUserEmailAddress": request.requesting_user_email_address,
         }
 
         if request.filters:
@@ -104,6 +110,7 @@ class SubmissionClient(BaseClappiaClient):
         forward: bool = True,
         page_size: int = 1000,
         filters: Optional[SubmissionFilters] = None,
+        requesting_user_email_address: Optional[str] = None,
     ) -> SubmissionsAggregationResponse:
         try:
             request = GetSubmissionsAggregationRequest(
@@ -114,6 +121,7 @@ class SubmissionClient(BaseClappiaClient):
                 forward=forward,
                 page_size=page_size,
                 filters=filters,
+                requesting_user_email_address=requesting_user_email_address,
             )
         except Exception as e:
             return SubmissionsAggregationResponse(
@@ -134,10 +142,12 @@ class SubmissionClient(BaseClappiaClient):
             )
 
         payload = {
+            "workplaceId": self.workplace_id,
             "appId": request.app_id,
             "forward": request.forward,
             "pageSize": request.page_size,
             "xAxisLabels": request.x_axis_labels or [],
+            "requestingUserEmailAddress": request.requesting_user_email_address,
         }
 
         if request.dimensions:
@@ -176,11 +186,13 @@ class SubmissionClient(BaseClappiaClient):
         self,
         app_id: str,
         data: Dict[str, Any],
+        requesting_user_email_address: Optional[str] = None,
     ) -> SubmissionResponse:
         try:
             request = CreateSubmissionRequest(
                 app_id=app_id,
                 data=data,
+                requesting_user_email_address=requesting_user_email_address,
             )
         except Exception as e:
             return SubmissionResponse(
@@ -208,8 +220,10 @@ class SubmissionClient(BaseClappiaClient):
             )
 
         payload = {
+            "workplaceId": self.workplace_id,
             "appId": request.app_id,
             "data": request.data,
+            "requestingUserEmailAddress": request.requesting_user_email_address,
         }
 
         logger.info(f"Creating submission for app_id: {app_id} with data: {data}")
@@ -243,12 +257,14 @@ class SubmissionClient(BaseClappiaClient):
         app_id: str,
         submission_id: str,
         data: Dict[str, Any],
+        requesting_user_email_address: Optional[str] = None,
     ) -> SubmissionResponse:
         try:
             request = EditSubmissionRequest(
                 app_id=app_id,
                 submission_id=submission_id,
                 data=data,
+                requesting_user_email_address=requesting_user_email_address,
             )
         except Exception as e:
             return SubmissionResponse(
@@ -279,9 +295,11 @@ class SubmissionClient(BaseClappiaClient):
             )
 
         payload = {
+            "workplaceId": self.workplace_id,
             "appId": request.app_id,
             "submissionId": request.submission_id,
             "data": request.data,
+            "requestingUserEmailAddress": request.requesting_user_email_address,
         }
 
         logger.info(
@@ -317,6 +335,7 @@ class SubmissionClient(BaseClappiaClient):
         submission_id: str,
         status_name: str,
         comments: Optional[str] = None,
+        requesting_user_email_address: Optional[str] = None,
     ) -> SubmissionResponse:
         try:
             request = UpdateSubmissionStatusRequest(
@@ -324,6 +343,7 @@ class SubmissionClient(BaseClappiaClient):
                 submission_id=submission_id,
                 status_name=status_name,
                 comments=comments,
+                requesting_user_email_address=requesting_user_email_address,
             )
         except Exception as e:
             return SubmissionResponse(
@@ -350,9 +370,11 @@ class SubmissionClient(BaseClappiaClient):
         }
 
         payload = {
+            "workplaceId": self.workplace_id,
             "appId": request.app_id,
             "submissionId": request.submission_id,
             "status": status,
+            "requestingUserEmailAddress": request.requesting_user_email_address,
         }
 
         logger.info(f"Updating status for submission {submission_id} to {status_name}")
@@ -386,6 +408,7 @@ class SubmissionClient(BaseClappiaClient):
         submission_id: str,
         email_ids: List[str],
         phone_numbers: Optional[List[str]] = None,
+        requesting_user_email_address: Optional[str] = None,
     ) -> SubmissionResponse:
         try:
             request = UpdateSubmissionOwnersRequest(
@@ -393,6 +416,7 @@ class SubmissionClient(BaseClappiaClient):
                 submission_id=submission_id,
                 email_ids=email_ids,
                 phone_numbers=phone_numbers,
+                requesting_user_email_address=requesting_user_email_address,
             )
         except Exception as e:
             return SubmissionResponse(
@@ -414,9 +438,11 @@ class SubmissionClient(BaseClappiaClient):
             )
 
         payload = {
+            "workplaceId": self.workplace_id,
             "appId": request.app_id,
             "submissionId": request.submission_id,
             "emailIds": [str(email) for email in request.email_ids],
+            "requestingUserEmailAddress": request.requesting_user_email_address,
         }
 
         logger.info(f"Updating owners for submission {submission_id}")
@@ -472,6 +498,7 @@ class SubmissionClient(BaseClappiaClient):
             )
 
         payload = {
+            "workplaceId": self.workplace_id,
             "appId": request.app_id,
             "requestingUserEmailAddress": str(request.requesting_user_email_address),
             "format": request.format,
@@ -518,11 +545,13 @@ class SubmissionClient(BaseClappiaClient):
         self,
         app_id: str,
         filters: Optional[SubmissionFilters] = None,
+        requesting_user_email_address: Optional[str] = None,
     ) -> SubmissionsCountResponse:
         try:
             request = GetSubmissionsCountRequest(
                 app_id=app_id,
                 filters=filters,
+                requesting_user_email_address=requesting_user_email_address,
             )
         except Exception as e:
             return SubmissionsCountResponse(
@@ -536,7 +565,9 @@ class SubmissionClient(BaseClappiaClient):
             )
 
         payload = {
+            "workplaceId": self.workplace_id,
             "appId": request.app_id,
+            "requestingUserEmailAddress": request.requesting_user_email_address,
         }
 
         if request.filters:
@@ -561,3 +592,53 @@ class SubmissionClient(BaseClappiaClient):
             total_count=response_data.get("totalCount"),
             filtered_count=response_data.get("filteredCount"),
         )
+
+
+class SubmissionAPIKeyClient(BaseAPIKeyClient, SubmissionClient):
+    """Client for managing Clappia submissions with API key authentication.
+
+    This client combines API key authentication with all submission business logic.
+    """
+
+    def __init__(
+        self,
+        api_key: str,
+        workplace_id: str,
+        base_url: Optional[str] = None,
+        timeout: int = 30,
+    ):
+        """Initialize submission client with API key.
+
+        Args:
+            api_key: Clappia API key.
+            workplace_id: Clappia Workplace ID #TODO: remove this parameter once ClappiaExternalService/v4 is live in all stages
+            base_url: API base URL.
+            timeout: Request timeout in seconds.
+        """
+        BaseAPIKeyClient.__init__(self, api_key, base_url, timeout)
+        self.workplace_id = workplace_id
+
+
+class SubmissionAuthTokenClient(BaseAuthTokenClient, SubmissionClient):
+    """Client for managing Clappia submissions with auth token authentication.
+
+    This client combines auth token authentication with all submission business logic.
+    """
+
+    def __init__(
+        self,
+        auth_token: str,
+        workplace_id: str,
+        base_url: Optional[str] = None,
+        timeout: int = 30,
+    ):
+        """Initialize submission client with auth token.
+
+        Args:
+            auth_token: Clappia Auth token.
+            workplace_id: Clappia Workplace ID.
+            base_url: API base URL.
+            timeout: Request timeout in seconds.
+        """
+        BaseAuthTokenClient.__init__(self, auth_token, workplace_id, base_url, timeout)
+        self.workplace_id = workplace_id

{clappia_api_tools-2.0.3 → clappia_api_tools-2.0.7}/clappia_api_tools/client/workflow_definition_client.py

@@ -1,5 +1,6 @@
+from abc import ABC
 from typing import Optional, Union
-from .base_client import BaseClappiaClient
+from .base_client import BaseClappiaClient, BaseAPIKeyClient, BaseAuthTokenClient
 from clappia_api_tools.utils.logging_utils import get_logger
 
 from clappia_api_tools.models.request import (
@@ -50,14 +51,18 @@ WorkflowStepRequestUnion = Union[
 logger = get_logger(__name__)
 
 
-class WorkflowDefinitionClient(BaseClappiaClient):
-    """Client for managing Clappia workflow definitions.
+class WorkflowDefinitionClient(BaseClappiaClient, ABC):
+    """Abstract client for managing Clappia workflow definitions.
 
     This client handles retrieving and managing workflow definitions, including
     getting workflows, adding workflow steps, removing workflow steps,
     updating workflow steps, and reordering workflow steps.
+    
+    Note: This is an abstract base class that contains business logic but no authentication.
+    Use WorkflowDefinitionAPIKeyClient or WorkflowDefinitionAuthTokenClient for actual usage.
     """
 
+
     def get_workflow(self, app_id: str, trigger_type: str) -> WorkflowResponse:
         """Get a workflow definition for a specific app and trigger type"""
 
@@ -2612,3 +2617,48 @@ class WorkflowDefinitionClient(BaseClappiaClient):
             step_variable_name=step_variable_name,
             data=response_data,
         )
+
+class WorkflowDefinitionAPIKeyClient(BaseAPIKeyClient, WorkflowDefinitionClient):
+    """Client for managing Clappia workflow definitions with API key authentication.
+
+    This client combines API key authentication with all workflow definition business logic.
+    """
+
+    def __init__(
+        self,
+        api_key: str,
+        base_url: Optional[str] = None,
+        timeout: int = 30,
+    ):
+        """Initialize workflow definition client with API key.
+
+        Args:
+            api_key: Clappia API key.
+            base_url: API base URL.
+            timeout: Request timeout in seconds.
+        """
+        BaseAPIKeyClient.__init__(self, api_key, base_url, timeout)
+
+
+class WorkflowDefinitionAuthTokenClient(BaseAuthTokenClient, WorkflowDefinitionClient):
+    """Client for managing Clappia workflow definitions with auth token authentication.
+
+    This client combines auth token authentication with all workflow definition business logic.
+    """
+
+    def __init__(
+        self,
+        auth_token: str,
+        workplace_id: str,
+        base_url: Optional[str] = None,
+        timeout: int = 30,
+    ):
+        """Initialize workflow definition client with auth token.
+
+        Args:
+            auth_token: Clappia Auth token.
+            workplace_id: Clappia Workplace ID.
+            base_url: API base URL.
+            timeout: Request timeout in seconds.
+        """
+        BaseAuthTokenClient.__init__(self, auth_token, workplace_id, base_url, timeout)

{clappia_api_tools-2.0.3 → clappia_api_tools-2.0.7}/clappia_api_tools/client/workplace_client.py

@@ -1,5 +1,6 @@
+from abc import ABC
 from typing import Dict, Any, List, Optional
-from .base_client import BaseClappiaClient
+from .base_client import BaseClappiaClient, BaseAPIKeyClient, BaseAuthTokenClient
 from clappia_api_tools.utils.logging_utils import get_logger
 from clappia_api_tools.models.request import (
     AddUserToWorkplaceRequest,
@@ -29,7 +30,7 @@ from clappia_api_tools.models.permissions import Permission
 logger = get_logger(__name__)
 
 
-class WorkplaceClient(BaseClappiaClient):
+class WorkplaceClient(BaseClappiaClient, ABC):
     """Client for managing Clappia workplace users.
 
     This client handles workplace user management operations including
@@ -752,3 +753,49 @@ class WorkplaceClient(BaseClappiaClient):
             operation="get_workplace_users",
             data=response_data,
         )
+
+
+class WorkplaceAPIKeyClient(BaseAPIKeyClient, WorkplaceClient):
+    """Client for managing Clappia workplace users with API key authentication.
+
+    This client combines API key authentication with all workplace business logic.
+    """
+
+    def __init__(
+        self,
+        api_key: str,
+        base_url: Optional[str] = None,
+        timeout: int = 30,
+    ):
+        """Initialize workplace client with API key.
+
+        Args:
+            api_key: Clappia API key.
+            base_url: API base URL.
+            timeout: Request timeout in seconds.
+        """
+        BaseAPIKeyClient.__init__(self, api_key, base_url, timeout)
+
+
+class WorkplaceAuthTokenClient(BaseAuthTokenClient, WorkplaceClient):
+    """Client for managing Clappia workplace users with auth token authentication.
+
+    This client combines auth token authentication with all workplace business logic.
+    """
+
+    def __init__(
+        self,
+        auth_token: str,
+        workplace_id: str,
+        base_url: Optional[str] = None,
+        timeout: int = 30,
+    ):
+        """Initialize workplace client with auth token.
+
+        Args:
+            auth_token: Clappia Auth token.
+            workplace_id: Clappia Workplace ID.
+            base_url: API base URL.
+            timeout: Request timeout in seconds.
+        """
+        BaseAuthTokenClient.__init__(self, auth_token, workplace_id, base_url, timeout)

{clappia_api_tools-2.0.3 → clappia_api_tools-2.0.7}/clappia_api_tools/models/request/submission_requests.py

@@ -11,6 +11,11 @@ from ..submission import (
 
 class BaseSubmissionRequest(BaseModel):
     app_id: str = Field(description="App Id")
+    # TODO: Remove this field once ClappiaExternalService/v4 is live in all stages
+    requesting_user_email_address: Optional[EmailStr] = Field(
+        None, description="Email of requesting user"
+    )
+
 
     @field_validator("app_id")
     def validate_app_id(cls, v: str) -> str:

clappia_api_tools-2.0.7/clappia_api_tools/utils/__init__.py

@@ -0,0 +1,4 @@
+from .logging_utils import get_logger, set_level
+from .api_utils import ClappiaAPIKeyUtils, ClappiaAuthTokenUtils
+
+__all__ = ["get_logger", "set_level", "ClappiaAPIKeyUtils", "ClappiaAuthTokenUtils"]

{clappia_api_tools-2.0.3 → clappia_api_tools-2.0.7}/clappia_api_tools/utils/api_utils.py

@@ -1,18 +1,18 @@
 import os
 import json
 import requests
+from abc import ABC, abstractmethod
 from typing import Optional, Dict, Any, Tuple
 from clappia_api_tools.utils.logging_utils import get_logger
 
 logger = get_logger(__name__)
 
 
-class ClappiaAPIUtils:
-    """Utilities for Clappia API interactions"""
+class ClappiaAPIUtils(ABC):
+    """Abstract base API utilities with common functionality for all Clappia API interactions"""
 
     def __init__(
         self,
-        api_key: str,
         base_url: str,
         timeout: int = 30,
     ):
@@ -20,21 +20,14 @@ class ClappiaAPIUtils:
         Initialize API utilities with configurable parameters
 
         Args:
-            api_key: Clappia API key
             base_url: API base URL
             timeout: Request timeout in seconds
         """
-        self.api_key = api_key
         self.base_url = base_url
         self.timeout = timeout
 
     def validate_environment(self) -> Tuple[bool, str]:
         """Validate that required configuration is available"""
-        if not self.api_key:
-            return (
-                False,
-                "API key is not configured",
-            )
         if not self.base_url:
             return (
                 False,
@@ -42,11 +35,9 @@ class ClappiaAPIUtils:
             )
         return True, ""
 
-    def get_headers(self) -> Dict[str, str]:
+    def get_headers(self, data: Optional[Dict[str, Any]] = None) -> Dict[str, str]:
         """Get standard headers for API requests"""
         return {
-            "x-api-key": self.api_key,
-            "Authorization": self.api_key,
             "Content-Type": "application/json"
         }
 
@@ -85,8 +76,7 @@ class ClappiaAPIUtils:
         method: str,
         endpoint: str,
         data: Optional[Dict[str, Any]] = None,
-        params: Optional[Dict[str, Any]] = None,
-        extra_headers: Optional[Dict[str, Any]] = None,
+        params: Optional[Dict[str, Any]] = None
     ) -> Tuple[bool, Optional[str], Optional[Dict[str, Any]]]:
         """
         Make HTTP request to Clappia API
@@ -105,12 +95,10 @@ class ClappiaAPIUtils:
             return False, f"Configuration error: {env_error}", None
 
         url = f"{self.base_url.rstrip('/')}/{endpoint.lstrip('/')}"
-        headers = self.get_headers()
-        if extra_headers:
-            headers.update(extra_headers)
+        headers = self.get_headers(data)
 
         try:
-            logger.info(f"Making {method} request to {url}")
+            logger.info(f"Making {method} request to {url}, headers: {headers}, data: {data}, params: {params}")
             if data:
                 logger.debug(f"Request data: {json.dumps(data, indent=2)}")
 
@@ -134,3 +122,92 @@ class ClappiaAPIUtils:
             return False, "Connection error - unable to reach Clappia API", None
         except Exception as e:
             return False, f"Unexpected error: {str(e)}", None
+
+class ClappiaAPIKeyUtils(ClappiaAPIUtils):
+    """API utilities for Clappia API key authentication"""
+
+    def __init__(
+        self,
+        api_key: str,
+        base_url: str,
+        timeout: int = 30,
+    ):
+        """
+        Initialize API utilities with configurable parameters
+
+        Args:
+            api_key: Clappia API key
+            base_url: API base URL
+            timeout: Request timeout in seconds
+        """
+        super().__init__(base_url, timeout)
+        self.api_key = api_key
+
+    def validate_environment(self) -> Tuple[bool, str]:
+        """Validate that required configuration is available"""
+        if not self.api_key:
+            return (
+                False,
+                "API key is not configured",
+            )
+        return super().validate_environment()
+
+    def get_headers(self, data: Optional[Dict[str, Any]] = None) -> Dict[str, str]:
+        """Get standard headers for API requests"""
+        headers = super().get_headers(data)
+        headers["x-api-key"] = self.api_key
+        return headers
+
+
+class ClappiaAuthTokenUtils(ClappiaAPIUtils):
+    """API utilities for Clappia auth token authentication with workplace ID support"""
+
+    def __init__(
+        self,
+        auth_token: str,
+        workplace_id: str,
+        base_url: str,
+        timeout: int = 30,
+    ):
+        """
+        Initialize API utilities with auth token and workplace ID
+
+        Args:
+            auth_token: Clappia Auth token
+            workplace_id: Clappia Workplace ID
+            base_url: API base URL
+            timeout: Request timeout in seconds
+        """
+        super().__init__(base_url, timeout)
+        self.auth_token = auth_token
+        self.workplace_id = workplace_id
+
+    def validate_environment(self) -> Tuple[bool, str]:
+        """Validate that required configuration is available"""
+        if not self.auth_token:
+            return (
+                False,
+                "Auth token is not configured",
+            )
+        if not self.workplace_id:
+            return (
+                False,
+                "Workplace ID is not configured",
+            )
+        return super().validate_environment()
+
+    def get_headers(self, data: Optional[Dict[str, Any]] = None) -> Dict[str, str]:
+        """Get standard headers for API requests with auth token and optional app_id"""
+        headers = super().get_headers(data)
+        headers["Authorization"] = self.auth_token
+        headers["workplaceId"] = self.workplace_id
+        
+        # Add appId header if present in request data or params
+        if params and "appId" in params:
+            headers["appId"] = params["appId"]
+        elif data and "appId" in data:
+            headers["appId"] = data["appId"]
+            
+        return headers
+
+

{clappia_api_tools-2.0.3 → clappia_api_tools-2.0.7}/clappia_api_tools.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clappia-api-tools
-Version: 2.0.3
+Version: 2.0.7
 Summary: Python client for Clappia API integration
 Author-email: Rishabh Verma <rishabh.v@clappia.com>
 License: MIT

{clappia_api_tools-2.0.3 → clappia_api_tools-2.0.7}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "clappia-api-tools"
-version = "2.0.3"
+version = "2.0.7"
 description = "Python client for Clappia API integration"
 readme = "README.md"
 requires-python = ">=3.10"

clappia_api_tools-2.0.3/clappia_api_tools/__init__.py

@@ -1,27 +0,0 @@
-"""
-Clappia Tools - LangChain integration for Clappia API
-
-This package provides a unified client for interacting with Clappia APIs.
-"""
-
-from .client.app_definition_client import AppDefinitionClient
-from .client.submission_client import SubmissionClient
-from .client.workflow_definition_client import WorkflowDefinitionClient
-from .client.analytics_client import AnalyticsClient
-from .client.workplace_client import WorkplaceClient
-from .client.base_client import BaseClappiaClient
-
-
-__version__ = "1.0.2"
-__all__ = [
-    "AppDefinitionClient",
-    "SubmissionClient",
-    "WorkflowDefinitionClient",
-    "AnalyticsClient",
-    "WorkplaceClient",
-    "BaseClappiaClient",
-]
-
-
-def __dir__():
-    return __all__

clappia_api_tools-2.0.3/clappia_api_tools/client/__init__.py

@@ -1,11 +0,0 @@
-from .base_client import BaseClappiaClient
-from .submission_client import SubmissionClient
-from .app_definition_client import AppDefinitionClient
-from .workplace_client import WorkplaceClient
-
-__all__ = [
-    "BaseClappiaClient",
-    "SubmissionClient",
-    "AppDefinitionClient",
-    "WorkplaceClient",
-]

clappia_api_tools-2.0.3/clappia_api_tools/client/base_client.py

@@ -1,25 +0,0 @@
-from typing import Optional
-from clappia_api_tools.utils.api_utils import ClappiaAPIUtils
-
-
-class BaseClappiaClient:
-    """Base client with shared functionality for all Clappia clients.
-
-    This class provides the common initialization and shared utilities
-    that all specialized Clappia clients will inherit from.
-    """
-
-    def __init__(
-        self,
-        api_key: Optional[str] = None,
-        base_url: Optional[str] = None,
-        timeout: int = 30,
-    ):
-        """Initialize base Clappia client.
-
-        Args:
-            api_key: Clappia API key.
-            base_url: API base URL.
-            timeout: Request timeout in seconds.
-        """
-        self.api_utils = ClappiaAPIUtils(api_key, base_url, timeout)

clappia_api_tools-2.0.3/clappia_api_tools/utils/__init__.py

@@ -1,4 +0,0 @@
-from .logging_utils import get_logger, set_level
-from .api_utils import ClappiaAPIUtils
-
-__all__ = ["get_logger", "set_level", "ClappiaAPIUtils"]