qctrl-workflow-client 5.3.1__tar.gz → 5.5.0__tar.gz

{qctrl_workflow_client-5.3.1 → qctrl_workflow_client-5.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: qctrl-workflow-client
-Version: 5.3.1
+Version: 5.5.0
 Summary: Q-CTRL Workflow Client
 License: https://q-ctrl.com/terms
 Keywords: black opal,boulder opal,fire opal,nisq,open controls,q control,q ctrl,q-control,q-ctrl,qcontrol,qctrl,quantum,quantum algorithms,quantum circuits,quantum coding,quantum coding software,quantum computing,quantum control,quantum control software,quantum control theory,quantum engineering,quantum error correction,quantum firmware,quantum fundamentals,quantum sensing,qubit,qudit

{qctrl_workflow_client-5.3.1 → qctrl_workflow_client-5.5.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "qctrl-workflow-client"
-version = "5.3.1"
+version = "5.5.0"
 description = "Q-CTRL Workflow Client"
 license = "https://q-ctrl.com/terms"
 authors = ["Q-CTRL <support@q-ctrl.com>"]

{qctrl_workflow_client-5.3.1 → qctrl_workflow_client-5.5.0}/qctrlworkflowclient/__init__.py

@@ -11,7 +11,7 @@
 # distributed under the License is distributed on an "AS IS" BASIS. See the
 # License for the specific language.
 
-__version__ = "5.3.1"
+__version__ = "5.5.0"
 
 from .defaults import get_authenticated_client_for_product
 from .functions import (

{qctrl_workflow_client-5.3.1 → qctrl_workflow_client-5.5.0}/qctrlworkflowclient/router/api.py

@@ -688,8 +688,74 @@ class ApiRouter(BaseRouter):
         )
         return response["tenant"]["tenant"]["currentInstances"]
 
+    def get_usage_time(self) -> float:
+        """
+        Return the total usage time of the machines in the user's cloud environment.
+        """
+        _query = gql.gql(
+            """
+            query UsageSummary($organizationId: ID!) {
+                tenant(organizationId: $organizationId) {
+                    tenant {
+                        usageSummary {
+                            allocatedComputeSeconds
+                            usedComputeSeconds
+                            availableComputeSeconds
+                        }
+                    }
+                    errors {
+                    message
+                    }
+                }
+            }
+            """
+        )
+
+        response = self._client.execute(
+            _query,
+            {"organizationId": self._get_configured_organization().organization_id},
+        )
+        return response["tenant"]["tenant"]["usageSummary"]
+
+    def shut_down_machines(self) -> dict[str, Any]:
+        """
+        Shut down all the machines in the user's cloud environment.
+
+        Returns
+        -------
+        dict[str, Any]
+            The response from the server,
+            like {'terminateTenant': {'successMessage': '...', 'errors': Any}}
+        """
+        _query = gql.gql(
+            """
+        mutation terminateTenant($organizationId: ID!, $organizationSlug: String!) {
+            terminateTenant(
+            input: {organizationId: $organizationId, organizationSlug: $organizationSlug}
+            ) {
+                successMessage
+                errors {
+                    fields
+                    message
+                }
+            }
+        }
+        """
+        )
+        return self._client.execute(
+            _query,
+            {
+                "organizationId": self._get_configured_organization().organization_id,
+                "organizationSlug": self._get_configured_organization().slug,
+            },
+        )
+
     def activity_monitor(
-        self, limit: int, offset: int = 0, status: Optional[str] = None
+        self,
+        limit: int,
+        offset: int = 0,
+        status: Optional[str] = None,
+        only_user_results: bool = True,
     ) -> list[dict[str, Any]]:
         """
         Fetch metadata from previously submitted actions.
@@ -703,6 +769,10 @@ class ApiRouter(BaseRouter):
             Defaults to 0.
         status : str or None, optional
             The filter for action status. Defaults to None.
+        only_user_results : bool, optional
+            If True, only fetch actions that belong to the user;
+            otherwise, fetch actions that belong to the user's organization.
+            Defaults to True.
 
         Returns
         -------
@@ -734,6 +804,8 @@ class ApiRouter(BaseRouter):
         check_argument(offset >= 0, "Offset must be at least 0.", {"offset": offset})
 
         filter_by = {}
+        if not only_user_results:
+            filter_by["organizationSlug"] = self._get_configured_organization().slug
         if status is not None:
             valid_statuses = [status.value for status in ActionStatus]
             check_argument(