Office365-REST-Python-Client 3.1.0__py3-none-any.whl → 3.2.0__py3-none-any.whl

office365/sharepoint/workflow/instances/service.py

@@ -1,3 +1,7 @@
+from uuid import UUID
+
+from office365.runtime.client_result import ClientResult
+from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
 from office365.sharepoint.entity_collection import EntityCollection
@@ -19,3 +23,32 @@ class WorkflowInstanceService(Entity):
     @property
     def entity_type_name(self):
         return "SP.WorkflowServices.WorkflowInstanceService"
+
+    @property
+    def current(self) -> "WorkflowInstanceService":
+        """Gets the Current property"""
+        return self.properties.get(
+            "Current", WorkflowInstanceService(self.context, ResourcePath("Current", self.resource_path))
+        )
+
+    def start_workflow_on_list_item_by_subscription_id(
+        self, subscription_id: UUID, item_id: int, payload: dict
+    ) -> ClientResult[str]:
+        """StartWorkflowOnListItemBySubscriptionId operation.
+
+        Args:
+            subscription_id (UUID): subscriptionId parameter
+            item_id (int): itemId parameter
+            payload (dict): payload parameter
+        """
+        return_type = ClientResult(self.context, str())
+        qry = ServiceOperationQuery(
+            self,
+            "StartWorkflowOnListItemBySubscriptionId",
+            None,
+            {"subscriptionId": subscription_id, "itemId": item_id, "payload": payload},
+            None,
+            return_type,
+        )
+        self.context.add_query(qry)
+        return return_type

office365/sharepoint/workflow/interopservice.py

@@ -1,6 +1,12 @@
 from __future__ import annotations
 
+from uuid import UUID
+
+from typing_extensions import Self
+
+from office365.runtime.client_result import ClientResult
 from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
 
 
@@ -13,3 +19,65 @@ class InteropService(Entity):
     @property
     def entity_type_name(self):
         return "SP.WorkflowServices.InteropService"
+
+    def cancel_workflow(self, instance_id: UUID) -> Self:
+        """CancelWorkflow operation.
+
+        Args:
+            instance_id (UUID): instanceId parameter
+        """
+        qry = ServiceOperationQuery(self, "CancelWorkflow", None, {"instanceId": instance_id}, None, None)
+        self.context.add_query(qry)
+        return self
+
+    def disable_events(self, list_id: UUID, item_guid: UUID) -> Self:
+        """DisableEvents operation.
+
+        Args:
+            list_id (UUID): listId parameter
+            item_guid (UUID): itemGuid parameter
+        """
+        qry = ServiceOperationQuery(self, "DisableEvents", None, {"listId": list_id, "itemGuid": item_guid}, None, None)
+        self.context.add_query(qry)
+        return self
+
+    def enable_events(self, list_id: UUID, item_guid: UUID) -> Self:
+        """EnableEvents operation.
+
+        Args:
+            list_id (UUID): listId parameter
+            item_guid (UUID): itemGuid parameter
+        """
+        qry = ServiceOperationQuery(self, "EnableEvents", None, {"listId": list_id, "itemGuid": item_guid}, None, None)
+        self.context.add_query(qry)
+        return self
+
+    def start_workflow(
+        self, association_name: str, correlation_id: UUID, list_id: UUID, item_guid: UUID, workflow_parameters: dict
+    ) -> ClientResult[str]:
+        """StartWorkflow operation.
+
+        Args:
+            association_name (str): associationName parameter
+            correlation_id (UUID): correlationId parameter
+            list_id (UUID): listId parameter
+            item_guid (UUID): itemGuid parameter
+            workflow_parameters (dict): workflowParameters parameter
+        """
+        return_type = ClientResult(self.context, str())
+        qry = ServiceOperationQuery(
+            self,
+            "StartWorkflow",
+            None,
+            {
+                "associationName": association_name,
+                "correlationId": correlation_id,
+                "listId": list_id,
+                "itemGuid": item_guid,
+                "workflowParameters": workflow_parameters,
+            },
+            None,
+            return_type,
+        )
+        self.context.add_query(qry)
+        return return_type

office365/sharepoint/workflow/messagingservice.py

@@ -1,3 +1,7 @@
+from uuid import UUID
+
+from office365.runtime.client_result import ClientResult
+from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
 
 
@@ -5,3 +9,23 @@ class WorkflowMessagingService(Entity):
     @property
     def entity_type_name(self) -> str:
         return "SP.WorkflowServices.WorkflowMessagingService"
+
+    def publish_event(self, event_source_id: UUID, event_name: str, payload: dict) -> ClientResult[str]:
+        """PublishEvent operation.
+
+        Args:
+            event_source_id (UUID): eventSourceId parameter
+            event_name (str): eventName parameter
+            payload (dict): payload parameter
+        """
+        return_type = ClientResult(self.context, str())
+        qry = ServiceOperationQuery(
+            self,
+            "PublishEvent",
+            None,
+            {"eventSourceId": event_source_id, "eventName": event_name, "payload": payload},
+            None,
+            return_type,
+        )
+        self.context.add_query(qry)
+        return return_type

office365/sharepoint/workflow/servicesmanager.py

@@ -1,3 +1,6 @@
+from typing import Optional
+
+from office365.runtime.client_result import ClientResult
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
@@ -10,14 +13,13 @@ class WorkflowServicesManager(Entity):
     def get_workflow_instance_service(self):
         """Returns the WorkflowInstanceService (manages and reads workflow instances from the workflow host),
         which manages workflow instances."""
-
         return_type = WorkflowInstanceService(self.context)
         qry = ServiceOperationQuery(self, "GetWorkflowInstanceService", None, None, None, return_type)
         self.context.add_query(qry)
         return return_type
 
     @staticmethod
-    def current(context):
+    def current(context) -> "WorkflowServicesManager":
         """Specifies the current instance for the SP.TenantSettings.
 
         Args:
@@ -28,3 +30,40 @@ class WorkflowServicesManager(Entity):
     @property
     def entity_type_name(self):
         return "SP.WorkflowServices.WorkflowServicesManager"
+
+    @property
+    def app_id(self) -> Optional[str]:
+        """Gets the AppId property"""
+        return self.properties.get("AppId", None)
+
+    @property
+    def is_connected(self) -> Optional[bool]:
+        """Gets the IsConnected property"""
+        return self.properties.get("IsConnected", None)
+
+    @property
+    def is_registered(self) -> Optional[bool]:
+        """Gets the IsRegistered property"""
+        return self.properties.get("IsRegistered", None)
+
+    @property
+    def scope_path(self) -> Optional[str]:
+        """Gets the ScopePath property"""
+        return self.properties.get("ScopePath", None)
+
+    @property
+    def service_health_status(self) -> Optional[int]:
+        """Gets the ServiceHealthStatus property"""
+        return self.properties.get("ServiceHealthStatus", None)
+
+    @property
+    def workflow2013_retired(self) -> Optional[bool]:
+        """Gets the Workflow2013Retired property"""
+        return self.properties.get("Workflow2013Retired", None)
+
+    def is_integrated_app(self) -> ClientResult[bool]:
+        """IsIntegratedApp operation."""
+        return_type = ClientResult(self.context, bool())
+        qry = ServiceOperationQuery(self, "IsIntegratedApp", None, {}, None, return_type)
+        self.context.add_query(qry)
+        return return_type

office365/sharepoint/workflow/subscriptions/service.py

@@ -1,6 +1,11 @@
 from __future__ import annotations
 
+from uuid import UUID
+
+from typing_extensions import Self
+
 from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.entity import Entity
 
 
@@ -15,3 +20,65 @@ class WorkflowSubscriptionService(Entity):
     @property
     def entity_type_name(self):
         return "SP.WorkflowServices.WorkflowSubscriptionService"
+
+    def delete_subscription(self, subscription_id: UUID) -> Self:
+        """DeleteSubscription operation.
+
+        Args:
+            subscription_id (UUID): subscriptionId parameter
+        """
+        qry = ServiceOperationQuery(self, "DeleteSubscription", None, {"subscriptionId": subscription_id}, None, None)
+        self.context.add_query(qry)
+        return self
+
+    def register_interest_in_host_web_list(self, list_id: UUID, event_name: str) -> Self:
+        """RegisterInterestInHostWebList operation.
+
+        Args:
+            list_id (UUID): listId parameter
+            event_name (str): eventName parameter
+        """
+        qry = ServiceOperationQuery(
+            self, "RegisterInterestInHostWebList", None, {"listId": list_id, "eventName": event_name}, None, None
+        )
+        self.context.add_query(qry)
+        return self
+
+    def register_interest_in_list(self, list_id: UUID, event_name: str) -> Self:
+        """RegisterInterestInList operation.
+
+        Args:
+            list_id (UUID): listId parameter
+            event_name (str): eventName parameter
+        """
+        qry = ServiceOperationQuery(
+            self, "RegisterInterestInList", None, {"listId": list_id, "eventName": event_name}, None, None
+        )
+        self.context.add_query(qry)
+        return self
+
+    def unregister_interest_in_host_web_list(self, list_id: UUID, event_name: str) -> Self:
+        """UnregisterInterestInHostWebList operation.
+
+        Args:
+            list_id (UUID): listId parameter
+            event_name (str): eventName parameter
+        """
+        qry = ServiceOperationQuery(
+            self, "UnregisterInterestInHostWebList", None, {"listId": list_id, "eventName": event_name}, None, None
+        )
+        self.context.add_query(qry)
+        return self
+
+    def unregister_interest_in_list(self, list_id: UUID, event_name: str) -> Self:
+        """UnregisterInterestInList operation.
+
+        Args:
+            list_id (UUID): listId parameter
+            event_name (str): eventName parameter
+        """
+        qry = ServiceOperationQuery(
+            self, "UnregisterInterestInList", None, {"listId": list_id, "eventName": event_name}, None, None
+        )
+        self.context.add_query(qry)
+        return self

office365/sharepoint/workflow/subscriptions/subscription.py

@@ -1,6 +1,10 @@
 from typing import Dict, Optional
 from uuid import UUID
 
+from typing_extensions import Self
+
+from office365.runtime.client_result import ClientResult
+from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.runtime.types.collections import StringCollection
 from office365.sharepoint.entity import Entity
 
@@ -54,3 +58,30 @@ class WorkflowSubscription(Entity):
     @property
     def entity_type_name(self):
         return "SP.WorkflowServices.WorkflowSubscription"
+
+    @property
+    def id(self) -> Optional[str]:
+        """Gets the Id property"""
+        return self.properties.get("Id", None)
+
+    def get_external_variable(self, name: str) -> ClientResult[str]:
+        """GetExternalVariable operation.
+
+        Args:
+            name (str): name parameter
+        """
+        return_type = ClientResult(self.context, str())
+        qry = ServiceOperationQuery(self, "GetExternalVariable", None, {"name": name}, None, return_type)
+        self.context.add_query(qry)
+        return return_type
+
+    def set_external_variable(self, name: str, value: str) -> Self:
+        """SetExternalVariable operation.
+
+        Args:
+            name (str): name parameter
+            value (str): value parameter
+        """
+        qry = ServiceOperationQuery(self, "SetExternalVariable", None, {"name": name, "value": value}, None, None)
+        self.context.add_query(qry)
+        return self