1.1.0 add additional methods

README.md

@@ -30,6 +30,10 @@ For users with J1 accounts in the EU region, the 'url' parameter will need to be
 
 If no 'url' parameter is passed, the default of "https://graphql.us.jupiterone.io" is used.
 
+##### Method Exmaples:
+
+See the examples/examples.py for full usage example documentation
+
 ##### Execute a query:
 
 ```python

examples/examples.py

@@ -5,12 +5,14 @@
 
 account = os.environ.get("JUPITERONE_ACCOUNT")
 token = os.environ.get("JUPITERONE_TOKEN")
+url = "https://graphql.us.jupiterone.io"
 
-j1 = JupiterOneClient(account=account, token=token)
+j1 = JupiterOneClient(account=account, token=token, url=url)
 
 # query_v1
 q = "FIND jupiterone_user"
 query_r = j1.query_v1(q)
+print("query_v1()")
 print(query_r)
 
 # create_entity
@@ -31,6 +33,7 @@
     properties=properties,
     timestamp=int(time.time()) * 1000  # Optional, defaults to current datetime
 )
+print("create_entity()")
 print(create_r)
 
 properties = {
@@ -42,6 +45,7 @@
     entity_id='{}'.format(create_r['entity']['_id']),
     properties=properties
 )
+print("update_entity()")
 print(update_r)
 
 # create_entity_2
@@ -61,6 +65,7 @@
     properties=properties,
     timestamp=int(time.time()) * 1000  # Optional, defaults to current datetime
 )
+print("create_entity()")
 print(create_r_2)
 
 # create_relationship
@@ -71,20 +76,214 @@
     from_entity_id=create_r['entity']['_id'],
     to_entity_id=create_r_2['entity']['_id'],
 )
+print("create_relationship()")
 print(create_relationship_r)
 
 # delete_relationship
 delete_relationship_r = j1.delete_relationship(relationship_id=create_relationship_r['relationship']['_id'])
+print("delete_relationship()")
 print(delete_relationship_r)
 
 # delete_entity
 delete_entity_r1 = j1.delete_entity(entity_id=create_r['entity']['_id'])
+print("delete_entity()")
 print(delete_entity_r1)
 
 delete_entity_r2 = j1.delete_entity(entity_id=create_r_2['entity']['_id'])
+print("delete_entity()")
 print(delete_entity_r2)
 
+# cursor_query
 q = "FIND Person"
 cursor_query_r = j1._cursor_query(q)
+print("cursor_query()")
 print(cursor_query_r)
-print(len(cursor_query_r['data']))
+
+# fetch_all_entity_properties
+fetch_all_entity_properties_r = j1.fetch_all_entity_properties()
+print("fetch_all_entity_properties()")
+print(fetch_all_entity_properties_r)
+
+# fetch_all_entity_tags
+fetch_all_entity_tags_r = j1.fetch_all_entity_tags()
+print("fetch_all_entity_tags()")
+print(fetch_all_entity_tags_r)
+
+# create_integration_instance
+create_integration_instance_r = j1.create_integration_instance(instance_name="pythonclient-customintegration",
+                                                               instance_description="dev-testing")
+print("create_integration_instance()")
+print(create_integration_instance_r)
+
+integration_instance_id = "<GUID>"
+
+# start_sync_job
+start_sync_job_r = j1.start_sync_job(instance_id=integration_instance_id)
+print("start_sync_job()")
+print(start_sync_job_r)
+
+# upload_entities_batch_json
+entity_payload = [
+    {
+      "_key": "1",
+      "_type": "pythonclient",
+      "_class": "API",
+      "displayName": "pythonclient1",
+      "propertyName": "value",
+      "relationshipProperty": "source",
+    },
+    {
+      "_key": "2",
+      "_type": "pythonclient",
+      "_class": "API",
+      "displayName": "pythonclient2",
+      "propertyName": "value"
+    },
+    {
+      "_key": "3",
+      "_type": "pythonclient",
+      "_class": "API",
+      "displayName": "pythonclient3",
+      "propertyName": "value"
+    }
+]
+
+# update_entities_batch_json
+upload_entities_batch_json_r = j1.upload_entities_batch_json(instance_job_id=start_sync_job_r['job']['id'],
+                                                             entities_list=entity_payload)
+print("upload_entities_batch_json()")
+print(upload_entities_batch_json_r)
+
+# upload_relationships_batch_json
+relationships_payload = [
+    {
+      "_key": "1:2",
+      "_class": "EXTENDS",
+      "_type": "pythonclient_extends_pythonclient",
+      "_fromEntityKey": "1",
+      "_toEntityKey": "2",
+      "relationshipProperty": "value"
+    },
+    {
+      "_key": "2:3",
+      "_class": "EXTENDS",
+      "_type": "pythonclient_extends_pythonclient",
+      "_fromEntityKey": "2",
+      "_toEntityKey": "3",
+      "relationshipProperty": "value"
+    }
+]
+
+# update_relationships_batch_json
+upload_relationships_batch_json_r = j1.upload_relationships_batch_json(instance_job_id=start_sync_job_r['job']['id'],
+                                                                       relationships_list=relationships_payload)
+print("upload_relationships_batch_json()")
+print(upload_relationships_batch_json_r)
+
+# upload_entities_batch_json
+combined_payload = {
+    "entities": [
+    {
+      "_key": "4",
+      "_type": "pythonclient",
+      "_class": "API",
+      "displayName": "pythonclient4",
+      "propertyName": "value",
+      "relationshipProperty": "source",
+    },
+    {
+      "_key": "5",
+      "_type": "pythonclient",
+      "_class": "API",
+      "displayName": "pythonclient5",
+      "propertyName": "value"
+    },
+    {
+      "_key": "6",
+      "_type": "pythonclient",
+      "_class": "API",
+      "displayName": "pythonclient6",
+      "propertyName": "value"
+    }
+],
+    "relationships": [
+    {
+      "_key": "4:5",
+      "_class": "EXTENDS",
+      "_type": "pythonclient_extends_pythonclient",
+      "_fromEntityKey": "4",
+      "_toEntityKey": "5",
+      "relationshipProperty": "value"
+    },
+    {
+      "_key": "5:6",
+      "_class": "EXTENDS",
+      "_type": "pythonclient_extends_pythonclient",
+      "_fromEntityKey": "5",
+      "_toEntityKey": "6",
+      "relationshipProperty": "value"
+    }
+]
+}
+
+# upload_combined_batch_json
+upload_combined_batch_json_r = j1.upload_combined_batch_json(instance_job_id=start_sync_job_r['job']['id'],
+                                                             combined_payload=combined_payload)
+print("upload_combined_batch_json()")
+print(upload_combined_batch_json_r)
+
+# finalize_sync_job
+finalize_sync_job_r = j1.finalize_sync_job(instance_job_id=start_sync_job_r['job']['id'])
+print("finalize_sync_job()")
+print(finalize_sync_job_r)
+
+# fetch_integration_jobs
+fetch_integration_jobs_r = j1.fetch_integration_jobs(instance_id=integration_instance_id)
+print("fetch_integration_jobs()")
+print(fetch_integration_jobs_r)
+
+while j1.fetch_integration_jobs(instance_id=integration_instance_id)['jobs'][0]['status'] == "IN_PROGRESS":
+
+    fetch_integration_jobs_r = j1.fetch_integration_jobs(instance_id=integration_instance_id)
+
+    print("fetch_integration_jobs()")
+    print(fetch_integration_jobs_r)
+
+# fetch_integration_job_events
+fetch_integration_job_events_r = j1.fetch_integration_job_events(instance_id=integration_instance_id,
+                                                                 instance_job_id=fetch_integration_jobs_r['jobs'][0]['id'])
+print("fetch_integration_job_events()")
+print(fetch_integration_job_events_r)
+
+# create_smartclass
+create_smartclass_r = j1.create_smartclass(smartclass_name="SmartClass1",
+                                           smartclass_description="Created via create_smartclass() method")
+print("create_smartclass()")
+print(create_smartclass_r)
+
+# create_smartclass_query
+create_smartclass_query_r = j1.create_smartclass_query(smartclass_id=create_smartclass_r['id'],
+                                                       query="FIND (Device|Host) with osType ~= \'Windows\'",
+                                                       query_description="all windows devices and hosts")
+print("create_smartclass_query()")
+print(create_smartclass_query_r)
+
+# evaluate_smartclass
+evaluate_smartclass_r = j1.evaluate_smartclass(smartclass_id=create_smartclass_query_r['smartClassId'])
+print("evaluate_smartclass()")
+print(evaluate_smartclass_r)
+
+# get_smartclass_details
+get_smartclass_details_r = j1.get_smartclass_details(smartclass_id=create_smartclass_query_r['smartClassId'])
+print("get_smartclass_details()")
+print(get_smartclass_details_r)
+
+# list_configured_alert_rules
+list_configured_alert_rules_r = j1.list_configured_alert_rules()
+print("list_configured_alert_rules()")
+print(list_configured_alert_rules_r)
+
+# generate_j1ql
+generate_j1ql_r = j1.generate_j1ql(natural_language_prompt="show me all Users containing 'jupiterone' in their email address")
+print("generate_j1ql()")
+print(generate_j1ql_r)