CheckmarxPythonSDK 1.1.7__tar.gz → 1.1.8__tar.gz

{checkmarxpythonsdk-1.1.7 → checkmarxpythonsdk-1.1.8}/CheckmarxPythonSDK/CxOne/__init__.py

@@ -199,6 +199,7 @@ from .scansAPI import (
     cancel_scan,
     delete_scan,
     get_a_detailed_workflow_of_a_scan,
+    get_scans_by_filters,
 )
 
 from .uploadsAPI import (

{checkmarxpythonsdk-1.1.7 → checkmarxpythonsdk-1.1.8}/CheckmarxPythonSDK/CxOne/dto/Scan.py

@@ -1,6 +1,11 @@
 # encoding: utf-8
+from typing import List
+from .StatusDetails import StatusDetails
+
+
 class Scan(object):
-    def __init__(self, scan_id, status, status_details, position_in_queue, project_id, branch, commit_id, commit_tag,
+    def __init__(self, scan_id, status, status_details: List[StatusDetails], position_in_queue, project_id, branch,
+                 commit_id, commit_tag,
                  upload_url, created_at, updated_at, user_agent, initiator, tags, metadata):
         """
 
@@ -9,7 +14,7 @@ class Scan(object):
             status (str): The execution status of the scan.
                     Enum:[ Queued, Running, Completed, Failed, Partial, Canceled ]
             status_details (`list` of `StatusDetails`):
-            position_in_queue (int): he position of the scan in the execution queue.
+            position_in_queue (int): the position of the scan in the execution queue.
             project_id (str): The associated project id
             branch (str): The git branch
             commit_id (str): The git commit id. Mutually exclusive to commitTag

checkmarxpythonsdk-1.1.8/CheckmarxPythonSDK/CxOne/dto/StatusDetails.py

@@ -0,0 +1,32 @@
+# encoding: utf-8
+class StatusDetails(object):
+    def __init__(self, name, status, details, start_date, end_date):
+        """
+
+        Args:
+            name:
+            status:
+            details:
+        """
+        self.name = name
+        self.status = status
+        self.details = details
+        self.start_date = start_date
+        self.end_date = end_date
+
+    def __str__(self):
+        return (f"StatusDetails("
+                f"name={self.name}, "
+                f"status={self.status}, "
+                f"details={self.details}, "
+                f"start_date={self.start_date}), "
+                f"end_date={self.end_date}")
+
+    def to_dict(self):
+        return {
+            "name": self.name,
+            "status": self.status,
+            "details": self.details,
+            "start_date": self.start_date,
+            "end_date": self.end_date,
+        }

{checkmarxpythonsdk-1.1.7 → checkmarxpythonsdk-1.1.8}/CheckmarxPythonSDK/CxOne/scansAPI.py

@@ -1,6 +1,6 @@
 # encoding: utf-8
 import json
-
+from typing import List
 from deprecated import deprecated
 from .httpRequests import get_request, post_request, delete_request, patch_request
 from CheckmarxPythonSDK.utilities.compat import NO_CONTENT
@@ -26,6 +26,8 @@ def __construct_scan(item):
                 name=detail.get("name"),
                 status=detail.get("status"),
                 details=detail.get("details"),
+                start_date=detail.get("startDate"),
+                end_date=detail.get("endDate"),
             )
             for detail in item.get("statusDetails") or []
         ],
@@ -93,9 +95,9 @@ def get_a_list_of_scans(offset=0, limit=20, scan_ids=None, groups=None, tags_key
                     (Case insensitive, OR operator for multiple statuses.)
                     Available values : Queued, Running, Completed, Failed, Partial, Canceled
         project_id (str): Filter results for scans of a single project, specified by project ID.
-                        (Exact match, case sensitive, mutually exclusive to 'project-ids'.)
+                        (Exact match, case-sensitive, mutually exclusive to 'project-ids'.)
         project_ids (`list` of str): Filter results for scans of multiple projects, specified by project IDs.
-                    (Exact match, case sensitive, OR operator for multiple IDs, mutually exclusive to 'project-id'.)
+                    (Exact match, case-sensitive, OR operator for multiple IDs, mutually exclusive to 'project-id'.)
         source_type (str): source_type from scans table. return zip or github
         source_origin (str): source_origin from scans table. return webapp or jenkins or etc.
         from_date (str): Filter for the earliest date and time of a scan for which you would like to show results.
@@ -375,3 +377,71 @@ def scan_by_repo_url(project_id, repo_url, branch, engines, tag):
 
     response = post_request(relative_url=relative_url, data=json.dumps(scan_data))
     return response
+
+
+def get_scans_by_filters(offset: int = 0, limit: int = 20, scan_ids: List[str] = None, tags_keys: List[str] = None,
+                         tags_values: List[str] = None, statuses=None,
+                         project_ids=None, project_names=None, branches=None, initiators=None, source_origins=None,
+                         source_types=None, search_id=None, sort_by=("+created_at", "+status")):
+    """
+
+    Args:
+        offset (int):  The number of results to skip before returning results
+        limit (int): The maximum number of results to return
+        scan_ids (List of str): Filter results by scan IDs. Only exact matches are returned. (OR operator is used for
+            multiple IDs.)
+        tags_keys (List of str): Filter by tag keys (of the key:value pairs) associated with your scans. (OR operator
+            is used for multiple keys.)
+        tags_values (List of str): Filter by tag keys (of the key:value pairs) associated with your scans. (OR operator
+            is used for multiple values.)
+        statuses (List of str): Filter results by scans' execution status. (Case insensitive, OR operator for multiple
+            statuses.)
+        project_ids (List of str): Filter results for scans of multiple projects, specified by project IDs. (Exact
+            match, case-sensitive, OR operator for multiple IDs, mutually exclusive to 'project-id'.)
+        project_names (List of str): Filter scans by their project name
+        branches (List of str): Filter results by the name of the Git branches.
+        initiators (List of str): Filter scans by their initiator
+        source_origins (List of str): Filter by scan origins.
+        source_types (List of str): Source_type from scans table. return zip or github
+        search_id (str): The scan searching with substring in all scan columns
+        sort_by (List of str): Sort results by the specified parameter. Enter '-/+' for ascending/descending order,
+        followed by the parameter.  [-created_at, +created_at, -status, +status, +branch, -branch, +initiator,
+            -initiator, +user_agent, -user_agent, +name, -name]
+
+    Returns:
+
+    """
+    relative_url = api_url + f"/byFilters"
+
+    if isinstance(sort_by, tuple):
+        sort_by = list(sort_by)
+    sort_by = ",".join(sort_by)
+    data = {
+      "offset": offset,
+      "limit": limit,
+      "sortBy": sort_by
+    }
+    if scan_ids:
+        data.update({"scan-ids": scan_ids})
+    if tags_keys:
+        data.update({"tags-keys": tags_keys})
+    if tags_values:
+        data.update({"tags-values": tags_values})
+    if statuses:
+        data.update({"statuses": statuses})
+    if project_ids:
+        data.update({"projectIDs": project_ids})
+    if project_names:
+        data.update({"project-names": project_names})
+    if branches:
+        data.update({"branches": branches})
+    if initiators:
+        data.update({"initiators": initiators})
+    if source_origins:
+        data.update({"source-origins": source_origins})
+    if source_types:
+        data.update({"source-types": source_types})
+    if search_id:
+        data.update({"searchID": search_id})
+    response = post_request(relative_url=relative_url, data=json.dumps(data))
+    return response

checkmarxpythonsdk-1.1.8/CheckmarxPythonSDK/__version__.py

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

{checkmarxpythonsdk-1.1.7 → checkmarxpythonsdk-1.1.8}/CheckmarxPythonSDK.egg-info/PKG-INFO

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

{checkmarxpythonsdk-1.1.7 → checkmarxpythonsdk-1.1.8}/PKG-INFO

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

checkmarxpythonsdk-1.1.7/CheckmarxPythonSDK/CxOne/dto/StatusDetails.py

@@ -1,25 +0,0 @@
-# encoding: utf-8
-class StatusDetails(object):
-    def __init__(self, name, status, details):
-        """
-
-        Args:
-            name:
-            status:
-            details:
-        """
-        self.name = name
-        self.status = status
-        self.details = details
-
-    def __str__(self):
-        return """StatusDetails(name={}, status={}, details={})""".format(
-            self.name, self.status, self.details
-        )
-
-    def to_dict(self):
-        return {
-            "name": self.name,
-            "status": self.status,
-            "details": self.details
-        }

checkmarxpythonsdk-1.1.7/CheckmarxPythonSDK/__version__.py

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