sapiopycommons 2024.8.28a313__py3-none-any.whl → 2024.8.28a315__py3-none-any.whl

sapiopycommons/processtracking/endpoints.py

@@ -1,12 +1,12 @@
 from sapiopylib.rest.User import SapioUser
-from sapiopylib.rest.pojo.webhook.WebhookContext import SapioWebhookContext
 
-from sapiopycommons.general.aliases import RecordIdentifier, AliasUtil, ExperimentIdentifier
+from sapiopycommons.general.aliases import RecordIdentifier, AliasUtil, ExperimentIdentifier, DataTypeIdentifier, \
+    UserIdentifier
 
 
 class ProcessTracking:
     @staticmethod
-    def assign_to_process(context: SapioWebhookContext | SapioUser, data_type: str, records: list[RecordIdentifier],
+    def assign_to_process(context: UserIdentifier, data_type: DataTypeIdentifier, records: list[RecordIdentifier],
                           process_name: str, step_number: int | None = None, branch_id: int | None = None,
                           request: RecordIdentifier | None = None) -> None:
         """
@@ -27,19 +27,19 @@ class ProcessTracking:
         """
         sub_path = '/ext/process-tracking/assign-to-process'
         payload = {
-            "data-type-name": data_type,
+            "data-type-name": AliasUtil.to_data_type_name(data_type),
             "record-ids": AliasUtil.to_record_ids(records),
             "process-name": process_name,
             "step-number": step_number,
             "branch-id": branch_id,
             "request-record-id": AliasUtil.to_record_ids([request])[0] if request is not None else None
         }
-        user: SapioUser = context if isinstance(context, SapioUser) else context.user
+        user: SapioUser = AliasUtil.to_sapio_user(context)
         response = user.post(sub_path, payload=payload)
         user.raise_for_status(response)
 
     @staticmethod
-    def begin_protocol(context: SapioWebhookContext | SapioUser, data_type: str, records: list[RecordIdentifier],
+    def begin_protocol(context: UserIdentifier, data_type: DataTypeIdentifier, records: list[RecordIdentifier],
                        experiment: ExperimentIdentifier) -> None:
         """
         Begin the assigned processes of the given tracked records as the given experiment. This sets the status of the
@@ -54,16 +54,16 @@ class ProcessTracking:
         """
         sub_path = '/ext/process-tracking/begin-protocol'
         payload = {
-            "data-type-name": data_type,
+            "data-type-name": AliasUtil.to_data_type_name(data_type),
             "record-ids": AliasUtil.to_record_ids(records),
             "experiment-id": AliasUtil.to_notebook_id(experiment),
         }
-        user: SapioUser = context if isinstance(context, SapioUser) else context.user
+        user: SapioUser = AliasUtil.to_sapio_user(context)
         response = user.post(sub_path, payload=payload)
         user.raise_for_status(response)
 
     @staticmethod
-    def complete_protocol(context: SapioWebhookContext | SapioUser, data_type: str, records: list[RecordIdentifier],
+    def complete_protocol(context: UserIdentifier, data_type: DataTypeIdentifier, records: list[RecordIdentifier],
                           experiment: ExperimentIdentifier) -> None:
         """
         Complete the current step that the given tracked records are at given the experiment.
@@ -80,16 +80,16 @@ class ProcessTracking:
         """
         sub_path = '/ext/process-tracking/complete-protocol'
         payload = {
-            "data-type-name": data_type,
+            "data-type-name": AliasUtil.to_data_type_name(data_type),
             "record-ids": AliasUtil.to_record_ids(records),
             "experiment-id": AliasUtil.to_notebook_id(experiment),
         }
-        user: SapioUser = context if isinstance(context, SapioUser) else context.user
+        user: SapioUser = AliasUtil.to_sapio_user(context)
         response = user.post(sub_path, payload=payload)
         user.raise_for_status(response)
 
     @staticmethod
-    def fail(context: SapioWebhookContext | SapioUser, data_type: str, records: list[RecordIdentifier],
+    def fail(context: UserIdentifier, data_type: DataTypeIdentifier, records: list[RecordIdentifier],
              experiment: ExperimentIdentifier) -> None:
         """
         Fail the assigned processes of the given tracked records, changing their statuses to "Failed -". The tracked
@@ -103,16 +103,16 @@ class ProcessTracking:
         """
         sub_path = '/ext/process-tracking/fail'
         payload = {
-            "data-type-name": data_type,
+            "data-type-name": AliasUtil.to_data_type_name(data_type),
             "record-ids": AliasUtil.to_record_ids(records),
             "experiment-id": AliasUtil.to_notebook_id(experiment),
         }
-        user: SapioUser = context if isinstance(context, SapioUser) else context.user
+        user: SapioUser = AliasUtil.to_sapio_user(context)
         response = user.post(sub_path, payload=payload)
         user.raise_for_status(response)
 
     @staticmethod
-    def promote_to_next_by_experiment(context: SapioWebhookContext | SapioUser, data_type: str,
+    def promote_to_next_by_experiment(context: UserIdentifier, data_type: DataTypeIdentifier,
                                       records: list[RecordIdentifier], experiment: ExperimentIdentifier) -> None:
         """
         Promote the status of the given tracked records to the next status in their process using an experiment.
@@ -129,16 +129,16 @@ class ProcessTracking:
         """
         sub_path = '/ext/process-tracking/promote-status-to-next'
         payload = {
-            "data-type-name": data_type,
+            "data-type-name": AliasUtil.to_data_type_name(data_type),
             "record-ids": AliasUtil.to_record_ids(records),
             "experiment-id": AliasUtil.to_notebook_id(experiment),
         }
-        user: SapioUser = context if isinstance(context, SapioUser) else context.user
+        user: SapioUser = AliasUtil.to_sapio_user(context)
         response = user.post(sub_path, payload=payload)
         user.raise_for_status(response)
 
     @staticmethod
-    def promote_to_next_by_step(context: SapioWebhookContext | SapioUser, data_type: str,
+    def promote_to_next_by_step(context: UserIdentifier, data_type: DataTypeIdentifier,
                                 records: list[RecordIdentifier], process_name: str, step_number: int,
                                 branch_id: int | None = None) -> None:
         """
@@ -159,7 +159,7 @@ class ProcessTracking:
         """
         sub_path = '/ext/process-tracking/promote-status-to-next'
         payload = {
-            "data-type-name": data_type,
+            "data-type-name": AliasUtil.to_data_type_name(data_type),
             "record-ids": AliasUtil.to_record_ids(records),
             "current-process-status": {
                 "process-name": process_name,
@@ -167,12 +167,12 @@ class ProcessTracking:
                 "branch-id": branch_id
             }
         }
-        user: SapioUser = context if isinstance(context, SapioUser) else context.user
+        user: SapioUser = AliasUtil.to_sapio_user(context)
         response = user.post(sub_path, payload=payload)
         user.raise_for_status(response)
 
     @staticmethod
-    def reprocess(context: SapioWebhookContext | SapioUser, records: list[RecordIdentifier]) -> None:
+    def reprocess(context: UserIdentifier, records: list[RecordIdentifier]) -> None:
         """
         Reprocess tracked records to a previous step in their process. Reprocessing is controlled by ReturnPoint records
         which are children of the AssignedProcess on the tracked records. Creates a new AssignedProcess record for the
@@ -187,6 +187,6 @@ class ProcessTracking:
         payload = {
             "record-ids": AliasUtil.to_record_ids(records)
         }
-        user: SapioUser = context if isinstance(context, SapioUser) else context.user
+        user: SapioUser = AliasUtil.to_sapio_user(context)
         response = user.post(sub_path, payload=payload)
         user.raise_for_status(response)