add delete_question()

Author: SeaBlooms

examples/08_questions_management.py

@@ -628,6 +628,44 @@ def update_question_examples(j1):
     except Exception as e:
         print(f"  ❌ Error updating variables: {e}\n")
 
+def delete_question_examples(j1):
+    """Demonstrate deleting existing questions."""
+    
+    print("=== Delete Question Examples ===\n")
+    
+    # Get question ID from user input
+    print("1. Enter the question ID to delete:")
+    print("   (You can find question IDs by running the list_questions_example first)")
+    print()
+    
+    # For demonstration purposes, use a placeholder ID
+    # In a real application, you would use: question_id = input("Enter question ID: ")
+    question_id = "your-question-id-here"  # Replace with actual question ID
+    
+    if question_id == "your-question-id-here":
+        print("  ⚠️  Please replace 'your-question-id-here' with an actual question ID")
+        print("  Example: question_id = 'fcc0507d-0473-43a2-b083-9d5571b92ae7'")
+        print()
+        return
+    
+    print(f"  Question ID to delete: {question_id}")
+    print()
+    
+    # Delete the question
+    print("2. Deleting the question:")
+    try:
+        deleted_question = j1.delete_question(question_id=question_id)
+        
+        print(f"  ✅ Successfully deleted question!")
+        print(f"  Deleted question title: {deleted_question['title']}")
+        print(f"  Deleted question ID: {deleted_question['id']}")
+        print(f"  Number of queries in deleted question: {len(deleted_question['queries'])}")
+        print()
+        
+    except Exception as e:
+        print(f"  ❌ Error deleting question: {e}")
+        print()
+
 def question_use_cases(j1):
     """Demonstrate real-world use cases for questions."""
 
@@ -719,6 +757,40 @@ def question_use_cases(j1):
         }
     )
     """)
+    
+    # Use Case 5: Question Deletion and Cleanup
+    print("\nUse Case 5: Question Deletion and Cleanup")
+    print("-" * 50)
+    print("Delete questions that are no longer needed:")
+    print("""
+    # Delete a single question
+    deleted_question = j1.delete_question(
+        question_id="question-id-to-delete"
+    )
+    print(f"Deleted: {deleted_question['title']}")
+    
+    # Batch delete deprecated questions
+    deprecated_questions = j1.list_questions(tags=["deprecated"])
+    for question in deprecated_questions:
+        try:
+            deleted = j1.delete_question(question_id=question['id'])
+            print(f"Deleted deprecated question: {deleted['title']}")
+        except Exception as e:
+            print(f"Failed to delete {question['title']}: {e}")
+    
+    # Safe deletion with backup
+    question_to_delete = j1.get_question_details(question_id="question-id")
+    backup_question = j1.create_question(
+        title=f"{question_to_delete['title']} - BACKUP",
+        queries=question_to_delete['queries'],
+        description=f"Backup before deletion: {question_to_delete.get('description', '')}",
+        tags=question_to_delete.get('tags', []) + ["backup"]
+    )
+    
+    # Now delete the original
+    j1.delete_question(question_id="question-id")
+    print("Original question deleted, backup preserved")
+    """)
 
 def main():
     """Run all question management examples."""
@@ -750,6 +822,9 @@ def main():
     update_question_examples(j1)
     time.sleep(1)
 
+    delete_question_examples(j1)
+    time.sleep(1)
+    
     question_use_cases(j1)
 
     print("\n" + "=" * 50)

jupiterone/client.py

@@ -59,6 +59,7 @@
     UPDATE_ENTITYV2,
     INVOKE_INTEGRATION_INSTANCE,
     UPDATE_QUESTION,
+    DELETE_QUESTION,
 )
 
 class JupiterOneClient:
@@ -1542,6 +1543,46 @@ def update_question(
         response = self._execute_query(UPDATE_QUESTION, variables)
         return response["data"]["updateQuestion"]
 
+    def delete_question(self, question_id: str) -> Dict:
+        """
+        Delete an existing question from the J1 account.
+        
+        Args:
+            question_id (str): The unique ID of the question to delete (required)
+            
+        Returns:
+            Dict: The deleted question object with all its details
+            
+        Raises:
+            ValueError: If question_id is not provided
+            JupiterOneApiError: If the question deletion fails or other API errors occur
+            
+        Example:
+            # Delete a question by ID
+            deleted_question = j1_client.delete_question(
+                question_id="fcc0507d-0473-43a2-b083-9d5571b92ae7"
+            )
+            
+            print(f"Question '{deleted_question['title']}' has been deleted")
+            print(f"Deleted question ID: {deleted_question['id']}")
+            print(f"Number of queries in deleted question: {len(deleted_question['queries'])}")
+            
+            # Access other deleted question details
+            if deleted_question.get('compliance'):
+                print(f"Compliance standard: {deleted_question['compliance']['standard']}")
+            
+            if deleted_question.get('tags'):
+                print(f"Tags: {', '.join(deleted_question['tags'])}")
+        """
+        if not question_id:
+            raise ValueError("question_id is required")
+        
+        # Execute the GraphQL mutation
+        variables = {"id": question_id}
+        
+        response = self._execute_query(DELETE_QUESTION, variables)
+        return response["data"]["deleteQuestion"]
+
     def get_compliance_framework_item_details(self, item_id: str = None):
         """Fetch Details of a Compliance Framework Requirement configured in J1 account"""
         variables = {"input": {"id": item_id}}

jupiterone/constants.py

@@ -1370,3 +1370,37 @@
       __typename
     }
 """
+
+DELETE_QUESTION = """
+    mutation DeleteQuestion($id: ID!) {
+      deleteQuestion(id: $id) {
+        id
+        title
+        description
+        queries {
+          query
+          name
+          version
+          __typename
+        }
+        compliance {
+          standard
+          requirements
+          controls
+          __typename
+        }
+        variables {
+          name
+          required
+          default
+          __typename
+        }
+        tags
+        accountId
+        integrationDefinitionId
+        showTrend
+        pollingInterval
+        __typename
+      }
+    }
+"""