Add support for sandbox_ids filter in Analytics.create_report (fixes #99)

Author: tjarrettveracode

docs/analytics.md

@@ -18,6 +18,7 @@ The following methods call Veracode REST APIs and return JSON.
   - `rawjson`: optional, defaults to False. Returns full response if True, the GUID of the request if false
   - `deletion_start_date`: required for `deletedscans` report type, beginning of date range for deleted scans.
   - `deletion_end_date`: optional, end of date range for deleted scans.
+  - `sandbox_ids`: optional, array of sandbox IDs (integers) for which to return results
 
 - `Analytics().get(guid, report_type(findings))`: check the status of the report request and return the report contents when ready. Note that this method returns a tuple of `status` (string) and `results` (list); when `status` is `COMPLETED`, the `results` list will populate with results. Also, you need to specify the type of data expected by the GUID with `report_type`; this defaults to `findings`.
 

docs/api.md

@@ -39,6 +39,9 @@ As an alternative to importing individual objects into your library, you can acc
   - `policy_sandbox`: optional, 'Policy' or 'Sandbox'
   - `application_id`: optional, application ID for which to return results
   - `rawjson`: optional, defaults to False. Returns full response if True, the GUID of the request if false
+  - `deletion_start_date`: required for `deletedscans` report type, beginning of date range for deleted scans.
+  - `deletion_end_date`: optional, end of date range for deleted scans.
+  - `sandbox_ids`: optional, array of sandbox IDs (integers) for which to return results
 
 - `get_analytics_report(guid)`: check the status of the report request and return the report contents when ready. Note that this method returns a tuple of `status` (string) and `results` (list); when `status` is `COMPLETED`, the `results` list will populate with results.
 

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = 'veracode_api_py'
-version = '0.9.58'
+version = '0.9.59'
 authors = [ {name = "Tim Jarrett", email="[email protected]"} ]
 description = 'Python helper library for working with the Veracode APIs. Handles retries, pagination, and other features of the modern Veracode REST APIs.'
 readme = 'README.md'
@@ -22,4 +22,4 @@ dependencies = {file = ["requirements.txt"]}
 [project.urls]
 "Homepage" = "https://github.com/veracode/veracode-api-py"
 "Bug Tracker" = "https://github.com/veracode/veracode-api-py/issues"
-"Download" = "https://github.com/veracode/veracode-api-py/archive/v_0958.tar.gz"
+"Download" = "https://github.com/veracode/veracode-api-py/archive/v_0959.tar.gz"

setup.py

@@ -7,15 +7,15 @@
 setup(
   name = 'veracode_api_py',         
   packages = ['veracode_api_py'],   
-  version = '0.9.58',      
+  version = '0.9.59',      
   license='MIT',        
   description = 'Python helper library for working with the Veracode APIs. Handles retries, pagination, and other features of the modern Veracode REST APIs.',   
   long_description = long_description,
   long_description_content_type="text/markdown",
   author = 'Tim Jarrett',                  
   author_email = '[email protected]',      
   url = 'https://github.com/tjarrettveracode',  
-  download_url = 'https://github.com/veracode/veracode-api-py/archive/v_09578tar.gz',    
+  download_url = 'https://github.com/veracode/veracode-api-py/archive/v_0959tar.gz',    
   keywords = ['veracode', 'veracode-api'],   
   install_requires=[            
           'veracode-api-signing'

veracode_api_py/analytics.py

@@ -17,7 +17,7 @@ class Analytics():
    def create_report(self,report_type,last_updated_start_date=None,last_updated_end_date=None,
                      scan_type:list = [], finding_status=None,passed_policy=None,
                      policy_sandbox=None,application_id=None,rawjson=False, deletion_start_date=None,
-                     deletion_end_date=None):
+                     deletion_end_date=None, sandbox_ids:list = []):
 
       if report_type not in self.report_types:
          raise ValueError("{} is not in the list of valid report types ({})".format(report_type,self.report_types))
@@ -48,7 +48,7 @@ def create_report(self,report_type,last_updated_start_date=None,last_updated_end
          elif report_type in [ 'scans', 'deletedscans' ]:
             valid_scan_types = self.scan_scan_types
          if not(self._case_insensitive_list_compare(scan_type,valid_scan_types)):
-            raise ValueError("{} is not in the list of valid scan types ({})".format(report_type,valid_scan_types))
+            raise ValueError("{} is not in the list of valid scan types ({})".format(scan_type,valid_scan_types))
          report_def['scan_type'] = scan_type
 
       if finding_status:
@@ -62,6 +62,9 @@ def create_report(self,report_type,last_updated_start_date=None,last_updated_end
 
       if application_id:
          report_def['application_id'] = application_id
+
+      if sandbox_ids:
+         report_def['sandbox_ids'] = sandbox_ids
 
       payload = json.dumps(report_def)
       response = APIHelper()._rest_request(url=self.base_url,method="POST",body=payload)

veracode_api_py/api.py

@@ -645,13 +645,13 @@ def dyn_start_scan(self, length, unit):
     def create_analytics_report(self,report_type,last_updated_start_date=None,last_updated_end_date=None,
                      scan_type:list = [], finding_status=None,passed_policy=None,
                      policy_sandbox=None,application_id=None,rawjson=False,deletion_start_date=None,
-                     deletion_end_date=None):
+                     deletion_end_date=None, sandbox_ids:list = []):
         return Analytics().create_report(report_type=report_type,last_updated_start_date=last_updated_start_date,
                                          last_updated_end_date=last_updated_end_date,scan_type=scan_type,
                                          finding_status=finding_status,passed_policy=passed_policy,
                                          policy_sandbox=policy_sandbox,application_id=application_id,
                                          rawjson=rawjson, deletion_start_date=deletion_start_date, 
-                                         deletion_end_date=deletion_end_date)
+                                         deletion_end_date=deletion_end_date, sandbox_ids=sandbox_ids)
 
     def get_analytics_report(self,guid: UUID):
         status, findings = Analytics().get(guid=guid)