Merge pull request #13 from pepsimidamerica/dev

Dev

nacwrap/data_model.py

@@ -64,6 +64,10 @@ class Action(BaseModel):
         errorMessage: Optional[str] = Field(default=None)
         logMessage: Optional[str] = Field(default=None)
 
+        @property
+        def age(self) -> timedelta:
+            return datetime.now(timezone.utc) - self.startDateTime
+
     # NintexInstance attributes
     instanceId: str
     name: Optional[str] = Field(default=None)
@@ -156,3 +160,7 @@ class NintexUser(BaseModel):
     @property
     def name(self):
         return self.firstName + " " + self.lastName
+
+
+class InstanceStartData(BaseModel):
+    pass

nacwrap/instances.py

@@ -258,7 +258,7 @@ def instances_list_pd(
     result: List[NintexInstance] = []
     for i in instance:
         result.append(NintexInstance(**i))
-        
+
     return result
 
 
@@ -300,6 +300,51 @@ def instance_resolve(instance_id: str, resolveType: ResolveType, message: str):
         )
 
 
-# TODO Delete instance
+@Decorators.refresh_token
+def instance_start_data(instance_id: str):
+    """
+    Returns start data from a specific workflow instance.
 
-# TODO Get instance start data
+    :param instance_id: ID of instance to return start data for.
+    """
+    url = (
+        os.environ["NINTEX_BASE_URL"]
+        + f"/workflows/v2/instances/{instance_id}/startdata"
+    )
+
+    try:
+        response = _fetch_page(
+            url,
+            headers={
+                "Authorization": "Bearer " + os.environ["NTX_BEARER_TOKEN"],
+                "Content-Type": "application/json",
+            },
+            params={},
+        )
+        response.raise_for_status()
+
+    except requests.exceptions.HTTPError as e:
+        raise Exception(
+            f"Error, instance not found when retrieving start data: {e.response.status_code} - {e.response.content}"
+        )
+
+    except requests.exceptions.RequestException as e:
+        raise Exception(f"Error, could not get instance start data: {e}")
+
+    data = response.json()
+    return data
+
+
+def instance_start_data_pd(instance_id: str, pydantic_model: InstanceStartData):
+    """
+    Returns start data as a pydantic object for a specific workflow instance.
+
+    :param instance_id: ID of instance to return start data for.
+    :param pydantic_model: Pydantic model to populate with results returned from Nintex API.
+    """
+
+    sd = instance_start_data(instance_id=instance_id)
+    return pydantic_model(**sd)
+
+
+# TODO Delete instance

setup.py

@@ -8,7 +8,7 @@
 
 setup(
     name="nacwrap",
-    version="0.1.8",
+    version="0.1.9",
     description="Python package that acts as a wrapper for the Nintex Automation Cloud system.",
     long_description=long_description,
     long_description_content_type="text/markdown",

tests/instance_test.py

@@ -2,11 +2,18 @@
 import sys
 from datetime import datetime, timedelta
 from pprint import pprint
+from pydantic import BaseModel
 
 sys.path.insert(0, "")
 from nacwrap import *
 
 
+class PurchDocStartData(InstanceStartData):
+    requestor: str = Field(alias='se_txtrequestor')
+    requestor_email: str = Field(alias="se_txtrequestoremail")
+    purchaser_code: str = Field(alias='se_txtpurchasercode')
+
+
 def test_list_instances():
     instances = nacwrap.instances_list(
         workflow_name="Purchase Approval", status=WorkflowStatus.RUNNING
@@ -33,5 +40,17 @@ def test_get_instance():
     print(instance)
 
 
+def test_instance_start_data():
+    # sd = nacwrap.instance_start_data(instance_id='d39c4615-863d-47ff-a800-c4b82cdc1e1f_0_4')
+    # pprint(sd)
+
+    sd = nacwrap.instance_start_data_pd(
+        instance_id="d39c4615-863d-47ff-a800-c4b82cdc1e1f_0_4",
+        pydantic_model=PurchDocStartData,
+    )
+    pprint(sd)
+
+
 # test_get_instance()
-test_list_instances()
+# test_list_instances()
+test_instance_start_data()