o aqex@sdZddlZddlmZddlmZddlmZmZm Z m Z ddl m Z ddlmZmZddlmZddlmZmZGd d d eZdS) z5A Python module for interacting with Slack's Web API.N)Future)IOBase)UnionListOptionalDict) BaseClient SlackResponse)View)_parse_web_class_objects_update_call_participantsc @s^eZdZdZddddededeeeffddZdeeeffd d Z deeeffd d Z deeeffd dZ deeeffddZ de dedeeeffddZdedeeeffddZdedeeeefdeeeffddZdedeeeffddZdedeeeffddZdededeeeffdd Zdeeeffd!d"Zdedeeeffd#d$Zded%eeefdeeeffd&d'Zdedeeeffd(d)Zdedeeeffd*d+Zdeeeffd,d-Zded.edeeeffd/d0Zdedeeeffd1d2Zded.ed3edeeeffd4d5Zdedeeeffd6d7Zdedeeeffd8d9Z deeeffd:d;Z!deeeffdd?Z#deeeffd@dAZ$deeeffdBdCZ%dDedeeeffdEdFZ&dGed3edeeeffdHdIZ'dJedeeeffdKdLZ(deeeffdMdNZ)deeeffdOdPZ*dJedeeeffdQdRZ+deeeffdSdTZ,d3edeeeffdUdVZ-dWedXedeeeffdYdZZ.deeeffd[d\Z/d3edeeeffd]d^Z0d3edeeeffd_d`Z1d3edaeeeefdeeeffdbdcZ2d3eddedeeeffdedfZ3d3edgedeeeffdhdiZ4d3edjedeeeffdkdlZ5d3ededeeeffdmdnZ6d3edoedaeeeefdeeeffdpdqZ7doedreeeefdeeeffdsdtZ8doedeeeffdudvZ9doedaeeeefdeeeffdwdxZ:d3edDedeeeffdydzZ;d3ed{edaeeeefdeeeffd|d}Zd3edDedeeeffddZ?de@d3edDedeeeffddZAd3edDedeeeffddZBd3edDedeeeffddZCdeeeffddZDdedeeeffddZEdededeeeffddZFdeeeffddZGdeeeffddZHdeeeffddZIdededeeeffddZJdedeeeffddZKdedeeeffddZLdedeeeeMeeffdeeeffddZNdedeeeeMeeffdeeeffddZOdedeeeffddZPdedeeeffddZQdedeeeffddZRdedeeeffddZSdedeeeffddZTdededeeeffddZUdedeeeffddZVdededeeeffddZWdedeeeffddZXdeeeffddZYdededeeeffddZZdededeeeffdd„Z[dededeeeffddńZ\dededeeeffddȄZ]dededeeeffdd˄Z^dedeeeffdd̈́Z_dededeeeffddτZ`dededeeeffdd҄ZadededeeeffddՄZbdededeeeffdd؄ZcdededeeeffddڄZddedeeeffdd܄Zededededeeeffdd߄ZfdedededeeeffddZgdededeeeffddZhdeeeffddZidedeeeffddZjdedeeeffddZkdedeeeffddZldedeeeffddZmdedeeeffddZndedeeeefdeeeffddZodedeeeffddZpdededeeeffddZqdedeeeffddZrdeeeffddZsdededeeeffddZtdedeeeffddZudeeeffddZvdededeeeffddZwdededeeeffddZxdededeeeffddZydededeeeffddZzdedeeeffd d Z{d ed edeeeffd dZ|deeeffddZ}deeeffddZ~deeeffddZde@deeeffddZdeeeefdeeeffddZdeeeffddZdededeeeffddZdedeeeffdd Zdedeeeffd!d"Zdeeeffd#d$Zdeeeffd%d&Zdeeeffd'd(Zd)ed*ed+edeeeffd,d-Zdeeeffd.d/Zdeeeffd0d1Zd2eeeefdeeeffd3d4Zdedeeeffd5d6Zdedeeeffd7d8Zddd9deeefd:edeeeffd;d<Zdedeeeffd=d>Zdedeeeffd?d@ZdedeeeffdAdBZdedeeeffdCdDZdedeeeffdEdFZdededeeeffdGdHZdededeeeffdIdJZdedeeeffdKdLZdeeeffdMdNZdededeeeffdOdPZdedeeeffdQdRZdededeeeffdSdTZdededeeeffdUdVZdededeeeffdWdXZdededeeeffdYdZZdedeeeffd[d\Zdedeeeffd]d^Zdedeeeffd_d`ZdeeeffdadbZdededeeeffdcddZdedeeeffdedfZdededeeeffdgdhZdeeeefdeeeffdidjZdedeeeffdkdlZdedeeeffdmdnZdeeeffdodpZdededeeeffdqdrZdeeeefdeeeffdsdtZdededeeeffdudvZddwdededxedyeedeeeff dzd{Zddwdededxedyeedeeeff d|d}Zdedeeeffd~dZdedeeeffddZdedeeeffddZdedeeeffddZdeeeffddZdeeeffddZdedeeeffddZdededeeeffddZdedeeeffddZdedeeeffddZdedeeeffddZdeeeffddZdeeeffddZdeeeffddZdedeeeffddZdedeeeffddZdedeeeffddZdeeeffddZdeeeffddZdeeeffddZdeeeffddZdeeeffddZdeeeffddZdeeeffddZdeeeffddZdedeeeffddZʐdedeeeffddZːdedeeeffddZdeeeffddZ͐dedeeeffddZΐdedeeeffddZϐdedeeeefdeeeffddZdeeeffddÄZdeeeffdĐdńZdedeeeffdƐdDŽZdeeeffdȐdɄZdedeeeffdʐd˄Zdeeeffd̐d̈́Zd{edeeeffdΐdτZאdeeefdeeeffdѐd҄ZؐdedeeeffdԐdՄZdeeeffd֐dׄZdeeeffdؐdلZېd edeeefdeeeffdېd܄Zݐd edeeefdeeeffdݐdބZdddߜdeeefd)ededeeeffddZdDedeeefdeeeffddZdddededeeeffddZdededeeeffddZddddedededeeeffddZdS( WebClientaxA WebClient allows apps to communicate with the Slack Platform's Web API. The Slack Web API is an interface for querying information from and enacting change in a Slack workspace. This client handles constructing and sending HTTP requests to Slack as well as parsing any responses received into a `SlackResponse`. Attributes: token (str): A string specifying an xoxp or xoxb token. use_session (bool): An boolean specifying if the client should take advantage of connection pooling. Default is True. base_url (str): A string representing the Slack API base URL. Default is 'https://www.slack.com/api/' timeout (int): The maximum number of seconds the client will wait to connect and receive a response from Slack. Default is 30 seconds. Methods: api_call: Constructs a request and executes the API call to Slack. Example of recommended usage: ```python import os import slack client = slack.WebClient(token=os.environ['SLACK_API_TOKEN']) response = client.chat_postMessage( channel='#random', text="Hello world!") assert response["ok"] assert response["message"]["text"] == "Hello world!" ``` Example manually creating an API request: ```python import os import slack client = slack.WebClient(token=os.environ['SLACK_API_TOKEN']) response = client.api_call( api_method='chat.postMessage', json={'channel': '#random','text': "Hello world!"} ) assert response["ok"] assert response["message"]["text"] == "Hello world!" ``` Note: Any attributes or methods prefixed with _underscores are intended to be "private" internal use only. They may be changed or removed at anytime. N)app_id request_idrrreturncKs@|r |d|in|r|d|intd|jd|dS)aApprove an app for installation on a workspace. Either app_id or request_id is required. These IDs can be obtained either directly via the app_requested event, or by the admin.apps.requests.list method. Args: app_id (str): The id of the app to approve. e.g. 'A12345' request_id (str): The id of the request to approve. e.g. 'Ar12345' Raises: SlackRequestError: If neither or both the `app_id` and `request_id` args are specified. rrz4The app_id or request_id argument must be specified.zadmin.apps.approvejson)updateeSlackRequestErrorapi_call)selfrrkwargsrQ/var/www/html/humari/django-venv/lib/python3.10/site-packages/slack/web/client.pyadmin_apps_approveEszWebClient.admin_apps_approvecK|jdd|dS)z+List approved apps for an org or workspace.zadmin.apps.approved.listGET http_verbparamsrrrrrradmin_apps_approved_list_z"WebClient.admin_apps_approved_listcKr)z'List app requests for a team/workspace.zadmin.apps.requests.listrrr!r"rrradmin_apps_requests_listcr$z"WebClient.admin_apps_requests_listcK|jd|dS)z0Restrict an app for installation on a workspace.zadmin.apps.restrictrr!r"rrradmin_apps_restrictgzWebClient.admin_apps_restrictcKr)z-List restricted apps for an org or workspace.zadmin.apps.restricted.listrrr!r"rrradmin_apps_restricted_listksz$WebClient.admin_apps_restricted_list is_privatenamecK|||d|jd|dS)a@Create a public or private channel-based conversation. Args: is_private (bool): When true, creates a private channel instead of a public channel name (str): Name of the public or private channel to create. org_wide (bool): When true, the channel will be available org-wide. Note: if the channel is not org_wide=true, you must specify a team_id for this channel team_id (str): The workspace to create the channel in. Note: this argument is required unless you set org_wide=true. )r*r+zadmin.conversations.createrrr)rr*r+rrrradmin_conversations_createqsz$WebClient.admin_conversations_create channel_idcK|d|i|jd|dS)zqDelete a public or private channel. Args: channel_id (str): The channel to delete. r/zadmin.conversations.deleterr-rr/rrrradmin_conversations_delete z$WebClient.admin_conversations_deleteuser_idscKJ|d|it|tr|dd|in|d|i|jd|dS)zInvite a user to a public or private channel. Args: channel_id (str): The channel that the users will be invited to. user_ids (str or list): The users to invite. r/r4,zadmin.conversations.inviter r isinstancelistjoinr)rr/r4rrrradmin_conversations_invites  z$WebClient.admin_conversations_invitecKr0)zrArchive a public or private channel. Args: channel_id (str): The channel to archive. r/zadmin.conversations.archiverr-r1rrradmin_conversations_archivez%WebClient.admin_conversations_archivecKr0)zvUnarchive a public or private channel. Args: channel_id (str): The channel to unarchive. r/zadmin.conversations.unarchiverr-r1rrradmin_conversations_unarchiver>z'WebClient.admin_conversations_unarchivecKr,)zRename a public or private channel. Args: channel_id (str): The channel to rename. name (str): The name to rename the channel to. )r/r+zadmin.conversations.renamerr-)rr/r+rrrradmin_conversations_rename z$WebClient.admin_conversations_renamecKr&)zDSearch for public or private channels in an Enterprise organization.zadmin.conversations.searchrr!r"rrradmin_conversations_searchr(z$WebClient.admin_conversations_searchcKr0)zConvert a public channel to a private channel. Args: channel_id (str): The channel to convert to private. r/z$admin.conversations.convertToPrivaterr-r1rrr$admin_conversations_convertToPrivater>z.WebClient.admin_conversations_convertToPrivateprefscKr,)zSet the posting permissions for a public or private channel. Args: channel_id (str): The channel to set the prefs for prefs (str or dict): The prefs for this channel in a stringified JSON format. )r/rDz(admin.conversations.setConversationPrefsrr-)rr/rDrrrr(admin_conversations_setConversationPrefsrAz2WebClient.admin_conversations_setConversationPrefscKr0)zGet conversation preferences for a public or private channel. Args: channel_id (str): The channel to get the preferences for. r/z(admin.conversations.getConversationPrefsrr-r1rrr(admin_conversations_getConversationPrefsr>z2WebClient.admin_conversations_getConversationPrefscKr0)zDisconnect a connected channel from one or more workspaces. Args: channel_id (str): The channel to be disconnected from some workspaces. r/z$admin.conversations.disconnectSharedrr-r1rrr$admin_conversations_disconnectSharedr>z.WebClient.admin_conversations_disconnectSharedcKr&)uList all disconnected channels—i.e., channels that were once connected to other workspaces and then disconnected—and the corresponding original channel IDs for key revocation with EKM. z8admin.conversations.ekm.listOriginalConnectedChannelInfor7r!r"rrr8admin_conversations_ekm_listOriginalConnectedChannelInfoszBWebClient.admin_conversations_ekm_listOriginalConnectedChannelInfogroup_idcK |||d|jdd|dS)a Add an allowlist of IDP groups for accessing a channel. Args: channel_id (str): The channel to link this group to. e.g. 'C1234567890' group_id (str): The IDP Group ID to be an allowlist for the private channel. 'S0604QSJC' team_id (str): The workspace where the channel exists. This argument is required for channels only tied to one workspace, and optional for channels that are shared across an organization. e.g 'T1234' )r/rIz+admin.conversations.restrictAccess.addGrouprrr-)rr/rIrrrr+admin_conversations_restrictAccess_addGroups  z5WebClient.admin_conversations_restrictAccess_addGroupcK|d|i|jdd|dS)aList all IDP Groups linked to a channel. Args: channel_id (str): The channel to link this group to. e.g. 'C1234567890' team_id (str): The workspace where the channel exists. This argument is required for channels only tied to one workspace, and optional for channels that are shared across an organization. e.g 'T1234' r/z-admin.conversations.restrictAccess.listGroupsrrr-r1rrr-admin_conversations_restrictAccess_listGroupss  z7WebClient.admin_conversations_restrictAccess_listGroupsteam_idcKs"||||d|jdd|dS)a Remove a linked IDP group linked from a private channel. Args: channel_id (str): The channel to link this group to. e.g. 'C1234567890' group_id (str): The IDP Group ID to be an allowlist for the private channel. 'S0604QSJC' team_id (str): The workspace where the channel exists. This argument is required for channels only tied to one workspace, and optional for channels that are shared across an organization. e.g 'T1234' )r/rIrNz.admin.conversations.restrictAccess.removeGrouprrr-)rr/rIrNrrrr.admin_conversations_restrictAccess_removeGroup$s z8WebClient.admin_conversations_restrictAccess_removeGroupcKr0)zSet the workspaces in an Enterprise grid org that connect to a channel. Args: channel_id (str): The encoded channel_id to add or remove to workspaces. r/zadmin.conversations.setTeamsrr-r1rrradmin_conversations_setTeams:r3z&WebClient.admin_conversations_setTeamscKr0)zSet the workspaces in an Enterprise grid org that connect to a channel. Args: channel_id (str): The channel to determine connected workspaces within the organization for. r/zadmin.conversations.getTeamsrr-r1rrradmin_conversations_getTeamsFr3z&WebClient.admin_conversations_getTeamscKr)z Add an emoji.zadmin.emoji.addrrr!r"rrradmin_emoji_addRr$zWebClient.admin_emoji_addcKr)zAdd an emoji alias.zadmin.emoji.addAliasrrr!r"rrradmin_emoji_addAliasVr$zWebClient.admin_emoji_addAliascKr)z/List emoji for an Enterprise Grid organization.zadmin.emoji.listrrr!r"rrradmin_emoji_listZr$zWebClient.admin_emoji_listcKr)z7Remove an emoji across an Enterprise Grid organization.zadmin.emoji.removerrr!r"rrradmin_emoji_remove^r$zWebClient.admin_emoji_removecKr)zRename an emoji.zadmin.emoji.renamerrr!r"rrradmin_emoji_renamebr$zWebClient.admin_emoji_renameuser_idcKr0)zWipes all valid sessions on all devices for a given user. Args: user_id (str): The ID of the user to wipe sessions for. e.g. 'W12345678' rWzadmin.users.session.resetrr-)rrWrrrradmin_users_session_resetfr>z#WebClient.admin_users_session_reset session_idcKr,)zInvalidate a single session for a user by session_id. Args: session_id (str): The ID of a session team_id (str): ID of the team that the session belongs to )rYrNzadmin.users.session.invalidater7r-)rrYrNrrrradmin_users_session_invalidateqrAz(WebClient.admin_users_session_invalidateinvite_request_idcKr0)zApprove a workspace invite request. team_id is required if your Enterprise Grid org contains more than one workspace. Args: invite_request_id (str): ID of the request to invite. e.g. 'Ir1234' r[zadmin.inviteRequests.approverr-rr[rrrradmin_inviteRequests_approve}s z&WebClient.admin_inviteRequests_approvecKr&)z,List all approved workspace invite requests.z"admin.inviteRequests.approved.listrr!r"rrr"admin_inviteRequests_approved_listz,WebClient.admin_inviteRequests_approved_listcKr&)z*List all denied workspace invite requests.z admin.inviteRequests.denied.listrr!r"rrr admin_inviteRequests_denied_listr_z*WebClient.admin_inviteRequests_denied_listcKr0)zDeny a workspace invite request. Args: invite_request_id (str): ID of the request to invite. e.g. 'Ir1234' r[zadmin.inviteRequests.denyrr-r\rrradmin_inviteRequests_denyr>z#WebClient.admin_inviteRequests_denycKr&)z+List all pending workspace invite requests.zadmin.inviteRequests.listrr!r"rrradmin_inviteRequests_listr(z#WebClient.admin_inviteRequests_listcKrL)oList all of the admins on a given workspace. Args: team_id (str): ID of the team. rNzadmin.teams.admins.listrrr-rrNrrrradmin_teams_admins_listz!WebClient.admin_teams_admins_list team_domain team_namecKr,)zCreate an Enterprise team. Args: team_domain (str): Team domain. e.g. 'slacksoftballteam' team_name (str): Team name. e.g. 'Slack Softball Team' )rgrhzadmin.teams.createrr-)rrgrhrrrradmin_teams_createrAzWebClient.admin_teams_createcKr&)z-List all teams on an Enterprise organization.zadmin.teams.listrr!r"rrradmin_teams_listr(zWebClient.admin_teams_listcKrL)rcrNzadmin.teams.owners.listrrr-rdrrradmin_teams_owners_listrfz!WebClient.admin_teams_owners_listcKr0)zrFetch information about settings in a workspace Args: team_id (str): ID of the team. rNzadmin.teams.settings.inforr-rdrrradmin_teams_settings_infor>z#WebClient.admin_teams_settings_info channel_idscKsL|d|it|tr|dd|in|d|i|jdd|dS)zSet the default channels of a workspace. Args: team_id (str): ID of the team. channel_ids (str or list): A list of channel_ids. At least one channel is required. e.g. ['C1A2B3C4D', 'C26Z25Y24'] rNrmr6z'admin.teams.settings.setDefaultChannelsrrr8)rrNrmrrrr'admin_teams_settings_setDefaultChannelss z1WebClient.admin_teams_settings_setDefaultChannels descriptioncKr,)zSet the description of a given workspace. Args: team_id (str): ID of the team. description (str): Description of the team. )rNroz#admin.teams.settings.setDescriptionrr-)rrNrorrrr#admin_teams_settings_setDescriptionrAz-WebClient.admin_teams_settings_setDescriptiondiscoverabilitycKr,)zSets the icon of a workspace. Args: team_id (str): ID of the team. discoverability (str): This workspace's discovery setting. It must be set to one of open, invite_only, closed, or unlisted. )rNrqz'admin.teams.settings.setDiscoverabilityrr-)rrNrqrrrr'admin_teams_settings_setDiscoverabilitys z1WebClient.admin_teams_settings_setDiscoverability image_urlcKrJ)zSets the icon of a workspace. Args: team_id (str): ID of the team. image_url (str): Url of the icon. )rNrszadmin.teams.settings.setIconrrr-)rrNrsrrrradmin_teams_settings_setIcons z&WebClient.admin_teams_settings_setIconcKr,)zSets the icon of a workspace. Args: team_id (str): ID of the team. name (str): Name of the team. )rNr+zadmin.teams.settings.setNamerr-)rrNr+rrrradmin_teams_settings_setNamerAz&WebClient.admin_teams_settings_setName usergroup_idcKL|||dt|tr|dd|in|d|i|jd|dS)alAdd one or more default channels to an IDP group. Args: team_id (str): The workspace to add default channels in. e.g. 'T1234' usergroup_id (str): ID of the IDP group to add default channels for. e.g. 'S1234' channel_ids (str or list): Comma separated string of channel IDs. e.g. 'C123,C234' or ['C123', 'C234'] )rNrvrmr6zadmin.usergroups.addChannelsrr8)rrNrvrmrrrradmin_usergroups_addChannelss  z&WebClient.admin_usergroups_addChannelsteam_idscKr5)aAssociate one or more default workspaces with an organization-wide IDP group. Args: usergroup_id (str): ID of the IDP group. e.g. 'S1234' team_ids (str or list): A comma separated list of encoded team (workspace) IDs. Each workspace MUST belong to the organization associated with the token. e.g. 'T12345678,T98765432' or ['T12345678', 'T98765432'] rvryr6zadmin.usergroups.addTeamsrr8)rrvryrrrradmin_usergroups_addTeams2  z#WebClient.admin_usergroups_addTeamscKr0)zAdd one or more default channels to an IDP group. Args: usergroup_id (str): ID of the IDP group to list default channels for. e.g. 'S1234' rvzadmin.usergroups.listChannelsrr-)rrvrrrradmin_usergroups_listChannelsDr>z'WebClient.admin_usergroups_listChannelscKr5)zAdd one or more default channels to an IDP group. Args: usergroup_id (str): ID of the IDP group. e.g. 'S1234' channel_ids (str or list): Comma separated string of channel IDs. e.g. 'C123,C234' or ['C123', 'C234'] rvrmr6zadmin.usergroups.removeChannelsrr8)rrvrmrrrradmin_usergroups_removeChannelsO  z)WebClient.admin_usergroups_removeChannelscKr,)zAdd an Enterprise user to a workspace. Args: team_id (str): ID of the team. e.g. 'T1234' user_id (str): ID of the user to add to the workspace. rNrWzadmin.users.assignrr-rrNrWrrrradmin_users_assign_rAzWebClient.admin_users_assignemailcKrw)alInvite a user to a workspace. Args: team_id (str): ID of the team. e.g. 'T1234' email (str): The email address of the person to invite. e.g. 'joe@email.com' channel_ids (str or list): A list of channel_ids for this user to join. At least one channel is required. e.g. ['C1A2B3C4D', 'C26Z25Y24'] )rNrrmr6zadmin.users.inviterr8)rrNrrmrrrradmin_users_inviteks  zWebClient.admin_users_invitecKr0)ziList users on a workspace Args: team_id (str): ID of the team. e.g. 'T1234' rNzadmin.users.listrr-rdrrradmin_users_list}r>zWebClient.admin_users_listcKr,)zRemove a user from a workspace. Args: team_id (str): ID of the team. e.g. 'T1234' user_id (str): The ID of the user to remove. e.g. 'W12345678' rzadmin.users.removerr-rrrradmin_users_removerAzWebClient.admin_users_removecKr,)zSet an existing guest, regular user, or owner to be an admin user. Args: team_id (str): ID of the team. e.g. 'T1234' user_id (str): The ID of the user to remove. e.g. 'W12345678' rzadmin.users.setAdminrr-rrrradmin_users_setAdminrAzWebClient.admin_users_setAdmin expiration_tscK ||||d|jd|dS)a0Set an expiration for a guest user. Args: expiration_ts (int): Timestamp when guest account should be disabled. e.g. '1234567890' team_id (str): ID of the team. e.g. 'T1234' user_id (str): The ID of the user to set an expiration for. e.g. 'W12345678' )rrNrWzadmin.users.setExpirationrr-)rrrNrWrrrradmin_users_setExpirations z#WebClient.admin_users_setExpirationcKr,)zSet an existing guest, regular user, or admin user to be a workspace owner. Args: team_id (str): ID of the team. e.g. 'T1234' user_id (str): The ID of the user to remove. e.g. 'W12345678' rzadmin.users.setOwnerrr-rrrradmin_users_setOwnerrAzWebClient.admin_users_setOwnercKr,)zSet an existing guest user, admin user, or owner to be a regular user. Args: team_id (str): ID of the team. e.g. 'T1234' user_id (str): The ID of the user to remove. e.g. 'W12345678' rzadmin.users.setRegularrr-rrrradmin_users_setRegularrAz WebClient.admin_users_setRegularcKr&)zChecks API calling code.zapi.testrr!r"rrrapi_testr(zWebClient.api_test event_contextcKr0)a'Get a list of authorizations for the given event context. Each authorization represents an app installation that the event is visible to. Args: event_context (str): You'll receive an event_context identifying an event in each event payload sent to your app. rzapps.event.authorizations.listr7r-)rrrrrrapps_event_authorizations_listr3z(WebClient.apps_event_authorizations_list client_id client_secretcKr,)aUninstalls your app from a workspace. Args: client_id (str): Issued when you created your application. e.g. '56579136444.26251006572' client_secret (str): Issued when you created your application. e.g. 'f25b5ceaf8a3c2a2c4f52bb4f0b0499e' rrzapps.uninstallr7r-)rrrrrrrapps_uninstallrAzWebClient.apps_uninstallcKr)zRevokes a token.z auth.revokerrr!r"rrr auth_revoker$zWebClient.auth_revokecKr&)z!Checks authentication & identity.z auth.testrr!r"rrr auth_testr(zWebClient.auth_testcKr)z"Gets information about a bot user.z bots.inforrr!r"rrr bots_infor$zWebClient.bots_infoexternal_unique_idjoin_urlcKs0|||dt||d|jdd|dS)aRegisters a new Call. Args: external_unique_id (str): An ID supplied by the 3rd-party Call provider. It must be unique across all Calls from that service. e.g. '025169F6-E37A-4E62-BB54-7F93A0FC4C1F' join_url (str): The URL required for a client to join the Call. e.g. 'https://example.com/calls/1234567890' )rrusersz calls.addPOSTr)rr getr)rrrrrrr calls_adds zWebClient.calls_addidcKrL)z|Ends a Call. Args: id (str): id returned when registering the call using the calls.add method. rz calls.endrrr-rrrrrr calls_endrfzWebClient.calls_endcKrL)zReturns information about a Call. Args: id (str): id returned when registering the call using the calls.add method. rz calls.inforrr-rrrr calls_info rfzWebClient.calls_inforcK(|d|it|||jdd|dS)zRegisters new participants added to a Call. Args: id (str): id returned when registering the call using the calls.add method. users: (list): The list of users to add as participants in the Call. rzcalls.participants.addrrrr rrrrrrrrcalls_participants_adds z WebClient.calls_participants_addcKr)zRegisters participants removed from a Call. Args: id (str): id returned when registering the call using the calls.add method. users: (list): The list of users to remove as participants in the Call. rzcalls.participants.removerrrrrrrcalls_participants_remove&s  z#WebClient.calls_participants_removecKrL)ztUpdates information about a Call. Args: id (str): id returned by the calls.add method. rz calls.updaterrr-rrrr calls_update9rfzWebClient.calls_updatechannelcKr0)ziArchives a channel. Args: channel (str): The channel id. e.g. 'C1234567890' rzchannels.archiverr-rrrrrrchannels_archiveDr>zWebClient.channels_archivecKr0)zlCreates a channel. Args: name (str): The name of the channel. e.g. 'mychannel' r+zchannels.createrr-rr+rrrrchannels_createOzWebClient.channels_createcKrL)zFetches history of messages and events from a channel. Args: channel (str): The channel id. e.g. 'C1234567890' rzchannels.historyrrr-rrrrchannels_historyXrfzWebClient.channels_historycKrL)zwGets information about a channel. Args: channel (str): The channel id. e.g. 'C1234567890' rz channels.inforrr-rrrr channels_infoczWebClient.channels_infousercKr,)zInvites a user to a channel. Args: channel (str): The channel id. e.g. 'C1234567890' user (str): The user id. e.g. 'U1234567890' rrzchannels.inviterr-rrrrrrrchannels_invitelrAzWebClient.channels_invitecKr0)zyJoins a channel, creating it if needed. Args: name (str): The channel name. e.g. '#general' r+z channels.joinrr-rrrr channels_joinxrzWebClient.channels_joincKr,)zRemoves a user from a channel. Args: channel (str): The channel id. e.g. 'C1234567890' user (str): The user id. e.g. 'U1234567890' rz channels.kickrr-rrrr channels_kickrAzWebClient.channels_kickcKr0)zgLeaves a channel. Args: channel (str): The channel id. e.g. 'C1234567890' rzchannels.leaverr-rrrrchannels_leaverzWebClient.channels_leavecKr)#Lists all channels in a Slack team.z channels.listrrr!r"rrr channels_listr$zWebClient.channels_listtscKr,)zSets the read cursor in a channel. Args: channel (str): The channel id. e.g. 'C1234567890' ts (str): Timestamp of the most recently seen message. e.g. '1234567890.123456' rrz channels.markrr-rrrrrrr channels_markrAzWebClient.channels_markcKr,)zRenames a channel. Args: channel (str): The channel id. e.g. 'C1234567890' name (str): The new channel name. e.g. 'newchannel' rr+zchannels.renamerr-rrr+rrrrchannels_renamerAzWebClient.channels_rename thread_tscKrJ)a Retrieve a thread of messages posted to a channel Args: channel (str): The channel id. e.g. 'C1234567890' thread_ts (str): The timestamp of an existing message with 0 or more replies. e.g. '1234567890.123456' rrzchannels.repliesrrr-rrrrrrrchannels_replies zWebClient.channels_repliespurposecKr,)zSets the purpose for a channel. Args: channel (str): The channel id. e.g. 'C1234567890' purpose (str): The new purpose for the channel. e.g. 'My Purpose' rrzchannels.setPurposerr-rrrrrrrchannels_setPurposerAzWebClient.channels_setPurposetopiccKr,)zSets the topic for a channel. Args: channel (str): The channel id. e.g. 'C1234567890' topic (str): The new topic for the channel. e.g. 'My Topic' rrzchannels.setTopicrr-rrrrrrrchannels_setTopicrAzWebClient.channels_setTopiccKr0)zkUnarchives a channel. Args: channel (str): The channel id. e.g. 'C1234567890' rzchannels.unarchiverr-rrrrchannels_unarchiver>zWebClient.channels_unarchivecKr,)zDeletes a message. Args: channel (str): Channel containing the message to be deleted. e.g. 'C1234567890' ts (str): Timestamp of the message to be deleted. e.g. '1234567890.123456' rz chat.deleterr-rrrr chat_deleterAzWebClient.chat_deletescheduled_message_idcKr,)a Deletes a scheduled message. Args: channel (str): The channel the scheduled_message is posting to. e.g. 'C1234567890' scheduled_message_id (str): scheduled_message_id returned from call to chat.scheduleMessage e.g. 'Q1234ABCD' )rrzchat.deleteScheduledMessagerr-)rrrrrrrchat_deleteScheduledMessages z%WebClient.chat_deleteScheduledMessage message_tscKrJ)zRetrieve a permalink URL for a specific extant message Args: channel (str): The channel id. e.g. 'C1234567890' message_ts (str): The timestamp. e.g. '1234567890.123456' )rrzchat.getPermalinkrrr-)rrrrrrrchat_getPermalink zWebClient.chat_getPermalinktextcKr,)zShare a me message into a channel. Args: channel (str): The channel id. e.g. 'C1234567890' text (str): The message you'd like to share. e.g. 'Hello world' )rrzchat.meMessagerr-)rrrrrrrchat_meMessagerAzWebClient.chat_meMessagecK&|||dt||jd|dS)a=Sends an ephemeral message to a user in a channel. Args: channel (str): The channel id. e.g. 'C1234567890' user (str): The id of user who should see the message. e.g. 'U0BPQUNTA' text (str): The message you'd like to share. e.g. 'Hello world' text is not required when presenting blocks. blocks (list): A dictionary list of blocks. Blocks are required when not presenting text. e.g. [{"type": "section", "text": {"type": "plain_text", "text": "Hello world"}}] rzchat.postEphemeralrrr rrrrrchat_postEphemeralzWebClient.chat_postEphemeralcKs$|d|it||jd|dS)aSends a message to a channel. Args: channel (str): The channel id. e.g. 'C1234567890' text (str): The message you'd like to share. e.g. 'Hello world' text is not required when presenting blocks. blocks (list): A dictionary list of blocks. Blocks are required when not presenting text. e.g. [{"type": "section", "text": {"type": "plain_text", "text": "Hello world"}}] rzchat.postMessagerrrrrrchat_postMessage&s zWebClient.chat_postMessagepost_atcKs(||||dt||jd|dS)a>Schedules a message. Args: channel (str): The channel the scheduled_message is posting to. e.g. 'C1234567890' post_at (str): Unix EPOCH timestamp of time in future to send the message. e.g. '299876400' text (str): The message you'd like to send. e.g. 'Hello world' )rrrzchat.scheduleMessagerr)rrrrrrrrchat_scheduleMessage7s zWebClient.chat_scheduleMessageunfurlscKr)aProvide custom unfurl behavior for user-posted URLs. Args: channel (str): The Channel ID of the message. e.g. 'C1234567890' ts (str): Timestamp of the message to add unfurl behavior to. e.g. '1234567890.123456' unfurls (dict): a dict of the specific URLs you're offering an unfurl for. e.g. {"https://example.com/": {"text": "Every day is the test."}} )rrrz chat.unfurlrr-)rrrrrrrr chat_unfurlEs zWebClient.chat_unfurlcKr)aOUpdates a message in a channel. Args: channel (str): The channel containing the message to be updated. e.g. 'C1234567890' ts (str): Timestamp of the message to be updated. e.g. '1234567890.123456' text (str): The message you'd like to share. e.g. 'Hello world' text is not required when presenting blocks. blocks (list): A dictionary list of blocks. Blocks are required when not presenting text. e.g. [{"type": "section", "text": {"type": "plain_text", "text": "Hello world"}}] rz chat.updaterrrrrr chat_updateSrzWebClient.chat_updatecKr&)zLists all scheduled messages.zchat.scheduledMessages.listrr!r"rrrchat_scheduledMessages_lister(z%WebClient.chat_scheduledMessages_listcKr0)znArchives a conversation. Args: channel (str): The channel id. e.g. 'C1234567890' rzconversations.archiverr-rrrrconversations_archiveir>zWebClient.conversations_archivecKr0)zCloses a direct message or multi-person direct message. Args: channel (str): The channel id. e.g. 'C1234567890' rzconversations.closerr-rrrrconversations_closetr>zWebClient.conversations_closecKr0)zInitiates a public or private channel-based conversation Args: name (str): The name of the channel. e.g. 'mychannel' r+zconversations.createrr-rrrrconversations_creater>zWebClient.conversations_createcKrL)zFetches a conversation's history of messages and events. Args: channel (str): The channel id. e.g. 'C1234567890' rzconversations.historyrrr-rrrrconversations_historyrfzWebClient.conversations_historycKrL)zRetrieve information about a conversation. Args: channel (str): The channel id. e.g. 'C1234567890' rzconversations.inforrr-rrrrconversations_inforfzWebClient.conversations_infocKr5)zInvites users to a channel. Args: channel (str): The channel id. e.g. 'C1234567890' users (str or list): An list of user id's to invite. e.g. ['U2345678901', 'U3456789012'] rrr6zconversations.inviterr8)rrrrrrrconversations_inviter~zWebClient.conversations_invitecKr0)zuJoins an existing conversation. Args: channel (str): The channel id. e.g. 'C1234567890' rzconversations.joinrr-rrrrconversations_joinr>zWebClient.conversations_joincKr,)zRemoves a user from a conversation. Args: channel (str): The channel id. e.g. 'C1234567890' user (str): The id of the user to kick. e.g. 'U2345678901' rzconversations.kickrr-rrrrconversations_kickrAzWebClient.conversations_kickcKr0)zlLeaves a conversation. Args: channel (str): The channel id. e.g. 'C1234567890' rzconversations.leaverr-rrrrconversations_leaver>zWebClient.conversations_leavecKr)rzconversations.listrrr!r"rrrconversations_listr$zWebClient.conversations_listcKr,)aSets the read cursor in a channel. Args: channel (str): Channel or conversation to set the read cursor for e.g. 'C1234567890' ts (str): Unique identifier of message to mark as most recently seen in the convo e.g. '1593473566.000200' rzconversations.markrr-rrrrconversations_markrAzWebClient.conversations_markcKrL)zyRetrieve members of a conversation. Args: channel (str): The channel id. e.g. 'C1234567890' rzconversations.membersrrr-rrrrconversations_membersrfzWebClient.conversations_memberscKr&)zAOpens or resumes a direct message or multi-person direct message.zconversations.openrr!r"rrrconversations_openr(zWebClient.conversations_opencKr,)zRenames a conversation. Args: channel (str): The channel id. e.g. 'C1234567890' name (str): The new channel name. e.g. 'newchannel' rzconversations.renamerr-rrrrconversations_renamerAzWebClient.conversations_renamecKrJ)aRetrieve a thread of messages posted to a conversation Args: channel (str): Conversation ID to fetch thread from. e.g. 'C1234567890' ts (str): Unique identifier of a thread's parent message. e.g. '1234567890.123456' rzconversations.repliesrrr-rrrrconversations_repliesrzWebClient.conversations_repliescKr,)zSets the purpose for a conversation. Args: channel (str): The channel id. e.g. 'C1234567890' purpose (str): The new purpose for the channel. e.g. 'My Purpose' rzconversations.setPurposerr-rrrrconversations_setPurpose rAz"WebClient.conversations_setPurposecKr,)zSets the topic for a conversation. Args: channel (str): The channel id. e.g. 'C1234567890' topic (str): The new topic for the channel. e.g. 'My Topic' rzconversations.setTopicrr-rrrrconversations_setTopicrAz WebClient.conversations_setTopiccKr0)zuReverses conversation archival. Args: channel (str): The channel id. e.g. 'C1234567890' rzconversations.unarchiverr-rrrrconversations_unarchive!r>z!WebClient.conversations_unarchivedialog trigger_idcKr,)aOpen a dialog with a user. Args: dialog (dict): A dictionary of dialog arguments. { "callback_id": "46eh782b0", "title": "Request something", "submit_label": "Request", "state": "Max", "elements": [ { "type": "text", "label": "Origin", "name": "loc_origin" }, { "type": "text", "label": "Destination", "name": "loc_destination" } ] } trigger_id (str): The trigger id of a recent message interaction. e.g. '12345.98765.abcd2358fdea' )rrz dialog.openrr-)rrrrrrr dialog_open,szWebClient.dialog_opencKr&)z;Ends the current user's Do Not Disturb session immediately.z dnd.endDndrr!r"rrr dnd_endDndKr(zWebClient.dnd_endDndcKr&)z0Ends the current user's snooze mode immediately.z dnd.endSnoozerr!r"rrr dnd_endSnoozeOr(zWebClient.dnd_endSnoozecKr)z1Retrieves a user's current Do Not Disturb status.zdnd.inforrr!r"rrrdnd_infoSr$zWebClient.dnd_info num_minutescKrL)zTurns on Do Not Disturb mode for the current user, or changes its duration. Args: num_minutes (int): The snooze duration. e.g. 60 rz dnd.setSnoozerrr-)rrrrrr dnd_setSnoozeWrfzWebClient.dnd_setSnoozecK>t|tr|dd|in|d|i|jdd|dS)zRetrieves the Do Not Disturb status for users on a team. Args: users (str or list): User IDs to fetch information e.g. 'U123,U234' or ["U123", "U234"] rr6z dnd.teamInforrr9r:rr;rrrrrrr dnd_teamInfobs zWebClient.dnd_teamInfocKr)zLists custom emoji for a team.z emoji.listrrr!r"rrr emoji_listpr$zWebClient.emoji_listfilecKr,)zDeletes an existing comment on a file. Args: file (str): The file id. e.g. 'F1234467890' id (str): The file comment id. e.g. 'Fc1234567890' )rrzfiles.comments.deleterr-)rrrrrrrfiles_comments_deletetrAzWebClient.files_comments_deletecKr0)z_Deletes a file. Args: file (str): The file id. e.g. 'F1234467890' rz files.deleterr-rrrrrr files_deleterzWebClient.files_deletecKrL)zsGets information about a team file. Args: file (str): The file id. e.g. 'F1234467890' rz files.inforrr-rrrr files_inforzWebClient.files_infocKr)zLists & filters team files.z files.listrrr!r"rrr files_listr$zWebClient.files_listcKr)8Retrieve information about a remote file added to Slack.zfiles.remote.inforrr!r"rrrfiles_remote_infor$zWebClient.files_remote_infocKr)rzfiles.remote.listrrr!r"rrrfiles_remote_listr$zWebClient.files_remote_list external_id external_urltitlecKs>||||dd}d|vrd|di}|jdd||dS)aOAdds a file from a remote service. Args: external_id (str): Creator defined GUID for the file. e.g. '123456' external_url (str): URL of the remote file. e.g. 'http://example.com/my_cloud_service_file/abc123' title (str): Title of the file being shared. e.g. 'Danger, High Voltage!' )rr r N preview_imagezfiles.remote.addr)rdatafiles)rpopr)rrr r rr rrrfiles_remote_adds zWebClient.files_remote_addcKr)z Updates an existing remote file.zfiles.remote.updaterrr!r"rrrfiles_remote_updater$zWebClient.files_remote_updatecKr)zRemove a remote file.zfiles.remote.removerrr!r"rrrfiles_remote_remover$zWebClient.files_remote_removechannelscKr)zShare a remote file into a channel. Args: channels (str or list): Comma-separated list of channel IDs where the file will be shared. e.g. ['C1234567890', 'C2345678901'] rr6zfiles.remote.sharerrr)rrrrrrfiles_remote_share zWebClient.files_remote_sharecKr0)zRevokes public/external sharing access for a file Args: file (str): The file id. e.g. 'F1234467890' rzfiles.revokePublicURLrr-rrrrfiles_revokePublicURLr>zWebClient.files_revokePublicURLcKr0)z{Enables a file for public/external sharing. Args: file (str): The file id. e.g. 'F1234467890' rzfiles.sharedPublicURLrr-rrrrfiles_sharedPublicURLr>zWebClient.files_sharedPublicURL)rcontentrcKs|dur |dur td|dur|durtd|r:d|vr0t|tr0|tjjd|d<|jdd|i|dS| }| d |i|jd|d S) aUploads or creates a file. Args: file (str): Supply a file path. when you'd like to upload a specific file. e.g. 'dramacat.gif' content (str): Supply content when you'd like to create an editable text file containing the specified text. e.g. 'launch plan' Raises: SlackRequestError: If niether or both the `file` and `content` args are specified. Nz/The file or content argument must be specified.z:You cannot specify both the file and the content argument.filenamez files.uploadrr r r)r ) rrr9strsplitospathseprcopyr)rrrrr rrr files_uploads zWebClient.files_uploadcKr0)zqArchives a private channel. Args: channel (str): The channel id. e.g. 'C1234567890' rzgroups.archiverr-rrrrgroups_archiverzWebClient.groups_archivecKr0)zzCreates a private channel. Args: name (str): The name of the private group. e.g. 'mychannel' r+z groups.createrr-rrrr groups_create rzWebClient.groups_createcKrL)zzClones and archives a private channel. Args: channel (str): The group id. e.g. 'G1234567890' rzgroups.createChildrrr-rrrrgroups_createChildrfzWebClient.groups_createChildcKrL)zFetches history of messages and events from a private channel. Args: channel (str): The group id. e.g. 'G1234567890' rzgroups.historyrrr-rrrrgroups_historyrzWebClient.groups_historycKrL)z}Gets information about a private channel. Args: channel (str): The group id. e.g. 'G1234567890' rz groups.inforrr-rrrr groups_info(rzWebClient.groups_infocKr,)zInvites a user to a private channel. Args: channel (str): The group id. e.g. 'G1234567890' user (str): The user id. e.g. 'U1234567890' rz groups.inviterr-rrrr groups_invite1rAzWebClient.groups_invitecKr,)zRemoves a user from a private channel. Args: channel (str): The group id. e.g. 'G1234567890' user (str): The user id. e.g. 'U1234567890' rz groups.kickrr-rrrr groups_kick=rAzWebClient.groups_kickcKr0)zmLeaves a private channel. Args: channel (str): The group id. e.g. 'G1234567890' rz groups.leaverr-rrrr groups_leaveIrzWebClient.groups_leavecKr)z;Lists private channels that the calling user has access to.z groups.listrrr!r"rrr groups_listRr$zWebClient.groups_listcKr,)zSets the read cursor in a private channel. Args: channel (str): Private channel to set reading cursor in. e.g. 'C1234567890' ts (str): Timestamp of the most recently seen message. e.g. '1234567890.123456' rz groups.markrr-rrrr groups_markVrAzWebClient.groups_markcKr0)znOpens a private channel. Args: channel (str): The channel id. e.g. 'C1234567890' rz groups.openrr-rrrr groups_openbrzWebClient.groups_opencKr,)zRenames a private channel. Args: channel (str): The channel id. e.g. 'C1234567890' name (str): The new channel name. e.g. 'newchannel' rz groups.renamerr-rrrr groups_renamekrAzWebClient.groups_renamecKrJ)aRetrieve a thread of messages posted to a private channel Args: channel (str): The channel id. e.g. 'C1234567890' thread_ts (str): The timestamp of an existing message with 0 or more replies. e.g. '1234567890.123456' rzgroups.repliesrrr-rrrrgroups_replieswrzWebClient.groups_repliescKr,)zSets the purpose for a private channel. Args: channel (str): The channel id. e.g. 'G1234567890' purpose (str): The new purpose for the channel. e.g. 'My Purpose' rzgroups.setPurposerr-rrrrgroups_setPurposerAzWebClient.groups_setPurposecKr,)zSets the topic for a private channel. Args: channel (str): The channel id. e.g. 'G1234567890' topic (str): The new topic for the channel. e.g. 'My Topic' rzgroups.setTopicrr-rrrrgroups_setTopicrAzWebClient.groups_setTopiccKr0)zsUnarchives a private channel. Args: channel (str): The channel id. e.g. 'G1234567890' rzgroups.unarchiverr-rrrrgroups_unarchiver>zWebClient.groups_unarchivecKr0)zClose a direct message channel. Args: channel (str): Direct message channel to close. e.g. 'D1234567890' rzim.closerr-rrrrim_closerzWebClient.im_closecKrL)zFetches history of messages and events from direct message channel. Args: channel (str): Direct message channel to fetch history from. e.g. 'D1234567890' rz im.historyrrr-rrrr im_historyrzWebClient.im_historycKr)z3Lists direct message channels for the calling user.zim.listrrr!r"rrrim_listr$zWebClient.im_listcKr,)aSets the read cursor in a direct message channel. Args: channel (str): Direct message channel to set reading cursor in. e.g. 'D1234567890' ts (str): Timestamp of the most recently seen message. e.g. '1234567890.123456' rzim.markrr-rrrrim_markrAzWebClient.im_markcKr0)zOpens a direct message channel. Args: user (str): The user id to open a DM with. e.g. 'W1234567890' rzim.openrr-rrrrrrim_openrzWebClient.im_opencKrJ)a;Retrieve a thread of messages posted to a direct message conversation Args: channel (str): Direct message channel to fetch thread from. e.g. 'C1234567890' thread_ts (str): The timestamp of an existing message with 0 or more replies. e.g. '1234567890.123456' rz im.repliesrrr-rrrr im_repliesrzWebClient.im_repliescKr)zFor Enterprise Grid workspaces, map local user IDs to global user IDs Args: users (str or list): A list of user ids, up to 400 per request. e.g. ['W1234567890', 'U2345678901', 'U3456789012'] rr6zmigration.exchangerrrrrrrmigration_exchangerzWebClient.migration_exchangecKr0)zCloses a multiparty direct message channel. Args: channel (str): Multiparty Direct message channel to close. e.g. 'G1234567890' rz mpim.closerr-rrrr mpim_closerzWebClient.mpim_closecKrL)zFetches history of messages and events from a multiparty direct message. Args: channel (str): Multiparty direct message to fetch history for. e.g. 'G1234567890' rz mpim.historyrrr-rrrr mpim_historyrzWebClient.mpim_historycKr)z>Lists multiparty direct message channels for the calling user.z mpim.listrrr!r"rrr mpim_listr$zWebClient.mpim_listcKr,)a:Sets the read cursor in a multiparty direct message channel. Args: channel (str): Multiparty direct message channel to set reading cursor in. e.g. 'G1234567890' ts (str): Timestamp of the most recently seen message. e.g. '1234567890.123456' rz mpim.markrr-rrrr mpim_marks zWebClient.mpim_markcKs<t|tr|dd|in|d|i|jd|dS)aThis method opens a multiparty direct message. Args: users (str or list): A lists of user ids. The ordering of the users is preserved whenever a MPIM group is returned. e.g. ['W1234567890', 'U2345678901', 'U3456789012'] rr6z mpim.openrrrrrr mpim_opens zWebClient.mpim_opencKrJ)asRetrieve a thread of messages posted to a direct message conversation from a multiparty direct message. Args: channel (str): Multiparty direct message channel to fetch thread from. e.g. 'G1234567890' thread_ts (str): Unique identifier of a thread's parent message. e.g. '1234567890.123456' rz mpim.repliesrrr-rrrr mpim_replies"s zWebClient.mpim_replies) redirect_uricoder@cK:|dur |d|i|d|i|jd|||ddS)Exchanges a temporary OAuth verifier code for an access token. Args: client_id (str): Issued when you created your application. e.g. '4b39e9-752c4' client_secret (str): Issued when you created your application. e.g. '33fea0113f5b1' code (str): The code param returned via the OAuth callback. e.g. 'ccdaa72ad' redirect_uri (optional str): Must match the originally submitted URI (if one was sent). e.g. 'https://example.com' Nr@rAzoauth.v2.accessrr authr-rrrrAr@rrrroauth_v2_access1zWebClient.oauth_v2_accesscKrB)rCNr@rAz oauth.accessrrDr-rFrrr oauth_accessLrHzWebClient.oauth_accesscKr0)aSPins an item to a channel. Args: channel (str): Channel to pin the item in. e.g. 'C1234567890' file (str): File id to pin. e.g. 'F1234567890' file_comment (str): File comment to pin. e.g. 'Fc1234567890' timestamp (str): Timestamp of message to pin. e.g. '1234567890.123456' rzpins.addrr-rrrrpins_addgr3zWebClient.pins_addcKrL)zLists items pinned to a channel. Args: channel (str): Channel to get pinned items for. e.g. 'C1234567890' rz pins.listrrr-rrrr pins_listsrzWebClient.pins_listcKr0)aXUn-pins an item from a channel. Args: channel (str): Channel to pin the item in. e.g. 'C1234567890' file (str): File id to pin. e.g. 'F1234567890' file_comment (str): File comment to pin. e.g. 'Fc1234567890' timestamp (str): Timestamp of message to pin. e.g. '1234567890.123456' rz pins.removerr-rrrr pins_remove|r3zWebClient.pins_removecKr0)aLAdds a reaction to an item. Args: name (str): Reaction (emoji) name. e.g. 'thumbsup' channel (str): Channel where the message to add reaction to was posted. e.g. 'C1234567890' timestamp (str): Timestamp of the message to add reaction to. e.g. '1234567890.123456' r+z reactions.addrr-rrrr reactions_addr3zWebClient.reactions_addcKr)zGets reactions for an item.z reactions.getrrr!r"rrr reactions_getr$zWebClient.reactions_getcKr)zLists reactions made by a user.zreactions.listrrr!r"rrrreactions_listr$zWebClient.reactions_listcKr0)zwRemoves a reaction from an item. Args: name (str): Reaction (emoji) name. e.g. 'thumbsup' r+zreactions.removerr-rrrrreactions_removerzWebClient.reactions_removetimecKr,)aCreates a reminder. Args: text (str): The content of the reminder. e.g. 'eat a banana' time (str): When this reminder should happen: the Unix timestamp (up to five years from now e.g. '1602288000'), the number of seconds until the reminder (if within 24 hours), or a natural language description (Ex. 'in 15 minutes' or 'every Thursday') )rrQz reminders.addrr-)rrrQrrrr reminders_adds zWebClient.reminders_addremindercKr0)zMarks a reminder as complete. Args: reminder (str): The ID of the reminder to be marked as complete. e.g. 'Rm12345678' rSzreminders.completerr-rrSrrrrreminders_completer3zWebClient.reminders_completecKr0)zqDeletes a reminder. Args: reminder (str): The ID of the reminder. e.g. 'Rm12345678' rSzreminders.deleterr-rTrrrreminders_deleter>zWebClient.reminders_deletecKrL)zGets information about a reminder. Args: reminder (str): The ID of the reminder. e.g. 'Rm12345678' rSzreminders.inforrr-rTrrrreminders_inforfzWebClient.reminders_infocKr)z3Lists all reminders created by or for a given user.zreminders.listrrr!r"rrrreminders_listr$zWebClient.reminders_listcKr)%Starts a Real Time Messaging session.z rtm.connectrrr!r"rrr rtm_connectr$zWebClient.rtm_connectcKr)rYz rtm.startrrr!r"rrr rtm_startr$zWebClient.rtm_startquerycKrL)zSearches for messages and files matching a query. Args: query (str): Search query. May contains booleans, etc. e.g. 'pickleface' r\z search.allrrr-rr\rrrr search_allzWebClient.search_allcKrL)zSearches for files matching a query. Args: query (str): Search query. May contains booleans, etc. e.g. 'pickleface' r\z search.filesrrr-r]rrr search_filesr_zWebClient.search_filescKrL)zSearches for messages matching a query. Args: query (str): Search query. May contains booleans, etc. e.g. 'pickleface' r\zsearch.messagesrrr-r]rrrsearch_messagesr_zWebClient.search_messagescKr&)aAdds a star to an item. Args: channel (str): Channel to add star to, or channel where the message to add star to was posted (used with timestamp). e.g. 'C1234567890' file (str): File to add star to. e.g. 'F1234567890' file_comment (str): File comment to add star to. e.g. 'Fc1234567890' timestamp (str): Timestamp of the message to add star to. e.g. '1234567890.123456' z stars.addrr!r"rrr stars_add zWebClient.stars_addcKr)zLists stars for a user.z stars.listrrr!r"rrr stars_list r$zWebClient.stars_listcKr&)aRemoves a star from an item. Args: channel (str): Channel to remove star from, or channel where the message to remove star from was posted (used with timestamp). e.g. 'C1234567890' file (str): File to remove star from. e.g. 'F1234567890' file_comment (str): File comment to remove star from. e.g. 'Fc1234567890' timestamp (str): Timestamp of the message to remove star from. e.g. '1234567890.123456' z stars.removerr!r"rrr stars_removerczWebClient.stars_removecKr)z*Gets the access logs for the current team.zteam.accessLogsrrr!r"rrrteam_accessLogsr$zWebClient.team_accessLogscKr)z5Gets billable users information for the current team.zteam.billableInforrr!r"rrrteam_billableInfo r$zWebClient.team_billableInfocKr)z(Gets information about the current team.z team.inforrr!r"rrr team_info$r$zWebClient.team_infocKr)z/Gets the integration logs for the current team.zteam.integrationLogsrrr!r"rrrteam_integrationLogs(r$zWebClient.team_integrationLogscKr)zRetrieve a team's profile.zteam.profile.getrrr!r"rrrteam_profile_get,r$zWebClient.team_profile_getcKr0)zCreate a User Group Args: name (str): A name for the User Group. Must be unique among User Groups. e.g. 'My Test Team' r+zusergroups.createrr-rrrrusergroups_create0szWebClient.usergroups_create usergroupcKr0)zDisable an existing User Group Args: usergroup (str): The encoded ID of the User Group to disable. e.g. 'S0604QSJC' rlzusergroups.disablerr-rrlrrrrusergroups_disable:r3zWebClient.usergroups_disablecKr0)zEnable a User Group Args: usergroup (str): The encoded ID of the User Group to enable. e.g. 'S0604QSJC' rlzusergroups.enablerr-rmrrrusergroups_enableFr3zWebClient.usergroups_enablecKr)zList all User Groups for a teamzusergroups.listrrr!r"rrrusergroups_listRr$zWebClient.usergroups_listcKr0)zUpdate an existing User Group Args: usergroup (str): The encoded ID of the User Group to update. e.g. 'S0604QSJC' rlzusergroups.updaterr-rmrrrusergroups_updateVr3zWebClient.usergroups_updatecKrL)zList all users in a User Group Args: usergroup (str): The encoded ID of the User Group to update. e.g. 'S0604QSJC' rlzusergroups.users.listrrr-rmrrrusergroups_users_listb zWebClient.usergroups_users_listcKr5)aHUpdate the list of users for a User Group Args: usergroup (str): The encoded ID of the User Group to update. e.g. 'S0604QSJC' users (str or list): A list user IDs that represent the entire list of users for the User Group. e.g. ['U060R4BJ4', 'U060RNRCZ'] rlrr6zusergroups.users.updaterr8)rrlrrrrrusergroups_users_updatenr{z!WebClient.usergroups_users_updatecKr)z/List conversations the calling user may access.zusers.conversationsrrr!r"rrrusers_conversationsr$zWebClient.users_conversationscKr)zDelete the user profile photozusers.deletePhotorrr!r"rrrusers_deletePhotor$zWebClient.users_deletePhotocKrL)zGets user presence information. Args: user (str): User to get presence info on. Defaults to the authed user. e.g. 'W1234567890' rzusers.getPresencerrr-r6rrrusers_getPresencer_zWebClient.users_getPresencecKr)zGet a user's identity.zusers.identityrrr!r"rrrusers_identityr$zWebClient.users_identitycKrL)zGets information about a user. Args: user (str): User to get info on. e.g. 'W1234567890' rz users.inforrr-r6rrr users_infor_zWebClient.users_infocKr)z Lists all users in a Slack team.z users.listrrr!r"rrr users_listr$zWebClient.users_listcKrL)zFind a user with an email address. Args: email (str): An email address belonging to a user in the workspace. e.g. 'spengler@ghostbusters.example.com' rzusers.lookupByEmailrrr-)rrrrrrusers_lookupByEmailrszWebClient.users_lookupByEmailimagecKs|jdd|i|dS)zSet the user profile photo Args: image (str): Supply the path of the image you'd like to upload. e.g. 'myimage.png' zusers.setPhotor|rr!)rr|rrrrusers_setPhotos zWebClient.users_setPhotopresencecKr0)ziManually sets user presence. Args: presence (str): Either 'auto' or 'away'. r~zusers.setPresencerr-)rr~rrrrusers_setPresencer>zWebClient.users_setPresencecKr)z'Retrieves a user's profile information.zusers.profile.getrrr!r"rrrusers_profile_getr$zWebClient.users_profile_getcKr&)z'Set the profile information for a user.zusers.profile.setrr!r"rrrusers_profile_setr(zWebClient.users_profile_setviewcKH|d|it|tr|d|in|d|i|jd|dS)a!Open a view for a user. See https://api.slack.com/block-kit/surfaces/modals for details. Args: trigger_id (str): Exchange a trigger to post to the user. e.g. '12345.98765.abcd2358fdea' view (dict or View): The view payload. rrz views.openrrr9r to_dictrrrrrrrr views_opens  zWebClient.views_opencKr)a8Push a view onto the stack of a root view. Push a new view onto the existing view stack by passing a view payload and a valid trigger_id generated from an interaction within the existing modal. Read the modals documentation (https://api.slack.com/block-kit/surfaces/modals) to learn more about the lifecycle and intricacies of views. Args: trigger_id (str): Exchange a trigger to post to the user. e.g. '12345.98765.abcd2358fdea' view (dict or View): The view payload. rrz views.pushrrrrrr views_pushs  zWebClient.views_push)rview_idrcKsl|r |d|in|r|d|intdt|tr(|d|in|d|i|jd|dS)aUpdate an existing view. Update a view by passing a new view definition along with the view_id returned in views.open or the external_id. See the modals documentation (https://api.slack.com/block-kit/surfaces/modals#updating_views) to learn more about updating views and avoiding race conditions with the hash argument. Args: view (dict or View): The view payload. external_id (str): A unique identifier of the view set by the developer. e.g. 'bmarley_view2' view_id (str): A unique identifier of the view to be updated. e.g. 'VMM512F2U' Raises: SlackRequestError: Either view_id or external_id is required. rrz*Either view_id or external_id is required.rz views.updater)rrrr9r rr)rrrrrrrr views_updates  zWebClient.views_updatecKr)a`Publish a static view for a User. Create or update the view that comprises an app's Home tab (https://api.slack.com/surfaces/tabs) for a specific user. Args: user_id (str): id of the user you want publish a view to. e.g. 'U0BPQUNTA' view (dict or View): The view payload. rWrz views.publishrr)rrWrrrrr views_publish s  zWebClient.views_publish)outputsworkflow_step_execute_idrcKs.|d|i|r|d|i|jd|dS)aTIndicate 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' } rrzworkflows.stepCompletedrr-)rrrrrrrworkflows_stepCompleted2 s z!WebClient.workflows_stepCompletederrorcKr,)a}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.' } )rrzworkflows.stepFailedrr-)rrrrrrrworkflows_stepFailedB s zWebClient.workflows_stepFailed)inputsrworkflow_step_edit_idrcKs@|d|i|r|d|i|r|d|i|jd|dS)a;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' }] rrrzworkflows.updateSteprr-)rrrrrrrrworkflows_updateStepQ s zWebClient.workflows_updateStep)__name__ __module__ __qualname____doc__rrrr rr#r%r'r)boolr.r2rr<r=r?r@rBrCdictrErFrGrHrKrMrOrPrQrRrSrTrUrVrXrZr]r^r`rarbrerirjrkrlrnrprrrtrurxrzr|r}rrrrrintrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrr!r"r#r$r%r&r'r(r)r*r+r,r-r.r/r0r1r2r3r4r5r7r8r9r:r;r<r=r>r?rrGrIrJrKrLrMrNrOrPrRrUrVrWrXrZr[r^r`rarbrdrerfrgrhrirjrkrnrorprqrrrtrurvrwrxryrzr{r}rrrr rrrrrrr:rrrrrr s68                                                                                                                                                                                                                                                                                              !                                          '       r )rrasyncioriortypingrrrr slack.errorserrorsrslack.web.base_clientrr slack.web.classes.viewsr slack.web.internal_utilsr r r rrrrs