python setup.py validate

Author: seratch

slack/web/async_client.py

@@ -2320,3 +2320,60 @@ async def views_publish(
         else:
             kwargs.update({"view": view})
         return await self.api_call("views.publish", json=kwargs)
+
+    async def workflows_stepCompleted(
+        self, *, workflow_step_execute_id: str, outputs: dict = None, **kwargs
+    ) -> AsyncSlackResponse:
+        """Indicate a successful outcome of a workflow step's execution.
+        Args:
+            workflow_step_execute_id (str): A unique identifier of the workflow step to be updated.
+                e.g. 'add_task'
+            outputs (dict): A key-value object of outputs from your step.
+                e.g. { 'task_name': 'Task Name' }
+        """
+        kwargs.update({"workflow_step_execute_id": workflow_step_execute_id})
+        if outputs:
+            kwargs.update({"outputs": outputs})
+
+        return await self.api_call("workflows.stepCompleted", json=kwargs)
+
+    async def workflows_stepFailed(
+        self, *, workflow_step_execute_id: str, error: dict, **kwargs
+    ) -> AsyncSlackResponse:
+        """Indicate an unsuccessful outcome of a workflow step's execution.
+        Args:
+            workflow_step_execute_id (str): A unique identifier of the workflow step to be updated.
+                e.g. 'add_task'
+            error (dict): A dict with a message property that contains a human readable error message
+                e.g. { message: 'Step failed to execute.' }
+        """
+        kwargs.update(
+            {"workflow_step_execute_id": workflow_step_execute_id, "error": error}
+        )
+        return await self.api_call("workflows.stepFailed", json=kwargs)
+
+    async def workflows_updateStep(
+        self,
+        *,
+        workflow_step_edit_id: str,
+        inputs: dict = None,
+        outputs: list = None,
+        **kwargs
+    ) -> AsyncSlackResponse:
+        """Update the configuration for a workflow extension step.
+        Args:
+            workflow_step_edit_id (str): A unique identifier of the workflow step to be updated.
+                e.g. 'add_task'
+            inputs (dict): A key-value object of inputs required from a user during step configuration.
+                e.g. { 'title': { 'value': 'The Title' }, 'submitter': { 'value': 'The Submitter' } }
+            outputs (list): A list of output objects used during step execution.
+                e.g. [{ 'type': 'text', 'name': 'title', 'label': 'Title' }]
+        """
+        kwargs.update({"workflow_step_edit_id": workflow_step_edit_id})
+
+        if inputs:
+            kwargs.update({"inputs": inputs})
+        if outputs:
+            kwargs.update({"outputs": outputs})
+
+        return await self.api_call("workflows.updateStep", json=kwargs)

slack/web/client.py

@@ -2316,11 +2316,7 @@ def views_publish(
         return self.api_call("views.publish", json=kwargs)
 
     def workflows_stepCompleted(
-        self,
-        *,
-        workflow_step_execute_id: str,
-        outputs: dict = None,
-        **kwargs
+        self, *, workflow_step_execute_id: str, outputs: dict = None, **kwargs
     ) -> Union[Future, SlackResponse]:
         """Indicate a successful outcome of a workflow step's execution.
         Args:
@@ -2336,11 +2332,7 @@ def workflows_stepCompleted(
         return self.api_call("workflows.stepCompleted", json=kwargs)
 
     def workflows_stepFailed(
-        self,
-        *,
-        workflow_step_execute_id: str,
-        error: dict,
-        **kwargs
+        self, *, workflow_step_execute_id: str, error: dict, **kwargs
     ) -> Union[Future, SlackResponse]:
         """Indicate an unsuccessful outcome of a workflow step's execution.
         Args:
@@ -2349,7 +2341,9 @@ def workflows_stepFailed(
             error (dict): A dict with a message property that contains a human readable error message
                 e.g. { message: 'Step failed to execute.' }
         """
-        kwargs.update({"workflow_step_execute_id": workflow_step_execute_id, "error": error})
+        kwargs.update(
+            {"workflow_step_execute_id": workflow_step_execute_id, "error": error}
+        )
         return self.api_call("workflows.stepFailed", json=kwargs)
 
     def workflows_updateStep(

tests/web/test_web_client_coverage.py

@@ -9,7 +9,7 @@
 
 
 class TestWebClientCoverage(unittest.TestCase):
-    #220 endpoints as of Sep 2, 2020
+    #221 endpoints as of Sep 2, 2020
     # Can be fetched by running `var methodNames = [].slice.call(document.getElementsByClassName('bold')).map(e => e.text);console.log(methodNames.toString());console.log(methodNames.length);` on https://api.slack.com/methods
     all_api_methods = "admin.apps.approve,admin.apps.restrict,admin.apps.approved.list,admin.apps.requests.list,admin.apps.restricted.list,admin.conversations.archive,admin.conversations.convertToPrivate,admin.conversations.create,admin.conversations.delete,admin.conversations.disconnectShared,admin.conversations.getConversationPrefs,admin.conversations.getTeams,admin.conversations.invite,admin.conversations.rename,admin.conversations.search,admin.conversations.setConversationPrefs,admin.conversations.setTeams,admin.conversations.unarchive,admin.conversations.ekm.listOriginalConnectedChannelInfo,admin.conversations.restrictAccess.addGroup,admin.conversations.restrictAccess.listGroups,admin.conversations.restrictAccess.removeGroup,admin.emoji.add,admin.emoji.addAlias,admin.emoji.list,admin.emoji.remove,admin.emoji.rename,admin.inviteRequests.approve,admin.inviteRequests.deny,admin.inviteRequests.list,admin.inviteRequests.approved.list,admin.inviteRequests.denied.list,admin.teams.admins.list,admin.teams.create,admin.teams.list,admin.teams.owners.list,admin.teams.settings.info,admin.teams.settings.setDefaultChannels,admin.teams.settings.setDescription,admin.teams.settings.setDiscoverability,admin.teams.settings.setIcon,admin.teams.settings.setName,admin.usergroups.addChannels,admin.usergroups.addTeams,admin.usergroups.listChannels,admin.usergroups.removeChannels,admin.users.assign,admin.users.invite,admin.users.list,admin.users.remove,admin.users.setAdmin,admin.users.setExpiration,admin.users.setOwner,admin.users.setRegular,admin.users.session.reset,api.test,apps.permissions.info,apps.permissions.request,apps.permissions.resources.list,apps.permissions.scopes.list,apps.permissions.users.list,apps.permissions.users.request,apps.uninstall,auth.revoke,auth.test,bots.info,calls.add,calls.end,calls.info,calls.update,calls.participants.add,calls.participants.remove,chat.delete,chat.deleteScheduledMessage,chat.getPermalink,chat.meMessage,chat.postEphemeral,chat.postMessage,chat.scheduleMessage,chat.unfurl,chat.update,chat.scheduledMessages.list,conversations.archive,conversations.close,conversations.create,conversations.history,conversations.info,conversations.invite,conversations.join,conversations.kick,conversations.leave,conversations.list,conversations.mark,conversations.members,conversations.open,conversations.rename,conversations.replies,conversations.setPurpose,conversations.setTopic,conversations.unarchive,dialog.open,dnd.endDnd,dnd.endSnooze,dnd.info,dnd.setSnooze,dnd.teamInfo,emoji.list,files.comments.delete,files.delete,files.info,files.list,files.revokePublicURL,files.sharedPublicURL,files.upload,files.remote.add,files.remote.info,files.remote.list,files.remote.remove,files.remote.share,files.remote.update,migration.exchange,oauth.access,oauth.token,oauth.v2.access,pins.add,pins.list,pins.remove,reactions.add,reactions.get,reactions.list,reactions.remove,reminders.add,reminders.complete,reminders.delete,reminders.info,reminders.list,rtm.connect,rtm.start,search.all,search.files,search.messages,stars.add,stars.list,stars.remove,team.accessLogs,team.billableInfo,team.info,team.integrationLogs,team.profile.get,usergroups.create,usergroups.disable,usergroups.enable,usergroups.list,usergroups.update,usergroups.users.list,usergroups.users.update,users.conversations,users.deletePhoto,users.getPresence,users.identity,users.info,users.list,users.lookupByEmail,users.setActive,users.setPhoto,users.setPresence,users.profile.get,users.profile.set,views.open,views.publish,views.push,views.update,workflows.stepCompleted,workflows.stepFailed,workflows.updateStep,admin.conversations.whitelist.add,admin.conversations.whitelist.listGroupsLinkedToChannel,admin.conversations.whitelist.remove,channels.archive,channels.create,channels.history,channels.info,channels.invite,channels.join,channels.kick,channels.leave,channels.list,channels.mark,channels.rename,channels.replies,channels.setPurpose,channels.setTopic,channels.unarchive,groups.archive,groups.create,groups.createChild,groups.history,groups.info,groups.invite,groups.kick,groups.leave,groups.list,groups.mark,groups.open,groups.rename,groups.replies,groups.setPurpose,groups.setTopic,groups.unarchive,im.close,im.history,im.list,im.mark,im.open,im.replies,mpim.close,mpim.history,mpim.list,mpim.mark,mpim.open,mpim.replies".split(
         ","
@@ -31,9 +31,6 @@ def setUp(self):
                 "admin.conversations.whitelist.add",  # deprecated
                 "admin.conversations.whitelist.listGroupsLinkedToChannel",  # deprecated
                 "admin.conversations.whitelist.remove",  # deprecated
-                "workflows.stepCompleted",  # still in beta
-                "workflows.stepFailed",  # still in beta
-                "workflows.updateStep",  # still in beta
             ]:
                 continue
             self.api_methods_to_call.append(api_method)