CheckmarxPythonSDK 1.4.9__tar.gz → 1.5.1__tar.gz

{checkmarxpythonsdk-1.4.9 → checkmarxpythonsdk-1.5.1}/CheckmarxPythonSDK/CxOne/CodeRepositoryProjectImportAPI.py

@@ -75,15 +75,17 @@ class CodeRepositoryProjectImportAPI(object):
         params = {"process-id": process_id}
         response = self.api_client.get_request(relative_url=relative_url, params=params)
         item = response.json()
-        return {
-          "migrationStatus": item.get("migrationStatus"),
-          "summary": item.get("summary"),
-          "totalProjects": item.get("totalProjects"),
-          "migratedProjects": item.get("migratedProjects"),
-          "successfulProjectsList": item.get("successfulProjectsList"),
-          "failedProjectList": item.get("failedProjectList")
+
+        response_data = {
+          "currentPhase": item.get("currentPhase"),
+          "percentage": item.get("percentage"),
         }
 
+        if "result" in item:
+            response_data["result"] = item["result"]
+
+        return response_data
+
 
 def import_code_repository(scm_import_input: SCMImportInput) -> dict:
     return CodeRepositoryProjectImportAPI().import_code_repository(scm_import_input=scm_import_input)

{checkmarxpythonsdk-1.4.9 → checkmarxpythonsdk-1.5.1}/CheckmarxPythonSDK/CxOne/__init__.py

@@ -348,3 +348,9 @@ from .uploadsAPI import (
     create_a_pre_signed_url_to_upload_files,
     upload_zip_content_for_scanning,
 )
+from .versionsAPI import (
+    VersionsAPI
+)
+from .webhookAPI import (
+    WebHookAPI
+)

{checkmarxpythonsdk-1.4.9 → checkmarxpythonsdk-1.5.1}/CheckmarxPythonSDK/CxOne/dto/ProjectsCollection.py

@@ -15,6 +15,6 @@ def construct_projects_collection(item):
             total_count=item.get("totalCount"),
             filtered_total_count=item.get("filteredTotalCount"),
             projects=[
-                construct_project(project) for project in item.get("projects", [])
+                construct_project(project) for project in (item.get("projects") or [])
             ]
         )

checkmarxpythonsdk-1.5.1/CheckmarxPythonSDK/CxOne/dto/VersionsOut.py

@@ -0,0 +1,22 @@
+from dataclasses import dataclass
+
+
+@dataclass
+class VersionsOut:
+    """
+    Attributes:
+        sast (str): sast engine version
+        kics (str): IaC Security (KICS) engine version
+        cx_one (str): CxOne version
+    """
+    sast: str
+    kics: str
+    cx_one: str
+
+
+def construct_versions_out(item):
+    return VersionsOut(
+        sast=item.get("SAST"),
+        kics=item.get("KICS"),
+        cx_one=item.get("CxOne")
+    )

checkmarxpythonsdk-1.5.1/CheckmarxPythonSDK/CxOne/dto/WebHook.py

@@ -0,0 +1,40 @@
+from dataclasses import dataclass
+from typing import List
+from .WebHookEvent import WebHookEvent
+from .WebHookConfig import WebHookConfig, construct_web_hook_config
+
+
+@dataclass
+class WebHook:
+    """
+
+    Attributes:
+        id (str): A unique identifier for an webhook
+        name (str): A name for the webhook
+        active (bool): Indicates whether a webhook is active or not
+        enabled_events (List[WebHookEvent]): List of subscribed events
+        config (WebHookConfig): Webhook configuration
+        created_at (str):
+        updated_at (str):
+    """
+    id: str = None
+    name: str = None
+    active: bool = None
+    enabled_events: List[WebHookEvent] = None
+    config: WebHookConfig = None
+    created_at: str = None
+    updated_at: str = None
+
+
+def construct_web_hook(item):
+    return WebHook(
+        id=item.get("id"),
+        name=item.get("name"),
+        active=item.get("active"),
+        enabled_events=[
+            WebHookEvent(event) for event in item.get("enabledEvents")
+        ],
+        config=construct_web_hook_config(item.get("config")),
+        created_at=item.get("createdAt"),
+        updated_at=item.get("updatedAt")
+    )

checkmarxpythonsdk-1.5.1/CheckmarxPythonSDK/CxOne/dto/WebHookConfig.py

@@ -0,0 +1,33 @@
+from dataclasses import dataclass
+
+
+@dataclass
+class WebHookConfig:
+    """
+    Attributes:
+       content_type (str):  Webhooks payload content type
+       insecure_ssl (bool): Enable SSL verification
+       url (str): Payload URL
+       secret (str): Post request attached secret
+    """
+    content_type: str = None
+    insecure_ssl: bool = None
+    url: str = None
+    secret: str = None
+
+    def to_dict(self):
+        return {
+            "contentType": self.content_type,
+            "insecureSsl": self.insecure_ssl,
+            "url": self.url,
+            "secret": self.secret
+        }
+
+
+def construct_web_hook_config(item):
+    return WebHookConfig(
+        content_type=item.get("contentType"),
+        insecure_ssl=item.get("insecureSsl"),
+        url=item.get("url"),
+        secret=item.get("secret")
+    )

checkmarxpythonsdk-1.5.1/CheckmarxPythonSDK/CxOne/dto/WebHookEvent.py

@@ -0,0 +1,8 @@
+from enum import StrEnum
+
+
+class WebHookEvent(StrEnum):
+    SCAN_COMPLETED = "scan_completed_successfully"
+    SCAN_FAILED = "scan_failed"
+    SCAN_PARTIAL = "scan_partial"
+    PROJECT_CREATED = "project_created"

checkmarxpythonsdk-1.5.1/CheckmarxPythonSDK/CxOne/dto/WebHookInput.py

@@ -0,0 +1,27 @@
+from dataclasses import dataclass
+from typing import List
+from .WebHookEvent import WebHookEvent
+from .WebHookConfig import WebHookConfig, construct_web_hook_config
+
+
+@dataclass
+class WebHookInput:
+    """
+    Attributes:
+        name (str): A name for the webhook
+        active (bool): Indicates whether a webhook is active or not
+        enabled_events (List[WebHookEvent]): List of subscribed events. project_created only available for tenant level
+        config: (WebHookConfig): Webhook configuration
+    """
+    name: str = None
+    active: bool = None
+    enabled_events: List[WebHookEvent] = None
+    config: WebHookConfig = None
+
+    def to_dict(self):
+        return {
+            "name": self.name,
+            "active": self.active,
+            "enabledEvents": self.enabled_events,
+            "config": self.config.to_dict()
+        }

checkmarxpythonsdk-1.5.1/CheckmarxPythonSDK/CxOne/dto/WebHooksCollection.py

@@ -0,0 +1,18 @@
+from dataclasses import dataclass
+from typing import List
+from .WebHook import WebHook, construct_web_hook
+
+
+@dataclass
+class WebHooksCollection:
+    total_count: int = None
+    webhooks: List[WebHook] = None
+
+
+def construct_web_hooks_collection(item):
+    return WebHooksCollection(
+        total_count=item.get("totalCount"),
+        webhooks=[
+            construct_web_hook(webhook) for webhook in item.get("webhooks")
+        ]
+    )

{checkmarxpythonsdk-1.4.9 → checkmarxpythonsdk-1.5.1}/CheckmarxPythonSDK/CxOne/dto/__init__.py

@@ -177,5 +177,11 @@ from .Upload import Upload
 from .User import User, construct_user
 from .UsersWithResourcesResponse import UsersWithResourcesResponse, construct_users_with_resources_response
 from .UserWithResource import UserWithResource, construct_user_with_resource
+from .VersionsOut import VersionsOut, construct_versions_out
 from .WebError import WebError, construct_web_error
+from .WebHook import WebHook, construct_web_hook
+from .WebHookConfig import WebHookConfig, construct_web_hook_config
+from .WebHookEvent import WebHookEvent
+from .WebHookInput import WebHookInput
+from .WebHooksCollection import WebHooksCollection, construct_web_hooks_collection
 from .WorkspaceQuery import WorkspaceQuery

checkmarxpythonsdk-1.5.1/CheckmarxPythonSDK/CxOne/versionsAPI.py

@@ -0,0 +1,28 @@
+from CheckmarxPythonSDK.api_client import ApiClient
+from CheckmarxPythonSDK.CxOne.config import construct_configuration
+from CheckmarxPythonSDK.CxOne.dto import (
+    VersionsOut, construct_versions_out
+)
+from CheckmarxPythonSDK.utilities.compat import NO_CONTENT
+
+api_url = "/api/versions"
+
+
+class VersionsAPI(object):
+
+    def __init__(self, api_client: ApiClient = None):
+        if api_client is None:
+            configuration = construct_configuration()
+            api_client = ApiClient(configuration=configuration)
+        self.api_client = api_client
+
+    def get_versions_from_engines(self) -> VersionsOut:
+        """
+
+        Returns:
+            VersionsOut
+        """
+        relative_url = f"{api_url}"
+        response = self.api_client.get_request(relative_url=relative_url)
+        item = response.json()
+        return construct_versions_out(item)

checkmarxpythonsdk-1.5.1/CheckmarxPythonSDK/CxOne/webhookAPI.py

@@ -0,0 +1,123 @@
+from CheckmarxPythonSDK.api_client import ApiClient
+from CheckmarxPythonSDK.CxOne.config import construct_configuration
+from CheckmarxPythonSDK.CxOne.dto import (
+    WebHookInput,
+    WebHook, construct_web_hook,
+    WebHooksCollection, construct_web_hooks_collection
+)
+from CheckmarxPythonSDK.utilities.compat import NO_CONTENT
+
+api_url = "/api/webhooks"
+
+
+class WebHookAPI(object):
+
+    def __init__(self, api_client: ApiClient = None):
+        if api_client is None:
+            configuration = construct_configuration()
+            api_client = ApiClient(configuration=configuration)
+        self.api_client = api_client
+
+    def create_a_webhook_for_a_tenant(self, webhook_input: WebHookInput) -> WebHook:
+        """
+
+        Args:
+            webhook_input (WebHookInput):
+
+        Returns:
+            WebHook
+        """
+        relative_url = f"{api_url}/tenant"
+        response = self.api_client.post_request(relative_url=relative_url, json=webhook_input.to_dict())
+        item = response.json()
+        return construct_web_hook(item)
+
+    def get_a_list_of_webhooks_related_to_tenant(self, offset: int = 0, limit: int = 10) -> WebHooksCollection:
+        """
+
+        Returns:
+            WebHooksCollection
+        """
+        relative_url = f"{api_url}/tenant"
+        params = {"offset": offset, "limit": limit}
+        response = self.api_client.get_request(relative_url=relative_url, params=params)
+        item = response.json()
+        return construct_web_hooks_collection(item)
+
+    def create_a_webhook_on_project(self, project_id: str, webhook_input: WebHookInput) -> WebHook:
+        """
+
+        Args:
+            project_id (str):
+            webhook_input (WebHookInput):
+
+        Returns:
+            WebHook
+        """
+        relative_url = f"{api_url}/projects/{project_id}"
+        response = self.api_client.post_request(relative_url=relative_url, json=webhook_input.to_dict())
+        item = response.json()
+        return construct_web_hook(item)
+
+    def get_a_list_of_webhooks_related_to_project(
+            self, project_id: str, offset: int = 0, limit: int = 10
+    ) -> WebHooksCollection:
+        """
+
+        Args:
+            project_id (str):
+            offset (int):
+            limit (int):
+
+        Returns:
+          WebHooksCollection
+        """
+
+        relative_url = f"{api_url}/projects/{project_id}"
+        params = {"offset": offset, "limit": limit}
+        response = self.api_client.get_request(relative_url=relative_url, params=params)
+        item = response.json()
+        return construct_web_hooks_collection(item)
+
+    def get_webhook_by_id(self, webhook_id: str) -> WebHook:
+        """
+
+        Args:
+           webhook_id (str):
+
+        Returns:
+            WebHook
+        """
+        relative_url = f"{api_url}/{webhook_id}"
+        response = self.api_client.get_request(relative_url=relative_url)
+        item = response.json()
+        return construct_web_hook(item)
+
+    def update_webhook_by_id(self, webhook_id: str, webhook_input: WebHookInput) -> bool:
+        """
+
+        Args:
+            webhook_id (str):
+            webhook_input (WebHookInput):
+
+        Returns:
+            bool
+        """
+
+        relative_url = f"{api_url}/{webhook_id}"
+        response = self.api_client.patch_request(relative_url=relative_url, json=webhook_input.to_dict())
+        return response.status_code == NO_CONTENT
+
+    def delete_webhook_by_id(self, webhook_id: str) -> bool:
+        """
+
+        Args:
+            webhook_id (str):
+
+        Returns:
+            bool
+        """
+
+        relative_url = f"{api_url}/{webhook_id}"
+        response = self.api_client.delete_request(relative_url=relative_url)
+        return response.status_code == NO_CONTENT

checkmarxpythonsdk-1.5.1/CheckmarxPythonSDK/__version__.py

@@ -0,0 +1 @@
+__version__ = '1.5.1'

{checkmarxpythonsdk-1.4.9 → checkmarxpythonsdk-1.5.1}/CheckmarxPythonSDK.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: CheckmarxPythonSDK
-Version: 1.4.9
+Version: 1.5.1
 Summary: Checkmarx Python SDK
 Home-page: https://github.com/checkmarx-ts/checkmarx-python-sdk
 Author: Happy Yang

{checkmarxpythonsdk-1.4.9 → checkmarxpythonsdk-1.5.1}/CheckmarxPythonSDK.egg-info/SOURCES.txt

@@ -79,6 +79,8 @@ CheckmarxPythonSDK/CxOne/scannersResultsAPI.py
 CheckmarxPythonSDK/CxOne/scansAPI.py
 CheckmarxPythonSDK/CxOne/uploadsAPI.py
 CheckmarxPythonSDK/CxOne/utilities.py
+CheckmarxPythonSDK/CxOne/versionsAPI.py
+CheckmarxPythonSDK/CxOne/webhookAPI.py
 CheckmarxPythonSDK/CxOne/AccessControlAPI/__init__.py
 CheckmarxPythonSDK/CxOne/AccessControlAPI/api.py
 CheckmarxPythonSDK/CxOne/AccessControlAPI/dto/AstIdWithName.py
@@ -342,7 +344,13 @@ CheckmarxPythonSDK/CxOne/dto/Upload.py
 CheckmarxPythonSDK/CxOne/dto/User.py
 CheckmarxPythonSDK/CxOne/dto/UserWithResource.py
 CheckmarxPythonSDK/CxOne/dto/UsersWithResourcesResponse.py
+CheckmarxPythonSDK/CxOne/dto/VersionsOut.py
 CheckmarxPythonSDK/CxOne/dto/WebError.py
+CheckmarxPythonSDK/CxOne/dto/WebHook.py
+CheckmarxPythonSDK/CxOne/dto/WebHookConfig.py
+CheckmarxPythonSDK/CxOne/dto/WebHookEvent.py
+CheckmarxPythonSDK/CxOne/dto/WebHookInput.py
+CheckmarxPythonSDK/CxOne/dto/WebHooksCollection.py
 CheckmarxPythonSDK/CxOne/dto/WorkspaceQuery.py
 CheckmarxPythonSDK/CxOne/dto/__init__.py
 CheckmarxPythonSDK/CxPortalSoapApiSDK/CxAuditWebService.py

{checkmarxpythonsdk-1.4.9 → checkmarxpythonsdk-1.5.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: CheckmarxPythonSDK
-Version: 1.4.9
+Version: 1.5.1
 Summary: Checkmarx Python SDK
 Home-page: https://github.com/checkmarx-ts/checkmarx-python-sdk
 Author: Happy Yang

checkmarxpythonsdk-1.4.9/CheckmarxPythonSDK/__version__.py

@@ -1 +0,0 @@
-__version__ = '1.4.9'