added deprecation warnings

Author: esslushy

ThreadFixProApi/threadfixpro.py

@@ -13,6 +13,8 @@
 import requests.exceptions
 import requests.packages.urllib3
 
+import warnings
+
 from _utils import *
 
 class ThreadFixProAPI(object):
@@ -30,6 +32,8 @@ def __init__(self, host, api_key, verify_ssl=True, timeout=30, user_agent=None,
         the private key and the certificate) or as a tuple of both file’s path
         :param debug: Prints requests and responses, useful for debugging.
         """
+        # Deprecation warning
+        warnings.warn('ThreadFixProAPI object is being changed to contain only links to ApplicationSec and NetworkSec APIs. This object as it is currently presented is being changed to ThreadFixProAPIApplications or ThreadFixProAPI.Applications', DeprecationWarning)
         self.TeamsAPI = TeamsAPI(host, api_key, verify_ssl, timeout, user_agent, cert, debug)
         self.ApplicationsAPI = ApplicationsAPI(host, api_key, verify_ssl, timeout, user_agent, cert, debug)
         self.DefectTrackersAPI = DefectTrackersAPI(host, api_key, verify_ssl, timeout, user_agent, cert, debug)

_utils/_cicd.py

@@ -7,6 +7,7 @@
 __status__ = "Production"
 __license__ = "MIT"
 
+import warnings
 import requests
 import urllib3
 import requests.exceptions
@@ -52,6 +53,7 @@ def create_cicd_pass_criteria(self, severity, max_allowed=None, max_introduced=N
         :param max_allowed: The maximum number of vulnerabilities allowed for the Pass Criteria.  If no value is specified there is no limit.
         :param max_introduced: The maximum number of new vulnerabilities in a scan for the Pass Criteria.  If no value is specified there is no limit.
         """
+        warnings.warn('This function has been deprecated in ThreadFix 2.8', DeprecationWarning)
         params = {'severity' : severity}
         if max_allowed:
             params['maxAllowed'] = max_allowed
@@ -67,6 +69,7 @@ def update_ci_cd_pass_criteria(self, cicd_id, severity, max_allowed=None, max_in
         :param max_allowed: The maximum number of vulnerabilities allowed for the Pass Criteria.  If no value is specified there is no limit.
         :param max_introduced: The maximum number of new vulnerabilities in a scan for the Pass Criteria.  If no value is specified there is no limit.
         """
+        warnings.warn('This function has been deprecated in ThreadFix 2.8', DeprecationWarning)
         params = {'severity' : severity}
         if max_allowed:
             params['maxAllowed'] = max_allowed
@@ -78,20 +81,23 @@ def list_cicd_pass_criteria(self):
         """
         Lists CI/CD pass criteria
         """
+        warnings.warn('This function has been deprecated in ThreadFix 2.8', DeprecationWarning)
         return self._request('GET', 'rest/cicd/passCriteria')
 
     def get_cicd_pass_criteria_details(self, cicd_id):
         """
         Returns detailed information about the specified CI/CD pass criteria
         :param cicd_id: CI/CD identifier
         """
+        warnings.warn('This function has been deprecated in ThreadFix 2.8', DeprecationWarning)
         return self._request('GET', 'rest/cicd/passCriteria/' + str(cicd_id) + '/detail')
 
     def delete_cicd_pass_criteria(self, cicd_id):
         """
         Deletes the specified CI/CD pass criteria
         :param cicd_id: CI/CD identifier
         """
+        warnings.warn('This function has been deprecated in ThreadFix 2.8', DeprecationWarning)
         return self._request('DELETE', 'rest/cicd/passCriteria/' + str(cicd_id) + '/delete')
 
     def add_application_to_cicd_pass_criteria(self, pass_criteria_id, application_id):
@@ -100,6 +106,7 @@ def add_application_to_cicd_pass_criteria(self, pass_criteria_id, application_id
         :param pass_criteria_id: Pass Criteria identifier
         :param application_id: Application identifier
         """
+        warnings.warn('This function has been deprecated in ThreadFix 2.8', DeprecationWarning)
         return self._request('PUT', 'rest/cicd/passCriteria/' + str(pass_criteria_id) + '/addApplication/' + str(application_id))
 
     def remove_application_from_cicd_pass_criteria(self, pass_criteria_id, application_id):
@@ -108,6 +115,7 @@ def remove_application_from_cicd_pass_criteria(self, pass_criteria_id, applicati
         :param pass_criteria_id: Pass Criteria identifier
         :param application_id: Application identifier
         """
+        warnings.warn('This function has been deprecated in ThreadFix 2.8', DeprecationWarning)
         return self._request('DELETE', 'rest/cicd/passCriteria/' + str(pass_criteria_id) + '/removeApplication/' + str(application_id))
 
     def evaluate_cicd_pass_criteria(self, application_id, from_date=None, to_date=None):

_utils/_vulnerabilities.py

@@ -312,6 +312,7 @@ def mark_vulnerability_as_exploitable(self, vulnerability_id):
         Change the specified vulnerability to exploitable
         :param vulnerability_id: Vulnerability identifer
         """
+        warnings.warn('This function has been deprecated in ThreadFix 2.8.2', DeprecationWarning)
         return self._request('POST', 'rest/vulnerabilities/' + str(vulnerability_id) + '/setExploitable')
 
     def mark_vulnerability_as_contested(self, vulnerability_id):