From d03eae365fe6839e8095e5ce5153bb231a36b34a Mon Sep 17 00:00:00 2001 From: Inooid Date: Tue, 9 Aug 2022 16:04:59 +0200 Subject: [PATCH 1/8] convert old files to new format --- lib/slack/web/docs/admin.apps.approve.json | 74 ++++----- lib/slack/web/docs/admin.apps.restrict.json | 74 ++++----- lib/slack/web/docs/api.test.json | 33 ++-- lib/slack/web/docs/apps.uninstall.json | 54 +++---- lib/slack/web/docs/auth.revoke.json | 32 ++-- lib/slack/web/docs/auth.test.json | 12 +- lib/slack/web/docs/bots.info.json | 12 +- lib/slack/web/docs/channels.archive.json | 34 ++-- lib/slack/web/docs/channels.create.json | 30 ++-- lib/slack/web/docs/channels.history.json | 94 +++++------ lib/slack/web/docs/channels.info.json | 26 ++- lib/slack/web/docs/channels.invite.json | 48 +++--- lib/slack/web/docs/channels.join.json | 32 ++-- lib/slack/web/docs/channels.kick.json | 48 +++--- lib/slack/web/docs/channels.leave.json | 30 ++-- lib/slack/web/docs/channels.list.json | 19 ++- lib/slack/web/docs/channels.mark.json | 42 +++-- lib/slack/web/docs/channels.rename.json | 44 +++-- lib/slack/web/docs/channels.replies.json | 35 ++-- lib/slack/web/docs/channels.setPurpose.json | 44 +++-- lib/slack/web/docs/channels.setTopic.json | 44 +++-- lib/slack/web/docs/channels.unarchive.json | 28 ++-- lib/slack/web/docs/chat.delete.json | 42 +++-- lib/slack/web/docs/chat.getPermalink.json | 18 +-- lib/slack/web/docs/chat.postEphemeral.json | 101 ++++++------ lib/slack/web/docs/chat.postMessage.json | 147 +++++++++-------- lib/slack/web/docs/chat.scheduleMessage.json | 150 +++++++++--------- lib/slack/web/docs/chat.unfurl.json | 144 ++++++++--------- lib/slack/web/docs/chat.update.json | 104 ++++++------ lib/slack/web/docs/conversations.close.json | 12 +- lib/slack/web/docs/conversations.create.json | 146 +++++++++-------- lib/slack/web/docs/conversations.history.json | 50 +++--- lib/slack/web/docs/conversations.info.json | 28 ++-- lib/slack/web/docs/conversations.invite.json | 141 ++++++++-------- lib/slack/web/docs/conversations.join.json | 48 +++--- lib/slack/web/docs/conversations.list.json | 42 +++-- lib/slack/web/docs/conversations.members.json | 40 +++-- lib/slack/web/docs/conversations.open.json | 34 ++-- lib/slack/web/docs/conversations.replies.json | 66 ++++---- .../web/docs/conversations.setPurpose.json | 24 ++- .../web/docs/conversations.setTopic.json | 24 ++- lib/slack/web/docs/dnd.endDnd.json | 12 +- lib/slack/web/docs/dnd.endSnooze.json | 15 +- lib/slack/web/docs/dnd.info.json | 21 ++- lib/slack/web/docs/dnd.setSnooze.json | 31 ++-- lib/slack/web/docs/dnd.teamInfo.json | 21 ++- lib/slack/web/docs/emoji.list.json | 12 +- lib/slack/web/docs/files.comments.add.json | 28 ++-- lib/slack/web/docs/files.comments.delete.json | 24 ++- lib/slack/web/docs/files.comments.edit.json | 36 ++--- lib/slack/web/docs/files.delete.json | 28 ++-- lib/slack/web/docs/files.info.json | 33 ++-- lib/slack/web/docs/files.list.json | 79 +++++---- lib/slack/web/docs/files.revokePublicURL.json | 26 ++- lib/slack/web/docs/files.sharedPublicURL.json | 28 ++-- lib/slack/web/docs/files.upload.json | 90 +++++------ lib/slack/web/docs/groups.archive.json | 34 ++-- lib/slack/web/docs/groups.close.json | 26 ++- lib/slack/web/docs/groups.create.json | 28 ++-- lib/slack/web/docs/groups.createChild.json | 30 ++-- lib/slack/web/docs/groups.history.json | 93 +++++------ lib/slack/web/docs/groups.info.json | 26 ++- lib/slack/web/docs/groups.invite.json | 44 +++-- lib/slack/web/docs/groups.kick.json | 46 +++--- lib/slack/web/docs/groups.leave.json | 32 ++-- lib/slack/web/docs/groups.list.json | 19 ++- lib/slack/web/docs/groups.mark.json | 39 +++-- lib/slack/web/docs/groups.open.json | 26 ++- lib/slack/web/docs/groups.rename.json | 39 +++-- lib/slack/web/docs/groups.replies.json | 35 ++-- lib/slack/web/docs/groups.setPurpose.json | 42 +++-- lib/slack/web/docs/groups.setTopic.json | 42 +++-- lib/slack/web/docs/groups.unarchive.json | 28 ++-- lib/slack/web/docs/im.close.json | 28 ++-- lib/slack/web/docs/im.history.json | 93 +++++------ lib/slack/web/docs/im.list.json | 4 +- lib/slack/web/docs/im.mark.json | 41 +++-- lib/slack/web/docs/im.open.json | 30 ++-- lib/slack/web/docs/im.replies.json | 35 ++-- lib/slack/web/docs/mpim.close.json | 26 ++- lib/slack/web/docs/mpim.history.json | 93 +++++------ lib/slack/web/docs/mpim.list.json | 4 +- lib/slack/web/docs/mpim.mark.json | 39 +++-- lib/slack/web/docs/mpim.open.json | 30 ++-- lib/slack/web/docs/oauth.access.json | 65 ++++---- lib/slack/web/docs/oauth.v2.access.json | 71 ++++----- lib/slack/web/docs/pins.add.json | 75 ++++----- lib/slack/web/docs/pins.list.json | 29 ++-- lib/slack/web/docs/pins.remove.json | 71 ++++----- lib/slack/web/docs/presence.set.json | 28 ++-- lib/slack/web/docs/reactions.add.json | 86 +++++----- lib/slack/web/docs/reactions.get.json | 72 ++++----- lib/slack/web/docs/reactions.list.json | 36 ++--- lib/slack/web/docs/reactions.remove.json | 82 +++++----- lib/slack/web/docs/rtm.connect.json | 20 +-- lib/slack/web/docs/search.all.json | 60 ++++--- lib/slack/web/docs/search.files.json | 60 ++++--- lib/slack/web/docs/search.messages.json | 60 ++++--- lib/slack/web/docs/stars.add.json | 71 ++++----- lib/slack/web/docs/stars.list.json | 31 ++-- lib/slack/web/docs/stars.remove.json | 71 ++++----- lib/slack/web/docs/team.accessLogs.json | 22 ++- lib/slack/web/docs/team.info.json | 12 +- lib/slack/web/docs/team.integrationLogs.json | 56 +++---- lib/slack/web/docs/usergroups.create.json | 63 ++++---- lib/slack/web/docs/usergroups.disable.json | 33 ++-- lib/slack/web/docs/usergroups.enable.json | 33 ++-- lib/slack/web/docs/usergroups.list.json | 45 +++--- lib/slack/web/docs/usergroups.update.json | 75 +++++---- lib/slack/web/docs/usergroups.users.list.json | 33 ++-- .../web/docs/usergroups.users.update.json | 45 +++--- lib/slack/web/docs/users.conversations.json | 42 +++-- lib/slack/web/docs/users.getPresence.json | 23 ++- lib/slack/web/docs/users.info.json | 28 ++-- lib/slack/web/docs/users.list.json | 18 +-- lib/slack/web/docs/users.lookupByEmail.json | 28 ++-- lib/slack/web/docs/users.profile.get.json | 42 +++-- lib/slack/web/docs/users.profile.set.json | 70 ++++---- lib/slack/web/docs/users.setActive.json | 12 +- lib/slack/web/docs/users.setPresence.json | 26 ++- lib/slack/web/docs/views.open.json | 108 ++++++------- lib/slack/web/docs/views.publish.json | 108 ++++++------- lib/slack/web/docs/views.push.json | 124 +++++++-------- lib/slack/web/docs/views.update.json | 142 ++++++++--------- 124 files changed, 2812 insertions(+), 3150 deletions(-) diff --git a/lib/slack/web/docs/admin.apps.approve.json b/lib/slack/web/docs/admin.apps.approve.json index 7bffc5d..ff29556 100644 --- a/lib/slack/web/docs/admin.apps.approve.json +++ b/lib/slack/web/docs/admin.apps.approve.json @@ -1,62 +1,58 @@ { - "desc": "Approve an app for installation on a workspace.", - "args": { "app_id": { - "required" : false, - "example" : "A12345", - "desc" : "The id of the app to approve. Required if `request_id` is missing." + "desc": "The id of the app to approve. Required if `request_id` is missing.", + "example": "A12345", + "required": false }, "request_id": { - "required" : false, - "example" : "Ar12345", - "desc" : "The id of the request to approve. Required if `app_id` is missing." + "desc": "The id of the request to approve. Required if `app_id` is missing.", + "example": "Ar12345", + "required": false }, "team_id": { - "required" : false, - "example" : "A12345", - "desc" : "The id of the team to approve. Required if your Enterprise Grid org contains more than one workspace." + "desc": "The id of the team to approve. Required if your Enterprise Grid org contains more than one workspace.", + "example": "A12345", + "required": false } }, - - "response": { - "ok": true - }, - + "desc": "Approve an app for installation on a workspace.", "errors": { - "invalid_request_id" : "The `request_id` passed was invalid.", - "invalid_app_id" : "The `app_id` passed was invalid.", - "request_id_required_for_custom_integrations" : "A `request_id` is required for custom integrations.", - "feature_not_enabled" : "Returned when the Admin APIs feature is not enabled for this team.", - "not_an_admin" : "This method is only accessible by org owners and admins.", - "request_id_or_app_id_is_required" : "Must include a `request_id` or `app_id`.", - "too_many_ids_provided" : "Please provide only `app_id` OR `request_id`.", - "too_many_teams_provided" : "Please provide only `team_id` OR `enterprise_id`.", - "request_already_resolved" : "The app request has already been resolved.", - "team_not_found" : "Returned when team id is not found.", - "app_management_app_not_installed_on_org" : "The app management app must be installed on the org.", - "not_authed": "No authentication token provided.", - "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", "account_inactive": "Authentication token is for a deleted user or workspace.", - "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed.", - "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", - "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "app_management_app_not_installed_on_org": "The app management app must be installed on the org.", "ekm_access_denied": "Administrators have suspended the ability to post a message.", - "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", - "is_bot": "This method cannot be called by a bot user.", - "invalid_arguments": "The method was called with invalid arguments.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "feature_not_enabled": "Returned when the Admin APIs feature is not enabled for this team.", + "invalid_app_id": "The `app_id` passed was invalid.", "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was called with invalid arguments.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", "invalid_charset": "The method was called via a `POST` request, but the `charset` specified in the `Content-Type` header was invalid. Valid charset names are: `utf-8` `iso-8859-1`.", "invalid_form_data": "The method was called via a `POST` request with `Content-Type` `application/x-www-form-urlencoded` or `multipart/form-data`, but the form data was either missing or syntactically invalid.", "invalid_post_type": "The method was called via a `POST` request, but the specified `Content-Type` was invalid. Valid types are: `application/json` `application/x-www-form-urlencoded` `multipart/form-data` `text/plain`.", + "invalid_request_id": "The `request_id` passed was invalid.", + "is_bot": "This method cannot be called by a bot user.", "missing_post_type": "The method was called via a `POST` request and included a data payload, but the request did not include a `Content-Type` header.", - "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_an_admin": "This method is only accessible by org owners and admins.", + "not_authed": "No authentication token provided.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "request_already_resolved": "The app request has already been resolved.", + "request_id_or_app_id_is_required": "Must include a `request_id` or `app_id`.", + "request_id_required_for_custom_integrations": "A `request_id` is required for custom integrations.", "request_timeout": "The method was called via a `POST` request, but the `POST` data was either missing or truncated.", - "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised." + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "team_not_found": "Returned when team id is not found.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed.", + "too_many_ids_provided": "Please provide only `app_id` OR `request_id`.", + "too_many_teams_provided": "Please provide only `team_id` OR `enterprise_id`." + }, + "response": { + "ok": true }, - "warnings": { "missing_charset": "The method was called via a `POST` request, and recommended practice for the specified `Content-Type` is to include a `charset` parameter. However, no `charset` was present. Specifically, non-form-data content types (e.g. `text/plain`) are the ones for which `charset` is recommended.", "superfluous_charset": "The method was called via a `POST` request, and the specified `Content-Type` is not defined to understand the `charset` parameter. However, `charset` was in fact present. Specifically, form-data content types (e.g. `multipart/form-data`) are the ones for which `charset` is superfluous." } -} +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.apps.restrict.json b/lib/slack/web/docs/admin.apps.restrict.json index 6372203..7fafb4c 100644 --- a/lib/slack/web/docs/admin.apps.restrict.json +++ b/lib/slack/web/docs/admin.apps.restrict.json @@ -1,62 +1,58 @@ { - "desc": "Restrict an app for installation on a workspace.", - "args": { "app_id": { - "required" : false, - "example" : "A12345", - "desc" : "The id of the app to restrict. Required if `request_id` is missing." + "desc": "The id of the app to restrict. Required if `request_id` is missing.", + "example": "A12345", + "required": false }, "request_id": { - "required" : false, - "example" : "Ar12345", - "desc" : "The id of the request to restrict. Required if `app_id` is missing." + "desc": "The id of the request to restrict. Required if `app_id` is missing.", + "example": "Ar12345", + "required": false }, "team_id": { - "required" : false, - "example" : "A12345", - "desc" : "The id of the team to restrict. Required if your Enterprise Grid org contains more than one workspace." + "desc": "The id of the team to restrict. Required if your Enterprise Grid org contains more than one workspace.", + "example": "A12345", + "required": false } }, - - "response": { - "ok": true - }, - + "desc": "Restrict an app for installation on a workspace.", "errors": { - "invalid_request_id" : "The `request_id` passed was invalid.", - "invalid_app_id" : "The `app_id` passed was invalid.", - "request_id_required_for_custom_integrations" : "A `request_id` is required for custom integrations.", - "feature_not_enabled" : "Returned when the Admin APIs feature is not enabled for this team.", - "not_an_admin" : "This method is only accessible by org owners and admins.", - "request_id_or_app_id_is_required" : "Must include a `request_id` or `app_id`.", - "too_many_ids_provided" : "Please provide only `app_id` OR `request_id`.", - "too_many_teams_provided" : "Please provide only `team_id` OR `enterprise_id`.", - "request_already_resolved" : "The app request has already been resolved.", - "team_not_found" : "Returned when team id is not found.", - "app_management_app_not_installed_on_org" : "The app management app must be installed on the org.", - "not_authed": "No authentication token provided.", - "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", "account_inactive": "Authentication token is for a deleted user or workspace.", - "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed.", - "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", - "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "app_management_app_not_installed_on_org": "The app management app must be installed on the org.", "ekm_access_denied": "Administrators have suspended the ability to post a message.", - "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", - "is_bot": "This method cannot be called by a bot user.", - "invalid_arguments": "The method was called with invalid arguments.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "feature_not_enabled": "Returned when the Admin APIs feature is not enabled for this team.", + "invalid_app_id": "The `app_id` passed was invalid.", "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was called with invalid arguments.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", "invalid_charset": "The method was called via a `POST` request, but the `charset` specified in the `Content-Type` header was invalid. Valid charset names are: `utf-8` `iso-8859-1`.", "invalid_form_data": "The method was called via a `POST` request with `Content-Type` `application/x-www-form-urlencoded` or `multipart/form-data`, but the form data was either missing or syntactically invalid.", "invalid_post_type": "The method was called via a `POST` request, but the specified `Content-Type` was invalid. Valid types are: `application/json` `application/x-www-form-urlencoded` `multipart/form-data` `text/plain`.", + "invalid_request_id": "The `request_id` passed was invalid.", + "is_bot": "This method cannot be called by a bot user.", "missing_post_type": "The method was called via a `POST` request and included a data payload, but the request did not include a `Content-Type` header.", - "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_an_admin": "This method is only accessible by org owners and admins.", + "not_authed": "No authentication token provided.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "request_already_resolved": "The app request has already been resolved.", + "request_id_or_app_id_is_required": "Must include a `request_id` or `app_id`.", + "request_id_required_for_custom_integrations": "A `request_id` is required for custom integrations.", "request_timeout": "The method was called via a `POST` request, but the `POST` data was either missing or truncated.", - "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised." + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "team_not_found": "Returned when team id is not found.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed.", + "too_many_ids_provided": "Please provide only `app_id` OR `request_id`.", + "too_many_teams_provided": "Please provide only `team_id` OR `enterprise_id`." + }, + "response": { + "ok": true }, - "warnings": { "missing_charset": "The method was called via a `POST` request, and recommended practice for the specified `Content-Type` is to include a `charset` parameter. However, no `charset` was present. Specifically, non-form-data content types (e.g. `text/plain`) are the ones for which `charset` is recommended.", "superfluous_charset": "The method was called via a `POST` request, and the specified `Content-Type` is not defined to understand the `charset` parameter. However, `charset` was in fact present. Specifically, form-data content types (e.g. `multipart/form-data`) are the ones for which `charset` is superfluous." } -} +} \ No newline at end of file diff --git a/lib/slack/web/docs/api.test.json b/lib/slack/web/docs/api.test.json index 62526bd..e6ff8a8 100644 --- a/lib/slack/web/docs/api.test.json +++ b/lib/slack/web/docs/api.test.json @@ -1,19 +1,16 @@ { - "desc": "Checks API calling code.", - - "args": { - "error": { - "required" : false, - "example" : "my_error", - "desc" : "Error response to return" - }, - "foo": { - "required" : false, - "example" : "bar", - "desc" : "example property to return" - } - }, - - "errors": { - } -} + "args": { + "error": { + "desc": "Error response to return", + "example": "my_error", + "required": false + }, + "foo": { + "desc": "example property to return", + "example": "bar", + "required": false + } + }, + "desc": "Checks API calling code.", + "errors": {} +} \ No newline at end of file diff --git a/lib/slack/web/docs/apps.uninstall.json b/lib/slack/web/docs/apps.uninstall.json index 6ac56be..9788a2d 100644 --- a/lib/slack/web/docs/apps.uninstall.json +++ b/lib/slack/web/docs/apps.uninstall.json @@ -1,28 +1,26 @@ -{ - "desc": "Uninstalls your app from a workspace.", - - "args": { - "client_id": { - "required" : true, - "example" : "4b39e9-752c4", - "desc" : "Issued when you created your application." - }, - "client_secret": { - "required" : true, - "example" : "33fea0113f5b1", - "desc" : "Issued when you created your application." - } - }, - - "errors": { - "invalid_client_id" : "Value passed for `client_id` was invalid.", - "bad_client_secret" : "Value passed for `client_secret` was invalid.", - "client_id_token_mismatch": "The provided client ID and token do not belong to the same app.", - "not_authed": "No authentication token provided.", - "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", - "account_inactive": "Authentication token is for a deleted user or workspace.", - "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed.", - "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", - "is_bot": "This method cannot be called by a bot user." - } -} +{ + "args": { + "client_id": { + "desc": "Issued when you created your application.", + "example": "4b39e9-752c4", + "required": true + }, + "client_secret": { + "desc": "Issued when you created your application.", + "example": "33fea0113f5b1", + "required": true + } + }, + "desc": "Uninstalls your app from a workspace.", + "errors": { + "account_inactive": "Authentication token is for a deleted user or workspace.", + "bad_client_secret": "Value passed for `client_secret` was invalid.", + "client_id_token_mismatch": "The provided client ID and token do not belong to the same app.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_client_id": "Value passed for `client_id` was invalid.", + "is_bot": "This method cannot be called by a bot user.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_authed": "No authentication token provided.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/auth.revoke.json b/lib/slack/web/docs/auth.revoke.json index 8f7132c..0e97758 100644 --- a/lib/slack/web/docs/auth.revoke.json +++ b/lib/slack/web/docs/auth.revoke.json @@ -1,17 +1,15 @@ -{ - "desc": "Revokes a token.", - - "args": { - "test": { - "required": false, - "example": true, - "desc": "Setting this parameter to 1 triggers a testing mode where the specified token will not actually be revoked." - } - }, - - "errors": { - "not_bearer_token": "Incompatible token type provided", - "not_authed": "No authentication token provided.", - "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request." - } -} +{ + "args": { + "test": { + "desc": "Setting this parameter to 1 triggers a testing mode where the specified token will not actually be revoked.", + "example": true, + "required": false + } + }, + "desc": "Revokes a token.", + "errors": { + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "not_authed": "No authentication token provided.", + "not_bearer_token": "Incompatible token type provided" + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/auth.test.json b/lib/slack/web/docs/auth.test.json index ae558ec..03e6103 100644 --- a/lib/slack/web/docs/auth.test.json +++ b/lib/slack/web/docs/auth.test.json @@ -1,9 +1,5 @@ { - "desc": "Checks authentication & identity.", - - "args": { - }, - - "errors": { - } -} + "args": {}, + "desc": "Checks authentication & identity.", + "errors": {} +} \ No newline at end of file diff --git a/lib/slack/web/docs/bots.info.json b/lib/slack/web/docs/bots.info.json index ac1a53d..3fd48c2 100644 --- a/lib/slack/web/docs/bots.info.json +++ b/lib/slack/web/docs/bots.info.json @@ -1,10 +1,10 @@ { - "desc": "Gets information about a bot user.", "args": { "bot": { - "example" : "B12345678", - "required": false, - "desc" : "Bot user to get info on" + "desc": "Bot user to get info on", + "example": "B12345678", + "required": false } - } -} + }, + "desc": "Gets information about a bot user." +} \ No newline at end of file diff --git a/lib/slack/web/docs/channels.archive.json b/lib/slack/web/docs/channels.archive.json index 9588d01..7ecea34 100644 --- a/lib/slack/web/docs/channels.archive.json +++ b/lib/slack/web/docs/channels.archive.json @@ -1,19 +1,17 @@ { - "desc": "Archives a channel.", - - "args": { - "channel": { - "type" : "channel", - "required" : true, - "desc" : "Channel to archive" - } - }, - - "errors": { - "channel_not_found" : "Value passed for `channel` was invalid.", - "already_archived" : "Channel has already been archived.", - "cant_archive_general" : "You cannot archive the general channel", - "last_ra_channel" : "You cannot archive the last channel for a restricted account", - "restricted_action" : "A team preference prevents the authenticated user from archiving." - } -} + "args": { + "channel": { + "desc": "Channel to archive", + "required": true, + "type": "channel" + } + }, + "desc": "Archives a channel.", + "errors": { + "already_archived": "Channel has already been archived.", + "cant_archive_general": "You cannot archive the general channel", + "channel_not_found": "Value passed for `channel` was invalid.", + "last_ra_channel": "You cannot archive the last channel for a restricted account", + "restricted_action": "A team preference prevents the authenticated user from archiving." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/channels.create.json b/lib/slack/web/docs/channels.create.json index 9559540..0de490e 100644 --- a/lib/slack/web/docs/channels.create.json +++ b/lib/slack/web/docs/channels.create.json @@ -1,17 +1,15 @@ { - "desc": "Creates a channel.", - - "args": { - "name": { - "required" : true, - "desc" : "Name of channel to create", - "example" : "mychannel" - } - }, - - "errors": { - "name_taken" : "A channel cannot be created with the given name.", - "restricted_action": "A team preference prevents the authenticated user from creating channels.", - "no_channel" : "Value passed for `name` was empty." - } -} + "args": { + "name": { + "desc": "Name of channel to create", + "example": "mychannel", + "required": true + } + }, + "desc": "Creates a channel.", + "errors": { + "name_taken": "A channel cannot be created with the given name.", + "no_channel": "Value passed for `name` was empty.", + "restricted_action": "A team preference prevents the authenticated user from creating channels." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/channels.history.json b/lib/slack/web/docs/channels.history.json index 78cc223..c4164ed 100644 --- a/lib/slack/web/docs/channels.history.json +++ b/lib/slack/web/docs/channels.history.json @@ -1,52 +1,44 @@ { - "desc": "Fetches history of messages and events from a channel.", - - "args": { - "channel": { - "type" : "channel", - "required" : true, - "desc" : "Channel to fetch history for." - }, - - "latest": { - "type" : "timestamp", - "required" : false, - "default" : "now", - "desc" : "End of time range of messages to include in results." - }, - - "oldest": { - "type" : "timestamp", - "required" : false, - "default" : "0", - "desc" : "Start of time range of messages to include in results." - }, - - "inclusive": { - "example" : 1, - "default" : 0, - "desc" : "Include messages with latest or oldest timestamp in results." - }, - - "count": { - "required" : false, - "default" : "100", - "example" : "100", - "desc" : "Number of messages to return, between 1 and 1000." - }, - - "unreads": { - "required" : false, - "default" : 0, - "example" : 1, - "desc" : "Include `unread_count_display` in the output?" - } - }, - - "errors": { - - "channel_not_found" : "Value passed for `channel` was invalid.", - "invalid_ts_latest" : "Value passed for `latest` was invalid", - "invalid_ts_oldest" : "Value passed for `oldest` was invalid" - } -} + "args": { + "channel": { + "desc": "Channel to fetch history for.", + "required": true, + "type": "channel" + }, + "count": { + "default": "100", + "desc": "Number of messages to return, between 1 and 1000.", + "example": "100", + "required": false + }, + "inclusive": { + "default": 0, + "desc": "Include messages with latest or oldest timestamp in results.", + "example": 1 + }, + "latest": { + "default": "now", + "desc": "End of time range of messages to include in results.", + "required": false, + "type": "timestamp" + }, + "oldest": { + "default": "0", + "desc": "Start of time range of messages to include in results.", + "required": false, + "type": "timestamp" + }, + "unreads": { + "default": 0, + "desc": "Include `unread_count_display` in the output?", + "example": 1, + "required": false + } + }, + "desc": "Fetches history of messages and events from a channel.", + "errors": { + "channel_not_found": "Value passed for `channel` was invalid.", + "invalid_ts_latest": "Value passed for `latest` was invalid", + "invalid_ts_oldest": "Value passed for `oldest` was invalid" + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/channels.info.json b/lib/slack/web/docs/channels.info.json index e03d561..983f24f 100644 --- a/lib/slack/web/docs/channels.info.json +++ b/lib/slack/web/docs/channels.info.json @@ -1,15 +1,13 @@ { - "desc": "Gets information about a channel.", - - "args": { - "channel": { - "type" : "channel", - "required" : true, - "desc" : "Channel to get info on" - } - }, - - "errors": { - "channel_not_found" : "Value passed for `channel` was invalid." - } -} + "args": { + "channel": { + "desc": "Channel to get info on", + "required": true, + "type": "channel" + } + }, + "desc": "Gets information about a channel.", + "errors": { + "channel_not_found": "Value passed for `channel` was invalid." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/channels.invite.json b/lib/slack/web/docs/channels.invite.json index c066c84..c512a13 100644 --- a/lib/slack/web/docs/channels.invite.json +++ b/lib/slack/web/docs/channels.invite.json @@ -1,26 +1,24 @@ { - "desc": "Invites a user to a channel.", - - "args": { - "channel": { - "type" : "channel", - "required" : true, - "desc" : "Channel to invite user to." - }, - "user": { - "type" : "user", - "required" : true, - "desc" : "User to invite to channel." - } - }, - - "errors": { - "channel_not_found" : "Value passed for `channel` was invalid.", - "user_not_found": "Value passed for `user` was invalid.", - "cant_invite_self" : "Authenticated user cannot invite themselves to a channel.", - "not_in_channel": "Authenticated user is not in the channel.", - "already_in_channel": "Invited user is already in the channel.", - "is_archived" : "Channel has been archived.", - "cant_invite" : "User cannot be invited to this channel." - } -} + "args": { + "channel": { + "desc": "Channel to invite user to.", + "required": true, + "type": "channel" + }, + "user": { + "desc": "User to invite to channel.", + "required": true, + "type": "user" + } + }, + "desc": "Invites a user to a channel.", + "errors": { + "already_in_channel": "Invited user is already in the channel.", + "cant_invite": "User cannot be invited to this channel.", + "cant_invite_self": "Authenticated user cannot invite themselves to a channel.", + "channel_not_found": "Value passed for `channel` was invalid.", + "is_archived": "Channel has been archived.", + "not_in_channel": "Authenticated user is not in the channel.", + "user_not_found": "Value passed for `user` was invalid." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/channels.join.json b/lib/slack/web/docs/channels.join.json index 85535d2..2fa7d97 100644 --- a/lib/slack/web/docs/channels.join.json +++ b/lib/slack/web/docs/channels.join.json @@ -1,18 +1,16 @@ { - "desc": "Joins a channel, creating it if needed.", - - "args": { - "name": { - "required" : true, - "desc" : "Name of channel to join" - } - }, - - "errors": { - "channel_not_found" : "Value passed for `channel` was invalid.", - "name_taken" : "A channel cannot be created with the given name.", - "restricted_action": "A team preference prevents the authenticated user from creating channels.", - "no_channel" : "Value passed for `name` was empty.", - "is_archived" : "Channel has been archived." - } -} + "args": { + "name": { + "desc": "Name of channel to join", + "required": true + } + }, + "desc": "Joins a channel, creating it if needed.", + "errors": { + "channel_not_found": "Value passed for `channel` was invalid.", + "is_archived": "Channel has been archived.", + "name_taken": "A channel cannot be created with the given name.", + "no_channel": "Value passed for `name` was empty.", + "restricted_action": "A team preference prevents the authenticated user from creating channels." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/channels.kick.json b/lib/slack/web/docs/channels.kick.json index 5db945f..11dc2b9 100644 --- a/lib/slack/web/docs/channels.kick.json +++ b/lib/slack/web/docs/channels.kick.json @@ -1,26 +1,24 @@ { - "desc": "Removes a user from a channel.", - - "args": { - "channel": { - "type" : "channel", - "required" : true, - "desc" : "Channel to remove user from." - }, - "user": { - "type" : "user", - "required" : true, - "desc" : "User to remove from channel." - } - }, - - "errors": { - "channel_not_found" : "Value passed for `channel` was invalid.", - "user_not_found" : "Value passed for `user` was invalid.", - "cant_kick_self" : "Authenticated user can't kick themselves from a channel.", - "not_in_channel" : "User was not in the channel.", - "cant_kick_from_general": "User cannot be removed from #general.", - "cant_kick_from_last_channel": "User cannot be removed from the last channel they're in.", - "restricted_action" : "A team preference prevents the authenticated user from kicking." - } -} + "args": { + "channel": { + "desc": "Channel to remove user from.", + "required": true, + "type": "channel" + }, + "user": { + "desc": "User to remove from channel.", + "required": true, + "type": "user" + } + }, + "desc": "Removes a user from a channel.", + "errors": { + "cant_kick_from_general": "User cannot be removed from #general.", + "cant_kick_from_last_channel": "User cannot be removed from the last channel they're in.", + "cant_kick_self": "Authenticated user can't kick themselves from a channel.", + "channel_not_found": "Value passed for `channel` was invalid.", + "not_in_channel": "User was not in the channel.", + "restricted_action": "A team preference prevents the authenticated user from kicking.", + "user_not_found": "Value passed for `user` was invalid." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/channels.leave.json b/lib/slack/web/docs/channels.leave.json index fa37b71..e2f915c 100644 --- a/lib/slack/web/docs/channels.leave.json +++ b/lib/slack/web/docs/channels.leave.json @@ -1,17 +1,15 @@ { - "desc": "Leaves a channel.", - - "args": { - "channel": { - "type" : "channel", - "required" : true, - "desc" : "Channel to leave" - } - }, - - "errors": { - "channel_not_found" : "Value passed for `channel` was invalid.", - "is_archived" : "Channel has been archived.", - "cant_leave_general" : "Authenticated user cannot leave the general channel" - } -} + "args": { + "channel": { + "desc": "Channel to leave", + "required": true, + "type": "channel" + } + }, + "desc": "Leaves a channel.", + "errors": { + "cant_leave_general": "Authenticated user cannot leave the general channel", + "channel_not_found": "Value passed for `channel` was invalid.", + "is_archived": "Channel has been archived." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/channels.list.json b/lib/slack/web/docs/channels.list.json index 3a2a151..bfabb55 100644 --- a/lib/slack/web/docs/channels.list.json +++ b/lib/slack/web/docs/channels.list.json @@ -1,11 +1,10 @@ { - "desc": "Lists all channels in a Slack team.", - - "args": { - "exclude_archived": { - "example" : 1, - "default" : 0, - "desc" : "Don't return archived channels." - } - } -} + "args": { + "exclude_archived": { + "default": 0, + "desc": "Don't return archived channels.", + "example": 1 + } + }, + "desc": "Lists all channels in a Slack team." +} \ No newline at end of file diff --git a/lib/slack/web/docs/channels.mark.json b/lib/slack/web/docs/channels.mark.json index 46fe3c3..1935f0c 100644 --- a/lib/slack/web/docs/channels.mark.json +++ b/lib/slack/web/docs/channels.mark.json @@ -1,24 +1,20 @@ { - "desc": "Sets the read cursor in a channel.", - - "args": { - "channel": { - "type" : "channel", - "required" : true, - "desc" : "Channel to set reading cursor in." - }, - - "ts": { - "type" : "timestamp", - "required" : true, - "desc" : "Timestamp of the most recently seen message." - } - }, - - "errors": { - - "channel_not_found" : "Value passed for `channel` was invalid.", - "invalid_timestamp" : "Value passed for `timestamp` was invalid.", - "not_in_channel" : "Caller is not a member of the channel." - } -} + "args": { + "channel": { + "desc": "Channel to set reading cursor in.", + "required": true, + "type": "channel" + }, + "ts": { + "desc": "Timestamp of the most recently seen message.", + "required": true, + "type": "timestamp" + } + }, + "desc": "Sets the read cursor in a channel.", + "errors": { + "channel_not_found": "Value passed for `channel` was invalid.", + "invalid_timestamp": "Value passed for `timestamp` was invalid.", + "not_in_channel": "Caller is not a member of the channel." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/channels.rename.json b/lib/slack/web/docs/channels.rename.json index 6c80a29..81f7810 100644 --- a/lib/slack/web/docs/channels.rename.json +++ b/lib/slack/web/docs/channels.rename.json @@ -1,25 +1,21 @@ { - "desc": "Renames a channel.", - - "args": { - "channel": { - "type" : "channel", - "required" : true, - "desc" : "Channel to rename" - }, - - "name": { - "required" : true, - "desc" : "New name for channel." - } - }, - - "errors": { - - "channel_not_found" : "Value passed for `channel` was invalid.", - "not_in_channel" : "Caller is not a member of the channel.", - "not_authorized" : "Caller cannot rename this channel", - "invalid_name" : "New name is invalid", - "name_taken" : "New channel name is taken" - } -} + "args": { + "channel": { + "desc": "Channel to rename", + "required": true, + "type": "channel" + }, + "name": { + "desc": "New name for channel.", + "required": true + } + }, + "desc": "Renames a channel.", + "errors": { + "channel_not_found": "Value passed for `channel` was invalid.", + "invalid_name": "New name is invalid", + "name_taken": "New channel name is taken", + "not_authorized": "Caller cannot rename this channel", + "not_in_channel": "Caller is not a member of the channel." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/channels.replies.json b/lib/slack/web/docs/channels.replies.json index 02d7ace..bc9c0cd 100644 --- a/lib/slack/web/docs/channels.replies.json +++ b/lib/slack/web/docs/channels.replies.json @@ -1,21 +1,18 @@ { - "desc": "Retrieve a thread of messages posted to a channel.", - - "args": { - "channel": { - "type" : "channel", - "required" : true, - "desc" : "Channel to fetch thread from" - }, - - "thread_ts": { - "required" : true, - "desc" : "Unique identifier of a thread's parent message." - } - }, - - "errors": { - "channel_not_found" : "Value passed for `channel` was invalid.", + "args": { + "channel": { + "desc": "Channel to fetch thread from", + "required": true, + "type": "channel" + }, + "thread_ts": { + "desc": "Unique identifier of a thread's parent message.", + "required": true + } + }, + "desc": "Retrieve a thread of messages posted to a channel.", + "errors": { + "channel_not_found": "Value passed for `channel` was invalid.", "thread_not_found": "Value for thread_ts was missing or invalid." - } -} + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/channels.setPurpose.json b/lib/slack/web/docs/channels.setPurpose.json index 81e065e..d7bcc84 100644 --- a/lib/slack/web/docs/channels.setPurpose.json +++ b/lib/slack/web/docs/channels.setPurpose.json @@ -1,24 +1,22 @@ { - "desc": "Sets the purpose for a channel.", - - "args": { - "channel": { - "type" : "channel", - "required" : true, - "desc" : "Channel to set the purpose of" - }, - "purpose": { - "required" : true, - "example" : "My Purpose", - "desc" : "The new purpose" - } - }, - - "errors": { - "channel_not_found" : "Value passed for `channel` was invalid.", - "not_in_channel": "Authenticated user is not in the channel.", - "is_archived" : "Channel has been archived.", - "too_long": "Purpose was longer than 250 characters.", - "user_is_restricted" : "Setting the purpose is a restricted action." - } -} + "args": { + "channel": { + "desc": "Channel to set the purpose of", + "required": true, + "type": "channel" + }, + "purpose": { + "desc": "The new purpose", + "example": "My Purpose", + "required": true + } + }, + "desc": "Sets the purpose for a channel.", + "errors": { + "channel_not_found": "Value passed for `channel` was invalid.", + "is_archived": "Channel has been archived.", + "not_in_channel": "Authenticated user is not in the channel.", + "too_long": "Purpose was longer than 250 characters.", + "user_is_restricted": "Setting the purpose is a restricted action." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/channels.setTopic.json b/lib/slack/web/docs/channels.setTopic.json index 1a529f2..60b5bdf 100644 --- a/lib/slack/web/docs/channels.setTopic.json +++ b/lib/slack/web/docs/channels.setTopic.json @@ -1,24 +1,22 @@ { - "desc": "Sets the topic for a channel.", - - "args": { - "channel": { - "type" : "channel", - "required" : true, - "desc" : "Channel to set the topic of" - }, - "topic": { - "required" : true, - "example" : "My Topic", - "desc" : "The new topic" - } - }, - - "errors": { - "channel_not_found" : "Value passed for `channel` was invalid.", - "not_in_channel": "Authenticated user is not in the channel.", - "is_archived" : "Channel has been archived.", - "too_long": "Topic was longer than 250 characters.", - "user_is_restricted" : "Setting the topic is a restricted action." - } -} + "args": { + "channel": { + "desc": "Channel to set the topic of", + "required": true, + "type": "channel" + }, + "topic": { + "desc": "The new topic", + "example": "My Topic", + "required": true + } + }, + "desc": "Sets the topic for a channel.", + "errors": { + "channel_not_found": "Value passed for `channel` was invalid.", + "is_archived": "Channel has been archived.", + "not_in_channel": "Authenticated user is not in the channel.", + "too_long": "Topic was longer than 250 characters.", + "user_is_restricted": "Setting the topic is a restricted action." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/channels.unarchive.json b/lib/slack/web/docs/channels.unarchive.json index becfd59..527fb4c 100644 --- a/lib/slack/web/docs/channels.unarchive.json +++ b/lib/slack/web/docs/channels.unarchive.json @@ -1,16 +1,14 @@ { - "desc": "Unarchives a channel.", - - "args": { - "channel": { - "type" : "channel", - "required" : true, - "desc" : "Channel to unarchive" - } - }, - - "errors": { - "channel_not_found" : "Value passed for `channel` was invalid.", - "not_archived" : "Channel is not archived." - } -} + "args": { + "channel": { + "desc": "Channel to unarchive", + "required": true, + "type": "channel" + } + }, + "desc": "Unarchives a channel.", + "errors": { + "channel_not_found": "Value passed for `channel` was invalid.", + "not_archived": "Channel is not archived." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/chat.delete.json b/lib/slack/web/docs/chat.delete.json index 9912eac..d69560d 100644 --- a/lib/slack/web/docs/chat.delete.json +++ b/lib/slack/web/docs/chat.delete.json @@ -1,23 +1,21 @@ { - "desc": "Deletes a message.", - - "args": { - "ts": { - "required" : true, - "example" : "1405894322.002768", - "desc" : "Timestamp of the message to be deleted." - }, - "channel": { - "type" : "channel", - "required" : true, - "desc" : "Channel containing the message to be deleted." - } - }, - - "errors": { - "message_not_found" : "No message exists with the requested timestamp.", - "channel_not_found" : "Value passed for `channel` was invalid.", - "cant_delete_message" : "Authenticated user does not have permission to delete this message.", - "compliance_exports_prevent_deletion" : "Compliance exports are on, messages can not be deleted" - } -} + "args": { + "channel": { + "desc": "Channel containing the message to be deleted.", + "required": true, + "type": "channel" + }, + "ts": { + "desc": "Timestamp of the message to be deleted.", + "example": "1405894322.002768", + "required": true + } + }, + "desc": "Deletes a message.", + "errors": { + "cant_delete_message": "Authenticated user does not have permission to delete this message.", + "channel_not_found": "Value passed for `channel` was invalid.", + "compliance_exports_prevent_deletion": "Compliance exports are on, messages can not be deleted", + "message_not_found": "No message exists with the requested timestamp." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/chat.getPermalink.json b/lib/slack/web/docs/chat.getPermalink.json index 2904692..393c56a 100644 --- a/lib/slack/web/docs/chat.getPermalink.json +++ b/lib/slack/web/docs/chat.getPermalink.json @@ -1,21 +1,19 @@ { - "desc": "Retrieve a permalink URL for a specific extant message.", - "args": { "channel": { - "type": "channel", + "desc": "The ID of the conversation or channel containing the message.", "required": true, - "desc": "The ID of the conversation or channel containing the message." + "type": "channel" }, "message_ts": { - "required": true, + "desc": "A message's ts value, uniquely identifying it within a channel.", "example": "1405894322.002768", - "desc": "A message's ts value, uniquely identifying it within a channel." + "required": true } }, - + "desc": "Retrieve a permalink URL for a specific extant message.", "errors": { - "message_not_found": "No message exists with the requested timestamp.", - "channel_not_found": "Value passed for `channel` was invalid." + "channel_not_found": "Value passed for `channel` was invalid.", + "message_not_found": "No message exists with the requested timestamp." } -} +} \ No newline at end of file diff --git a/lib/slack/web/docs/chat.postEphemeral.json b/lib/slack/web/docs/chat.postEphemeral.json index d5bdfa5..4dfb893 100644 --- a/lib/slack/web/docs/chat.postEphemeral.json +++ b/lib/slack/web/docs/chat.postEphemeral.json @@ -1,53 +1,50 @@ { - "desc": "Sends an ephemeral message to a channel.", - - "args": { - "channel": { - "type" : "channel", - "required" : true, - "desc" : "Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name. See [below](#channels) for more details." - }, - "text": { - "required" : true, - "example" : "Hello world", - "desc" : "Text of the message to send. See below for an explanation of [formatting](#formatting)." - }, - "user": { - "type" : "user", - "required" : true, - "desc" : "`id` of the user who will receive the ephemeral message. The user should be in the channel specified by the `channel` argument." - }, - "parse": { - "example" : "full", - "desc" : "Change how messages are treated. Defaults to `none`. See [below](#formatting)." - }, - "link_names": { - "example" : "1", - "desc" : "Find and link channel names and usernames." - }, - "attachments": { - "example" : "[{\"pretext\": \"pre-hello\", \"text\": \"text-world\"}]", - "desc" : "Structured message attachments." - }, - "as_user": { - "required" : false, - "example" : "true", - "desc" : "Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See [authorship](#authorship) below." - }, - "blocks": { - "required" : false, - "example" : "[{\"type\": \"section\", \"text\": {\"type\": \"plain_text\", \"text\": \"Hello world\"}}]", - "desc" : "A JSON-based array of structured blocks, presented as a URL-encoded string" - } - }, - - "errors": { - - "channel_not_found" : "Value passed for `channel` was invalid.", - "user_not_in_channel" : "Cannot post user messages to a channel they are not in.", - "is_archived" : "Channel has been archived.", - "msg_too_long" : "Message text is too long", - "no_text" : "No message text provided", - "rate_limited" : "Application has posted too many messages, [read the Rate Limit documentation](/docs/rate-limits) for more information" - } -} + "args": { + "as_user": { + "desc": "Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See [authorship](#authorship) below.", + "example": "true", + "required": false + }, + "attachments": { + "desc": "Structured message attachments.", + "example": "[{\"pretext\": \"pre-hello\", \"text\": \"text-world\"}]" + }, + "blocks": { + "desc": "A JSON-based array of structured blocks, presented as a URL-encoded string", + "example": "[{\"type\": \"section\", \"text\": {\"type\": \"plain_text\", \"text\": \"Hello world\"}}]", + "required": false + }, + "channel": { + "desc": "Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name. See [below](#channels) for more details.", + "required": true, + "type": "channel" + }, + "link_names": { + "desc": "Find and link channel names and usernames.", + "example": "1" + }, + "parse": { + "desc": "Change how messages are treated. Defaults to `none`. See [below](#formatting).", + "example": "full" + }, + "text": { + "desc": "Text of the message to send. See below for an explanation of [formatting](#formatting).", + "example": "Hello world", + "required": true + }, + "user": { + "desc": "`id` of the user who will receive the ephemeral message. The user should be in the channel specified by the `channel` argument.", + "required": true, + "type": "user" + } + }, + "desc": "Sends an ephemeral message to a channel.", + "errors": { + "channel_not_found": "Value passed for `channel` was invalid.", + "is_archived": "Channel has been archived.", + "msg_too_long": "Message text is too long", + "no_text": "No message text provided", + "rate_limited": "Application has posted too many messages, [read the Rate Limit documentation](/docs/rate-limits) for more information", + "user_not_in_channel": "Cannot post user messages to a channel they are not in." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/chat.postMessage.json b/lib/slack/web/docs/chat.postMessage.json index bb51c78..9aa3637 100644 --- a/lib/slack/web/docs/chat.postMessage.json +++ b/lib/slack/web/docs/chat.postMessage.json @@ -1,76 +1,73 @@ { - "desc": "Sends a message to a channel.", - - "args": { - "channel": { - "type" : "channel", - "required" : true, - "desc" : "Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name. See [below](#channels) for more details." - }, - "text": { - "required" : true, - "example" : "Hello world", - "desc" : "Text of the message to send. See below for an explanation of [formatting](#formatting)." - }, - "parse": { - "example" : "full", - "desc" : "Change how messages are treated. Defaults to `none`. See [below](#formatting)." - }, - "link_names": { - "example" : "1", - "desc" : "Find and link channel names and usernames." - }, - "attachments": { - "example" : "[{\"pretext\": \"pre-hello\", \"text\": \"text-world\"}]", - "desc" : "Structured message attachments." - }, - "blocks": { - "required" : false, - "example" : "[{\"type\": \"section\", \"text\": {\"type\": \"plain_text\", \"text\": \"Hello world\"}}]", - "desc" : "A JSON-based array of structured blocks, presented as a URL-encoded string" - }, - "thread_ts": { - "required" : false, - "example" : "1234567890.123456", - "desc" : "Provide another message's ts value to make this message a reply. Avoid using a reply's ts value; use its parent instead." - }, - "unfurl_links": { - "example" : "true", - "desc" : "Pass true to enable unfurling of primarily text-based content." - }, - "unfurl_media": { - "example" : "false", - "desc" : "Pass false to disable unfurling of media content." - }, - "username": { - "required" : false, - "example" : "My Bot", - "desc" : "Set your bot's user name. Must be used in conjunction with `as_user` set to false, otherwise ignored. See [authorship](#authorship) below." - }, - "as_user": { - "required" : false, - "example" : "true", - "desc" : "Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See [authorship](#authorship) below." - }, - "icon_url": { - "required" : false, - "example" : "http://lorempixel.com/48/48", - "desc" : "URL to an image to use as the icon for this message. Must be used in conjunction with `as_user` set to false, otherwise ignored. See [authorship](#authorship) below." - }, - "icon_emoji": { - "required" : false, - "example" : ":chart_with_upwards_trend:", - "desc" : "emoji to use as the icon for this message. Overrides `icon_url`. Must be used in conjunction with `as_user` set to false, otherwise ignored. See [authorship](#authorship) below." - } - }, - - "errors": { - - "channel_not_found" : "Value passed for `channel` was invalid.", - "not_in_channel" : "Cannot post user messages to a channel they are not in.", - "is_archived" : "Channel has been archived.", - "msg_too_long" : "Message text is too long", - "no_text" : "No message text provided", - "rate_limited" : "Application has posted too many messages, [read the Rate Limit documentation](/docs/rate-limits) for more information" - } -} + "args": { + "as_user": { + "desc": "Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See [authorship](#authorship) below.", + "example": "true", + "required": false + }, + "attachments": { + "desc": "Structured message attachments.", + "example": "[{\"pretext\": \"pre-hello\", \"text\": \"text-world\"}]" + }, + "blocks": { + "desc": "A JSON-based array of structured blocks, presented as a URL-encoded string", + "example": "[{\"type\": \"section\", \"text\": {\"type\": \"plain_text\", \"text\": \"Hello world\"}}]", + "required": false + }, + "channel": { + "desc": "Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name. See [below](#channels) for more details.", + "required": true, + "type": "channel" + }, + "icon_emoji": { + "desc": "emoji to use as the icon for this message. Overrides `icon_url`. Must be used in conjunction with `as_user` set to false, otherwise ignored. See [authorship](#authorship) below.", + "example": ":chart_with_upwards_trend:", + "required": false + }, + "icon_url": { + "desc": "URL to an image to use as the icon for this message. Must be used in conjunction with `as_user` set to false, otherwise ignored. See [authorship](#authorship) below.", + "example": "http://lorempixel.com/48/48", + "required": false + }, + "link_names": { + "desc": "Find and link channel names and usernames.", + "example": "1" + }, + "parse": { + "desc": "Change how messages are treated. Defaults to `none`. See [below](#formatting).", + "example": "full" + }, + "text": { + "desc": "Text of the message to send. See below for an explanation of [formatting](#formatting).", + "example": "Hello world", + "required": true + }, + "thread_ts": { + "desc": "Provide another message's ts value to make this message a reply. Avoid using a reply's ts value; use its parent instead.", + "example": "1234567890.123456", + "required": false + }, + "unfurl_links": { + "desc": "Pass true to enable unfurling of primarily text-based content.", + "example": "true" + }, + "unfurl_media": { + "desc": "Pass false to disable unfurling of media content.", + "example": "false" + }, + "username": { + "desc": "Set your bot's user name. Must be used in conjunction with `as_user` set to false, otherwise ignored. See [authorship](#authorship) below.", + "example": "My Bot", + "required": false + } + }, + "desc": "Sends a message to a channel.", + "errors": { + "channel_not_found": "Value passed for `channel` was invalid.", + "is_archived": "Channel has been archived.", + "msg_too_long": "Message text is too long", + "no_text": "No message text provided", + "not_in_channel": "Cannot post user messages to a channel they are not in.", + "rate_limited": "Application has posted too many messages, [read the Rate Limit documentation](/docs/rate-limits) for more information" + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/chat.scheduleMessage.json b/lib/slack/web/docs/chat.scheduleMessage.json index 7c78b7c..0fdb26b 100644 --- a/lib/slack/web/docs/chat.scheduleMessage.json +++ b/lib/slack/web/docs/chat.scheduleMessage.json @@ -1,122 +1,118 @@ { - "desc": "Schedules a message to be sent to a channel.", - "args": { - "channel": { - "required": true, - "example": "C1234567890", - "desc": "Channel, private group, or DM channel to send message to. Can be an encoded ID, or a name." - }, - "post_at": { - "required": true, - "example": "299876400", - "desc": "Unix EPOCH timestamp of time in future to send the message." - }, "as_user": { - "required": false, + "desc": "Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See `chat.postMessage`.", "example": "true", - "desc": "Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See `chat.postMessage`." + "required": false }, "attachments": { - "required": false, + "desc": "A JSON-based array of structured attachments, presented as a URL-encoded string.", "example": "[{\"pretext\": \"pre-hello\", \"text\": \"text-world\"}]", - "desc": "A JSON-based array of structured attachments, presented as a URL-encoded string." + "required": false }, "blocks": { - "required": false, + "desc": "A JSON-based array of structured blocks, presented as a URL-encoded string.", "example": "[{\"type\": \"section\", \"text\": {\"type\": \"plain_text\", \"text\": \"Hello world\"}}]", - "desc": "A JSON-based array of structured blocks, presented as a URL-encoded string." + "required": false + }, + "channel": { + "desc": "Channel, private group, or DM channel to send message to. Can be an encoded ID, or a name.", + "example": "C1234567890", + "required": true }, "link_names": { - "required": false, + "desc": "Find and link channel names and usernames.", "example": "true", - "desc": "Find and link channel names and usernames." + "required": false }, "parse": { - "required": false, + "desc": "Change how messages are treated. Defaults to none. See `chat.postMessage`.", "example": "full", - "desc": "Change how messages are treated. Defaults to none. See `chat.postMessage`." + "required": false + }, + "post_at": { + "desc": "Unix EPOCH timestamp of time in future to send the message.", + "example": "299876400", + "required": true }, "reply_broadcast": { - "required": false, + "desc": "Used in conjunction with `thread_ts` and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to `false`.", "example": "true", - "desc": "Used in conjunction with `thread_ts` and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to `false`." + "required": false }, "thread_ts": { - "required": false, + "desc": "Provide another message's `ts` value to make this message a reply. Avoid using a reply's `ts` value; use its parent instead.", "example": "1234567890.123456", - "desc": "Provide another message's `ts` value to make this message a reply. Avoid using a reply's `ts` value; use its parent instead." + "required": false }, "unfurl_links": { - "required": false, + "desc": "Pass true to enable unfurling of primarily text-based content.", "example": "true", - "desc": "Pass true to enable unfurling of primarily text-based content." + "required": false }, "unfurl_media": { - "required": false, + "desc": "Pass false to disable unfurling of media content.", "example": "false", - "desc": "Pass false to disable unfurling of media content." + "required": false } }, - - "response": { - "ok": true, - "channel": "C1H9RESGL", - "scheduled_message_id": "Q1298393284", - "post_at": "1562180400", - "message": { - "text": "Here's a message for you in the future", - "username": "ecto1", - "bot_id": "B19LU7CSY", - "attachments": [ - { - "text": "This is an attachment", - "id": 1, - "fallback": "This is an attachment's fallback" - } - ], - "type": "delayed_message", - "subtype": "bot_message" - } - }, - + "desc": "Schedules a message to be sent to a channel.", "errors": { - "invalid_time" : "value passed for `post_time` was invalid.", - "time_in_past" : "value passed for `post_time` was in the past.", - "time_too_far": "value passed for `post_time` was too far into the future.", - "channel_not_found": "Value passed for `channel` was invalid.", - "not_in_channel": "Cannot post user messages to a channel they are not in.", - "is_archived": "Channel has been archived.", - "msg_too_long": "Message text is too long", - "no_text": "No message text provided", - "restricted_action": "A workspace preference prevents the authenticated user from posting.", - "restricted_action_read_only_channel": "Cannot post any message into a read-only channel.", - "restricted_action_thread_only_channel": "Cannot post top-level messages into a thread-only channel.", - "restricted_action_non_threadable_channel": "Cannot post thread replies into a non_threadable channel.", - "too_many_attachments": "Too many attachments were provided with this message. A maximum of 100 attachments are allowed on a message.", - "rate_limited": "Application has posted too many messages, read the Rate Limit documentation for more information", - "not_authed": "No authentication token provided.", - "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", "account_inactive": "Authentication token is for a deleted user or workspace.", - "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed.", - "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", - "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "channel_not_found": "Value passed for `channel` was invalid.", "ekm_access_denied": "Administrators have suspended the ability to post a message.", - "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", - "invalid_arguments": "The method was called with invalid arguments.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was called with invalid arguments.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", "invalid_charset": "The method was called via a `POST` request, but the `charset` specified in the `Content-Type` header was invalid. Valid charset names are: `utf-8` `iso-8859-1`.", "invalid_form_data": "The method was called via a `POST` request with `Content-Type` `application/x-www-form-urlencoded` or `multipart/form-data`, but the form data was either missing or syntactically invalid.", "invalid_post_type": "The method was called via a `POST` request, but the specified `Content-Type` was invalid. Valid types are: `application/json` `application/x-www-form-urlencoded` `multipart/form-data` `text/plain`.", + "invalid_time": "value passed for `post_time` was invalid.", + "is_archived": "Channel has been archived.", "missing_post_type": "The method was called via a `POST` request and included a data payload, but the request did not include a `Content-Type` header.", - "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "msg_too_long": "Message text is too long", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "no_text": "No message text provided", + "not_authed": "No authentication token provided.", + "not_in_channel": "Cannot post user messages to a channel they are not in.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "rate_limited": "Application has posted too many messages, read the Rate Limit documentation for more information", "request_timeout": "The method was called via a `POST` request, but the `POST` data was either missing or truncated.", - "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised." + "restricted_action": "A workspace preference prevents the authenticated user from posting.", + "restricted_action_non_threadable_channel": "Cannot post thread replies into a non_threadable channel.", + "restricted_action_read_only_channel": "Cannot post any message into a read-only channel.", + "restricted_action_thread_only_channel": "Cannot post top-level messages into a thread-only channel.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "time_in_past": "value passed for `post_time` was in the past.", + "time_too_far": "value passed for `post_time` was too far into the future.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed.", + "too_many_attachments": "Too many attachments were provided with this message. A maximum of 100 attachments are allowed on a message." + }, + "response": { + "channel": "C1H9RESGL", + "message": { + "attachments": [ + { + "fallback": "This is an attachment's fallback", + "id": 1, + "text": "This is an attachment" + } + ], + "bot_id": "B19LU7CSY", + "subtype": "bot_message", + "text": "Here's a message for you in the future", + "type": "delayed_message", + "username": "ecto1" + }, + "ok": true, + "post_at": "1562180400", + "scheduled_message_id": "Q1298393284" }, - "warnings": { "message_truncated": "The `text` field of a message should have no more than 40,000 characters. We truncate really long messages.", "missing_charset": "The method was called via a `POST` request, and recommended practice for the specified `Content-Type` is to include a `charset` parameter. However, no `charset` was present. Specifically, non-form-data content types (e.g. `text/plain`) are the ones for which `charset` is recommended.", "superfluous_charset": "The method was called via a `POST` request, and the specified `Content-Type` is not defined to understand the `charset` parameter. However, `charset` was in fact present. Specifically, form-data content types (e.g. `multipart/form-data`) are the ones for which `charset` is superfluous." } -} +} \ No newline at end of file diff --git a/lib/slack/web/docs/chat.unfurl.json b/lib/slack/web/docs/chat.unfurl.json index feae2f0..03a5531 100644 --- a/lib/slack/web/docs/chat.unfurl.json +++ b/lib/slack/web/docs/chat.unfurl.json @@ -1,75 +1,75 @@ { - "desc":"Provide custom unfurl behavior for user-posted URLs.", - "args":{ - "ts":{ - "required":true, - "example":"1405894322.002768", - "desc":"Timestamp of the message to add unfurl behavior to." - }, - "channel":{ - "required":true, - "type":"channel", - "example":"C1234567890", - "desc":"Channel ID of the message." - }, - "unfurls":{ - "required":true, - "desc":"URL-encoded JSON map with keys set to URLs featured in the the message, pointing to their unfurl blocks or message attachments." - }, - "user_auth_message":{ - "required":false, - "desc":"Provide a simply-formatted string to send as an ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior." - }, - "user_auth_required":{ - "required":false, - "example":true, - "desc":"Set to true or 1 to indicate the user must install your Slack app to trigger unfurls for this domain." - }, - "user_auth_url":{ - "required":false, - "example":"https://example.com/onboarding?user_id=xxx", - "desc":"Send users to this custom URL where they will complete authentication in your app to fully trigger unfurling. Value should be properly URL-encoded.." - } + "args": { + "channel": { + "desc": "Channel ID of the message.", + "example": "C1234567890", + "required": true, + "type": "channel" }, - "errors":{ - "missing_channel":"The request is missing the channel parameter", - "missing_ts":"The request is missing the ts parameter", - "cannot_find_channel":"The specified channel could not be located for this token.", - "cannot_find_service":"A record of your app being allowed to unfurl for this workspace could not be found.", - "cannot_parse_attachment":"The provided unfurls argument could not be parsed or understood.", - "missing_unfurls":"The request is missing the unfurls parameter.", - "invalid_unfurls_format":"The unfurls parameter cannot be JSON-decoded into a map of URLs to attachments.", - "cannot_unfurl_url":"The URL cannot be unfurled. This error may be returned if you haven't acknowledged a link_shared event tied to the same URL. It is also returned when the domain appears in a workspace's administrative blacklists.", - "cannot_prompt":"The current user has already interacted with and dismissed a prompt for this application.", - "cannot_find_message":"The ts value in the request does not match a message.", - "cannot_unfurl_message":"The URL cannot be unfurled because the URL provided does not appear in the message.", - "not_authed":"No authentication token provided.", - "invalid_auth":"Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", - "account_inactive":"Authentication token is for a deleted user or workspace.", - "token_revoked":"Authentication token is for a deleted user or workspace or the app has been removed.", - "no_permission":"The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", - "org_login_required":"The workspace is undergoing an enterprise migration and will not be available until migration is complete.", - "ekm_access_denied":"Administrators have suspended the ability to post a message.", - "missing_scope":"The token used is not granted the specific scope permissions required to complete this request.", - "not_allowed_token_type":"The token type used in this request is not allowed.", - "method_deprecated":"The method has been deprecated.", - "deprecated_endpoint":"The endpoint has been deprecated.", - "two_factor_setup_required":"Two factor setup is required.", - "enterprise_is_restricted":"The method cannot be called from an Enterprise.", - "is_bot":"This method cannot be called by a bot user.", - "invalid_arguments":"The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", - "invalid_arg_name":"The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", - "invalid_array_arg":"The method was passed an array as an argument. Please only input valid strings.", - "invalid_charset":"The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8 iso-8859-1.", - "invalid_form_data":"The method was called via a POST request with Content-Type application/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", - "invalid_post_type":"The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/json application/x-www-form-urlencoded multipart/form-data text/plain.", - "missing_post_type":"The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", - "team_added_to_org":"The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", - "ratelimited":"The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", - "accesslimited":"Access to this method is limited on the current network", - "request_timeout":"The method was called via a POST request, but the POST data was either missing or truncated.", - "service_unavailable":"The service is temporarily unavailable", - "fatal_error":"The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", - "internal_error":"The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised." + "ts": { + "desc": "Timestamp of the message to add unfurl behavior to.", + "example": "1405894322.002768", + "required": true + }, + "unfurls": { + "desc": "URL-encoded JSON map with keys set to URLs featured in the the message, pointing to their unfurl blocks or message attachments.", + "required": true + }, + "user_auth_message": { + "desc": "Provide a simply-formatted string to send as an ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior.", + "required": false + }, + "user_auth_required": { + "desc": "Set to true or 1 to indicate the user must install your Slack app to trigger unfurls for this domain.", + "example": true, + "required": false + }, + "user_auth_url": { + "desc": "Send users to this custom URL where they will complete authentication in your app to fully trigger unfurling. Value should be properly URL-encoded..", + "example": "https://example.com/onboarding?user_id=xxx", + "required": false } - } \ No newline at end of file + }, + "desc": "Provide custom unfurl behavior for user-posted URLs.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace.", + "cannot_find_message": "The ts value in the request does not match a message.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "missing_unfurls": "The request is missing the unfurls parameter.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "missing_channel": "The request is missing the channel parameter", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/json application/x-www-form-urlencoded multipart/form-data text/plain.", + "cannot_find_service": "A record of your app being allowed to unfurl for this workspace could not be found.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "cannot_unfurl_url": "The URL cannot be unfurled. This error may be returned if you haven't acknowledged a link_shared event tied to the same URL. It is also returned when the domain appears in a workspace's administrative blacklists.", + "invalid_form_data": "The method was called via a POST request with Content-Type application/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "cannot_parse_attachment": "The provided unfurls argument could not be parsed or understood.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "missing_ts": "The request is missing the ts parameter", + "invalid_unfurls_format": "The unfurls parameter cannot be JSON-decoded into a map of URLs to attachments.", + "cannot_prompt": "The current user has already interacted with and dismissed a prompt for this application.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8 iso-8859-1.", + "cannot_unfurl_message": "The URL cannot be unfurled because the URL provided does not appear in the message.", + "cannot_find_channel": "The specified channel could not be located for this token.", + "method_deprecated": "The method has been deprecated." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/chat.update.json b/lib/slack/web/docs/chat.update.json index 4cf9f06..b3bb8d2 100644 --- a/lib/slack/web/docs/chat.update.json +++ b/lib/slack/web/docs/chat.update.json @@ -1,54 +1,52 @@ { - "desc": "Updates a message.", - - "args": { - "ts": { - "required" : true, - "example" : "1405894322.002768", - "desc" : "Timestamp of the message to be updated." - }, - "channel": { - "type" : "channel", - "required" : true, - "desc" : "Channel containing the message to be updated." - }, - "text": { - "required" : false, - "example" : "Hello world", - "desc" : "New text for the message, using the default formatting rules. It's not required when presenting blocks or attachments." - }, - "attachments": { - "example" : "[{\"pretext\": \"pre-hello\", \"text\": \"text-world\"}]", - "desc" : "Structured message attachments." - }, - "parse": { - "required" : false, - "example" : "none", - "desc" : "Change how messages are treated. Defaults to `client`, unlike `chat.postMessage`. See [below](#formatting)." - }, - "link_names": { - "required" : false, - "example" : "1", - "desc" : "Find and link channel names and usernames. Defaults to `none`. This parameter should be used in conjunction with `parse`. To set `link_names` to `1`, specify a `parse` mode of `full`." - }, - "as_user": { - "required" : false, - "example" : "true", - "desc" : "Pass true to update the message as the authed user. [Bot users](/bot-users) in this context are considered authed users." - }, - "blocks": { - "required" : false, - "example" : "[{\"type\": \"section\", \"text\": {\"type\": \"plain_text\", \"text\": \"Hello world\"}}]", - "desc": "A JSON-based array of structured blocks, presented as a URL-encoded string. If you don't include this field, the message's previous `blocks` will be retained. To remove previous `blocks`, include an empty array for this field." - } - }, - - "errors": { - "message_not_found" : "No message exists with the requested timestamp.", - "cant_update_message" : "Authenticated user does not have permission to update this message.", - "channel_not_found" : "Value passed for `channel` was invalid.", - "edit_window_closed": "The message cannot be edited due to the team message edit settings", - "msg_too_long" : "Message text is too long", - "no_text" : "No message text provided" - } -} + "args": { + "as_user": { + "desc": "Pass true to update the message as the authed user. [Bot users](/bot-users) in this context are considered authed users.", + "example": "true", + "required": false + }, + "attachments": { + "desc": "Structured message attachments.", + "example": "[{\"pretext\": \"pre-hello\", \"text\": \"text-world\"}]" + }, + "blocks": { + "desc": "A JSON-based array of structured blocks, presented as a URL-encoded string. If you don't include this field, the message's previous `blocks` will be retained. To remove previous `blocks`, include an empty array for this field.", + "example": "[{\"type\": \"section\", \"text\": {\"type\": \"plain_text\", \"text\": \"Hello world\"}}]", + "required": false + }, + "channel": { + "desc": "Channel containing the message to be updated.", + "required": true, + "type": "channel" + }, + "link_names": { + "desc": "Find and link channel names and usernames. Defaults to `none`. This parameter should be used in conjunction with `parse`. To set `link_names` to `1`, specify a `parse` mode of `full`.", + "example": "1", + "required": false + }, + "parse": { + "desc": "Change how messages are treated. Defaults to `client`, unlike `chat.postMessage`. See [below](#formatting).", + "example": "none", + "required": false + }, + "text": { + "desc": "New text for the message, using the default formatting rules. It's not required when presenting blocks or attachments.", + "example": "Hello world", + "required": false + }, + "ts": { + "desc": "Timestamp of the message to be updated.", + "example": "1405894322.002768", + "required": true + } + }, + "desc": "Updates a message.", + "errors": { + "cant_update_message": "Authenticated user does not have permission to update this message.", + "channel_not_found": "Value passed for `channel` was invalid.", + "edit_window_closed": "The message cannot be edited due to the team message edit settings", + "message_not_found": "No message exists with the requested timestamp.", + "msg_too_long": "Message text is too long", + "no_text": "No message text provided" + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/conversations.close.json b/lib/slack/web/docs/conversations.close.json index 692cf13..f18fa8b 100644 --- a/lib/slack/web/docs/conversations.close.json +++ b/lib/slack/web/docs/conversations.close.json @@ -1,15 +1,13 @@ { - "desc": "Closes direct messages, multi-person or 1:1 or otherwise.", - "args": { "channel": { - "example" : "G1234567890", - "required": true, - "desc" : "Conversation to close." + "desc": "Conversation to close.", + "example": "G1234567890", + "required": true } }, - + "desc": "Closes direct messages, multi-person or 1:1 or otherwise.", "errors": { "channel_not_found": "Value passed for `channel` was invalid" } -} +} \ No newline at end of file diff --git a/lib/slack/web/docs/conversations.create.json b/lib/slack/web/docs/conversations.create.json index 1543993..14b6b33 100644 --- a/lib/slack/web/docs/conversations.create.json +++ b/lib/slack/web/docs/conversations.create.json @@ -1,102 +1,98 @@ { - "desc": "Initiates a public or private channel-based conversation.", - "args": { - "name": { - "required" : true, - "example" : "mychannel", - "desc" : "Name of the public or private channel to create." - }, "is_private": { - "required" : false, - "example" : "true", - "desc" : "Create a private channel instead of a public one." + "desc": "Create a private channel instead of a public one.", + "example": "true", + "required": false + }, + "name": { + "desc": "Name of the public or private channel to create.", + "example": "mychannel", + "required": true }, "user_ids": { - "required" : false, - "example" : "W1234567890,U2345678901,U3456789012", - "desc" : "Required for workspace apps. A list of between 1 and 30 human users that will be added to the newly-created conversation. This argument has no effect when used by classic Slack apps." + "desc": "Required for workspace apps. A list of between 1 and 30 human users that will be added to the newly-created conversation. This argument has no effect when used by classic Slack apps.", + "example": "W1234567890,U2345678901,U3456789012", + "required": false } }, - + "desc": "Initiates a public or private channel-based conversation.", + "errors": { + "account_inactive": "Authentication token is for a deleted user or workspace.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was called with invalid arguments.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_charset": "The method was called via a `POST` request, but the `charset` specified in the `Content-Type` header was invalid. Valid charset names are: `utf-8` `iso-8859-1`.", + "invalid_form_data": "The method was called via a `POST` request with `Content-Type` `application/x-www-form-urlencoded` or `multipart/form-data`, but the form data was either missing or syntactically invalid.", + "invalid_name": "Value passed for `name` was invalid.", + "invalid_name_maxlength": "Value passed for `name` exceeded max length.", + "invalid_name_punctuation": "Value passed for `name` contained only punctuation.", + "invalid_name_required": "Value passed for `name` was empty.", + "invalid_name_specials": "Value passed for `name` contained unallowed special characters or upper case characters.", + "invalid_post_type": "The method was called via a `POST` request, but the specified `Content-Type` was invalid. Valid types are: `application/json` `application/x-www-form-urlencoded` `multipart/form-data` `text/plain`.", + "invalid_users": "Value passed for `user_ids` was empty or invalid.", + "is_bot": "This method cannot be called by a bot user.", + "missing_post_type": "The method was called via a `POST` request and included a data payload, but the request did not include a `Content-Type` header.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "name_taken": "A channel cannot be created with the given name.", + "no_channel": "Value passed for `name` was empty.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_authed": "No authentication token provided.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "request_timeout": "The method was called via a `POST` request, but the `POST` data was either missing or truncated.", + "restricted_action": "A team preference prevents the authenticated user from creating channels.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed.", + "too_many_convos_for_app_on_team": "This app has exceeded its per-workspace limit of public and private channels.", + "too_many_convos_for_team": "The workspace has exceeded its limit of public and private channels.", + "user_is_ultra_restricted": "This method cannot be called by a single channel guest.", + "user_not_found": "One or more users in `user_ids` was not found." + }, "response": { - "ok": true, "channel": { - "id": "C0EAQDV4Z", - "name": "endeavor", - "is_channel": true, - "is_group": false, - "is_im": false, "created": 1504554479, "creator": "U0123456", + "id": "C0EAQDV4Z", "is_archived": false, - "is_general": false, - "unlinked": 0, - "name_normalized": "endeavor", - "is_shared": false, + "is_channel": true, "is_ext_shared": false, + "is_general": false, + "is_group": false, + "is_im": false, + "is_member": true, + "is_mpim": false, "is_org_shared": false, - "pending_shared": [], "is_pending_ext_shared": false, - "is_member": true, "is_private": false, - "is_mpim": false, + "is_shared": false, "last_read": "0000000000.000000", "latest": null, - "unread_count": 0, - "unread_count_display": 0, - "topic": { - "value": "", + "name": "endeavor", + "name_normalized": "endeavor", + "pending_shared": [], + "previous_names": [], + "priority": 0, + "purpose": { "creator": "", - "last_set": 0 + "last_set": 0, + "value": "" }, - "purpose": { - "value": "", + "topic": { "creator": "", - "last_set": 0 + "last_set": 0, + "value": "" }, - "previous_names": [], - "priority": 0 - } - }, - - "errors": { - "name_taken": "A channel cannot be created with the given name.", - "restricted_action": "A team preference prevents the authenticated user from creating channels.", - "no_channel": "Value passed for `name` was empty.", - "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", - "invalid_name_required": "Value passed for `name` was empty.", - "invalid_name_punctuation": "Value passed for `name` contained only punctuation.", - "invalid_name_maxlength": "Value passed for `name` exceeded max length.", - "invalid_name_specials": "Value passed for `name` contained unallowed special characters or upper case characters.", - "invalid_name": "Value passed for `name` was invalid.", - "invalid_users": "Value passed for `user_ids` was empty or invalid.", - "user_not_found": "One or more users in `user_ids` was not found.", - "too_many_convos_for_team": "The workspace has exceeded its limit of public and private channels.", - "too_many_convos_for_app_on_team": "This app has exceeded its per-workspace limit of public and private channels.", - "not_authed": "No authentication token provided.", - "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", - "account_inactive": "Authentication token is for a deleted user or workspace.", - "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed.", - "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", - "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", - "ekm_access_denied": "Administrators have suspended the ability to post a message.", - "is_bot": "This method cannot be called by a bot user.", - "user_is_ultra_restricted": "This method cannot be called by a single channel guest.", - "invalid_arguments": "The method was called with invalid arguments.", - "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", - "invalid_charset": "The method was called via a `POST` request, but the `charset` specified in the `Content-Type` header was invalid. Valid charset names are: `utf-8` `iso-8859-1`.", - "invalid_form_data": "The method was called via a `POST` request with `Content-Type` `application/x-www-form-urlencoded` or `multipart/form-data`, but the form data was either missing or syntactically invalid.", - "invalid_post_type": "The method was called via a `POST` request, but the specified `Content-Type` was invalid. Valid types are: `application/json` `application/x-www-form-urlencoded` `multipart/form-data` `text/plain`.", - "missing_post_type": "The method was called via a `POST` request and included a data payload, but the request did not include a `Content-Type` header.", - "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", - "request_timeout": "The method was called via a `POST` request, but the `POST` data was either missing or truncated.", - "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", - "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised." + "unlinked": 0, + "unread_count": 0, + "unread_count_display": 0 + }, + "ok": true }, - "warnings": { "missing_charset": "The method was called via a `POST` request, and recommended practice for the specified `Content-Type` is to include a `charset` parameter. However, no `charset` was present. Specifically, non-form-data content types (e.g. `text/plain`) are the ones for which `charset` is recommended.", "superfluous_charset": "The method was called via a `POST` request, and the specified `Content-Type` is not defined to understand the `charset` parameter. However, `charset` was in fact present. Specifically, form-data content types (e.g. `multipart/form-data`) are the ones for which `charset` is superfluous." } -} +} \ No newline at end of file diff --git a/lib/slack/web/docs/conversations.history.json b/lib/slack/web/docs/conversations.history.json index 27eeb7c..24fb1bc 100644 --- a/lib/slack/web/docs/conversations.history.json +++ b/lib/slack/web/docs/conversations.history.json @@ -1,44 +1,42 @@ { - "desc": "Returns a portion of message events from the specified conversation.\n\nBot user tokens may use this method for direct message and multi-party direct message conversations but lack sufficient permissions to use this method on public and private channels.", - "args": { "channel": { - "example" : "G1234567890", - "required": true, - "desc" : "Conversation ID to fetch history for." + "desc": "Conversation ID to fetch history for.", + "example": "G1234567890", + "required": true }, "cursor": { - "example" : "dXNlcjpVMDYxTkZUVDI=", - "required": false, - "desc" : "Paginate through collections of data by setting the cursor parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first \"page\" of the collection. See pagination for more detail." + "desc": "Paginate through collections of data by setting the cursor parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first \"page\" of the collection. See pagination for more detail.", + "example": "dXNlcjpVMDYxTkZUVDI=", + "required": false }, "inclusive": { - "example" : "true", - "required": false, - "desc" : "Include messages with latest or oldest timestamp in results only when either timestamp is specified.", - "default" : 0 + "default": 0, + "desc": "Include messages with latest or oldest timestamp in results only when either timestamp is specified.", + "example": "true", + "required": false }, "latest": { - "example" : "1234567890.123456", - "required": false, - "desc" : "End of time range of messages to include in results.", - "default" : "now" + "default": "now", + "desc": "End of time range of messages to include in results.", + "example": "1234567890.123456", + "required": false }, "limit": { - "example" : 20, - "required": false, - "desc" : "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.", - "default" : 100 + "default": 100, + "desc": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.", + "example": 20, + "required": false }, "oldest": { - "example" : "1234567890.123456", - "required": false, - "desc" : "Start of time range of messages to include in results.", - "default" : 0 + "default": 0, + "desc": "Start of time range of messages to include in results.", + "example": "1234567890.123456", + "required": false } }, - + "desc": "Returns a portion of message events from the specified conversation.\n\nBot user tokens may use this method for direct message and multi-party direct message conversations but lack sufficient permissions to use this method on public and private channels.", "errors": { "channel_not_found": "Value passed for `channel` was invalid" } -} +} \ No newline at end of file diff --git a/lib/slack/web/docs/conversations.info.json b/lib/slack/web/docs/conversations.info.json index ce8243b..6274327 100644 --- a/lib/slack/web/docs/conversations.info.json +++ b/lib/slack/web/docs/conversations.info.json @@ -1,27 +1,25 @@ { - "desc": "Returns information about a workspace conversation.", - "args": { "channel": { - "example" : "G1234567890", - "required": true, - "desc" : "Conversation ID to learn more about." + "desc": "Conversation ID to learn more about.", + "example": "G1234567890", + "required": true }, "include_locale": { - "example" : "true", - "required": false, - "desc" : "Set this to `true` to receive the locale for this conversation. Defaults to `false`", - "default" : "false" + "default": "false", + "desc": "Set this to `true` to receive the locale for this conversation. Defaults to `false`", + "example": "true", + "required": false }, "include_num_members": { - "example" : "true", - "required": false, - "desc" : "Set to `true` to include the member count for the specified conversation. Defaults to `false`", - "default" : "false" + "default": "false", + "desc": "Set to `true` to include the member count for the specified conversation. Defaults to `false`", + "example": "true", + "required": false } }, - + "desc": "Returns information about a workspace conversation.", "errors": { "channel_not_found": "Value passed for `channel` was invalid" } -} +} \ No newline at end of file diff --git a/lib/slack/web/docs/conversations.invite.json b/lib/slack/web/docs/conversations.invite.json index 5fea753..b50ee57 100644 --- a/lib/slack/web/docs/conversations.invite.json +++ b/lib/slack/web/docs/conversations.invite.json @@ -1,100 +1,95 @@ { - "desc": "Invites users to a channel.", - "args": { "channel": { - "required" : true, - "example" : "C1234567890", - "desc" : "The ID of the public or private channel to invite user(s) to." + "desc": "The ID of the public or private channel to invite user(s) to.", + "example": "C1234567890", + "required": true }, "users": { - "required" : true, - "example" : "W1234567890,U2345678901,U3456789012", - "desc" : "A comma separated list of user IDs. Up to 1000 users may be listed." + "desc": "A comma separated list of user IDs. Up to 1000 users may be listed.", + "example": "W1234567890,U2345678901,U3456789012", + "required": true } }, - + "desc": "Invites users to a channel.", + "errors": { + "account_inactive": "Authentication token is for a deleted user or workspace.", + "already_in_channel": "Invited user is already in the channel.", + "cant_invite": "User cannot be invited to this channel.", + "cant_invite_self": "Authenticated user cannot invite themselves to a channel.", + "channel_not_found": "Value passed for `channel` was invalid.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was called with invalid arguments.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_charset": "The method was called via a `POST` request, but the `charset` specified in the `Content-Type` header was invalid. Valid charset names are: `utf-8` `iso-8859-1`.", + "invalid_form_data": "The method was called via a `POST` request with `Content-Type` `application/x-www-form-urlencoded` or `multipart/form-data`, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a `POST` request, but the specified `Content-Type` was invalid. Valid types are: `application/json` `application/x-www-form-urlencoded` `multipart/form-data` `text/plain`.", + "invitee_cant_see_channel": "The Grid multi-workspace channel you are inviting a user to is not shared with any workspaces the user is currently a member of.", + "is_archived": "Channel has been archived.", + "is_bot": "This method cannot be called by a bot user.", + "method_not_supported_for_channel_type": "This type of conversation cannot be used with this method.", + "missing_post_type": "The method was called via a `POST` request and included a data payload, but the request did not include a `Content-Type` header.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "no_user": "No value was passed for `users`.", + "not_authed": "No authentication token provided.", + "not_in_channel": "Authenticated user is not in the channel.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "request_timeout": "The method was called via a `POST` request, but the `POST` data was either missing or truncated.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed.", + "ura_max_channels": "URA is already in the maximum number of channels.", + "user_is_ultra_restricted": "This method cannot be called by a single channel guest.", + "user_not_found": "Value passed for `users` was invalid." + }, "response": { - "ok": true, - "ok": true, "channel": { - "id": "C012AB3CD", - "name": "general", - "is_channel": true, - "is_group": false, - "is_im": false, "created": 1449252889, "creator": "W012A3BCD", + "id": "C012AB3CD", "is_archived": false, - "is_general": true, - "unlinked": 0, - "name_normalized": "general", - "is_read_only": false, - "is_shared": false, + "is_channel": true, "is_ext_shared": false, + "is_general": true, + "is_group": false, + "is_im": false, + "is_member": true, + "is_mpim": false, "is_org_shared": false, - "pending_shared": [], "is_pending_ext_shared": false, - "is_member": true, "is_private": false, - "is_mpim": false, + "is_read_only": false, + "is_shared": false, "last_read": "1502126650.228446", - "topic": { - "value": "For public discussion of generalities", - "creator": "W012A3BCD", - "last_set": 1449709364 - }, - "purpose": { - "value": "This part of the workspace is for fun. Make fun here.", - "creator": "W012A3BCD", - "last_set": 1449709364 - }, + "locale": "en-US", + "name": "general", + "name_normalized": "general", + "num_members": 23, + "pending_shared": [], "previous_names": [ "specifics", "abstractions", "etc" ], - "num_members": 23, - "locale": "en-US" - } - }, - - "errors": { - "channel_not_found": "Value passed for `channel` was invalid.", - "user_not_found": "Value passed for `users` was invalid.", - "no_user": "No value was passed for `users`.", - "cant_invite_self": "Authenticated user cannot invite themselves to a channel.", - "not_in_channel": "Authenticated user is not in the channel.", - "already_in_channel": "Invited user is already in the channel.", - "is_archived": "Channel has been archived.", - "cant_invite": "User cannot be invited to this channel.", - "method_not_supported_for_channel_type": "This type of conversation cannot be used with this method.", - "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", - "invitee_cant_see_channel": "The Grid multi-workspace channel you are inviting a user to is not shared with any workspaces the user is currently a member of.", - "ura_max_channels": "URA is already in the maximum number of channels.", - "not_authed": "No authentication token provided.", - "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", - "account_inactive": "Authentication token is for a deleted user or workspace.", - "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed.", - "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", - "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", - "ekm_access_denied": "Administrators have suspended the ability to post a message.", - "is_bot": "This method cannot be called by a bot user.", - "user_is_ultra_restricted": "This method cannot be called by a single channel guest.", - "invalid_arguments": "The method was called with invalid arguments.", - "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", - "invalid_charset": "The method was called via a `POST` request, but the `charset` specified in the `Content-Type` header was invalid. Valid charset names are: `utf-8` `iso-8859-1`.", - "invalid_form_data": "The method was called via a `POST` request with `Content-Type` `application/x-www-form-urlencoded` or `multipart/form-data`, but the form data was either missing or syntactically invalid.", - "invalid_post_type": "The method was called via a `POST` request, but the specified `Content-Type` was invalid. Valid types are: `application/json` `application/x-www-form-urlencoded` `multipart/form-data` `text/plain`.", - "missing_post_type": "The method was called via a `POST` request and included a data payload, but the request did not include a `Content-Type` header.", - "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", - "request_timeout": "The method was called via a `POST` request, but the `POST` data was either missing or truncated.", - "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", - "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised." + "purpose": { + "creator": "W012A3BCD", + "last_set": 1449709364, + "value": "This part of the workspace is for fun. Make fun here." + }, + "topic": { + "creator": "W012A3BCD", + "last_set": 1449709364, + "value": "For public discussion of generalities" + }, + "unlinked": 0 + }, + "ok": true }, - "warnings": { "missing_charset": "The method was called via a `POST` request, and recommended practice for the specified `Content-Type` is to include a `charset` parameter. However, no `charset` was present. Specifically, non-form-data content types (e.g. `text/plain`) are the ones for which `charset` is recommended.", "superfluous_charset": "The method was called via a `POST` request, and the specified `Content-Type` is not defined to understand the `charset` parameter. However, `charset` was in fact present. Specifically, form-data content types (e.g. `multipart/form-data`) are the ones for which `charset` is superfluous." } -} +} \ No newline at end of file diff --git a/lib/slack/web/docs/conversations.join.json b/lib/slack/web/docs/conversations.join.json index a8933ec..c3db7ee 100644 --- a/lib/slack/web/docs/conversations.join.json +++ b/lib/slack/web/docs/conversations.join.json @@ -1,43 +1,41 @@ { - "desc": "Joins an existing conversation", - "args": { "channel": { + "desc": "ID of conversation to join", "example": "C1234567890", - "required": true, - "desc": "ID of conversation to join" + "required": true } }, - + "desc": "Joins an existing conversation", "errors": { - "channel_not_found": "Value passed for `channel` was invalid.", - "is_archived": "Channel has been archived.", - "method_not_supported_for_channel_type": "This type of conversation cannot be used with this method.", - "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", - "too_many_members": "The membership in the channel has exceeded our maximum member limit. No more users can join the channel.", - "not_authed": "No authentication token provided.", - "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", "account_inactive": "Authentication token is for a deleted user or workspace.", - "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed.", - "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", - "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", - "ekm_access_denied": "Administrators have suspended the ability to post a message.", - "not_allowed_token_type": "The token type used in this request is not allowed.", - "method_deprecated": "The method has been deprecated.", + "channel_not_found": "Value passed for `channel` was invalid.", "deprecated_endpoint": "The endpoint has been deprecated.", - "is_bot": "This method cannot be called by a bot user.", - "user_is_restricted": "This method cannot be called by a restricted user or single channel guest.", - "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than `_`. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", "invalid_charset": "The method was called via a `POST` request, but the charset specified in the `Content-Type` header was invalid. Valid charset names are: `utf-8` `iso-8859-1`.", "invalid_form_data": "The method was called via a `POST` request with `Content-Type` `application/x-www-form-urlencoded` or `multipart/form-data`, but the form data was either missing or syntactically invalid.", "invalid_post_type": "The method was called via a `POST` request, but the specified `Content-Type` was invalid. Valid types are: `application/json` `application/x-www-form-urlencoded` `multipart/form-data` `text/plain`.", + "is_archived": "Channel has been archived.", + "is_bot": "This method cannot be called by a bot user.", + "method_deprecated": "The method has been deprecated.", + "method_not_supported_for_channel_type": "This type of conversation cannot be used with this method.", "missing_post_type": "The method was called via a `POST` request and included a data payload, but the request did not include a `Content-Type` header.", - "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "not_authed": "No authentication token provided.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", "ratelimited": "The request has been ratelimited. Refer to the `Retry-After` header for when to retry the request.", "request_timeout": "The method was called via a `POST` request, but the `POST` data was either missing or truncated.", "service_unavailable": "The service is temporarily unavailable", - "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", - "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised." + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed.", + "too_many_members": "The membership in the channel has exceeded our maximum member limit. No more users can join the channel.", + "user_is_restricted": "This method cannot be called by a restricted user or single channel guest." } -} +} \ No newline at end of file diff --git a/lib/slack/web/docs/conversations.list.json b/lib/slack/web/docs/conversations.list.json index ae6e2a1..aee2f26 100644 --- a/lib/slack/web/docs/conversations.list.json +++ b/lib/slack/web/docs/conversations.list.json @@ -1,36 +1,34 @@ { - "desc": "Returns a list of all channel-like conversations in a workspace.", - "args": { "cursor": { - "example" : "dXNlcjpVMDYxTkZUVDI=", - "required": false, - "desc" : "Paginate through collections of data by setting the cursor parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first \"page\" of the collection. See pagination for more detail." + "desc": "Paginate through collections of data by setting the cursor parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first \"page\" of the collection. See pagination for more detail.", + "example": "dXNlcjpVMDYxTkZUVDI=", + "required": false }, "exclude_archived": { - "example" : "true", - "required": false, - "desc" : "Set this to `true` to exclude archived channels from the list", - "default" : "false" + "default": "false", + "desc": "Set this to `true` to exclude archived channels from the list", + "example": "true", + "required": false }, "limit": { - "example" : 20, - "required": false, - "desc" : "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. Must be an integer no larger than 1000.", - "default" : 100 + "default": 100, + "desc": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. Must be an integer no larger than 1000.", + "example": 20, + "required": false }, "types": { - "example" : "public_channel,private_channel", - "required": false, - "desc" : "Mix and match channel types by providing a comma-separated list of any combination of `public_channel`, `private_channel`, `mpim`, `im`", - "default" : "public_channel" + "default": "public_channel", + "desc": "Mix and match channel types by providing a comma-separated list of any combination of `public_channel`, `private_channel`, `mpim`, `im`", + "example": "public_channel,private_channel", + "required": false } }, - + "desc": "Returns a list of all channel-like conversations in a workspace.", "errors": { - "method_not_supported_for_channel_type": "This type of conversation cannot be used with this method.", - "invalid_limit": "Value passed for `limit` was invalid.", "invalid_cursor": "Value passed for `cursor` was invalid.", - "invalid_types": "Value passed for type could not be used based on the method's capabilities or the permission scopes granted to the used token." + "invalid_limit": "Value passed for `limit` was invalid.", + "invalid_types": "Value passed for type could not be used based on the method's capabilities or the permission scopes granted to the used token.", + "method_not_supported_for_channel_type": "This type of conversation cannot be used with this method." } -} +} \ No newline at end of file diff --git a/lib/slack/web/docs/conversations.members.json b/lib/slack/web/docs/conversations.members.json index 0adb69d..3813f6c 100644 --- a/lib/slack/web/docs/conversations.members.json +++ b/lib/slack/web/docs/conversations.members.json @@ -1,36 +1,34 @@ { - "desc": "Returns a paginated list of members party to a conversation.", - "args": { "channel": { - "example" : "G1234567890", - "required": true, - "desc" : "ID of the conversation to retrieve members for" + "desc": "ID of the conversation to retrieve members for", + "example": "G1234567890", + "required": true }, "cursor": { - "example" : "dXNlcjpVMDYxTkZUVDI=", - "required": false, - "desc" : "Paginate through collections of data by setting the cursor parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first \"page\" of the collection. See pagination for more detail." + "desc": "Paginate through collections of data by setting the cursor parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first \"page\" of the collection. See pagination for more detail.", + "example": "dXNlcjpVMDYxTkZUVDI=", + "required": false }, "exclude_archived": { - "example" : "true", - "required": false, - "desc" : "Set this to `true` to exclude archived channels from the list", - "default" : "false" + "default": "false", + "desc": "Set this to `true` to exclude archived channels from the list", + "example": "true", + "required": false }, "limit": { - "example" : 20, - "required": false, - "desc" : "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached.", - "default" : 100 + "default": 100, + "desc": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached.", + "example": 20, + "required": false } }, - + "desc": "Returns a paginated list of members party to a conversation.", "errors": { - "method_not_supported_for_channel_type": "This type of conversation cannot be used with this method.", "channel_not_found": "Value passed for `channel` was invalid.", - "invalid_limit": "Value passed for `limit` was invalid.", + "fetch_members_failed": "Failed to fetch members for the conversation.", "invalid_cursor": "Value passed for `cursor` was invalid.", - "fetch_members_failed": "Failed to fetch members for the conversation." + "invalid_limit": "Value passed for `limit` was invalid.", + "method_not_supported_for_channel_type": "This type of conversation cannot be used with this method." } -} +} \ No newline at end of file diff --git a/lib/slack/web/docs/conversations.open.json b/lib/slack/web/docs/conversations.open.json index 1ce8a9b..200dd02 100644 --- a/lib/slack/web/docs/conversations.open.json +++ b/lib/slack/web/docs/conversations.open.json @@ -1,32 +1,30 @@ { - "desc": "Opens a multi-person direct message or just a 1:1 direct message.", - "args": { "channel": { - "example" : "G1234567890", - "required": false, - "desc" : "Resume a conversation by supplying an `im` or `mpim`'s ID. Or provide the `users` field instead." + "desc": "Resume a conversation by supplying an `im` or `mpim`'s ID. Or provide the `users` field instead.", + "example": "G1234567890", + "required": false }, "return_im": { - "example" : "true", - "required": false, - "desc" : "Boolean, indicates you want the full IM channel definition in the response." + "desc": "Boolean, indicates you want the full IM channel definition in the response.", + "example": "true", + "required": false }, "users": { - "example" : "W1234567890,U2345678901,U3456789012", - "required": false, - "desc" : "Comma separated lists of users. If only one user is included, this creates a 1:1 DM. The ordering of the users is preserved whenever a multi-person direct message is returned. Supply a `channel` when not supplying `users`." + "desc": "Comma separated lists of users. If only one user is included, this creates a 1:1 DM. The ordering of the users is preserved whenever a multi-person direct message is returned. Supply a `channel` when not supplying `users`.", + "example": "W1234567890,U2345678901,U3456789012", + "required": false } }, - + "desc": "Opens a multi-person direct message or just a 1:1 direct message.", "errors": { "channel_not_found": "Value passed for `channel` was invalid", - "user_not_found": "Value(s) passed for `users` was invalid", - "user_not_visible": "The calling user is restricted from seeing the requested user.", - "user_disabled": "A specified `user` has been disabled", - "users_list_not_supplied": "Missing `users` in request", + "method_not_supported_for_channel_type": "This type of conversation cannot be used with this method.", "not_enough_users": "Needs at least 2 users to open", "too_many_users": "Needs at most 8 users to open", - "method_not_supported_for_channel_type": "This type of conversation cannot be used with this method." + "user_disabled": "A specified `user` has been disabled", + "user_not_found": "Value(s) passed for `users` was invalid", + "user_not_visible": "The calling user is restricted from seeing the requested user.", + "users_list_not_supplied": "Missing `users` in request" } -} +} \ No newline at end of file diff --git a/lib/slack/web/docs/conversations.replies.json b/lib/slack/web/docs/conversations.replies.json index 3e72846..d526a0e 100644 --- a/lib/slack/web/docs/conversations.replies.json +++ b/lib/slack/web/docs/conversations.replies.json @@ -1,53 +1,51 @@ { - "desc": "Returns an entire thread (a message plus all the messages in reply to it), while `conversations.history` method returns only parent messages.\n\nBot user tokens may use this method for direct message and multi-party direct message conversations but lack sufficient permissions to use this method on public and private channels.", - "args": { "channel": { - "example" : "G1234567890", - "required": true, - "desc" : "Conversation ID to fetch thread from." + "desc": "Conversation ID to fetch thread from.", + "example": "G1234567890", + "required": true }, - "ts": { - "example" : "1234567890.123456", - "required": true, - "desc" : "Unique identifier of a thread's parent message." + "cursor": { + "desc": "Paginate through collections of data by setting the cursor parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first \"page\" of the collection. See pagination for more detail.", + "example": "dXNlcjpVMDYxTkZUVDI=", + "required": false }, "inclusive": { - "example" : "true", - "required": false, - "desc" : "Include messages with latest or oldest timestamp in results only when either timestamp is specified.", - "default" : 0 - }, - "cursor": { - "example" : "dXNlcjpVMDYxTkZUVDI=", - "required": false, - "desc" : "Paginate through collections of data by setting the cursor parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first \"page\" of the collection. See pagination for more detail." + "default": 0, + "desc": "Include messages with latest or oldest timestamp in results only when either timestamp is specified.", + "example": "true", + "required": false }, "latest": { - "example" : "1234567890.123456", - "required": false, - "desc" : "End of time range of messages to include in results.", - "default" : "now" + "default": "now", + "desc": "End of time range of messages to include in results.", + "example": "1234567890.123456", + "required": false }, "limit": { - "example" : 20, - "required": false, - "desc" : "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.", - "default" : 100 + "default": 100, + "desc": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.", + "example": 20, + "required": false }, "oldest": { - "example" : "1234567890.123456", - "required": false, - "desc" : "Start of time range of messages to include in results.", - "default" : 0 + "default": 0, + "desc": "Start of time range of messages to include in results.", + "example": "1234567890.123456", + "required": false + }, + "ts": { + "desc": "Unique identifier of a thread's parent message.", + "example": "1234567890.123456", + "required": true } }, - + "desc": "Returns an entire thread (a message plus all the messages in reply to it), while `conversations.history` method returns only parent messages.\n\nBot user tokens may use this method for direct message and multi-party direct message conversations but lack sufficient permissions to use this method on public and private channels.", "errors": { "channel_not_found": "Value for `channel` was invalid", - "thread_not_found": "Value for `ts` was missing or invalid", "invalid_cursor": "Value passed for `cursor` was invalid.", "invalid_ts_latest": "Value passed for `latest` was invalid.", - "invalid_ts_oldest": "Value passed for `oldest` was invalid." + "invalid_ts_oldest": "Value passed for `oldest` was invalid.", + "thread_not_found": "Value for `ts` was missing or invalid" } -} +} \ No newline at end of file diff --git a/lib/slack/web/docs/conversations.setPurpose.json b/lib/slack/web/docs/conversations.setPurpose.json index 0d84096..afe8119 100644 --- a/lib/slack/web/docs/conversations.setPurpose.json +++ b/lib/slack/web/docs/conversations.setPurpose.json @@ -1,25 +1,23 @@ { - "desc": "Change the purpose of a conversation. The calling user must be a member of the conversation. Not all conversation types may have a purpose set.", - "args": { "channel": { - "example" : "G1234567890", - "required": true, - "desc" : "Conversation to set the purpose of." + "desc": "Conversation to set the purpose of.", + "example": "G1234567890", + "required": true }, "purpose": { - "example" : "My More Special Purpose", - "required": true, - "desc" : "A new, specialer purpose" + "desc": "A new, specialer purpose", + "example": "My More Special Purpose", + "required": true } }, - + "desc": "Change the purpose of a conversation. The calling user must be a member of the conversation. Not all conversation types may have a purpose set.", "errors": { "channel_not_found": "Value passed for `channel` was invalid", - "not_in_channel": "Authenticated user is not in the channel.", "is_archived": "Channel has been archived", + "method_not_supported_for_channel_type": "This type of conversation cannot be used with this method.", + "not_in_channel": "Authenticated user is not in the channel.", "too_long": "Purpose was longer than 250 characters.", - "user_is_restricted": "This method cannot be called by a restricted user or single channel guest.", - "method_not_supported_for_channel_type": "This type of conversation cannot be used with this method." + "user_is_restricted": "This method cannot be called by a restricted user or single channel guest." } -} +} \ No newline at end of file diff --git a/lib/slack/web/docs/conversations.setTopic.json b/lib/slack/web/docs/conversations.setTopic.json index 2ed78d4..fd407b8 100644 --- a/lib/slack/web/docs/conversations.setTopic.json +++ b/lib/slack/web/docs/conversations.setTopic.json @@ -1,25 +1,23 @@ { - "desc": "Change the topic of a conversation. The calling user must be a member of the conversation. Not all conversation types may have a purpose set.", - "args": { "channel": { - "example" : "G1234567890", - "required": true, - "desc" : "Conversation to set the purpose of." + "desc": "Conversation to set the purpose of.", + "example": "G1234567890", + "required": true }, "topic": { - "example" : "Apply topically for best effects", - "required": true, - "desc" : "The new topic string. Does not support formatting or linkification." + "desc": "The new topic string. Does not support formatting or linkification.", + "example": "Apply topically for best effects", + "required": true } }, - + "desc": "Change the topic of a conversation. The calling user must be a member of the conversation. Not all conversation types may have a purpose set.", "errors": { "channel_not_found": "Value passed for `channel` was invalid", - "not_in_channel": "Authenticated user is not in the channel.", "is_archived": "Channel has been archived", + "method_not_supported_for_channel_type": "This type of conversation cannot be used with this method.", + "not_in_channel": "Authenticated user is not in the channel.", "too_long": "Topic was longer than 250 characters.", - "user_is_restricted": "This method cannot be called by a restricted user or single channel guest.", - "method_not_supported_for_channel_type": "This type of conversation cannot be used with this method." + "user_is_restricted": "This method cannot be called by a restricted user or single channel guest." } -} +} \ No newline at end of file diff --git a/lib/slack/web/docs/dnd.endDnd.json b/lib/slack/web/docs/dnd.endDnd.json index d4d8b42..daa0c08 100644 --- a/lib/slack/web/docs/dnd.endDnd.json +++ b/lib/slack/web/docs/dnd.endDnd.json @@ -1,8 +1,6 @@ { - "desc": "Ends the current user's Do Not Disturb session immediately.", - - "errors": { - "unknown_error" : "There was a mysterious problem ending the user's Do Not Disturb session" - } - -} + "desc": "Ends the current user's Do Not Disturb session immediately.", + "errors": { + "unknown_error": "There was a mysterious problem ending the user's Do Not Disturb session" + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/dnd.endSnooze.json b/lib/slack/web/docs/dnd.endSnooze.json index a114297..3268b0c 100644 --- a/lib/slack/web/docs/dnd.endSnooze.json +++ b/lib/slack/web/docs/dnd.endSnooze.json @@ -1,10 +1,7 @@ { - "desc": "Ends the current user's snooze mode immediately.", - - "errors": { - "snooze_not_active" : "Snooze is not active for this user and cannot be ended", - "snooze_end_failed" : "There was a problem setting the user's Do Not Disturb status" - - } - -} + "desc": "Ends the current user's snooze mode immediately.", + "errors": { + "snooze_end_failed": "There was a problem setting the user's Do Not Disturb status", + "snooze_not_active": "Snooze is not active for this user and cannot be ended" + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/dnd.info.json b/lib/slack/web/docs/dnd.info.json index d160f6e..946f7f0 100644 --- a/lib/slack/web/docs/dnd.info.json +++ b/lib/slack/web/docs/dnd.info.json @@ -1,12 +1,11 @@ { - "desc": "Retrieves a user's current Do Not Disturb status.", - - "args": { - "user": { - "required" : false, - "type" : "string", - "example" : "U1234", - "desc" : "User to fetch status for (defaults to current user)" - } - } -} + "args": { + "user": { + "desc": "User to fetch status for (defaults to current user)", + "example": "U1234", + "required": false, + "type": "string" + } + }, + "desc": "Retrieves a user's current Do Not Disturb status." +} \ No newline at end of file diff --git a/lib/slack/web/docs/dnd.setSnooze.json b/lib/slack/web/docs/dnd.setSnooze.json index 83dd623..f142b4d 100644 --- a/lib/slack/web/docs/dnd.setSnooze.json +++ b/lib/slack/web/docs/dnd.setSnooze.json @@ -1,18 +1,15 @@ { - "desc": "Turns on Do Not Disturb mode for the current user, or changes its duration.", - - "args": { - "num_minutes": { - "required" : true, - "type" : "int", - "example" : "60", - "desc" : "Number of minutes, from now, to snooze until." - } - }, - "errors": { - "missing_duration" : "No value provided for `num_minutes`", - "snooze_failed" : "There was a problem setting the user's Do Not Disturb status" - - } - -} + "args": { + "num_minutes": { + "desc": "Number of minutes, from now, to snooze until.", + "example": "60", + "required": true, + "type": "int" + } + }, + "desc": "Turns on Do Not Disturb mode for the current user, or changes its duration.", + "errors": { + "missing_duration": "No value provided for `num_minutes`", + "snooze_failed": "There was a problem setting the user's Do Not Disturb status" + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/dnd.teamInfo.json b/lib/slack/web/docs/dnd.teamInfo.json index 4619c0f..d793624 100644 --- a/lib/slack/web/docs/dnd.teamInfo.json +++ b/lib/slack/web/docs/dnd.teamInfo.json @@ -1,12 +1,11 @@ { - "desc": "Retrieves the Do Not Disturb status for users on a team.", - - "args": { - "users": { - "required" : false, - "type" : "string", - "example" : "U1234,U4567", - "desc" : "Comma-separated list of users to fetch Do Not Disturb status for" - } - } -} + "args": { + "users": { + "desc": "Comma-separated list of users to fetch Do Not Disturb status for", + "example": "U1234,U4567", + "required": false, + "type": "string" + } + }, + "desc": "Retrieves the Do Not Disturb status for users on a team." +} \ No newline at end of file diff --git a/lib/slack/web/docs/emoji.list.json b/lib/slack/web/docs/emoji.list.json index 8d3bf68..c0e5f0e 100644 --- a/lib/slack/web/docs/emoji.list.json +++ b/lib/slack/web/docs/emoji.list.json @@ -1,9 +1,5 @@ { - "desc": "Lists custom emoji for a team.", - - "args": { - }, - - "errors": { - } -} + "args": {}, + "desc": "Lists custom emoji for a team.", + "errors": {} +} \ No newline at end of file diff --git a/lib/slack/web/docs/files.comments.add.json b/lib/slack/web/docs/files.comments.add.json index 60fc51c..f3aa579 100644 --- a/lib/slack/web/docs/files.comments.add.json +++ b/lib/slack/web/docs/files.comments.add.json @@ -1,22 +1,20 @@ { - "desc": "Add a comment to an existing file.", - "args": { - "file": { - "required" : true, - "example" : "F1234567890", - "desc" : "File to add a comment to." - }, "comment": { - "required" : true, - "example" : "Everyone should take a moment to read this file.", - "desc" : "Text of the comment to add." + "desc": "Text of the comment to add.", + "example": "Everyone should take a moment to read this file.", + "required": true + }, + "file": { + "desc": "File to add a comment to.", + "example": "F1234567890", + "required": true } }, - + "desc": "Add a comment to an existing file.", "errors": { - "file_not_found" : "The requested file could not be found.", - "file_deleted" : "The requested file was previously deleted.", - "no_comment" : "The `comment` field was empty." + "file_deleted": "The requested file was previously deleted.", + "file_not_found": "The requested file could not be found.", + "no_comment": "The `comment` field was empty." } -} +} \ No newline at end of file diff --git a/lib/slack/web/docs/files.comments.delete.json b/lib/slack/web/docs/files.comments.delete.json index 938f017..a91eb41 100644 --- a/lib/slack/web/docs/files.comments.delete.json +++ b/lib/slack/web/docs/files.comments.delete.json @@ -1,22 +1,20 @@ { - "desc": "Deletes an existing comment on a file.", - "args": { "file": { - "required" : true, - "example" : "F1234567890", - "desc" : "File to delete a comment from." + "desc": "File to delete a comment from.", + "example": "F1234567890", + "required": true }, "id": { - "required" : true, - "example" : "Fc1234567890", - "desc" : "The comment to delete." + "desc": "The comment to delete.", + "example": "Fc1234567890", + "required": true } }, - + "desc": "Deletes an existing comment on a file.", "errors": { - "file_not_found" : "The requested file could not be found.", - "file_deleted" : "The requested file was previously deleted.", - "cant_delete" : "The requested comment could not be deleted." + "cant_delete": "The requested comment could not be deleted.", + "file_deleted": "The requested file was previously deleted.", + "file_not_found": "The requested file could not be found." } -} +} \ No newline at end of file diff --git a/lib/slack/web/docs/files.comments.edit.json b/lib/slack/web/docs/files.comments.edit.json index 6e5feba..be6d7ff 100644 --- a/lib/slack/web/docs/files.comments.edit.json +++ b/lib/slack/web/docs/files.comments.edit.json @@ -1,29 +1,27 @@ { - "desc": "Edit an existing file comment.", - "args": { + "comment": { + "desc": "Text of the comment to edit.", + "example": "Everyone should take a moment to read this file, seriously.", + "required": true + }, "file": { - "required" : true, - "example" : "F1234567890", - "desc" : "File containing the comment to edit." + "desc": "File containing the comment to edit.", + "example": "F1234567890", + "required": true }, "id": { - "required" : true, - "example" : "Fc1234567890", - "desc" : "The comment to edit." - }, - "comment": { - "required" : true, - "example" : "Everyone should take a moment to read this file, seriously.", - "desc" : "Text of the comment to edit." + "desc": "The comment to edit.", + "example": "Fc1234567890", + "required": true } }, - + "desc": "Edit an existing file comment.", "errors": { - "file_not_found" : "The requested file could not be found.", - "file_deleted" : "The requested file was previously deleted.", - "no_comment" : "The `comment` field was empty.", + "cant_edit": "The requested file could not be found.", "edit_window_closed": "The timeframe for editing the comment has expired.", - "cant_edit" : "The requested file could not be found." + "file_deleted": "The requested file was previously deleted.", + "file_not_found": "The requested file could not be found.", + "no_comment": "The `comment` field was empty." } -} +} \ No newline at end of file diff --git a/lib/slack/web/docs/files.delete.json b/lib/slack/web/docs/files.delete.json index ac985c0..fe84680 100644 --- a/lib/slack/web/docs/files.delete.json +++ b/lib/slack/web/docs/files.delete.json @@ -1,16 +1,14 @@ { - "desc": "Deletes a file.", - - "args": { - "file": { - "required" : true, - "desc" : "ID of file to delete." - } - }, - - "errors": { - "file_not_found" : "The file does not exist, or is not visible to the calling user.", - "file_deleted" : "The file has already been deleted.", - "cant_delete_file" : "Authenticated user does not have permission to delete this file." - } -} + "args": { + "file": { + "desc": "ID of file to delete.", + "required": true + } + }, + "desc": "Deletes a file.", + "errors": { + "cant_delete_file": "Authenticated user does not have permission to delete this file.", + "file_deleted": "The file has already been deleted.", + "file_not_found": "The file does not exist, or is not visible to the calling user." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/files.info.json b/lib/slack/web/docs/files.info.json index 7d9d57e..c63c9fb 100644 --- a/lib/slack/web/docs/files.info.json +++ b/lib/slack/web/docs/files.info.json @@ -1,19 +1,16 @@ { - "desc": "Gets information about a team file.", - - "args": { - "file": { - "required" : true, - "desc" : "Specify a file by providing its ID.", - "example" : "F2147483862" - } - }, - - "has_paging" : true, - "default_count" : 100, - - "errors": { - "file_not_found" : "Value passed for `file` was invalid", - "file_deleted" : "The requested file has been deleted" - } -} + "args": { + "file": { + "desc": "Specify a file by providing its ID.", + "example": "F2147483862", + "required": true + } + }, + "default_count": 100, + "desc": "Gets information about a team file.", + "errors": { + "file_deleted": "The requested file has been deleted", + "file_not_found": "Value passed for `file` was invalid" + }, + "has_paging": true +} \ No newline at end of file diff --git a/lib/slack/web/docs/files.list.json b/lib/slack/web/docs/files.list.json index 04eb393..c32f802 100644 --- a/lib/slack/web/docs/files.list.json +++ b/lib/slack/web/docs/files.list.json @@ -1,42 +1,39 @@ { - "desc": "Lists & filters team files.", - - "args": { - "user": { - "type" : "user", - "required" : false, - "desc" : "Filter files created by a single user." - }, - "channel": { - "type" : "channel", - "required" : false, - "desc" : "Filter files appearing in a specific channel, indicated by its ID." - }, - "ts_from": { - "required" : false, - "example" : "123456789", - "default" : "0", - "desc" : "Filter files created after this timestamp (inclusive)." - }, - "ts_to": { - "required" : false, - "example" : "123456789", - "default" : "now", - "desc" : "Filter files created before this timestamp (inclusive)." - }, - "types": { - "required" : false, - "default" : "all", - "example" : "images", - "desc" : "Filter files by type:\n\n* `all` - All files\n* `posts` - Posts\n* `snippets` - Snippets\n* `images` - Image files\n* `gdocs` - Google docs\n* `zips` - Zip files\n* `pdfs` - PDF files\n\nYou can pass multiple values in the types argument, like `types=posts,snippets`.The default value is `all`, which does not filter the list." - } - }, - - "has_paging" : true, - "default_count" : 100, - - "errors": { - "user_not_found" : "Value passed for `user` was invalid", - "unknown_type" : "Value passed for `types` was invalid" - } -} + "args": { + "channel": { + "desc": "Filter files appearing in a specific channel, indicated by its ID.", + "required": false, + "type": "channel" + }, + "ts_from": { + "default": "0", + "desc": "Filter files created after this timestamp (inclusive).", + "example": "123456789", + "required": false + }, + "ts_to": { + "default": "now", + "desc": "Filter files created before this timestamp (inclusive).", + "example": "123456789", + "required": false + }, + "types": { + "default": "all", + "desc": "Filter files by type:\n\n* `all` - All files\n* `posts` - Posts\n* `snippets` - Snippets\n* `images` - Image files\n* `gdocs` - Google docs\n* `zips` - Zip files\n* `pdfs` - PDF files\n\nYou can pass multiple values in the types argument, like `types=posts,snippets`.The default value is `all`, which does not filter the list.", + "example": "images", + "required": false + }, + "user": { + "desc": "Filter files created by a single user.", + "required": false, + "type": "user" + } + }, + "default_count": 100, + "desc": "Lists & filters team files.", + "errors": { + "unknown_type": "Value passed for `types` was invalid", + "user_not_found": "Value passed for `user` was invalid" + }, + "has_paging": true +} \ No newline at end of file diff --git a/lib/slack/web/docs/files.revokePublicURL.json b/lib/slack/web/docs/files.revokePublicURL.json index 882cc5d..9aa9cdc 100644 --- a/lib/slack/web/docs/files.revokePublicURL.json +++ b/lib/slack/web/docs/files.revokePublicURL.json @@ -1,15 +1,13 @@ { - "desc": "Revokes public/external sharing access for a file", - - "args": { - "file": { - "required" : true, - "desc" : "File to revoke", - "type" : "file" - } - }, - - "errors": { - "file_not_found" : "Value passed for `file` was invalid" - } -} + "args": { + "file": { + "desc": "File to revoke", + "required": true, + "type": "file" + } + }, + "desc": "Revokes public/external sharing access for a file", + "errors": { + "file_not_found": "Value passed for `file` was invalid" + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/files.sharedPublicURL.json b/lib/slack/web/docs/files.sharedPublicURL.json index ef573c4..2d05924 100644 --- a/lib/slack/web/docs/files.sharedPublicURL.json +++ b/lib/slack/web/docs/files.sharedPublicURL.json @@ -1,16 +1,14 @@ { - "desc": "Enables a file for public/external sharing.", - - "args": { - "file": { - "required" : true, - "desc" : "File to share", - "type" : "file" - } - }, - - "errors": { - "file_not_found" : "Value passed for `file` was invalid", - "not_allowed" : "Public sharing has been disabled for this team" - } -} + "args": { + "file": { + "desc": "File to share", + "required": true, + "type": "file" + } + }, + "desc": "Enables a file for public/external sharing.", + "errors": { + "file_not_found": "Value passed for `file` was invalid", + "not_allowed": "Public sharing has been disabled for this team" + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/files.upload.json b/lib/slack/web/docs/files.upload.json index b34ea5c..fefc9a8 100644 --- a/lib/slack/web/docs/files.upload.json +++ b/lib/slack/web/docs/files.upload.json @@ -1,47 +1,45 @@ { - "desc": "Uploads or creates a file.", - - "args": { - "file": { - "required" : true, - "example" : "...", - "desc" : "File contents via `multipart/form-data`.", - "type" : "file" - }, - "content": { - "required" : false, - "example" : "...", - "desc" : "File contents via a POST var." - }, - "filetype": { - "required" : false, - "example" : "php", - "desc" : "Slack-internal file type identifier." - }, - "filename": { - "required" : true, - "example" : "foo.txt", - "desc" : "Filename of file." - }, - "title": { - "required" : false, - "example" : "My File", - "desc" : "Title of file." - }, - "initial_comment": { - "required" : false, - "example" : "Best!", - "desc" : "Initial comment to add to file." - }, - "channels": { - "type" : "channel", - "required" : false, - "desc" : "Comma-separated list of channel names or IDs where the file will be shared." - } - }, - - "errors": { - "posting_to_general_channel_denied" : "An admin has restricted posting to the #general channel.", - "invalid_channel" : "One or more channels supplied are invalid" - } -} + "args": { + "channels": { + "desc": "Comma-separated list of channel names or IDs where the file will be shared.", + "required": false, + "type": "channel" + }, + "content": { + "desc": "File contents via a POST var.", + "example": "...", + "required": false + }, + "file": { + "desc": "File contents via `multipart/form-data`.", + "example": "...", + "required": true, + "type": "file" + }, + "filename": { + "desc": "Filename of file.", + "example": "foo.txt", + "required": true + }, + "filetype": { + "desc": "Slack-internal file type identifier.", + "example": "php", + "required": false + }, + "initial_comment": { + "desc": "Initial comment to add to file.", + "example": "Best!", + "required": false + }, + "title": { + "desc": "Title of file.", + "example": "My File", + "required": false + } + }, + "desc": "Uploads or creates a file.", + "errors": { + "invalid_channel": "One or more channels supplied are invalid", + "posting_to_general_channel_denied": "An admin has restricted posting to the #general channel." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/groups.archive.json b/lib/slack/web/docs/groups.archive.json index 07cc423..2c2aebc 100644 --- a/lib/slack/web/docs/groups.archive.json +++ b/lib/slack/web/docs/groups.archive.json @@ -1,19 +1,17 @@ { - "desc": "Archives a private channel.", - - "args": { - "channel": { - "type" : "group", - "required" : true, - "desc" : "Private channel to archive" - } - }, - - "errors": { - "channel_not_found" : "Value passed for `channel` was invalid.", - "already_archived" : "Group has already been archived.", - "group_contains_others" : "Restricted accounts cannot archive groups containing others.", - "last_ra_channel" : "You cannot archive the last channel for a restricted account.", - "restricted_action" : "A team preference prevents the authenticated user from archiving." - } -} + "args": { + "channel": { + "desc": "Private channel to archive", + "required": true, + "type": "group" + } + }, + "desc": "Archives a private channel.", + "errors": { + "already_archived": "Group has already been archived.", + "channel_not_found": "Value passed for `channel` was invalid.", + "group_contains_others": "Restricted accounts cannot archive groups containing others.", + "last_ra_channel": "You cannot archive the last channel for a restricted account.", + "restricted_action": "A team preference prevents the authenticated user from archiving." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/groups.close.json b/lib/slack/web/docs/groups.close.json index 4b3f47a..bae34be 100644 --- a/lib/slack/web/docs/groups.close.json +++ b/lib/slack/web/docs/groups.close.json @@ -1,15 +1,13 @@ { - "desc": "Closes a private channel.", - - "args": { - "channel": { - "type" : "group", - "required" : true, - "desc" : "Private channel to close." - } - }, - - "errors": { - "channel_not_found" : "Value passed for `channel` was invalid." - } -} + "args": { + "channel": { + "desc": "Private channel to close.", + "required": true, + "type": "group" + } + }, + "desc": "Closes a private channel.", + "errors": { + "channel_not_found": "Value passed for `channel` was invalid." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/groups.create.json b/lib/slack/web/docs/groups.create.json index 9ecb5b4..7b36252 100644 --- a/lib/slack/web/docs/groups.create.json +++ b/lib/slack/web/docs/groups.create.json @@ -1,16 +1,14 @@ { - "desc": "Creates a private channel.", - - "args": { - "name": { - "required" : true, - "desc" : "Name of private channel to create" - } - }, - - "errors": { - "no_channel": "No group name was passed.", - "restricted_action": "A team preference prevents the authenticated user from creating groups.", - "name_taken" : "A group cannot be created with the given name." - } -} + "args": { + "name": { + "desc": "Name of private channel to create", + "required": true + } + }, + "desc": "Creates a private channel.", + "errors": { + "name_taken": "A group cannot be created with the given name.", + "no_channel": "No group name was passed.", + "restricted_action": "A team preference prevents the authenticated user from creating groups." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/groups.createChild.json b/lib/slack/web/docs/groups.createChild.json index 09497aa..b414cca 100644 --- a/lib/slack/web/docs/groups.createChild.json +++ b/lib/slack/web/docs/groups.createChild.json @@ -1,17 +1,15 @@ { - "desc": "Clones and archives a private channel.", - - "args": { - "channel": { - "type" : "group", - "required" : true, - "desc" : "Private channel to clone and archive." - } - }, - - "errors": { - "channel_not_found": "Value passed for `channel` was invalid.", - "already_archived": "An archived group cannot be cloned", - "restricted_action": "A team preference prevents the authenticated user from creating groups." - } -} + "args": { + "channel": { + "desc": "Private channel to clone and archive.", + "required": true, + "type": "group" + } + }, + "desc": "Clones and archives a private channel.", + "errors": { + "already_archived": "An archived group cannot be cloned", + "channel_not_found": "Value passed for `channel` was invalid.", + "restricted_action": "A team preference prevents the authenticated user from creating groups." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/groups.history.json b/lib/slack/web/docs/groups.history.json index 5cfb5ea..5cc9d4f 100644 --- a/lib/slack/web/docs/groups.history.json +++ b/lib/slack/web/docs/groups.history.json @@ -1,51 +1,44 @@ { - "desc": "Fetches history of messages and events from a private channel.", - - "args": { - "channel": { - "type" : "group", - "required" : true, - "desc" : "Private channel to fetch history for." - }, - - "latest": { - "type" : "timestamp", - "required" : false, - "default" : "now", - "desc" : "End of time range of messages to include in results." - }, - - "oldest": { - "type" : "timestamp", - "required" : false, - "default" : "0", - "desc" : "Start of time range of messages to include in results." - }, - - "inclusive": { - "example" : 1, - "default" : 0, - "desc" : "Include messages with latest or oldest timestamp in results." - }, - - "count": { - "required" : false, - "default" : "100", - "example" : "100", - "desc" : "Number of messages to return, between 1 and 1000." - }, - - "unreads": { - "required" : false, - "default" : 0, - "example" : 1, - "desc" : "Include `unread_count_display` in the output?" - } - }, - - "errors": { - "channel_not_found" : "Value passed for `channel` was invalid.", - "invalid_ts_latest" : "Value passed for `latest` was invalid", - "invalid_ts_oldest" : "Value passed for `oldest` was invalid" - } -} + "args": { + "channel": { + "desc": "Private channel to fetch history for.", + "required": true, + "type": "group" + }, + "count": { + "default": "100", + "desc": "Number of messages to return, between 1 and 1000.", + "example": "100", + "required": false + }, + "inclusive": { + "default": 0, + "desc": "Include messages with latest or oldest timestamp in results.", + "example": 1 + }, + "latest": { + "default": "now", + "desc": "End of time range of messages to include in results.", + "required": false, + "type": "timestamp" + }, + "oldest": { + "default": "0", + "desc": "Start of time range of messages to include in results.", + "required": false, + "type": "timestamp" + }, + "unreads": { + "default": 0, + "desc": "Include `unread_count_display` in the output?", + "example": 1, + "required": false + } + }, + "desc": "Fetches history of messages and events from a private channel.", + "errors": { + "channel_not_found": "Value passed for `channel` was invalid.", + "invalid_ts_latest": "Value passed for `latest` was invalid", + "invalid_ts_oldest": "Value passed for `oldest` was invalid" + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/groups.info.json b/lib/slack/web/docs/groups.info.json index 6fcab38..adbafc5 100644 --- a/lib/slack/web/docs/groups.info.json +++ b/lib/slack/web/docs/groups.info.json @@ -1,15 +1,13 @@ { - "desc": "Gets information about a private channel.", - - "args": { - "channel": { - "type" : "channel", - "required" : true, - "desc" : "Private channel to get info on" - } - }, - - "errors": { - "channel_not_found" : "Value passed for `channel` was invalid." - } -} + "args": { + "channel": { + "desc": "Private channel to get info on", + "required": true, + "type": "channel" + } + }, + "desc": "Gets information about a private channel.", + "errors": { + "channel_not_found": "Value passed for `channel` was invalid." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/groups.invite.json b/lib/slack/web/docs/groups.invite.json index 9706458..c355a5a 100644 --- a/lib/slack/web/docs/groups.invite.json +++ b/lib/slack/web/docs/groups.invite.json @@ -1,24 +1,22 @@ { - "desc": "Invites a user to a private channel.", - - "args": { - "channel": { - "type" : "group", - "required" : true, - "desc" : "Private channel to invite user to." - }, - "user": { - "type" : "user", - "required" : true, - "desc" : "User to invite." - } - }, - - "errors": { - "channel_not_found" : "Value passed for `channel` was invalid.", - "user_not_found": "Value passed for `user` was invalid.", - "cant_invite_self" : "Authenticated user cannot invite themselves to a group.", - "is_archived" : "Group has been archived.", - "cant_invite" : "User cannot be invited to this group." - } -} + "args": { + "channel": { + "desc": "Private channel to invite user to.", + "required": true, + "type": "group" + }, + "user": { + "desc": "User to invite.", + "required": true, + "type": "user" + } + }, + "desc": "Invites a user to a private channel.", + "errors": { + "cant_invite": "User cannot be invited to this group.", + "cant_invite_self": "Authenticated user cannot invite themselves to a group.", + "channel_not_found": "Value passed for `channel` was invalid.", + "is_archived": "Group has been archived.", + "user_not_found": "Value passed for `user` was invalid." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/groups.kick.json b/lib/slack/web/docs/groups.kick.json index 036f824..c172e75 100644 --- a/lib/slack/web/docs/groups.kick.json +++ b/lib/slack/web/docs/groups.kick.json @@ -1,26 +1,22 @@ { - "desc": "Removes a user from a private channel.", - - "args": { - "channel": { - "type" : "group", - "required" : true, - "desc" : "Private channel to remove user from." - }, - "user": { - "type" : "user", - "required" : true, - "desc" : "User to remove from private channel." - } - }, - - "errors": { - - "channel_not_found" : "Value passed for `channel` was invalid.", - "user_not_found" : "Value passed for `user` was invalid.", - "cant_kick_self" : "You can't remove yourself from a group", - "not_in_group" : "User or caller were are not in the group", - "restricted_action" : "A team preference prevents the authenticated user from kicking." - - } -} + "args": { + "channel": { + "desc": "Private channel to remove user from.", + "required": true, + "type": "group" + }, + "user": { + "desc": "User to remove from private channel.", + "required": true, + "type": "user" + } + }, + "desc": "Removes a user from a private channel.", + "errors": { + "cant_kick_self": "You can't remove yourself from a group", + "channel_not_found": "Value passed for `channel` was invalid.", + "not_in_group": "User or caller were are not in the group", + "restricted_action": "A team preference prevents the authenticated user from kicking.", + "user_not_found": "Value passed for `user` was invalid." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/groups.leave.json b/lib/slack/web/docs/groups.leave.json index bb43c30..497b972 100644 --- a/lib/slack/web/docs/groups.leave.json +++ b/lib/slack/web/docs/groups.leave.json @@ -1,18 +1,16 @@ { - "desc": "Leaves a private channel.", - - "args": { - "channel": { - "type" : "group", - "required" : true, - "desc" : "Private channel to leave" - } - }, - - "errors": { - "channel_not_found" : "Value passed for `channel` was invalid.", - "is_archived" : "Group has been archived.", - "cant_leave_last_channel": "Authenticated user cannot leave the last channel they are in", - "last_member" : "Authenticated user is the last member of a group and cannot leave it" - } -} + "args": { + "channel": { + "desc": "Private channel to leave", + "required": true, + "type": "group" + } + }, + "desc": "Leaves a private channel.", + "errors": { + "cant_leave_last_channel": "Authenticated user cannot leave the last channel they are in", + "channel_not_found": "Value passed for `channel` was invalid.", + "is_archived": "Group has been archived.", + "last_member": "Authenticated user is the last member of a group and cannot leave it" + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/groups.list.json b/lib/slack/web/docs/groups.list.json index 131b629..586083f 100644 --- a/lib/slack/web/docs/groups.list.json +++ b/lib/slack/web/docs/groups.list.json @@ -1,11 +1,10 @@ { - "desc": "Lists private channels that the calling user has access to.", - - "args": { - "exclude_archived": { - "example" : 1, - "default" : 0, - "desc" : "Don't return archived private channels." - } - } -} + "args": { + "exclude_archived": { + "default": 0, + "desc": "Don't return archived private channels.", + "example": 1 + } + }, + "desc": "Lists private channels that the calling user has access to." +} \ No newline at end of file diff --git a/lib/slack/web/docs/groups.mark.json b/lib/slack/web/docs/groups.mark.json index ea1ca02..1ca9bfc 100644 --- a/lib/slack/web/docs/groups.mark.json +++ b/lib/slack/web/docs/groups.mark.json @@ -1,22 +1,19 @@ { - "desc": "Sets the read cursor in a private channel.", - - "args": { - "channel": { - "type" : "group", - "required" : true, - "desc" : "Private channel to set reading cursor in." - }, - - "ts": { - "type" : "timestamp", - "required" : true, - "desc" : "Timestamp of the most recently seen message." - } - }, - - "errors": { - "channel_not_found" : "Value passed for `channel` was invalid.", - "invalid_timestamp" : "Value passed for `timestamp` was invalid." - } -} + "args": { + "channel": { + "desc": "Private channel to set reading cursor in.", + "required": true, + "type": "group" + }, + "ts": { + "desc": "Timestamp of the most recently seen message.", + "required": true, + "type": "timestamp" + } + }, + "desc": "Sets the read cursor in a private channel.", + "errors": { + "channel_not_found": "Value passed for `channel` was invalid.", + "invalid_timestamp": "Value passed for `timestamp` was invalid." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/groups.open.json b/lib/slack/web/docs/groups.open.json index 4eb7e3f..f25d90c 100644 --- a/lib/slack/web/docs/groups.open.json +++ b/lib/slack/web/docs/groups.open.json @@ -1,15 +1,13 @@ { - "desc": "Opens a private channel.", - - "args": { - "channel": { - "type" : "group", - "required" : true, - "desc" : "Private channel to open." - } - }, - - "errors": { - "channel_not_found" : "Value passed for `channel` was invalid." - } -} + "args": { + "channel": { + "desc": "Private channel to open.", + "required": true, + "type": "group" + } + }, + "desc": "Opens a private channel.", + "errors": { + "channel_not_found": "Value passed for `channel` was invalid." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/groups.rename.json b/lib/slack/web/docs/groups.rename.json index 9f78261..13e0024 100644 --- a/lib/slack/web/docs/groups.rename.json +++ b/lib/slack/web/docs/groups.rename.json @@ -1,22 +1,19 @@ { - "desc": "Renames a private channel.", - - "args": { - "channel": { - "type" : "channel", - "required" : true, - "desc" : "Private channel to rename" - }, - - "name": { - "required" : true, - "desc" : "New name for private channel." - } - }, - - "errors": { - "channel_not_found" : "Value passed for `channel` was invalid.", - "invalid_name" : "New name is invalid", - "name_taken" : "New channel name is taken" - } -} + "args": { + "channel": { + "desc": "Private channel to rename", + "required": true, + "type": "channel" + }, + "name": { + "desc": "New name for private channel.", + "required": true + } + }, + "desc": "Renames a private channel.", + "errors": { + "channel_not_found": "Value passed for `channel` was invalid.", + "invalid_name": "New name is invalid", + "name_taken": "New channel name is taken" + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/groups.replies.json b/lib/slack/web/docs/groups.replies.json index ec8fba2..8983d4f 100644 --- a/lib/slack/web/docs/groups.replies.json +++ b/lib/slack/web/docs/groups.replies.json @@ -1,21 +1,18 @@ { - "desc": "Retrieve a thread of messages posted to a private channel.", - - "args": { - "channel": { - "type" : "channel", - "required" : true, - "desc" : "Private channel to fetch thread from" - }, - - "thread_ts": { - "required" : true, - "desc" : "Unique identifier of a thread's parent message." - } - }, - - "errors": { - "channel_not_found" : "Value passed for `channel` was invalid.", + "args": { + "channel": { + "desc": "Private channel to fetch thread from", + "required": true, + "type": "channel" + }, + "thread_ts": { + "desc": "Unique identifier of a thread's parent message.", + "required": true + } + }, + "desc": "Retrieve a thread of messages posted to a private channel.", + "errors": { + "channel_not_found": "Value passed for `channel` was invalid.", "thread_not_found": "Value for thread_ts was missing or invalid." - } -} + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/groups.setPurpose.json b/lib/slack/web/docs/groups.setPurpose.json index fe801e9..376abf4 100644 --- a/lib/slack/web/docs/groups.setPurpose.json +++ b/lib/slack/web/docs/groups.setPurpose.json @@ -1,23 +1,21 @@ { - "desc": "Sets the purpose for a private channel.", - - "args": { - "channel": { - "type" : "channel", - "required" : true, - "desc" : "Private channel to set the purpose of" - }, - "purpose": { - "required" : true, - "example" : "My Purpose", - "desc" : "The new purpose" - } - }, - - "errors": { - "channel_not_found" : "Value passed for `channel` was invalid.", - "is_archived": "Private group has been archived", - "too_long": "Purpose was longer than 250 characters.", - "user_is_restricted" : "Setting the purpose is a restricted action." - } -} + "args": { + "channel": { + "desc": "Private channel to set the purpose of", + "required": true, + "type": "channel" + }, + "purpose": { + "desc": "The new purpose", + "example": "My Purpose", + "required": true + } + }, + "desc": "Sets the purpose for a private channel.", + "errors": { + "channel_not_found": "Value passed for `channel` was invalid.", + "is_archived": "Private group has been archived", + "too_long": "Purpose was longer than 250 characters.", + "user_is_restricted": "Setting the purpose is a restricted action." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/groups.setTopic.json b/lib/slack/web/docs/groups.setTopic.json index 24ac3c5..95dc7d3 100644 --- a/lib/slack/web/docs/groups.setTopic.json +++ b/lib/slack/web/docs/groups.setTopic.json @@ -1,23 +1,21 @@ { - "desc": "Sets the topic for a private channel.", - - "args": { - "channel": { - "type" : "channel", - "required" : true, - "desc" : "Private channel to set the topic of" - }, - "topic": { - "required" : true, - "example" : "My Topic", - "desc" : "The new topic" - } - }, - - "errors": { - "channel_not_found" : "Value passed for `channel` was invalid.", - "is_archived": "Private group has been archived", - "too_long": "Topic was longer than 250 characters.", - "user_is_restricted" : "Setting the topic is a restricted action." - } -} + "args": { + "channel": { + "desc": "Private channel to set the topic of", + "required": true, + "type": "channel" + }, + "topic": { + "desc": "The new topic", + "example": "My Topic", + "required": true + } + }, + "desc": "Sets the topic for a private channel.", + "errors": { + "channel_not_found": "Value passed for `channel` was invalid.", + "is_archived": "Private group has been archived", + "too_long": "Topic was longer than 250 characters.", + "user_is_restricted": "Setting the topic is a restricted action." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/groups.unarchive.json b/lib/slack/web/docs/groups.unarchive.json index 29ba778..16c5753 100644 --- a/lib/slack/web/docs/groups.unarchive.json +++ b/lib/slack/web/docs/groups.unarchive.json @@ -1,16 +1,14 @@ { - "desc": "Unarchives a private channel.", - - "args": { - "channel": { - "type" : "group", - "required" : true, - "desc" : "Private channel to unarchive" - } - }, - - "errors": { - "channel_not_found" : "Value passed for `channel` was invalid.", - "not_archived" : "Group is not archived." - } -} + "args": { + "channel": { + "desc": "Private channel to unarchive", + "required": true, + "type": "group" + } + }, + "desc": "Unarchives a private channel.", + "errors": { + "channel_not_found": "Value passed for `channel` was invalid.", + "not_archived": "Group is not archived." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/im.close.json b/lib/slack/web/docs/im.close.json index 2954f96..2fa2832 100644 --- a/lib/slack/web/docs/im.close.json +++ b/lib/slack/web/docs/im.close.json @@ -1,16 +1,14 @@ { - "desc": "Close a direct message channel.", - - "args": { - "channel": { - "type" : "im", - "required" : true, - "desc" : "Direct message channel to close." - } - }, - - "errors": { - "channel_not_found" : "Value passed for `channel` was invalid.", - "user_does_not_own_channel" : "Calling user does not own this DM channel." - } -} + "args": { + "channel": { + "desc": "Direct message channel to close.", + "required": true, + "type": "im" + } + }, + "desc": "Close a direct message channel.", + "errors": { + "channel_not_found": "Value passed for `channel` was invalid.", + "user_does_not_own_channel": "Calling user does not own this DM channel." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/im.history.json b/lib/slack/web/docs/im.history.json index 7b1b41a..b1f5848 100644 --- a/lib/slack/web/docs/im.history.json +++ b/lib/slack/web/docs/im.history.json @@ -1,51 +1,44 @@ { - "desc": "Fetches history of messages and events from direct message channel.", - - "args": { - "channel": { - "type" : "im", - "required" : true, - "desc" : "Direct message channel to fetch history for." - }, - - "latest": { - "type" : "timestamp", - "required" : false, - "default" : "now", - "desc" : "End of time range of messages to include in results." - }, - - "oldest": { - "type" : "timestamp", - "required" : false, - "default" : "0", - "desc" : "Start of time range of messages to include in results." - }, - - "inclusive": { - "example" : 1, - "default" : 0, - "desc" : "Include messages with latest or oldest timestamp in results." - }, - - "count": { - "required" : false, - "default" : "100", - "example" : "100", - "desc" : "Number of messages to return, between 1 and 1000." - }, - - "unreads": { - "required" : false, - "default" : 0, - "example" : 1, - "desc" : "Include `unread_count_display` in the output?" - } - }, - - "errors": { - "channel_not_found" : "Value passed for `channel` was invalid.", - "invalid_ts_latest" : "Value passed for `latest` was invalid", - "invalid_ts_oldest" : "Value passed for `oldest` was invalid" - } -} + "args": { + "channel": { + "desc": "Direct message channel to fetch history for.", + "required": true, + "type": "im" + }, + "count": { + "default": "100", + "desc": "Number of messages to return, between 1 and 1000.", + "example": "100", + "required": false + }, + "inclusive": { + "default": 0, + "desc": "Include messages with latest or oldest timestamp in results.", + "example": 1 + }, + "latest": { + "default": "now", + "desc": "End of time range of messages to include in results.", + "required": false, + "type": "timestamp" + }, + "oldest": { + "default": "0", + "desc": "Start of time range of messages to include in results.", + "required": false, + "type": "timestamp" + }, + "unreads": { + "default": 0, + "desc": "Include `unread_count_display` in the output?", + "example": 1, + "required": false + } + }, + "desc": "Fetches history of messages and events from direct message channel.", + "errors": { + "channel_not_found": "Value passed for `channel` was invalid.", + "invalid_ts_latest": "Value passed for `latest` was invalid", + "invalid_ts_oldest": "Value passed for `oldest` was invalid" + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/im.list.json b/lib/slack/web/docs/im.list.json index e8b7b41..fd7bc66 100644 --- a/lib/slack/web/docs/im.list.json +++ b/lib/slack/web/docs/im.list.json @@ -1,3 +1,3 @@ { - "desc": "Lists direct message channels for the calling user." -} + "desc": "Lists direct message channels for the calling user." +} \ No newline at end of file diff --git a/lib/slack/web/docs/im.mark.json b/lib/slack/web/docs/im.mark.json index c198147..4df7463 100644 --- a/lib/slack/web/docs/im.mark.json +++ b/lib/slack/web/docs/im.mark.json @@ -1,23 +1,20 @@ { - "desc": "Sets the read cursor in a direct message channel.", - - "args": { - "channel": { - "type" : "im", - "required" : true, - "desc" : "Direct message channel to set reading cursor in." - }, - - "ts": { - "type" : "timestamp", - "required" : true, - "desc" : "Timestamp of the most recently seen message." - } - }, - - "errors": { - "channel_not_found" : "Value passed for `channel` was invalid.", - "invalid_timestamp" : "Value passed for `timestamp` was invalid.", - "not_in_channel" : "Caller is not a member of the channel." - } -} + "args": { + "channel": { + "desc": "Direct message channel to set reading cursor in.", + "required": true, + "type": "im" + }, + "ts": { + "desc": "Timestamp of the most recently seen message.", + "required": true, + "type": "timestamp" + } + }, + "desc": "Sets the read cursor in a direct message channel.", + "errors": { + "channel_not_found": "Value passed for `channel` was invalid.", + "invalid_timestamp": "Value passed for `timestamp` was invalid.", + "not_in_channel": "Caller is not a member of the channel." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/im.open.json b/lib/slack/web/docs/im.open.json index b9c6243..b3290d6 100644 --- a/lib/slack/web/docs/im.open.json +++ b/lib/slack/web/docs/im.open.json @@ -1,17 +1,15 @@ { - "desc": "Opens a direct message channel.", - - "args": { - "user": { - "type" : "user", - "required" : true, - "desc" : "User to open a direct message channel with." - } - }, - - "errors": { - "user_not_found" : "Value passed for `user` was invalid.", - "user_not_visible" : "The calling user is restricted from seeing the requested user.", - "user_disabled" : "The `user` has been disabled." - } -} + "args": { + "user": { + "desc": "User to open a direct message channel with.", + "required": true, + "type": "user" + } + }, + "desc": "Opens a direct message channel.", + "errors": { + "user_disabled": "The `user` has been disabled.", + "user_not_found": "Value passed for `user` was invalid.", + "user_not_visible": "The calling user is restricted from seeing the requested user." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/im.replies.json b/lib/slack/web/docs/im.replies.json index aa70af2..836cb2a 100644 --- a/lib/slack/web/docs/im.replies.json +++ b/lib/slack/web/docs/im.replies.json @@ -1,21 +1,18 @@ { - "desc": "Retrieve a thread of messages posted to a direct message conversation.", - - "args": { - "channel": { - "type" : "channel", - "required" : true, - "desc" : "Direct message channel to fetch thread from" - }, - - "thread_ts": { - "required" : true, - "desc" : "Unique identifier of a thread's parent message." - } - }, - - "errors": { - "channel_not_found" : "Value passed for `channel` was invalid.", + "args": { + "channel": { + "desc": "Direct message channel to fetch thread from", + "required": true, + "type": "channel" + }, + "thread_ts": { + "desc": "Unique identifier of a thread's parent message.", + "required": true + } + }, + "desc": "Retrieve a thread of messages posted to a direct message conversation.", + "errors": { + "channel_not_found": "Value passed for `channel` was invalid.", "thread_not_found": "Value for thread_ts was missing or invalid." - } -} + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/mpim.close.json b/lib/slack/web/docs/mpim.close.json index 2ce14db..7318050 100644 --- a/lib/slack/web/docs/mpim.close.json +++ b/lib/slack/web/docs/mpim.close.json @@ -1,15 +1,13 @@ { - "desc": "Closes a multiparty direct message channel.", - - "args": { - "channel": { - "type" : "mpim", - "required" : true, - "desc" : "MPIM to close." - } - }, - - "errors": { - "channel_not_found" : "Value passed for `channel` was invalid." - } -} + "args": { + "channel": { + "desc": "MPIM to close.", + "required": true, + "type": "mpim" + } + }, + "desc": "Closes a multiparty direct message channel.", + "errors": { + "channel_not_found": "Value passed for `channel` was invalid." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/mpim.history.json b/lib/slack/web/docs/mpim.history.json index 844e32f..fe86f9a 100644 --- a/lib/slack/web/docs/mpim.history.json +++ b/lib/slack/web/docs/mpim.history.json @@ -1,51 +1,44 @@ { - "desc": "Fetches history of messages and events from a multiparty direct message.", - - "args": { - "channel": { - "type" : "mpim", - "required" : true, - "desc" : "Multiparty direct message to fetch history for." - }, - - "latest": { - "type" : "timestamp", - "required" : false, - "default" : "now", - "desc" : "End of time range of messages to include in results." - }, - - "oldest": { - "type" : "timestamp", - "required" : false, - "default" : "0", - "desc" : "Start of time range of messages to include in results." - }, - - "inclusive": { - "example" : 1, - "default" : 0, - "desc" : "Include messages with latest or oldest timestamp in results." - }, - - "count": { - "required" : false, - "default" : "100", - "example" : "100", - "desc" : "Number of messages to return, between 1 and 1000." - }, - - "unreads": { - "required" : false, - "default" : 0, - "example" : 1, - "desc" : "Include `unread_count_display` in the output?" - } - }, - - "errors": { - "channel_not_found" : "Value passed for `channel` was invalid.", - "invalid_ts_latest" : "Value passed for `latest` was invalid", - "invalid_ts_oldest" : "Value passed for `oldest` was invalid" - } -} + "args": { + "channel": { + "desc": "Multiparty direct message to fetch history for.", + "required": true, + "type": "mpim" + }, + "count": { + "default": "100", + "desc": "Number of messages to return, between 1 and 1000.", + "example": "100", + "required": false + }, + "inclusive": { + "default": 0, + "desc": "Include messages with latest or oldest timestamp in results.", + "example": 1 + }, + "latest": { + "default": "now", + "desc": "End of time range of messages to include in results.", + "required": false, + "type": "timestamp" + }, + "oldest": { + "default": "0", + "desc": "Start of time range of messages to include in results.", + "required": false, + "type": "timestamp" + }, + "unreads": { + "default": 0, + "desc": "Include `unread_count_display` in the output?", + "example": 1, + "required": false + } + }, + "desc": "Fetches history of messages and events from a multiparty direct message.", + "errors": { + "channel_not_found": "Value passed for `channel` was invalid.", + "invalid_ts_latest": "Value passed for `latest` was invalid", + "invalid_ts_oldest": "Value passed for `oldest` was invalid" + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/mpim.list.json b/lib/slack/web/docs/mpim.list.json index ad2cae7..de86c6b 100644 --- a/lib/slack/web/docs/mpim.list.json +++ b/lib/slack/web/docs/mpim.list.json @@ -1,3 +1,3 @@ { - "desc": "Lists multiparty direct message channels for the calling user." -} + "desc": "Lists multiparty direct message channels for the calling user." +} \ No newline at end of file diff --git a/lib/slack/web/docs/mpim.mark.json b/lib/slack/web/docs/mpim.mark.json index 6a9aebc..7a7b187 100644 --- a/lib/slack/web/docs/mpim.mark.json +++ b/lib/slack/web/docs/mpim.mark.json @@ -1,22 +1,19 @@ { - "desc": "Sets the read cursor in a multiparty direct message channel.", - - "args": { - "channel": { - "type" : "group", - "required" : true, - "desc" : "multiparty direct message channel to set reading cursor in." - }, - - "ts": { - "type" : "timestamp", - "required" : true, - "desc" : "Timestamp of the most recently seen message." - } - }, - - "errors": { - "channel_not_found" : "Value passed for `channel` was invalid.", - "invalid_timestamp" : "Value passed for `timestamp` was invalid." - } -} + "args": { + "channel": { + "desc": "multiparty direct message channel to set reading cursor in.", + "required": true, + "type": "group" + }, + "ts": { + "desc": "Timestamp of the most recently seen message.", + "required": true, + "type": "timestamp" + } + }, + "desc": "Sets the read cursor in a multiparty direct message channel.", + "errors": { + "channel_not_found": "Value passed for `channel` was invalid.", + "invalid_timestamp": "Value passed for `timestamp` was invalid." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/mpim.open.json b/lib/slack/web/docs/mpim.open.json index aaccc56..095a452 100644 --- a/lib/slack/web/docs/mpim.open.json +++ b/lib/slack/web/docs/mpim.open.json @@ -1,17 +1,15 @@ { - "desc": "This method opens a multiparty direct message.", - - "args": { - "users": { - "type" : "users", - "required" : true, - "desc" : "Comma separated lists of users. The ordering of the users is preserved whenever a MPIM group is returned." - } - }, - - "errors": { - "users_list_not_supplied" : "Missing `users` in request", - "not_enough_users" : "Needs at least 2 users to open", - "too_many_users" : "Needs at most 8 users to open" - } -} + "args": { + "users": { + "desc": "Comma separated lists of users. The ordering of the users is preserved whenever a MPIM group is returned.", + "required": true, + "type": "users" + } + }, + "desc": "This method opens a multiparty direct message.", + "errors": { + "not_enough_users": "Needs at least 2 users to open", + "too_many_users": "Needs at most 8 users to open", + "users_list_not_supplied": "Missing `users` in request" + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/oauth.access.json b/lib/slack/web/docs/oauth.access.json index d06ff87..e0ec879 100644 --- a/lib/slack/web/docs/oauth.access.json +++ b/lib/slack/web/docs/oauth.access.json @@ -1,36 +1,31 @@ { - "desc": "Exchanges a temporary OAuth code for an API token.", - - "args": { - "client_id": { - "required" : true, - "example" : "4b39e9-752c4", - "desc" : "Issued when you created your application." - }, - - "client_secret": { - "required" : true, - "example" : "33fea0113f5b1", - "desc" : "Issued when you created your application." - }, - - "code": { - "required" : true, - "example" : "ccdaa72ad", - "desc" : "The `code` param returned via the OAuth callback." - }, - - "redirect_uri": { - "required" : false, - "example" : "http://example.com", - "desc" : "This must match the originally submitted URI (if one was sent)." - } - }, - - "errors": { - "invalid_client_id" : "Value passed for `client_id` was invalid.", - "bad_client_secret" : "Value passed for `client_secret` was invalid.", - "invalid_code" : "Value passed for `code` was invalid.", - "bad_redirect_uri" : "Value passed for `redirect_uri` did not match the `redirect_uri` in the original request." - } -} + "args": { + "client_id": { + "desc": "Issued when you created your application.", + "example": "4b39e9-752c4", + "required": true + }, + "client_secret": { + "desc": "Issued when you created your application.", + "example": "33fea0113f5b1", + "required": true + }, + "code": { + "desc": "The `code` param returned via the OAuth callback.", + "example": "ccdaa72ad", + "required": true + }, + "redirect_uri": { + "desc": "This must match the originally submitted URI (if one was sent).", + "example": "http://example.com", + "required": false + } + }, + "desc": "Exchanges a temporary OAuth code for an API token.", + "errors": { + "bad_client_secret": "Value passed for `client_secret` was invalid.", + "bad_redirect_uri": "Value passed for `redirect_uri` did not match the `redirect_uri` in the original request.", + "invalid_client_id": "Value passed for `client_id` was invalid.", + "invalid_code": "Value passed for `code` was invalid." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/oauth.v2.access.json b/lib/slack/web/docs/oauth.v2.access.json index 14d235e..5f46d2b 100644 --- a/lib/slack/web/docs/oauth.v2.access.json +++ b/lib/slack/web/docs/oauth.v2.access.json @@ -1,38 +1,33 @@ -{ - "desc": "Exchanges a temporary OAuth verifier code for an access token.", - - "args": { - "client_id": { - "required" : true, - "example" : "4b39e9-752c4", - "desc" : "Issued when you created your application." - }, - - "client_secret": { - "required" : true, - "example" : "33fea0113f5b1", - "desc" : "Issued when you created your application." - }, - - "code": { - "required" : true, - "example" : "ccdaa72ad", - "desc" : "The `code` param returned via the OAuth callback." - }, - - "redirect_uri": { - "required" : false, - "example" : "http://example.com", - "desc" : "This must match the originally submitted URI (if one was sent)." - } - }, - - "errors": { - "invalid_grant_type": "Value passed for grant_type was invalid.", - "invalid_client_id" : "Value passed for `client_id` was invalid.", - "bad_client_secret" : "Value passed for `client_secret` was invalid.", - "invalid_code" : "Value passed for `code` was invalid.", - "bad_redirect_uri" : "Value passed for `redirect_uri` did not match the `redirect_uri` in the original request.", - "oauth_authorization_url_mismatch": "The OAuth flow was initiated on an incorrect version of the authorization url. The flow must be initiated via /oauth/v2/authorize." - } -} +{ + "args": { + "client_id": { + "desc": "Issued when you created your application.", + "example": "4b39e9-752c4", + "required": true + }, + "client_secret": { + "desc": "Issued when you created your application.", + "example": "33fea0113f5b1", + "required": true + }, + "code": { + "desc": "The `code` param returned via the OAuth callback.", + "example": "ccdaa72ad", + "required": true + }, + "redirect_uri": { + "desc": "This must match the originally submitted URI (if one was sent).", + "example": "http://example.com", + "required": false + } + }, + "desc": "Exchanges a temporary OAuth verifier code for an access token.", + "errors": { + "bad_client_secret": "Value passed for `client_secret` was invalid.", + "bad_redirect_uri": "Value passed for `redirect_uri` did not match the `redirect_uri` in the original request.", + "invalid_client_id": "Value passed for `client_id` was invalid.", + "invalid_code": "Value passed for `code` was invalid.", + "invalid_grant_type": "Value passed for grant_type was invalid.", + "oauth_authorization_url_mismatch": "The OAuth flow was initiated on an incorrect version of the authorization url. The flow must be initiated via /oauth/v2/authorize." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/pins.add.json b/lib/slack/web/docs/pins.add.json index 39fba65..2ba5e87 100644 --- a/lib/slack/web/docs/pins.add.json +++ b/lib/slack/web/docs/pins.add.json @@ -1,41 +1,36 @@ { - "desc" : "Pins an item to a channel.", - - "args" : { - "channel" : { - "required" : true, - "type" : "channel", - "desc" : "Channel to pin the item in." - }, - - "file" : { - "type" : "file", - "required" : false, - "desc" : "File to pin." - }, - - "file_comment" : { - "type" : "file_comment", - "required" : false, - "desc" : "File comment to pin." - }, - - "timestamp" : { - "required" : false, - "type" : "timestamp", - "desc" : "Timestamp of the message to pin." - } - }, - - "errors" : { - "bad_timestamp" : "Value passed for `timestamp` was invalid.", - "file_not_found" : "File specified by `file` does not exist.", - "file_comment_not_found" : "File comment specified by `file_comment` does not exist.", - "message_not_found" : "Message specified by `channel` and `timestamp` does not exist.", - "channel_not_found" : "The `channel` argument was not specified or was invalid", - "no_item_specified" : "One of `file`, `file_comment`, or `timestamp` was not specified.", - "already_pinned" : "The specified item is already pinned to the channel.", - "permission_denied" : "The user does not have permission to add pins to the channel.", - "file_not_shared" : "File specified by `file` is not public nor shared to the channel." - } -} + "args": { + "channel": { + "desc": "Channel to pin the item in.", + "required": true, + "type": "channel" + }, + "file": { + "desc": "File to pin.", + "required": false, + "type": "file" + }, + "file_comment": { + "desc": "File comment to pin.", + "required": false, + "type": "file_comment" + }, + "timestamp": { + "desc": "Timestamp of the message to pin.", + "required": false, + "type": "timestamp" + } + }, + "desc": "Pins an item to a channel.", + "errors": { + "already_pinned": "The specified item is already pinned to the channel.", + "bad_timestamp": "Value passed for `timestamp` was invalid.", + "channel_not_found": "The `channel` argument was not specified or was invalid", + "file_comment_not_found": "File comment specified by `file_comment` does not exist.", + "file_not_found": "File specified by `file` does not exist.", + "file_not_shared": "File specified by `file` is not public nor shared to the channel.", + "message_not_found": "Message specified by `channel` and `timestamp` does not exist.", + "no_item_specified": "One of `file`, `file_comment`, or `timestamp` was not specified.", + "permission_denied": "The user does not have permission to add pins to the channel." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/pins.list.json b/lib/slack/web/docs/pins.list.json index 423630c..5d71fab 100644 --- a/lib/slack/web/docs/pins.list.json +++ b/lib/slack/web/docs/pins.list.json @@ -1,17 +1,14 @@ { - "desc": "Lists items pinned to a channel.", - - "args": { - "channel": { - "required" : true, - "type" : "channel", - "desc" : "Channel to get pinned items for." - } - }, - - "default_count": 100, - - "errors": { - "channel_not_found" : "Value passed for `channel` was invalid." - } -} + "args": { + "channel": { + "desc": "Channel to get pinned items for.", + "required": true, + "type": "channel" + } + }, + "default_count": 100, + "desc": "Lists items pinned to a channel.", + "errors": { + "channel_not_found": "Value passed for `channel` was invalid." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/pins.remove.json b/lib/slack/web/docs/pins.remove.json index 32e95aa..803ecf5 100644 --- a/lib/slack/web/docs/pins.remove.json +++ b/lib/slack/web/docs/pins.remove.json @@ -1,39 +1,34 @@ { - "desc": "Un-pins an item from a channel.", - - "args": { - "channel": { - "required" : true, - "type" : "channel", - "desc" : "Channel where the item is pinned to." - }, - - "file": { - "type" : "file", - "required" : false, - "desc" : "File to un-pin." - }, - - "file_comment": { - "type" : "file_comment", - "required" : false, - "desc" : "File comment to un-pin." - }, - - "timestamp": { - "required" : false, - "type" : "timestamp", - "desc" : "Timestamp of the message to un-pin." - } - }, - - "errors": { - "bad_timestamp" : "Value passed for `timestamp` was invalid.", - "file_not_found" : "File specified by `file` does not exist.", - "file_comment_not_found" : "File comment specified by `file_comment` does not exist.", - "message_not_found" : "Message specified by `channel` and `timestamp` does not exist.", - "no_item_specified" : "One of `file`, `file_comment`, or `timestamp` was not specified.", - "not_pinned" : "The specified item is not pinned to the channel.", - "permission_denied" : "The user does not have permission to remove pins from the channel." - } -} + "args": { + "channel": { + "desc": "Channel where the item is pinned to.", + "required": true, + "type": "channel" + }, + "file": { + "desc": "File to un-pin.", + "required": false, + "type": "file" + }, + "file_comment": { + "desc": "File comment to un-pin.", + "required": false, + "type": "file_comment" + }, + "timestamp": { + "desc": "Timestamp of the message to un-pin.", + "required": false, + "type": "timestamp" + } + }, + "desc": "Un-pins an item from a channel.", + "errors": { + "bad_timestamp": "Value passed for `timestamp` was invalid.", + "file_comment_not_found": "File comment specified by `file_comment` does not exist.", + "file_not_found": "File specified by `file` does not exist.", + "message_not_found": "Message specified by `channel` and `timestamp` does not exist.", + "no_item_specified": "One of `file`, `file_comment`, or `timestamp` was not specified.", + "not_pinned": "The specified item is not pinned to the channel.", + "permission_denied": "The user does not have permission to remove pins from the channel." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/presence.set.json b/lib/slack/web/docs/presence.set.json index 3009ce1..f1e94e4 100644 --- a/lib/slack/web/docs/presence.set.json +++ b/lib/slack/web/docs/presence.set.json @@ -1,16 +1,14 @@ { - "desc": "Manually set user presence", - "deprecated": true, - - "args": { - "presence": { - "required" : true, - "example" : "away", - "desc" : "Either `active` or `away`" - } - }, - - "errors": { - "invalid_presence": "Value passed for `presence` was invalid." - } -} + "args": { + "presence": { + "desc": "Either `active` or `away`", + "example": "away", + "required": true + } + }, + "deprecated": true, + "desc": "Manually set user presence", + "errors": { + "invalid_presence": "Value passed for `presence` was invalid." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/reactions.add.json b/lib/slack/web/docs/reactions.add.json index cf37f79..507b5f1 100644 --- a/lib/slack/web/docs/reactions.add.json +++ b/lib/slack/web/docs/reactions.add.json @@ -1,47 +1,41 @@ { - "desc": "Adds a reaction to an item.", - - "args": { - "name": { - "required" : true, - "example" : "thumbsup", - "desc" : "Reaction (emoji) name." - }, - - "file": { - "type" : "file", - "required" : false, - "desc" : "File to add reaction to." - }, - - "file_comment": { - "type" : "file_comment", - "required" : false, - "desc" : "File comment to add reaction to." - }, - - "channel": { - "required" : false, - "type" : "channel", - "desc" : "Channel where the message to add reaction to was posted." - }, - - "timestamp": { - "required" : false, - "type" : "timestamp", - "desc" : "Timestamp of the message to add reaction to." - } - }, - - "errors": { - "bad_timestamp" : "Value passed for `timestamp` was invalid.", - "file_not_found" : "File specified by `file` does not exist.", - "file_comment_not_found" : "File comment specified by `file_comment` does not exist.", - "message_not_found" : "Message specified by `channel` and `timestamp` does not exist.", - "no_item_specified" : "`file`, `file_comment`, or combination of `channel` and `timestamp` was not specified.", - "invalid_name" : "Value passed for `name` was invalid.", - "already_reacted" : "The specified item already has the user/reaction combination.", - "too_many_emoji" : "The limit for distinct reactions (i.e emoji) on the item has been reached.", - "too_many_reactions" : "The limit for reactions a person may add to the item has been reached." - } -} + "args": { + "channel": { + "desc": "Channel where the message to add reaction to was posted.", + "required": false, + "type": "channel" + }, + "file": { + "desc": "File to add reaction to.", + "required": false, + "type": "file" + }, + "file_comment": { + "desc": "File comment to add reaction to.", + "required": false, + "type": "file_comment" + }, + "name": { + "desc": "Reaction (emoji) name.", + "example": "thumbsup", + "required": true + }, + "timestamp": { + "desc": "Timestamp of the message to add reaction to.", + "required": false, + "type": "timestamp" + } + }, + "desc": "Adds a reaction to an item.", + "errors": { + "already_reacted": "The specified item already has the user/reaction combination.", + "bad_timestamp": "Value passed for `timestamp` was invalid.", + "file_comment_not_found": "File comment specified by `file_comment` does not exist.", + "file_not_found": "File specified by `file` does not exist.", + "invalid_name": "Value passed for `name` was invalid.", + "message_not_found": "Message specified by `channel` and `timestamp` does not exist.", + "no_item_specified": "`file`, `file_comment`, or combination of `channel` and `timestamp` was not specified.", + "too_many_emoji": "The limit for distinct reactions (i.e emoji) on the item has been reached.", + "too_many_reactions": "The limit for reactions a person may add to the item has been reached." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/reactions.get.json b/lib/slack/web/docs/reactions.get.json index 929ddc3..f833305 100644 --- a/lib/slack/web/docs/reactions.get.json +++ b/lib/slack/web/docs/reactions.get.json @@ -1,42 +1,36 @@ { - "desc": "Gets reactions for an item.", - - "args": { - "file": { - "type" : "file", - "required" : false, - "desc" : "File to get reactions for." - }, - - "file_comment": { - "type" : "file_comment", - "required" : false, - "desc" : "File comment to get reactions for." - }, - - "channel": { - "required" : false, - "type" : "channel", - "desc" : "Channel where the message to get reactions for was posted." - }, - - "timestamp": { - "required" : false, - "type" : "timestamp", - "desc" : "Timestamp of the message to get reactions for." - }, - - "full": { - "required" : false, - "desc" : "If true always return the complete reaction list." - } + "args": { + "channel": { + "desc": "Channel where the message to get reactions for was posted.", + "required": false, + "type": "channel" }, - - "errors": { - "bad_timestamp" : "Value passed for `timestamp` was invalid.", - "file_not_found" : "File specified by `file` does not exist.", - "file_comment_not_found" : "File comment specified by `file_comment` does not exist.", - "message_not_found" : "Message specified by `channel` and `timestamp` does not exist.", - "no_item_specified" : "`file`, `file_comment`, or combination of `channel` and `timestamp` was not specified." + "file": { + "desc": "File to get reactions for.", + "required": false, + "type": "file" + }, + "file_comment": { + "desc": "File comment to get reactions for.", + "required": false, + "type": "file_comment" + }, + "full": { + "desc": "If true always return the complete reaction list.", + "required": false + }, + "timestamp": { + "desc": "Timestamp of the message to get reactions for.", + "required": false, + "type": "timestamp" } -} + }, + "desc": "Gets reactions for an item.", + "errors": { + "bad_timestamp": "Value passed for `timestamp` was invalid.", + "file_comment_not_found": "File comment specified by `file_comment` does not exist.", + "file_not_found": "File specified by `file` does not exist.", + "message_not_found": "Message specified by `channel` and `timestamp` does not exist.", + "no_item_specified": "`file`, `file_comment`, or combination of `channel` and `timestamp` was not specified." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/reactions.list.json b/lib/slack/web/docs/reactions.list.json index f468458..5d62c23 100644 --- a/lib/slack/web/docs/reactions.list.json +++ b/lib/slack/web/docs/reactions.list.json @@ -1,23 +1,19 @@ { - "desc": "Lists reactions made by a user.", - - "args": { - "user": { - "type" : "user", - "required" : false, - "desc" : "Show reactions made by this user. Defaults to the authed user." - }, - - "full": { - "required" : false, - "desc" : "If true always return the complete reaction list." - } + "args": { + "full": { + "desc": "If true always return the complete reaction list.", + "required": false }, - - "has_paging" : true, - "default_count" : 100, - - "errors": { - "user_not_found" : "Value passed for `user` was invalid." + "user": { + "desc": "Show reactions made by this user. Defaults to the authed user.", + "required": false, + "type": "user" } -} + }, + "default_count": 100, + "desc": "Lists reactions made by a user.", + "errors": { + "user_not_found": "Value passed for `user` was invalid." + }, + "has_paging": true +} \ No newline at end of file diff --git a/lib/slack/web/docs/reactions.remove.json b/lib/slack/web/docs/reactions.remove.json index f93a8bd..17f22f2 100644 --- a/lib/slack/web/docs/reactions.remove.json +++ b/lib/slack/web/docs/reactions.remove.json @@ -1,45 +1,39 @@ { - "desc": "Removes a reaction from an item.", - - "args": { - "name": { - "required" : true, - "example" : "thumbsup", - "desc" : "Reaction (emoji) name." - }, - - "file": { - "type" : "file", - "required" : false, - "desc" : "File to remove reaction from." - }, - - "file_comment": { - "type" : "file_comment", - "required" : false, - "desc" : "File comment to remove reaction from." - }, - - "channel": { - "required" : false, - "type" : "channel", - "desc" : "Channel where the message to remove reaction from was posted." - }, - - "timestamp": { - "required" : false, - "type" : "timestamp", - "desc" : "Timestamp of the message to remove reaction from." - } - }, - - "errors": { - "bad_timestamp" : "Value passed for `timestamp` was invalid.", - "file_not_found" : "File specified by `file` does not exist.", - "file_comment_not_found" : "File comment specified by `file_comment` does not exist.", - "message_not_found" : "Message specified by `channel` and `timestamp` does not exist.", - "no_item_specified" : "`file`, `file_comment`, or combination of `channel` and `timestamp` was not specified.", - "invalid_name" : "Value passed for `name` was invalid.", - "no_reaction" : "The specified item does not have the user/reaction combination." - } -} + "args": { + "channel": { + "desc": "Channel where the message to remove reaction from was posted.", + "required": false, + "type": "channel" + }, + "file": { + "desc": "File to remove reaction from.", + "required": false, + "type": "file" + }, + "file_comment": { + "desc": "File comment to remove reaction from.", + "required": false, + "type": "file_comment" + }, + "name": { + "desc": "Reaction (emoji) name.", + "example": "thumbsup", + "required": true + }, + "timestamp": { + "desc": "Timestamp of the message to remove reaction from.", + "required": false, + "type": "timestamp" + } + }, + "desc": "Removes a reaction from an item.", + "errors": { + "bad_timestamp": "Value passed for `timestamp` was invalid.", + "file_comment_not_found": "File comment specified by `file_comment` does not exist.", + "file_not_found": "File specified by `file` does not exist.", + "invalid_name": "Value passed for `name` was invalid.", + "message_not_found": "Message specified by `channel` and `timestamp` does not exist.", + "no_item_specified": "`file`, `file_comment`, or combination of `channel` and `timestamp` was not specified.", + "no_reaction": "The specified item does not have the user/reaction combination." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/rtm.connect.json b/lib/slack/web/docs/rtm.connect.json index f9c5318..a7de739 100644 --- a/lib/slack/web/docs/rtm.connect.json +++ b/lib/slack/web/docs/rtm.connect.json @@ -1,15 +1,15 @@ { - "desc": "Starts a Real Time Messaging session.", - "args": { + "args": { "batch_presence_aware": { - "type": "int", + "desc": "Batch presence deliveries via subscription. Enabling changes the shape of `presence_change` events. See [batch presence](https://api.slack.com/docs/presence-and-status#batching).", "required": false, - "desc": "Batch presence deliveries via subscription. Enabling changes the shape of `presence_change` events. See [batch presence](https://api.slack.com/docs/presence-and-status#batching)." + "type": "int" }, "presence_sub": { - "type": "bool", - "required": false, - "desc": "Only deliver presence events when requested by subscription. See [presence subscriptions](https://api.slack.com/docs/presence-and-status#subscriptions)." - } - } -} + "desc": "Only deliver presence events when requested by subscription. See [presence subscriptions](https://api.slack.com/docs/presence-and-status#subscriptions).", + "required": false, + "type": "bool" + } + }, + "desc": "Starts a Real Time Messaging session." +} \ No newline at end of file diff --git a/lib/slack/web/docs/search.all.json b/lib/slack/web/docs/search.all.json index bfba4b1..4e3e805 100644 --- a/lib/slack/web/docs/search.all.json +++ b/lib/slack/web/docs/search.all.json @@ -1,33 +1,29 @@ { - "desc": "Searches for messages and files matching a query.", - - "args": { - "query": { - "required" : true, - "example" : "pickleface", - "desc" : "Search query. May contains booleans, etc." - }, - "sort": { - "required" : false, - "default" : "score", - "example" : "timestamp", - "desc" : "Return matches sorted by either `score` or `timestamp`." - }, - "sort_dir": { - "required" : false, - "default" : "desc", - "example" : "asc", - "desc" : "Change sort direction to ascending (`asc`) or descending (`desc`)." - }, - "highlight": { - "required" : false, - "example" : 1, - "desc" : "Pass a value of `1` to enable query highlight markers (see below)." - } - }, - - "has_paging" : true, - - "errors": { - } -} + "args": { + "highlight": { + "desc": "Pass a value of `1` to enable query highlight markers (see below).", + "example": 1, + "required": false + }, + "query": { + "desc": "Search query. May contains booleans, etc.", + "example": "pickleface", + "required": true + }, + "sort": { + "default": "score", + "desc": "Return matches sorted by either `score` or `timestamp`.", + "example": "timestamp", + "required": false + }, + "sort_dir": { + "default": "desc", + "desc": "Change sort direction to ascending (`asc`) or descending (`desc`).", + "example": "asc", + "required": false + } + }, + "desc": "Searches for messages and files matching a query.", + "errors": {}, + "has_paging": true +} \ No newline at end of file diff --git a/lib/slack/web/docs/search.files.json b/lib/slack/web/docs/search.files.json index c4714d3..06b6b83 100644 --- a/lib/slack/web/docs/search.files.json +++ b/lib/slack/web/docs/search.files.json @@ -1,33 +1,29 @@ { - "desc": "Searches for files matching a query.", - - "args": { - "query": { - "required" : true, - "example" : "pickleface", - "desc" : "Search query. May contain booleans, etc." - }, - "sort": { - "required" : false, - "default" : "score", - "example" : "timestamp", - "desc" : "Return matches sorted by either `score` or `timestamp`." - }, - "sort_dir": { - "required" : false, - "default" : "desc", - "example" : "asc", - "desc" : "Change sort direction to ascending (`asc`) or descending (`desc`)." - }, - "highlight": { - "required" : false, - "example" : 1, - "desc" : "Pass a value of `1` to enable query highlight markers (see below)." - } - }, - - "has_paging" : true, - - "errors": { - } -} + "args": { + "highlight": { + "desc": "Pass a value of `1` to enable query highlight markers (see below).", + "example": 1, + "required": false + }, + "query": { + "desc": "Search query. May contain booleans, etc.", + "example": "pickleface", + "required": true + }, + "sort": { + "default": "score", + "desc": "Return matches sorted by either `score` or `timestamp`.", + "example": "timestamp", + "required": false + }, + "sort_dir": { + "default": "desc", + "desc": "Change sort direction to ascending (`asc`) or descending (`desc`).", + "example": "asc", + "required": false + } + }, + "desc": "Searches for files matching a query.", + "errors": {}, + "has_paging": true +} \ No newline at end of file diff --git a/lib/slack/web/docs/search.messages.json b/lib/slack/web/docs/search.messages.json index f59bd02..978322e 100644 --- a/lib/slack/web/docs/search.messages.json +++ b/lib/slack/web/docs/search.messages.json @@ -1,33 +1,29 @@ { - "desc": "Searches for messages matching a query.", - - "args": { - "query": { - "required" : true, - "example" : "pickleface", - "desc" : "Search query. May contains booleans, etc." - }, - "sort": { - "required" : false, - "default" : "score", - "example" : "timestamp", - "desc" : "Return matches sorted by either `score` or `timestamp`." - }, - "sort_dir": { - "required" : false, - "default" : "desc", - "example" : "asc", - "desc" : "Change sort direction to ascending (`asc`) or descending (`desc`)." - }, - "highlight": { - "required" : false, - "example" : 1, - "desc" : "Pass a value of `1` to enable query highlight markers (see below)." - } - }, - - "has_paging" : true, - - "errors": { - } -} + "args": { + "highlight": { + "desc": "Pass a value of `1` to enable query highlight markers (see below).", + "example": 1, + "required": false + }, + "query": { + "desc": "Search query. May contains booleans, etc.", + "example": "pickleface", + "required": true + }, + "sort": { + "default": "score", + "desc": "Return matches sorted by either `score` or `timestamp`.", + "example": "timestamp", + "required": false + }, + "sort_dir": { + "default": "desc", + "desc": "Change sort direction to ascending (`asc`) or descending (`desc`).", + "example": "asc", + "required": false + } + }, + "desc": "Searches for messages matching a query.", + "errors": {}, + "has_paging": true +} \ No newline at end of file diff --git a/lib/slack/web/docs/stars.add.json b/lib/slack/web/docs/stars.add.json index 1cb4d96..7b05027 100644 --- a/lib/slack/web/docs/stars.add.json +++ b/lib/slack/web/docs/stars.add.json @@ -1,39 +1,34 @@ { - "desc": "Adds a star to an item.", - - "args": { - "file": { - "type" : "file", - "required" : false, - "desc" : "File to add star to." - }, - - "file_comment": { - "type" : "file_comment", - "required" : false, - "desc" : "File comment to add star to." - }, - - "channel": { - "required" : false, - "type" : "channel", - "desc" : "Channel to add star to, or channel where the message to add star to was posted (used with `timestamp`)." - }, - - "timestamp": { - "required" : false, - "type" : "timestamp", - "desc" : "Timestamp of the message to add star to." - } - }, - - "errors": { - "bad_timestamp" : "Value passed for `timestamp` was invalid.", - "message_not_found" : "Message specified by `channel` and `timestamp` does not exist.", - "file_not_found" : "File specified by `file` does not exist.", - "file_comment_not_found" : "File comment specified by `file_comment` does not exist.", - "channel_not_found" : "Channel, private group, or DM specified by `channel` does not exist", - "no_item_specified" : "`file`, `file_comment`, `channel` and `timestamp` was not specified.", - "already_starred" : "The specified item has already been starred by the authenticated user." - } -} + "args": { + "channel": { + "desc": "Channel to add star to, or channel where the message to add star to was posted (used with `timestamp`).", + "required": false, + "type": "channel" + }, + "file": { + "desc": "File to add star to.", + "required": false, + "type": "file" + }, + "file_comment": { + "desc": "File comment to add star to.", + "required": false, + "type": "file_comment" + }, + "timestamp": { + "desc": "Timestamp of the message to add star to.", + "required": false, + "type": "timestamp" + } + }, + "desc": "Adds a star to an item.", + "errors": { + "already_starred": "The specified item has already been starred by the authenticated user.", + "bad_timestamp": "Value passed for `timestamp` was invalid.", + "channel_not_found": "Channel, private group, or DM specified by `channel` does not exist", + "file_comment_not_found": "File comment specified by `file_comment` does not exist.", + "file_not_found": "File specified by `file` does not exist.", + "message_not_found": "Message specified by `channel` and `timestamp` does not exist.", + "no_item_specified": "`file`, `file_comment`, `channel` and `timestamp` was not specified." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/stars.list.json b/lib/slack/web/docs/stars.list.json index 0fa339f..a4b3b76 100644 --- a/lib/slack/web/docs/stars.list.json +++ b/lib/slack/web/docs/stars.list.json @@ -1,18 +1,15 @@ { - "desc": "Lists stars for a user.", - - "args": { - "user": { - "type" : "user", - "required" : false, - "desc" : "Show stars by this user. Defaults to the authed user." - } - }, - - "has_paging" : true, - "default_count" : 100, - - "errors": { - "user_not_found" : "Value passed for `user` was invalid" - } -} + "args": { + "user": { + "desc": "Show stars by this user. Defaults to the authed user.", + "required": false, + "type": "user" + } + }, + "default_count": 100, + "desc": "Lists stars for a user.", + "errors": { + "user_not_found": "Value passed for `user` was invalid" + }, + "has_paging": true +} \ No newline at end of file diff --git a/lib/slack/web/docs/stars.remove.json b/lib/slack/web/docs/stars.remove.json index b1ac041..e9f8390 100644 --- a/lib/slack/web/docs/stars.remove.json +++ b/lib/slack/web/docs/stars.remove.json @@ -1,39 +1,34 @@ { - "desc": "Removes a star from an item.", - - "args": { - "file": { - "type" : "file", - "required" : false, - "desc" : "File to remove star from." - }, - - "file_comment": { - "type" : "file_comment", - "required" : false, - "desc" : "File comment to remove star from." - }, - - "channel": { - "required" : false, - "type" : "channel", - "desc" : "Channel to remove star from, or channel where the message to remove star from was posted (used with `timestamp`)." - }, - - "timestamp": { - "required" : false, - "type" : "timestamp", - "desc" : "Timestamp of the message to remove star from." - } - }, - - "errors": { - "bad_timestamp" : "Value passed for `timestamp` was invalid.", - "message_not_found" : "Message specified by `channel` and `timestamp` does not exist.", - "file_not_found" : "File specified by `file` does not exist.", - "file_comment_not_found" : "File comment specified by `file_comment` does not exist.", - "channel_not_found" : "Channel, private group, or DM specified by `channel` does not exist", - "no_item_specified" : "`file`, `file_comment`, `channel` and `timestamp` was not specified.", - "not_starred" : "The specified item is not currently starred by the authenticated user." - } -} + "args": { + "channel": { + "desc": "Channel to remove star from, or channel where the message to remove star from was posted (used with `timestamp`).", + "required": false, + "type": "channel" + }, + "file": { + "desc": "File to remove star from.", + "required": false, + "type": "file" + }, + "file_comment": { + "desc": "File comment to remove star from.", + "required": false, + "type": "file_comment" + }, + "timestamp": { + "desc": "Timestamp of the message to remove star from.", + "required": false, + "type": "timestamp" + } + }, + "desc": "Removes a star from an item.", + "errors": { + "bad_timestamp": "Value passed for `timestamp` was invalid.", + "channel_not_found": "Channel, private group, or DM specified by `channel` does not exist", + "file_comment_not_found": "File comment specified by `file_comment` does not exist.", + "file_not_found": "File specified by `file` does not exist.", + "message_not_found": "Message specified by `channel` and `timestamp` does not exist.", + "no_item_specified": "`file`, `file_comment`, `channel` and `timestamp` was not specified.", + "not_starred": "The specified item is not currently starred by the authenticated user." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/team.accessLogs.json b/lib/slack/web/docs/team.accessLogs.json index 69f8e51..c937338 100644 --- a/lib/slack/web/docs/team.accessLogs.json +++ b/lib/slack/web/docs/team.accessLogs.json @@ -1,14 +1,10 @@ { - "desc": "Gets the access logs for the current team.", - - "args": { - }, - - "has_paging" : true, - "default_count" : 100, - - "errors": { - "paid_only": "This is only available to paid teams.", - "over_pagination_limit": "It is not possible to request more than 1000 items per page or more than 100 pages." - } -} + "args": {}, + "default_count": 100, + "desc": "Gets the access logs for the current team.", + "errors": { + "over_pagination_limit": "It is not possible to request more than 1000 items per page or more than 100 pages.", + "paid_only": "This is only available to paid teams." + }, + "has_paging": true +} \ No newline at end of file diff --git a/lib/slack/web/docs/team.info.json b/lib/slack/web/docs/team.info.json index 2b2b7a4..35d65d7 100644 --- a/lib/slack/web/docs/team.info.json +++ b/lib/slack/web/docs/team.info.json @@ -1,9 +1,5 @@ { - "desc": "Gets information about the current team.", - - "args": { - }, - - "errors": { - } -} + "args": {}, + "desc": "Gets information about the current team.", + "errors": {} +} \ No newline at end of file diff --git a/lib/slack/web/docs/team.integrationLogs.json b/lib/slack/web/docs/team.integrationLogs.json index 9736c25..3da5988 100644 --- a/lib/slack/web/docs/team.integrationLogs.json +++ b/lib/slack/web/docs/team.integrationLogs.json @@ -1,32 +1,28 @@ { - "desc": "Gets the integration logs for the current team.", - - "args": { - "service_id": { - "type" : "int", - "required" : false, - "desc" : "Filter logs to this service. Defaults to all logs." - }, - "app_id": { - "type" : "int", - "required" : false, - "desc" : "Filter logs to this Slack app. Defaults to all logs." - }, - "user": { - "type" : "user", - "required" : false, - "desc" : "Filter logs generated by this user’s actions. Defaults to all logs." - }, - "change_type": { - "required" : false, - "example" : "added", - "desc" : "Filter logs with this change type. Defaults to all logs." - } - }, - - "has_paging" : true, - "default_count" : 100, - - "errors": { - } + "args": { + "app_id": { + "desc": "Filter logs to this Slack app. Defaults to all logs.", + "required": false, + "type": "int" + }, + "change_type": { + "desc": "Filter logs with this change type. Defaults to all logs.", + "example": "added", + "required": false + }, + "service_id": { + "desc": "Filter logs to this service. Defaults to all logs.", + "required": false, + "type": "int" + }, + "user": { + "desc": "Filter logs generated by this user’s actions. Defaults to all logs.", + "required": false, + "type": "user" + } + }, + "default_count": 100, + "desc": "Gets the integration logs for the current team.", + "errors": {}, + "has_paging": true } \ No newline at end of file diff --git a/lib/slack/web/docs/usergroups.create.json b/lib/slack/web/docs/usergroups.create.json index 84d21e9..82e41fd 100644 --- a/lib/slack/web/docs/usergroups.create.json +++ b/lib/slack/web/docs/usergroups.create.json @@ -1,33 +1,32 @@ { - "desc": "Create a user group", - - "args": { - "name": { - "required" : true, - "type" : "string", - "example" : "My Test Team", - "desc" : "A name for the user group. Must be unique among user groups." - }, - "handle": { - "required" : false, - "type" : "string", - "desc" : "A mention handle. Must be unique among channels, users and user groups." - }, - "description": { - "required" : false, - "type" : "string", - "desc" : "A short description of the user group." - }, - "channels": { - "required" : false, - "type" : "string", - "desc" : "A comma separated string of encoded channel IDs for which the user group uses as a default." - }, - "include_count": { - "required" : false, - "type" : "int", - "example" : "1", - "desc" : "Include the number of users in each user group." - } - } -} + "args": { + "channels": { + "desc": "A comma separated string of encoded channel IDs for which the user group uses as a default.", + "required": false, + "type": "string" + }, + "description": { + "desc": "A short description of the user group.", + "required": false, + "type": "string" + }, + "handle": { + "desc": "A mention handle. Must be unique among channels, users and user groups.", + "required": false, + "type": "string" + }, + "include_count": { + "desc": "Include the number of users in each user group.", + "example": "1", + "required": false, + "type": "int" + }, + "name": { + "desc": "A name for the user group. Must be unique among user groups.", + "example": "My Test Team", + "required": true, + "type": "string" + } + }, + "desc": "Create a user group" +} \ No newline at end of file diff --git a/lib/slack/web/docs/usergroups.disable.json b/lib/slack/web/docs/usergroups.disable.json index 020f3bd..491ea67 100644 --- a/lib/slack/web/docs/usergroups.disable.json +++ b/lib/slack/web/docs/usergroups.disable.json @@ -1,18 +1,17 @@ { - "desc": "Disable an existing user group", - - "args": { - "usergroup": { - "required" : true, - "type" : "string", - "example" : "S0604QSJC", - "desc" : "The encoded ID of the user group to disable." - }, - "include_count": { - "required" : false, - "type" : "int", - "example" : "1", - "desc" : "Include the number of users in the user group." - } - } -} + "args": { + "include_count": { + "desc": "Include the number of users in the user group.", + "example": "1", + "required": false, + "type": "int" + }, + "usergroup": { + "desc": "The encoded ID of the user group to disable.", + "example": "S0604QSJC", + "required": true, + "type": "string" + } + }, + "desc": "Disable an existing user group" +} \ No newline at end of file diff --git a/lib/slack/web/docs/usergroups.enable.json b/lib/slack/web/docs/usergroups.enable.json index f8a58fa..f5e2c5c 100644 --- a/lib/slack/web/docs/usergroups.enable.json +++ b/lib/slack/web/docs/usergroups.enable.json @@ -1,18 +1,17 @@ { - "desc": "Enable a user group", - - "args": { - "usergroup": { - "required" : true, - "type" : "string", - "example" : "S0604QSJC", - "desc" : "The encoded ID of the user group to enable." - }, - "include_count": { - "required" : false, - "type" : "int", - "example" : "1", - "desc" : "Include the number of users in the user group." - } - } -} + "args": { + "include_count": { + "desc": "Include the number of users in the user group.", + "example": "1", + "required": false, + "type": "int" + }, + "usergroup": { + "desc": "The encoded ID of the user group to enable.", + "example": "S0604QSJC", + "required": true, + "type": "string" + } + }, + "desc": "Enable a user group" +} \ No newline at end of file diff --git a/lib/slack/web/docs/usergroups.list.json b/lib/slack/web/docs/usergroups.list.json index 54521a8..ce17eec 100644 --- a/lib/slack/web/docs/usergroups.list.json +++ b/lib/slack/web/docs/usergroups.list.json @@ -1,24 +1,23 @@ { - "desc": "List all user groups for a team", - - "args": { - "include_disabled": { - "required" : false, - "type" : "int", - "example" : "1", - "desc" : "Include disabled user groups." - }, - "include_count": { - "required" : false, - "type" : "int", - "example" : "1", - "desc" : "Include the number of users in each user group." - }, - "include_users": { - "required" : false, - "type" : "int", - "example" : "1", - "desc" : "Include the list of users for each user group." - } - } -} + "args": { + "include_count": { + "desc": "Include the number of users in each user group.", + "example": "1", + "required": false, + "type": "int" + }, + "include_disabled": { + "desc": "Include disabled user groups.", + "example": "1", + "required": false, + "type": "int" + }, + "include_users": { + "desc": "Include the list of users for each user group.", + "example": "1", + "required": false, + "type": "int" + } + }, + "desc": "List all user groups for a team" +} \ No newline at end of file diff --git a/lib/slack/web/docs/usergroups.update.json b/lib/slack/web/docs/usergroups.update.json index 019a3aa..572c214 100644 --- a/lib/slack/web/docs/usergroups.update.json +++ b/lib/slack/web/docs/usergroups.update.json @@ -1,39 +1,38 @@ { - "desc": "Update an existing user group", - - "args": { - "usergroup": { - "required" : true, - "type" : "string", - "example" : "S0604QSJC", - "desc" : "The encoded ID of the user group to update." - }, - "name": { - "required" : false, - "type" : "string", - "example" : "My Test Team", - "desc" : "A name for the user group. Must be unique among user groups." - }, - "handle": { - "required" : false, - "type" : "string", - "desc" : "A mention handle. Must be unique among channels, users and user groups." - }, - "description": { - "required" : false, - "type" : "string", - "desc" : "A short description of the user group." - }, - "channels": { - "required" : false, - "type" : "string", - "desc" : "A comma separated string of encoded channel IDs for which the user group uses as a default." - }, - "include_count": { - "required" : false, - "type" : "int", - "example" : "1", - "desc" : "Include the number of users in the user group." - } - } -} + "args": { + "channels": { + "desc": "A comma separated string of encoded channel IDs for which the user group uses as a default.", + "required": false, + "type": "string" + }, + "description": { + "desc": "A short description of the user group.", + "required": false, + "type": "string" + }, + "handle": { + "desc": "A mention handle. Must be unique among channels, users and user groups.", + "required": false, + "type": "string" + }, + "include_count": { + "desc": "Include the number of users in the user group.", + "example": "1", + "required": false, + "type": "int" + }, + "name": { + "desc": "A name for the user group. Must be unique among user groups.", + "example": "My Test Team", + "required": false, + "type": "string" + }, + "usergroup": { + "desc": "The encoded ID of the user group to update.", + "example": "S0604QSJC", + "required": true, + "type": "string" + } + }, + "desc": "Update an existing user group" +} \ No newline at end of file diff --git a/lib/slack/web/docs/usergroups.users.list.json b/lib/slack/web/docs/usergroups.users.list.json index 0c0bf32..cca9692 100644 --- a/lib/slack/web/docs/usergroups.users.list.json +++ b/lib/slack/web/docs/usergroups.users.list.json @@ -1,18 +1,17 @@ { - "desc": "List all users in a user group", - - "args": { - "usergroup": { - "required" : true, - "type" : "string", - "example" : "S0604QSJC", - "desc" : "The encoded ID of the user group to update." - }, - "include_disabled": { - "required" : false, - "type" : "int", - "example" : "1", - "desc" : "Allow results that involve disabled user groups." - } - } -} + "args": { + "include_disabled": { + "desc": "Allow results that involve disabled user groups.", + "example": "1", + "required": false, + "type": "int" + }, + "usergroup": { + "desc": "The encoded ID of the user group to update.", + "example": "S0604QSJC", + "required": true, + "type": "string" + } + }, + "desc": "List all users in a user group" +} \ No newline at end of file diff --git a/lib/slack/web/docs/usergroups.users.update.json b/lib/slack/web/docs/usergroups.users.update.json index 04e014c..f49e87d 100644 --- a/lib/slack/web/docs/usergroups.users.update.json +++ b/lib/slack/web/docs/usergroups.users.update.json @@ -1,24 +1,23 @@ { - "desc": "Update the list of users for a user group", - - "args": { - "usergroup": { - "required" : true, - "type" : "string", - "example" : "S0604QSJC", - "desc" : "The encoded ID of the user group to update." - }, - "users": { - "required" : true, - "type" : "string", - "example" : "U060R4BJ4,U060RNRCZ", - "desc" : "A comma separated string of encoded user IDs that represent the entire list of users for the user group." - }, - "include_count": { - "required" : false, - "type" : "int", - "example" : "1", - "desc" : "Include the number of users in the user group." - } - } -} + "args": { + "include_count": { + "desc": "Include the number of users in the user group.", + "example": "1", + "required": false, + "type": "int" + }, + "usergroup": { + "desc": "The encoded ID of the user group to update.", + "example": "S0604QSJC", + "required": true, + "type": "string" + }, + "users": { + "desc": "A comma separated string of encoded user IDs that represent the entire list of users for the user group.", + "example": "U060R4BJ4,U060RNRCZ", + "required": true, + "type": "string" + } + }, + "desc": "Update the list of users for a user group" +} \ No newline at end of file diff --git a/lib/slack/web/docs/users.conversations.json b/lib/slack/web/docs/users.conversations.json index 583886b..c89c73b 100644 --- a/lib/slack/web/docs/users.conversations.json +++ b/lib/slack/web/docs/users.conversations.json @@ -1,38 +1,36 @@ { - "desc": "Returns a list of all channel-like conversations accessible to the user or app tied to the presented token, as part of Conversations API.", - "args": { "cursor": { - "example" : "dXNlcjpVMDYxTkZUVDI=", - "required": false, - "desc" : "Paginate through collections of data by setting the cursor parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first \"page\" of the collection. See pagination for more detail." + "desc": "Paginate through collections of data by setting the cursor parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first \"page\" of the collection. See pagination for more detail.", + "example": "dXNlcjpVMDYxTkZUVDI=", + "required": false }, "exclude_archived": { - "example" : "true", - "required": false, - "desc" : "Set this to `true` to exclude archived channels from the list", - "default" : "false" + "default": "false", + "desc": "Set this to `true` to exclude archived channels from the list", + "example": "true", + "required": false }, "limit": { - "example" : 20, - "required": false, - "desc" : "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. Must be an integer no larger than 1000.", - "default" : 100 + "default": 100, + "desc": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. Must be an integer no larger than 1000.", + "example": 20, + "required": false }, "types": { - "example" : "public_channel,private_channel", - "required": false, - "desc" : "Mix and match channel types by providing a comma-separated list of any combination of `public_channel`, `private_channel`, `mpim`, `im`", - "default" : "public_channel" + "default": "public_channel", + "desc": "Mix and match channel types by providing a comma-separated list of any combination of `public_channel`, `private_channel`, `mpim`, `im`", + "example": "public_channel,private_channel", + "required": false }, "user": { - "example" : "W0B2345D", - "required": false, - "desc" : "Browse conversations by a specific user ID's membership. Non-public channels are restricted to those where the calling user shares membership." + "desc": "Browse conversations by a specific user ID's membership. Non-public channels are restricted to those where the calling user shares membership.", + "example": "W0B2345D", + "required": false } }, - + "desc": "Returns a list of all channel-like conversations accessible to the user or app tied to the presented token, as part of Conversations API.", "errors": { "method_not_supported_for_channel_type": "This type of conversation cannot be used with this method." } -} +} \ No newline at end of file diff --git a/lib/slack/web/docs/users.getPresence.json b/lib/slack/web/docs/users.getPresence.json index b69def7..3a5668a 100644 --- a/lib/slack/web/docs/users.getPresence.json +++ b/lib/slack/web/docs/users.getPresence.json @@ -1,14 +1,11 @@ { - "desc": "Gets user presence information.", - - "args": { - "user": { - "required" : true, - "type" : "user", - "desc" : "User to get presence info on. Defaults to the authed user." - } - }, - - "errors": { - } -} + "args": { + "user": { + "desc": "User to get presence info on. Defaults to the authed user.", + "required": true, + "type": "user" + } + }, + "desc": "Gets user presence information.", + "errors": {} +} \ No newline at end of file diff --git a/lib/slack/web/docs/users.info.json b/lib/slack/web/docs/users.info.json index 85d5892..927f852 100644 --- a/lib/slack/web/docs/users.info.json +++ b/lib/slack/web/docs/users.info.json @@ -1,16 +1,14 @@ { - "desc": "Gets information about a user.", - - "args": { - "user": { - "type" : "user", - "required" : true, - "desc" : "User to get info on" - } - }, - - "errors": { - "user_not_found" : "Value passed for `user` was invalid.", - "user_not_visible" : "The requested user is not visible to the calling user" - } -} + "args": { + "user": { + "desc": "User to get info on", + "required": true, + "type": "user" + } + }, + "desc": "Gets information about a user.", + "errors": { + "user_not_found": "Value passed for `user` was invalid.", + "user_not_visible": "The requested user is not visible to the calling user" + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/users.list.json b/lib/slack/web/docs/users.list.json index 514c81b..75dee7a 100644 --- a/lib/slack/web/docs/users.list.json +++ b/lib/slack/web/docs/users.list.json @@ -1,10 +1,10 @@ { - "desc": "Lists all users in a Slack team.", - "args": { - "presence": { - "required" : false, - "example" : 1, - "desc" : "Whether to include presence data in the output" - } - } -} + "args": { + "presence": { + "desc": "Whether to include presence data in the output", + "example": 1, + "required": false + } + }, + "desc": "Lists all users in a Slack team." +} \ No newline at end of file diff --git a/lib/slack/web/docs/users.lookupByEmail.json b/lib/slack/web/docs/users.lookupByEmail.json index 345c512..47b5de7 100644 --- a/lib/slack/web/docs/users.lookupByEmail.json +++ b/lib/slack/web/docs/users.lookupByEmail.json @@ -1,16 +1,14 @@ { - "desc": "Retrieve a single user by looking them up by their registered email address. Requires `users:read.email`.", - - "args": { - "email": { - "type" : "string", - "required" : true, - "desc" : "User's email address" - } - }, - - "errors": { - "user_not_found" : "Value passed for `user` was invalid.", - "missing_scope" : "The token used is not granted the specific scope permissions required to complete this request. Need: `users:read.email`." - } -} + "args": { + "email": { + "desc": "User's email address", + "required": true, + "type": "string" + } + }, + "desc": "Retrieve a single user by looking them up by their registered email address. Requires `users:read.email`.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request. Need: `users:read.email`.", + "user_not_found": "Value passed for `user` was invalid." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/users.profile.get.json b/lib/slack/web/docs/users.profile.get.json index 5aede5f..e4b6fdd 100644 --- a/lib/slack/web/docs/users.profile.get.json +++ b/lib/slack/web/docs/users.profile.get.json @@ -1,22 +1,20 @@ -{ - "desc": "Retrieves a user's profile information.", - - "args": { - "user": { - "type": "user", - "required": false, - "example": "W1234567890", - "desc": "User to retrieve profile info for" - }, - "include_labels": { - "type": "boolean", - "required": false, - "example": true, - "desc": "Include labels for each ID in custom profile fields" - } - }, - - "errors": { - "user_not_found": "Value passed for `user` was invalid." - } -} +{ + "args": { + "include_labels": { + "desc": "Include labels for each ID in custom profile fields", + "example": true, + "required": false, + "type": "boolean" + }, + "user": { + "desc": "User to retrieve profile info for", + "example": "W1234567890", + "required": false, + "type": "user" + } + }, + "desc": "Retrieves a user's profile information.", + "errors": { + "user_not_found": "Value passed for `user` was invalid." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/users.profile.set.json b/lib/slack/web/docs/users.profile.set.json index 1c65b96..2cbf975 100644 --- a/lib/slack/web/docs/users.profile.set.json +++ b/lib/slack/web/docs/users.profile.set.json @@ -1,36 +1,34 @@ -{ - "desc": "Set the profile information for a user.", - - "args": { - "user": { - "type": "user", - "required": false, - "example": "W1234567890", - "desc": "User to retrieve profile info for" - }, - "name": { - "required": false, - "example": "first_name", - "desc": "Name of a single key to set. Usable only if `profile` is not passed." - }, - "value": { - "required": false, - "example": "John", - "desc": "Value to set a single key to. Usable only if `profile` is not passed." - }, - "profile": { - "required": false, - "example": "`{ first_name: \"John\", ... }`", - "desc": "Collection of key:value pairs presented as a URL-encoded JSON hash. At most 50 fields may be set. Each field name is limited to 255 characters." - } - }, - - "errors": { - "reserved_name": "First or last name are reserved.", - "invalid_profile": "Profile object passed in is not valid JSON (make sure it is URL encoded!).", - "profile_set_failed": "Failed to set user profile.", - "not_admin": "Only admins can update the profile of another user. Some fields, like email may only be updated by an admin.", - "not_app_admin": "Only team owners and selected members can update the profile of a bot user.", - "cannot_update_admin_user": "Only a primary owner can update the profile of an admin." - } -} +{ + "args": { + "name": { + "desc": "Name of a single key to set. Usable only if `profile` is not passed.", + "example": "first_name", + "required": false + }, + "profile": { + "desc": "Collection of key:value pairs presented as a URL-encoded JSON hash. At most 50 fields may be set. Each field name is limited to 255 characters.", + "example": "`{ first_name: \"John\", ... }`", + "required": false + }, + "user": { + "desc": "User to retrieve profile info for", + "example": "W1234567890", + "required": false, + "type": "user" + }, + "value": { + "desc": "Value to set a single key to. Usable only if `profile` is not passed.", + "example": "John", + "required": false + } + }, + "desc": "Set the profile information for a user.", + "errors": { + "cannot_update_admin_user": "Only a primary owner can update the profile of an admin.", + "invalid_profile": "Profile object passed in is not valid JSON (make sure it is URL encoded!).", + "not_admin": "Only admins can update the profile of another user. Some fields, like email may only be updated by an admin.", + "not_app_admin": "Only team owners and selected members can update the profile of a bot user.", + "profile_set_failed": "Failed to set user profile.", + "reserved_name": "First or last name are reserved." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/users.setActive.json b/lib/slack/web/docs/users.setActive.json index e839678..492ca74 100644 --- a/lib/slack/web/docs/users.setActive.json +++ b/lib/slack/web/docs/users.setActive.json @@ -1,9 +1,5 @@ { - "desc": "Marks a user as active.", - - "args": { - }, - - "errors": { - } -} + "args": {}, + "desc": "Marks a user as active.", + "errors": {} +} \ No newline at end of file diff --git a/lib/slack/web/docs/users.setPresence.json b/lib/slack/web/docs/users.setPresence.json index 870abfd..84b85e0 100644 --- a/lib/slack/web/docs/users.setPresence.json +++ b/lib/slack/web/docs/users.setPresence.json @@ -1,15 +1,13 @@ { - "desc": "Manually sets user presence.", - - "args": { - "presence": { - "required" : true, - "example" : "away", - "desc" : "Either `auto` or `away`" - } - }, - - "errors": { - "invalid_presence": "Value passed for `presence` was invalid." - } -} + "args": { + "presence": { + "desc": "Either `auto` or `away`", + "example": "away", + "required": true + } + }, + "desc": "Manually sets user presence.", + "errors": { + "invalid_presence": "Value passed for `presence` was invalid." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/views.open.json b/lib/slack/web/docs/views.open.json index d200c17..539ba63 100644 --- a/lib/slack/web/docs/views.open.json +++ b/lib/slack/web/docs/views.open.json @@ -1,88 +1,84 @@ { - "desc": "Open a view for a user.", - "args": { "trigger_id": { - "required": true, + "desc": "Exchange a trigger to post to the user.", "example": "12345.98765.abcd2358fdea", - "desc": "Exchange a trigger to post to the user." + "required": true }, "view": { - "required": true, + "desc": "A view payload. This must be a JSON-encoded string.", "example": "Ar12345", - "desc": "A view payload. This must be a JSON-encoded string." + "required": true } }, - + "desc": "Open a view for a user.", + "errors": { + "account_inactive": "Authentication token is for a deleted user or workspace.", + "duplicate_external_id": "Error returned when the given `external_id` has already be used.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was called with invalid arguments.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_charset": "The method was called via a `POST` request, but the `charset` specified in the `Content-Type` header was invalid. Valid charset names are: `utf-8` `iso-8859-1`.", + "invalid_form_data": "The method was called via a `POST` request with `Content-Type` `application/x-www-form-urlencoded` or `multipart/form-data`, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a `POST` request, but the specified `Content-Type` was invalid. Valid types are: `application/json` `application/x-www-form-urlencoded` `multipart/form-data` `text/plain`.", + "missing_post_type": "The method was called via a `POST` request and included a data payload, but the request did not include a `Content-Type` header.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_authed": "No authentication token provided.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "request_timeout": "The method was called via a `POST` request, but the `POST` data was either missing or truncated.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed.", + "view_too_large": "Error returned if the provided view is greater than 250kb." + }, "response": { "ok": true, "view": { - "id": "VMHU10V25", - "team_id": "T8N4K1JN", - "type": "modal", - "title": { - "type": "plain_text", - "text": "Quite a plain modal" - }, - "submit": { - "type": "plain_text", - "text": "Create" - }, + "app_id": "AA4928AQ", "blocks": [ { - "type": "input", "block_id": "a_block_id", + "element": { + "action_id": "an_action_id", + "type": "plain_text_input" + }, "label": { - "type": "plain_text", + "emoji": true, "text": "A simple label", - "emoji": true + "type": "plain_text" }, "optional": false, - "element": { - "type": "plain_text_input", - "action_id": "an_action_id" - } + "type": "input" } ], - "private_metadata": "Shh it is a secret", + "bot_id": "BA13894H", "callback_id": "identify_your_modals", + "clear_on_close": false, "external_id": "", - "state": { - "values": [] - }, "hash": "156772938.1827394", - "clear_on_close": false, + "id": "VMHU10V25", "notify_on_close": false, + "private_metadata": "Shh it is a secret", "root_view_id": "VMHU10V25", - "app_id": "AA4928AQ", - "bot_id": "BA13894H" + "state": { + "values": [] + }, + "submit": { + "text": "Create", + "type": "plain_text" + }, + "team_id": "T8N4K1JN", + "title": { + "text": "Quite a plain modal", + "type": "plain_text" + }, + "type": "modal" } }, - - "errors": { - "duplicate_external_id" : "Error returned when the given `external_id` has already be used.", - "view_too_large" : "Error returned if the provided view is greater than 250kb.", - "not_authed": "No authentication token provided.", - "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", - "account_inactive": "Authentication token is for a deleted user or workspace.", - "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed.", - "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", - "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", - "ekm_access_denied": "Administrators have suspended the ability to post a message.", - "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", - "invalid_arguments": "The method was called with invalid arguments.", - "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", - "invalid_charset": "The method was called via a `POST` request, but the `charset` specified in the `Content-Type` header was invalid. Valid charset names are: `utf-8` `iso-8859-1`.", - "invalid_form_data": "The method was called via a `POST` request with `Content-Type` `application/x-www-form-urlencoded` or `multipart/form-data`, but the form data was either missing or syntactically invalid.", - "invalid_post_type": "The method was called via a `POST` request, but the specified `Content-Type` was invalid. Valid types are: `application/json` `application/x-www-form-urlencoded` `multipart/form-data` `text/plain`.", - "missing_post_type": "The method was called via a `POST` request and included a data payload, but the request did not include a `Content-Type` header.", - "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", - "request_timeout": "The method was called via a `POST` request, but the `POST` data was either missing or truncated.", - "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised." - }, - "warnings": { "missing_charset": "The method was called via a `POST` request, and recommended practice for the specified `Content-Type` is to include a `charset` parameter. However, no `charset` was present. Specifically, non-form-data content types (e.g. `text/plain`) are the ones for which `charset` is recommended.", "superfluous_charset": "The method was called via a `POST` request, and the specified `Content-Type` is not defined to understand the `charset` parameter. However, `charset` was in fact present. Specifically, form-data content types (e.g. `multipart/form-data`) are the ones for which `charset` is superfluous." } -} +} \ No newline at end of file diff --git a/lib/slack/web/docs/views.publish.json b/lib/slack/web/docs/views.publish.json index 0a8a902..c9bddfd 100644 --- a/lib/slack/web/docs/views.publish.json +++ b/lib/slack/web/docs/views.publish.json @@ -1,86 +1,82 @@ { - "desc": "Publish a static view for a User.", - "args": { + "hash": { + "desc": "A string that represents view state to protect against possible race conditions.", + "example": "156772938.1827394", + "required": false + }, "user_id": { - "required": true, + "desc": "`id` of the user you want publish a view to.", "example": "U0BPQUNTA", - "desc": "`id` of the user you want publish a view to." + "required": true }, "view": { - "required": true, + "desc": "A view payload. This must be a JSON-encoded string.", "example": "Ar12345", - "desc": "A view payload. This must be a JSON-encoded string." - }, - "hash": { - "required": false, - "example": "156772938.1827394", - "desc": "A string that represents view state to protect against possible race conditions." + "required": true } }, - + "desc": "Publish a static view for a User.", + "errors": { + "account_inactive": "Authentication token is for a deleted user or workspace.", + "duplicate_external_id": "Error returned when the given `external_id` has already be used.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "hash_conflict": "Error returned when the provided `hash` doesn't match the current stored value.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was called with invalid arguments.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_charset": "The method was called via a `POST` request, but the `charset` specified in the `Content-Type` header was invalid. Valid charset names are: `utf-8` `iso-8859-1`.", + "invalid_form_data": "The method was called via a `POST` request with `Content-Type` `application/x-www-form-urlencoded` or `multipart/form-data`, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a `POST` request, but the specified `Content-Type` was invalid. Valid types are: `application/json` `application/x-www-form-urlencoded` `multipart/form-data` `text/plain`.", + "missing_post_type": "The method was called via a `POST` request and included a data payload, but the request did not include a `Content-Type` header.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_allowed_token_type": "The type of token your app used when requesting this method is not allowed.", + "not_authed": "No authentication token provided.", + "not_enabled": "Error returned if a `home` view is published but the Home tab isn't enabled for the app.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "request_timeout": "The method was called via a `POST` request, but the `POST` data was either missing or truncated.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed.", + "view_too_large": "Error returned if the provided view is greater than 250kb." + }, "response": { "ok": true, "view": { - "id": "VMHU10V25", - "team_id": "T8N4K1JN", - "type": "home", - "close": null, - "submit": null, + "app_id": "AA4928AQ", "blocks": [ { - "type": "section", "block_id": "2WGp9", "text": { - "type": "mrkdwn", "text": "A simple section with some sample sentence.", + "type": "mrkdwn", "verbatim": false - } + }, + "type": "section" } ], - "private_metadata": "Shh it is a secret", + "bot_id": "BA13894H", "callback_id": "identify_your_home_tab", - "state": { - "values": [] - }, - "hash": "156772938.1827394", "clear_on_close": false, + "close": null, + "external_id": "", + "hash": "156772938.1827394", + "id": "VMHU10V25", "notify_on_close": false, - "root_view_id": "VMHU10V25", "previous_view_id": null, - "app_id": "AA4928AQ", - "external_id": "", - "bot_id": "BA13894H" + "private_metadata": "Shh it is a secret", + "root_view_id": "VMHU10V25", + "state": { + "values": [] + }, + "submit": null, + "team_id": "T8N4K1JN", + "type": "home" } }, - - "errors": { - "hash_conflict" : "Error returned when the provided `hash` doesn't match the current stored value.", - "duplicate_external_id": "Error returned when the given `external_id` has already be used.", - "view_too_large" : "Error returned if the provided view is greater than 250kb.", - "not_enabled": "Error returned if a `home` view is published but the Home tab isn't enabled for the app.", - "not_allowed_token_type": "The type of token your app used when requesting this method is not allowed.", - "not_authed": "No authentication token provided.", - "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", - "account_inactive": "Authentication token is for a deleted user or workspace.", - "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed.", - "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", - "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", - "ekm_access_denied": "Administrators have suspended the ability to post a message.", - "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", - "invalid_arguments": "The method was called with invalid arguments.", - "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", - "invalid_charset": "The method was called via a `POST` request, but the `charset` specified in the `Content-Type` header was invalid. Valid charset names are: `utf-8` `iso-8859-1`.", - "invalid_form_data": "The method was called via a `POST` request with `Content-Type` `application/x-www-form-urlencoded` or `multipart/form-data`, but the form data was either missing or syntactically invalid.", - "invalid_post_type": "The method was called via a `POST` request, but the specified `Content-Type` was invalid. Valid types are: `application/json` `application/x-www-form-urlencoded` `multipart/form-data` `text/plain`.", - "missing_post_type": "The method was called via a `POST` request and included a data payload, but the request did not include a `Content-Type` header.", - "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", - "request_timeout": "The method was called via a `POST` request, but the `POST` data was either missing or truncated.", - "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised." - }, - "warnings": { "missing_charset": "The method was called via a `POST` request, and recommended practice for the specified `Content-Type` is to include a `charset` parameter. However, no `charset` was present. Specifically, non-form-data content types (e.g. `text/plain`) are the ones for which `charset` is recommended.", "superfluous_charset": "The method was called via a `POST` request, and the specified `Content-Type` is not defined to understand the `charset` parameter. However, `charset` was in fact present. Specifically, form-data content types (e.g. `multipart/form-data`) are the ones for which `charset` is superfluous." } -} +} \ No newline at end of file diff --git a/lib/slack/web/docs/views.push.json b/lib/slack/web/docs/views.push.json index c76f8e2..e00a6a3 100644 --- a/lib/slack/web/docs/views.push.json +++ b/lib/slack/web/docs/views.push.json @@ -1,95 +1,91 @@ { - "desc": "Push a view onto the stack of a root view.", - "args": { "trigger_id": { - "required": true, + "desc": "Exchange a trigger to post to the user.", "example": "12345.98765.abcd2358fdea", - "desc": "Exchange a trigger to post to the user." + "required": true }, "view": { - "required": true, + "desc": "A view payload. This must be a JSON-encoded string.", "example": "Ar12345", - "desc": "A view payload. This must be a JSON-encoded string." + "required": true } }, - + "desc": "Push a view onto the stack of a root view.", + "errors": { + "account_inactive": "Authentication token is for a deleted user or workspace.", + "duplicate_external_id": "Error returned when the given `external_id` has already be used.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was called with invalid arguments.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_charset": "The method was called via a `POST` request, but the `charset` specified in the `Content-Type` header was invalid. Valid charset names are: `utf-8` `iso-8859-1`.", + "invalid_form_data": "The method was called via a `POST` request with `Content-Type` `application/x-www-form-urlencoded` or `multipart/form-data`, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a `POST` request, but the specified `Content-Type` was invalid. Valid types are: `application/json` `application/x-www-form-urlencoded` `multipart/form-data` `text/plain`.", + "missing_post_type": "The method was called via a `POST` request and included a data payload, but the request did not include a `Content-Type` header.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_authed": "No authentication token provided.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "push_limit_reached": "Error returned when the max push limit has been reached for views. Currently the limit is 3.", + "request_timeout": "The method was called via a `POST` request, but the `POST` data was either missing or truncated.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed.", + "view_too_large": "Error returned if the provided view is greater than 250kb." + }, "response": { "ok": true, "view": { - "id": "VNM522E2U", - "team_id": "T9M4RL1JM", - "type": "modal", - "title": { - "type": "plain_text", - "text": "Pushed Modal", - "emoji": true - }, - "close": { - "type": "plain_text", - "text": "Back", - "emoji": true - }, - "submit": { - "type": "plain_text", - "text": "Save", - "emoji": true - }, + "app_id": "AAD3351BQ", "blocks": [ { - "type": "input", "block_id": "edit_details", "element": { - "type": "plain_text_input", "action_id": "detail_input", "label": { - "type": "plain_text", - "text": "Edit details" - } - } + "text": "Edit details", + "type": "plain_text" + }, + "type": "plain_text_input" + }, + "type": "input" } ], - "private_metadata": "", + "bot_id": "BADF7A34H", "callback_id": "view_4", - "external_id": "", - "state": { - "values": [] + "clear_on_close": true, + "close": { + "emoji": true, + "text": "Back", + "type": "plain_text" }, + "external_id": "", "hash": "1569362015.55b5e41b", - "clear_on_close": true, + "id": "VNM522E2U", "notify_on_close": false, - "root_view_id": "VNN729E3U", "previous_view_id": null, - "app_id": "AAD3351BQ", - "bot_id": "BADF7A34H" + "private_metadata": "", + "root_view_id": "VNN729E3U", + "state": { + "values": [] + }, + "submit": { + "emoji": true, + "text": "Save", + "type": "plain_text" + }, + "team_id": "T9M4RL1JM", + "title": { + "emoji": true, + "text": "Pushed Modal", + "type": "plain_text" + }, + "type": "modal" } }, - - "errors": { - "push_limit_reached" : "Error returned when the max push limit has been reached for views. Currently the limit is 3.", - "duplicate_external_id": "Error returned when the given `external_id` has already be used.", - "view_too_large" : "Error returned if the provided view is greater than 250kb.", - "not_authed": "No authentication token provided.", - "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", - "account_inactive": "Authentication token is for a deleted user or workspace.", - "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed.", - "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", - "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", - "ekm_access_denied": "Administrators have suspended the ability to post a message.", - "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", - "invalid_arguments": "The method was called with invalid arguments.", - "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", - "invalid_charset": "The method was called via a `POST` request, but the `charset` specified in the `Content-Type` header was invalid. Valid charset names are: `utf-8` `iso-8859-1`.", - "invalid_form_data": "The method was called via a `POST` request with `Content-Type` `application/x-www-form-urlencoded` or `multipart/form-data`, but the form data was either missing or syntactically invalid.", - "invalid_post_type": "The method was called via a `POST` request, but the specified `Content-Type` was invalid. Valid types are: `application/json` `application/x-www-form-urlencoded` `multipart/form-data` `text/plain`.", - "missing_post_type": "The method was called via a `POST` request and included a data payload, but the request did not include a `Content-Type` header.", - "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", - "request_timeout": "The method was called via a `POST` request, but the `POST` data was either missing or truncated.", - "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised." - }, - "warnings": { "missing_charset": "The method was called via a `POST` request, and recommended practice for the specified `Content-Type` is to include a `charset` parameter. However, no `charset` was present. Specifically, non-form-data content types (e.g. `text/plain`) are the ones for which `charset` is recommended.", "superfluous_charset": "The method was called via a `POST` request, and the specified `Content-Type` is not defined to understand the `charset` parameter. However, `charset` was in fact present. Specifically, form-data content types (e.g. `multipart/form-data`) are the ones for which `charset` is superfluous." } -} +} \ No newline at end of file diff --git a/lib/slack/web/docs/views.update.json b/lib/slack/web/docs/views.update.json index 374fb81..fbbca0c 100644 --- a/lib/slack/web/docs/views.update.json +++ b/lib/slack/web/docs/views.update.json @@ -1,107 +1,103 @@ { - "desc": "Update an existing view.", - "args": { - "view": { - "required": true, - "example": "Ar12345", - "desc": "A view payload. This must be a JSON-encoded string." - }, "external_id": { - "required": false, + "desc": "A unique identifier of the view set by the developer. Must be unique for all views on a team. Max length of 255 characters. Either `view_id` or `external_id` is required.", "example": "bmarley_view2", - "desc": "A unique identifier of the view set by the developer. Must be unique for all views on a team. Max length of 255 characters. Either `view_id` or `external_id` is required." + "required": false }, "hash": { - "required": false, + "desc": "A string that represents view state to protect against possible race conditions.", "example": "156772938.1827394", - "desc": "A string that represents view state to protect against possible race conditions." + "required": false + }, + "view": { + "desc": "A view payload. This must be a JSON-encoded string.", + "example": "Ar12345", + "required": true }, "view_id": { - "required": false, + "desc": "A unique identifier of the view to be updated. Either `view_id` or `external_id` is required.", "example": "VMM512F2U", - "desc": "A unique identifier of the view to be updated. Either `view_id` or `external_id` is required." + "required": false } }, - + "desc": "Update an existing view.", + "errors": { + "account_inactive": "Authentication token is for a deleted user or workspace.", + "duplicate_external_id": "Error returned when the given `external_id` has already be used.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "hash_conflict": "Error returned when the provided `hash` doesn't match the current stored value.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was called with invalid arguments.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_charset": "The method was called via a `POST` request, but the `charset` specified in the `Content-Type` header was invalid. Valid charset names are: `utf-8` `iso-8859-1`.", + "invalid_form_data": "The method was called via a `POST` request with `Content-Type` `application/x-www-form-urlencoded` or `multipart/form-data`, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a `POST` request, but the specified `Content-Type` was invalid. Valid types are: `application/json` `application/x-www-form-urlencoded` `multipart/form-data` `text/plain`.", + "missing_post_type": "The method was called via a `POST` request and included a data payload, but the request did not include a `Content-Type` header.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_authed": "No authentication token provided.", + "not_found": "Error returned when the given `view_id` or `external_id` doesn't exist.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "request_timeout": "The method was called via a `POST` request, but the `POST` data was either missing or truncated.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed.", + "view_too_large": "Error returned if the provided view is greater than 250kb." + }, "response": { "ok": true, "view": { - "id": "VNM522E2U", - "team_id": "T9M4RL1JM", - "type": "modal", - "title": { - "type": "plain_text", - "text": "Updated Modal", - "emoji": true - }, - "close": { - "type": "plain_text", - "text": "Close", - "emoji": true - }, - "submit": null, + "app_id": "AAD3351BQ", "blocks": [ { - "type": "section", + "accessory": { + "action_id": "button_4", + "text": { + "text": "Click me", + "type": "plain_text" + }, + "type": "button" + }, "block_id": "s_block", "text": { - "type": "plain_text", + "emoji": true, "text": "I am but an updated modal", - "emoji": true + "type": "plain_text" }, - "accessory": { - "type": "button", - "action_id": "button_4", - "text": { - "type": "plain_text", - "text": "Click me" - } - } + "type": "section" } ], - "private_metadata": "", + "bot_id": "BADF7A34H", "callback_id": "view_2", - "external_id": "", - "state": { - "values": [] + "clear_on_close": true, + "close": { + "emoji": true, + "text": "Close", + "type": "plain_text" }, + "external_id": "", "hash": "1569262015.55b5e41b", - "clear_on_close": true, + "id": "VNM522E2U", "notify_on_close": false, - "root_view_id": "VNN729E3U", "previous_view_id": null, - "app_id": "AAD3351BQ", - "bot_id": "BADF7A34H" + "private_metadata": "", + "root_view_id": "VNN729E3U", + "state": { + "values": [] + }, + "submit": null, + "team_id": "T9M4RL1JM", + "title": { + "emoji": true, + "text": "Updated Modal", + "type": "plain_text" + }, + "type": "modal" } }, - - "errors": { - "hash_conflict" : "Error returned when the provided `hash` doesn't match the current stored value.", - "not_found": "Error returned when the given `view_id` or `external_id` doesn't exist.", - "duplicate_external_id": "Error returned when the given `external_id` has already be used.", - "view_too_large" : "Error returned if the provided view is greater than 250kb.", - "not_authed": "No authentication token provided.", - "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", - "account_inactive": "Authentication token is for a deleted user or workspace.", - "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed.", - "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", - "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", - "ekm_access_denied": "Administrators have suspended the ability to post a message.", - "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", - "invalid_arguments": "The method was called with invalid arguments.", - "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", - "invalid_charset": "The method was called via a `POST` request, but the `charset` specified in the `Content-Type` header was invalid. Valid charset names are: `utf-8` `iso-8859-1`.", - "invalid_form_data": "The method was called via a `POST` request with `Content-Type` `application/x-www-form-urlencoded` or `multipart/form-data`, but the form data was either missing or syntactically invalid.", - "invalid_post_type": "The method was called via a `POST` request, but the specified `Content-Type` was invalid. Valid types are: `application/json` `application/x-www-form-urlencoded` `multipart/form-data` `text/plain`.", - "missing_post_type": "The method was called via a `POST` request and included a data payload, but the request did not include a `Content-Type` header.", - "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", - "request_timeout": "The method was called via a `POST` request, but the `POST` data was either missing or truncated.", - "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised." - }, - "warnings": { "missing_charset": "The method was called via a `POST` request, and recommended practice for the specified `Content-Type` is to include a `charset` parameter. However, no `charset` was present. Specifically, non-form-data content types (e.g. `text/plain`) are the ones for which `charset` is recommended.", "superfluous_charset": "The method was called via a `POST` request, and the specified `Content-Type` is not defined to understand the `charset` parameter. However, `charset` was in fact present. Specifically, form-data content types (e.g. `multipart/form-data`) are the ones for which `charset` is superfluous." } -} +} \ No newline at end of file From 952114d2990665453fd02054bffc2e597c1ea4f2 Mon Sep 17 00:00:00 2001 From: Inooid Date: Tue, 9 Aug 2022 16:06:49 +0200 Subject: [PATCH 2/8] override old docs with new ones --- .../web/docs/admin.analytics.getFile.json | 90 +++++++ lib/slack/web/docs/admin.apps.approve.json | 108 +++++--- .../web/docs/admin.apps.approved.list.json | 140 +++++++++++ .../web/docs/admin.apps.clearResolution.json | 86 +++++++ .../web/docs/admin.apps.requests.cancel.json | 86 +++++++ .../web/docs/admin.apps.requests.list.json | 149 +++++++++++ lib/slack/web/docs/admin.apps.restrict.json | 107 +++++--- .../web/docs/admin.apps.restricted.list.json | 140 +++++++++++ lib/slack/web/docs/admin.apps.uninstall.json | 88 +++++++ .../admin.audit.anomaly.allow.getItem.json | 54 ++++ .../admin.audit.anomaly.allow.updateItem.json | 70 ++++++ .../admin.auth.policy.assignEntities.json | 86 +++++++ .../docs/admin.auth.policy.getEntities.json | 98 ++++++++ .../admin.auth.policy.removeEntities.json | 83 +++++++ lib/slack/web/docs/admin.barriers.create.json | 84 +++++++ lib/slack/web/docs/admin.barriers.delete.json | 67 +++++ lib/slack/web/docs/admin.barriers.list.json | 74 ++++++ lib/slack/web/docs/admin.barriers.update.json | 92 +++++++ .../web/docs/admin.conversations.archive.json | 73 ++++++ .../admin.conversations.convertToPrivate.json | 81 ++++++ .../web/docs/admin.conversations.create.json | 104 ++++++++ .../web/docs/admin.conversations.delete.json | 72 ++++++ .../admin.conversations.disconnectShared.json | 84 +++++++ ....ekm.listOriginalConnectedChannelInfo.json | 99 ++++++++ ...in.conversations.getConversationPrefs.json | 72 ++++++ ...dmin.conversations.getCustomRetention.json | 73 ++++++ .../docs/admin.conversations.getTeams.json | 91 +++++++ .../web/docs/admin.conversations.invite.json | 79 ++++++ ...n.conversations.removeCustomRetention.json | 73 ++++++ .../web/docs/admin.conversations.rename.json | 79 ++++++ ...conversations.restrictAccess.addGroup.json | 92 +++++++ ...nversations.restrictAccess.listGroups.json | 79 ++++++ ...versations.restrictAccess.removeGroup.json | 88 +++++++ .../web/docs/admin.conversations.search.json | 174 +++++++++++++ ...in.conversations.setConversationPrefs.json | 81 ++++++ ...dmin.conversations.setCustomRetention.json | 81 ++++++ .../docs/admin.conversations.setTeams.json | 102 ++++++++ .../docs/admin.conversations.unarchive.json | 72 ++++++ lib/slack/web/docs/admin.emoji.add.json | 88 +++++++ lib/slack/web/docs/admin.emoji.addAlias.json | 80 ++++++ lib/slack/web/docs/admin.emoji.list.json | 129 ++++++++++ lib/slack/web/docs/admin.emoji.remove.json | 68 +++++ lib/slack/web/docs/admin.emoji.rename.json | 80 ++++++ .../docs/admin.inviteRequests.approve.json | 78 ++++++ .../admin.inviteRequests.approved.list.json | 82 ++++++ .../admin.inviteRequests.denied.list.json | 82 ++++++ .../web/docs/admin.inviteRequests.deny.json | 77 ++++++ .../web/docs/admin.inviteRequests.list.json | 82 ++++++ .../web/docs/admin.teams.admins.list.json | 86 +++++++ lib/slack/web/docs/admin.teams.create.json | 96 +++++++ lib/slack/web/docs/admin.teams.list.json | 88 +++++++ .../web/docs/admin.teams.owners.list.json | 85 +++++++ .../web/docs/admin.teams.settings.info.json | 78 ++++++ ...min.teams.settings.setDefaultChannels.json | 76 ++++++ .../admin.teams.settings.setDescription.json | 75 ++++++ ...min.teams.settings.setDiscoverability.json | 76 ++++++ .../docs/admin.teams.settings.setIcon.json | 76 ++++++ .../docs/admin.teams.settings.setName.json | 75 ++++++ .../docs/admin.usergroups.addChannels.json | 88 +++++++ .../web/docs/admin.usergroups.addTeams.json | 83 +++++++ .../docs/admin.usergroups.listChannels.json | 112 +++++++++ .../docs/admin.usergroups.removeChannels.json | 78 ++++++ lib/slack/web/docs/admin.users.assign.json | 103 ++++++++ lib/slack/web/docs/admin.users.invite.json | 142 +++++++++++ lib/slack/web/docs/admin.users.list.json | 94 +++++++ lib/slack/web/docs/admin.users.remove.json | 79 ++++++ .../admin.users.session.clearSettings.json | 71 ++++++ .../docs/admin.users.session.getSettings.json | 79 ++++++ .../docs/admin.users.session.invalidate.json | 81 ++++++ .../web/docs/admin.users.session.list.json | 118 +++++++++ .../web/docs/admin.users.session.reset.json | 86 +++++++ .../docs/admin.users.session.resetBulk.json | 88 +++++++ .../docs/admin.users.session.setSettings.json | 87 +++++++ lib/slack/web/docs/admin.users.setAdmin.json | 80 ++++++ .../web/docs/admin.users.setExpiration.json | 90 +++++++ lib/slack/web/docs/admin.users.setOwner.json | 81 ++++++ .../web/docs/admin.users.setRegular.json | 79 ++++++ ...dmin.users.unsupportedVersions.export.json | 73 ++++++ lib/slack/web/docs/api.test.json | 40 ++- lib/slack/web/docs/apps.connections.open.json | 62 +++++ .../docs/apps.event.authorizations.list.json | 96 +++++++ lib/slack/web/docs/apps.manifest.create.json | 78 ++++++ lib/slack/web/docs/apps.manifest.delete.json | 69 ++++++ lib/slack/web/docs/apps.manifest.export.json | 132 ++++++++++ lib/slack/web/docs/apps.manifest.update.json | 81 ++++++ .../web/docs/apps.manifest.validate.json | 79 ++++++ lib/slack/web/docs/apps.uninstall.json | 68 ++++- lib/slack/web/docs/auth.revoke.json | 56 ++++- lib/slack/web/docs/auth.teams.list.json | 93 +++++++ lib/slack/web/docs/auth.test.json | 61 ++++- lib/slack/web/docs/bookmarks.add.json | 137 ++++++++++ lib/slack/web/docs/bookmarks.edit.json | 118 +++++++++ lib/slack/web/docs/bookmarks.list.json | 84 +++++++ lib/slack/web/docs/bookmarks.remove.json | 77 ++++++ lib/slack/web/docs/bots.info.json | 81 +++++- lib/slack/web/docs/calls.add.json | 118 +++++++++ lib/slack/web/docs/calls.end.json | 74 ++++++ lib/slack/web/docs/calls.info.json | 65 +++++ .../web/docs/calls.participants.add.json | 77 ++++++ .../web/docs/calls.participants.remove.json | 77 ++++++ lib/slack/web/docs/calls.update.json | 87 +++++++ lib/slack/web/docs/channels.archive.json | 17 -- lib/slack/web/docs/channels.create.json | 15 -- lib/slack/web/docs/channels.history.json | 44 ---- lib/slack/web/docs/channels.info.json | 13 - lib/slack/web/docs/channels.invite.json | 24 -- lib/slack/web/docs/channels.join.json | 16 -- lib/slack/web/docs/channels.kick.json | 24 -- lib/slack/web/docs/channels.leave.json | 15 -- lib/slack/web/docs/channels.list.json | 10 - lib/slack/web/docs/channels.mark.json | 20 -- lib/slack/web/docs/channels.rename.json | 21 -- lib/slack/web/docs/channels.replies.json | 18 -- lib/slack/web/docs/channels.setPurpose.json | 22 -- lib/slack/web/docs/channels.setTopic.json | 22 -- lib/slack/web/docs/channels.unarchive.json | 14 -- lib/slack/web/docs/chat.delete.json | 75 +++++- .../web/docs/chat.deleteScheduledMessage.json | 82 ++++++ lib/slack/web/docs/chat.getPermalink.json | 72 +++++- lib/slack/web/docs/chat.meMessage.json | 80 ++++++ lib/slack/web/docs/chat.postEphemeral.json | 143 +++++++++-- lib/slack/web/docs/chat.postMessage.json | 186 +++++++++++--- lib/slack/web/docs/chat.scheduleMessage.json | 165 ++++++++---- .../web/docs/chat.scheduledMessages.list.json | 115 +++++++++ lib/slack/web/docs/chat.unfurl.json | 101 ++++++-- lib/slack/web/docs/chat.update.json | 148 +++++++++-- .../conversations.acceptSharedInvite.json | 132 ++++++++++ .../conversations.approveSharedInvite.json | 84 +++++++ lib/slack/web/docs/conversations.archive.json | 74 ++++++ lib/slack/web/docs/conversations.close.json | 61 ++++- lib/slack/web/docs/conversations.create.json | 106 +++++--- .../conversations.declineSharedInvite.json | 79 ++++++ lib/slack/web/docs/conversations.history.json | 129 ++++++++-- lib/slack/web/docs/conversations.info.json | 118 ++++++++- lib/slack/web/docs/conversations.invite.json | 90 ++++--- .../web/docs/conversations.inviteShared.json | 113 +++++++++ lib/slack/web/docs/conversations.join.json | 118 +++++++-- lib/slack/web/docs/conversations.kick.json | 82 ++++++ lib/slack/web/docs/conversations.leave.json | 73 ++++++ lib/slack/web/docs/conversations.list.json | 168 +++++++++++-- .../conversations.listConnectInvites.json | 81 ++++++ lib/slack/web/docs/conversations.mark.json | 75 ++++++ lib/slack/web/docs/conversations.members.json | 95 +++++-- lib/slack/web/docs/conversations.open.json | 92 ++++++- lib/slack/web/docs/conversations.rename.json | 125 ++++++++++ lib/slack/web/docs/conversations.replies.json | 156 ++++++++++-- .../web/docs/conversations.setPurpose.json | 73 +++++- .../web/docs/conversations.setTopic.json | 122 ++++++++- .../web/docs/conversations.unarchive.json | 70 ++++++ lib/slack/web/docs/dialog.open.json | 80 ++++++ lib/slack/web/docs/dnd.endDnd.json | 55 +++- lib/slack/web/docs/dnd.endSnooze.json | 55 +++- lib/slack/web/docs/dnd.info.json | 64 ++++- lib/slack/web/docs/dnd.setSnooze.json | 59 ++++- lib/slack/web/docs/dnd.teamInfo.json | 79 +++++- lib/slack/web/docs/emoji.list.json | 55 +++- lib/slack/web/docs/files.comments.add.json | 20 -- lib/slack/web/docs/files.comments.delete.json | 60 ++++- lib/slack/web/docs/files.comments.edit.json | 27 -- lib/slack/web/docs/files.delete.json | 59 ++++- lib/slack/web/docs/files.info.json | 156 +++++++++++- lib/slack/web/docs/files.list.json | 218 ++++++++++++++-- lib/slack/web/docs/files.remote.add.json | 104 ++++++++ lib/slack/web/docs/files.remote.info.json | 75 ++++++ lib/slack/web/docs/files.remote.list.json | 94 +++++++ lib/slack/web/docs/files.remote.remove.json | 76 ++++++ lib/slack/web/docs/files.remote.share.json | 83 +++++++ lib/slack/web/docs/files.remote.update.json | 114 +++++++++ lib/slack/web/docs/files.revokePublicURL.json | 59 ++++- lib/slack/web/docs/files.sharedPublicURL.json | 62 ++++- lib/slack/web/docs/files.upload.json | 159 +++++++++++- lib/slack/web/docs/groups.archive.json | 17 -- lib/slack/web/docs/groups.close.json | 13 - lib/slack/web/docs/groups.create.json | 14 -- lib/slack/web/docs/groups.createChild.json | 15 -- lib/slack/web/docs/groups.history.json | 44 ---- lib/slack/web/docs/groups.info.json | 13 - lib/slack/web/docs/groups.invite.json | 22 -- lib/slack/web/docs/groups.kick.json | 22 -- lib/slack/web/docs/groups.leave.json | 16 -- lib/slack/web/docs/groups.list.json | 10 - lib/slack/web/docs/groups.mark.json | 19 -- lib/slack/web/docs/groups.open.json | 13 - lib/slack/web/docs/groups.rename.json | 19 -- lib/slack/web/docs/groups.replies.json | 18 -- lib/slack/web/docs/groups.setPurpose.json | 21 -- lib/slack/web/docs/groups.setTopic.json | 21 -- lib/slack/web/docs/groups.unarchive.json | 14 -- lib/slack/web/docs/im.close.json | 14 -- lib/slack/web/docs/im.history.json | 44 ---- lib/slack/web/docs/im.list.json | 3 - lib/slack/web/docs/im.mark.json | 20 -- lib/slack/web/docs/im.open.json | 15 -- lib/slack/web/docs/im.replies.json | 18 -- lib/slack/web/docs/migration.exchange.json | 92 +++++++ lib/slack/web/docs/mpim.close.json | 13 - lib/slack/web/docs/mpim.history.json | 44 ---- lib/slack/web/docs/mpim.list.json | 3 - lib/slack/web/docs/mpim.mark.json | 19 -- lib/slack/web/docs/mpim.open.json | 15 -- lib/slack/web/docs/oauth.access.json | 104 +++++++- lib/slack/web/docs/oauth.v2.access.json | 92 ++++++- lib/slack/web/docs/oauth.v2.exchange.json | 53 ++++ lib/slack/web/docs/openid.connect.token.json | 88 +++++++ .../web/docs/openid.connect.userInfo.json | 84 +++++++ lib/slack/web/docs/pins.add.json | 92 +++++-- lib/slack/web/docs/pins.list.json | 91 ++++++- lib/slack/web/docs/pins.remove.json | 84 +++++-- lib/slack/web/docs/presence.set.json | 14 -- lib/slack/web/docs/reactions.add.json | 94 +++++-- lib/slack/web/docs/reactions.get.json | 108 +++++++- lib/slack/web/docs/reactions.list.json | 186 +++++++++++++- lib/slack/web/docs/reactions.remove.json | 88 ++++++- lib/slack/web/docs/reminders.add.json | 102 ++++++++ lib/slack/web/docs/reminders.complete.json | 77 ++++++ lib/slack/web/docs/reminders.delete.json | 75 ++++++ lib/slack/web/docs/reminders.info.json | 74 ++++++ lib/slack/web/docs/reminders.list.json | 66 +++++ lib/slack/web/docs/rtm.connect.json | 76 +++++- lib/slack/web/docs/rtm.start.json | 109 ++++++++ lib/slack/web/docs/search.all.json | 234 ++++++++++++++++-- lib/slack/web/docs/search.files.json | 183 ++++++++++++-- lib/slack/web/docs/search.messages.json | 177 +++++++++++-- lib/slack/web/docs/stars.add.json | 84 ++++++- lib/slack/web/docs/stars.list.json | 93 ++++++- lib/slack/web/docs/stars.remove.json | 85 ++++++- lib/slack/web/docs/team.accessLogs.json | 119 ++++++++- lib/slack/web/docs/team.billableInfo.json | 84 +++++++ lib/slack/web/docs/team.billing.info.json | 58 +++++ lib/slack/web/docs/team.info.json | 93 ++++++- lib/slack/web/docs/team.integrationLogs.json | 94 ++++++- lib/slack/web/docs/team.preferences.list.json | 62 +++++ lib/slack/web/docs/team.profile.get.json | 133 ++++++++++ lib/slack/web/docs/tooling.tokens.rotate.json | 49 ++++ lib/slack/web/docs/usergroups.create.json | 101 +++++++- lib/slack/web/docs/usergroups.disable.json | 77 +++++- lib/slack/web/docs/usergroups.enable.json | 77 +++++- lib/slack/web/docs/usergroups.list.json | 151 ++++++++++- lib/slack/web/docs/usergroups.update.json | 120 ++++++++- lib/slack/web/docs/usergroups.users.list.json | 79 +++++- .../web/docs/usergroups.users.update.json | 110 +++++++- lib/slack/web/docs/users.conversations.json | 167 +++++++++++-- lib/slack/web/docs/users.deletePhoto.json | 57 +++++ lib/slack/web/docs/users.getPresence.json | 59 ++++- lib/slack/web/docs/users.identity.json | 65 +++++ lib/slack/web/docs/users.info.json | 101 +++++++- lib/slack/web/docs/users.list.json | 171 ++++++++++++- lib/slack/web/docs/users.lookupByEmail.json | 95 ++++++- lib/slack/web/docs/users.profile.get.json | 101 +++++++- lib/slack/web/docs/users.profile.set.json | 127 +++++++++- lib/slack/web/docs/users.setActive.json | 58 ++++- lib/slack/web/docs/users.setPhoto.json | 89 +++++++ lib/slack/web/docs/users.setPresence.json | 58 ++++- lib/slack/web/docs/views.open.json | 74 ++++-- lib/slack/web/docs/views.publish.json | 83 +++++-- lib/slack/web/docs/views.push.json | 85 +++++-- lib/slack/web/docs/views.update.json | 87 ++++--- .../web/docs/workflows.stepCompleted.json | 79 ++++++ lib/slack/web/docs/workflows.stepFailed.json | 76 ++++++ lib/slack/web/docs/workflows.updateStep.json | 100 ++++++++ mix.exs | 3 +- mix.lock | 21 +- 262 files changed, 18972 insertions(+), 1816 deletions(-) create mode 100644 lib/slack/web/docs/admin.analytics.getFile.json create mode 100644 lib/slack/web/docs/admin.apps.approved.list.json create mode 100644 lib/slack/web/docs/admin.apps.clearResolution.json create mode 100644 lib/slack/web/docs/admin.apps.requests.cancel.json create mode 100644 lib/slack/web/docs/admin.apps.requests.list.json create mode 100644 lib/slack/web/docs/admin.apps.restricted.list.json create mode 100644 lib/slack/web/docs/admin.apps.uninstall.json create mode 100644 lib/slack/web/docs/admin.audit.anomaly.allow.getItem.json create mode 100644 lib/slack/web/docs/admin.audit.anomaly.allow.updateItem.json create mode 100644 lib/slack/web/docs/admin.auth.policy.assignEntities.json create mode 100644 lib/slack/web/docs/admin.auth.policy.getEntities.json create mode 100644 lib/slack/web/docs/admin.auth.policy.removeEntities.json create mode 100644 lib/slack/web/docs/admin.barriers.create.json create mode 100644 lib/slack/web/docs/admin.barriers.delete.json create mode 100644 lib/slack/web/docs/admin.barriers.list.json create mode 100644 lib/slack/web/docs/admin.barriers.update.json create mode 100644 lib/slack/web/docs/admin.conversations.archive.json create mode 100644 lib/slack/web/docs/admin.conversations.convertToPrivate.json create mode 100644 lib/slack/web/docs/admin.conversations.create.json create mode 100644 lib/slack/web/docs/admin.conversations.delete.json create mode 100644 lib/slack/web/docs/admin.conversations.disconnectShared.json create mode 100644 lib/slack/web/docs/admin.conversations.ekm.listOriginalConnectedChannelInfo.json create mode 100644 lib/slack/web/docs/admin.conversations.getConversationPrefs.json create mode 100644 lib/slack/web/docs/admin.conversations.getCustomRetention.json create mode 100644 lib/slack/web/docs/admin.conversations.getTeams.json create mode 100644 lib/slack/web/docs/admin.conversations.invite.json create mode 100644 lib/slack/web/docs/admin.conversations.removeCustomRetention.json create mode 100644 lib/slack/web/docs/admin.conversations.rename.json create mode 100644 lib/slack/web/docs/admin.conversations.restrictAccess.addGroup.json create mode 100644 lib/slack/web/docs/admin.conversations.restrictAccess.listGroups.json create mode 100644 lib/slack/web/docs/admin.conversations.restrictAccess.removeGroup.json create mode 100644 lib/slack/web/docs/admin.conversations.search.json create mode 100644 lib/slack/web/docs/admin.conversations.setConversationPrefs.json create mode 100644 lib/slack/web/docs/admin.conversations.setCustomRetention.json create mode 100644 lib/slack/web/docs/admin.conversations.setTeams.json create mode 100644 lib/slack/web/docs/admin.conversations.unarchive.json create mode 100644 lib/slack/web/docs/admin.emoji.add.json create mode 100644 lib/slack/web/docs/admin.emoji.addAlias.json create mode 100644 lib/slack/web/docs/admin.emoji.list.json create mode 100644 lib/slack/web/docs/admin.emoji.remove.json create mode 100644 lib/slack/web/docs/admin.emoji.rename.json create mode 100644 lib/slack/web/docs/admin.inviteRequests.approve.json create mode 100644 lib/slack/web/docs/admin.inviteRequests.approved.list.json create mode 100644 lib/slack/web/docs/admin.inviteRequests.denied.list.json create mode 100644 lib/slack/web/docs/admin.inviteRequests.deny.json create mode 100644 lib/slack/web/docs/admin.inviteRequests.list.json create mode 100644 lib/slack/web/docs/admin.teams.admins.list.json create mode 100644 lib/slack/web/docs/admin.teams.create.json create mode 100644 lib/slack/web/docs/admin.teams.list.json create mode 100644 lib/slack/web/docs/admin.teams.owners.list.json create mode 100644 lib/slack/web/docs/admin.teams.settings.info.json create mode 100644 lib/slack/web/docs/admin.teams.settings.setDefaultChannels.json create mode 100644 lib/slack/web/docs/admin.teams.settings.setDescription.json create mode 100644 lib/slack/web/docs/admin.teams.settings.setDiscoverability.json create mode 100644 lib/slack/web/docs/admin.teams.settings.setIcon.json create mode 100644 lib/slack/web/docs/admin.teams.settings.setName.json create mode 100644 lib/slack/web/docs/admin.usergroups.addChannels.json create mode 100644 lib/slack/web/docs/admin.usergroups.addTeams.json create mode 100644 lib/slack/web/docs/admin.usergroups.listChannels.json create mode 100644 lib/slack/web/docs/admin.usergroups.removeChannels.json create mode 100644 lib/slack/web/docs/admin.users.assign.json create mode 100644 lib/slack/web/docs/admin.users.invite.json create mode 100644 lib/slack/web/docs/admin.users.list.json create mode 100644 lib/slack/web/docs/admin.users.remove.json create mode 100644 lib/slack/web/docs/admin.users.session.clearSettings.json create mode 100644 lib/slack/web/docs/admin.users.session.getSettings.json create mode 100644 lib/slack/web/docs/admin.users.session.invalidate.json create mode 100644 lib/slack/web/docs/admin.users.session.list.json create mode 100644 lib/slack/web/docs/admin.users.session.reset.json create mode 100644 lib/slack/web/docs/admin.users.session.resetBulk.json create mode 100644 lib/slack/web/docs/admin.users.session.setSettings.json create mode 100644 lib/slack/web/docs/admin.users.setAdmin.json create mode 100644 lib/slack/web/docs/admin.users.setExpiration.json create mode 100644 lib/slack/web/docs/admin.users.setOwner.json create mode 100644 lib/slack/web/docs/admin.users.setRegular.json create mode 100644 lib/slack/web/docs/admin.users.unsupportedVersions.export.json create mode 100644 lib/slack/web/docs/apps.connections.open.json create mode 100644 lib/slack/web/docs/apps.event.authorizations.list.json create mode 100644 lib/slack/web/docs/apps.manifest.create.json create mode 100644 lib/slack/web/docs/apps.manifest.delete.json create mode 100644 lib/slack/web/docs/apps.manifest.export.json create mode 100644 lib/slack/web/docs/apps.manifest.update.json create mode 100644 lib/slack/web/docs/apps.manifest.validate.json create mode 100644 lib/slack/web/docs/auth.teams.list.json create mode 100644 lib/slack/web/docs/bookmarks.add.json create mode 100644 lib/slack/web/docs/bookmarks.edit.json create mode 100644 lib/slack/web/docs/bookmarks.list.json create mode 100644 lib/slack/web/docs/bookmarks.remove.json create mode 100644 lib/slack/web/docs/calls.add.json create mode 100644 lib/slack/web/docs/calls.end.json create mode 100644 lib/slack/web/docs/calls.info.json create mode 100644 lib/slack/web/docs/calls.participants.add.json create mode 100644 lib/slack/web/docs/calls.participants.remove.json create mode 100644 lib/slack/web/docs/calls.update.json delete mode 100644 lib/slack/web/docs/channels.archive.json delete mode 100644 lib/slack/web/docs/channels.create.json delete mode 100644 lib/slack/web/docs/channels.history.json delete mode 100644 lib/slack/web/docs/channels.info.json delete mode 100644 lib/slack/web/docs/channels.invite.json delete mode 100644 lib/slack/web/docs/channels.join.json delete mode 100644 lib/slack/web/docs/channels.kick.json delete mode 100644 lib/slack/web/docs/channels.leave.json delete mode 100644 lib/slack/web/docs/channels.list.json delete mode 100644 lib/slack/web/docs/channels.mark.json delete mode 100644 lib/slack/web/docs/channels.rename.json delete mode 100644 lib/slack/web/docs/channels.replies.json delete mode 100644 lib/slack/web/docs/channels.setPurpose.json delete mode 100644 lib/slack/web/docs/channels.setTopic.json delete mode 100644 lib/slack/web/docs/channels.unarchive.json create mode 100644 lib/slack/web/docs/chat.deleteScheduledMessage.json create mode 100644 lib/slack/web/docs/chat.meMessage.json create mode 100644 lib/slack/web/docs/chat.scheduledMessages.list.json create mode 100644 lib/slack/web/docs/conversations.acceptSharedInvite.json create mode 100644 lib/slack/web/docs/conversations.approveSharedInvite.json create mode 100644 lib/slack/web/docs/conversations.archive.json create mode 100644 lib/slack/web/docs/conversations.declineSharedInvite.json create mode 100644 lib/slack/web/docs/conversations.inviteShared.json create mode 100644 lib/slack/web/docs/conversations.kick.json create mode 100644 lib/slack/web/docs/conversations.leave.json create mode 100644 lib/slack/web/docs/conversations.listConnectInvites.json create mode 100644 lib/slack/web/docs/conversations.mark.json create mode 100644 lib/slack/web/docs/conversations.rename.json create mode 100644 lib/slack/web/docs/conversations.unarchive.json create mode 100644 lib/slack/web/docs/dialog.open.json delete mode 100644 lib/slack/web/docs/files.comments.add.json delete mode 100644 lib/slack/web/docs/files.comments.edit.json create mode 100644 lib/slack/web/docs/files.remote.add.json create mode 100644 lib/slack/web/docs/files.remote.info.json create mode 100644 lib/slack/web/docs/files.remote.list.json create mode 100644 lib/slack/web/docs/files.remote.remove.json create mode 100644 lib/slack/web/docs/files.remote.share.json create mode 100644 lib/slack/web/docs/files.remote.update.json delete mode 100644 lib/slack/web/docs/groups.archive.json delete mode 100644 lib/slack/web/docs/groups.close.json delete mode 100644 lib/slack/web/docs/groups.create.json delete mode 100644 lib/slack/web/docs/groups.createChild.json delete mode 100644 lib/slack/web/docs/groups.history.json delete mode 100644 lib/slack/web/docs/groups.info.json delete mode 100644 lib/slack/web/docs/groups.invite.json delete mode 100644 lib/slack/web/docs/groups.kick.json delete mode 100644 lib/slack/web/docs/groups.leave.json delete mode 100644 lib/slack/web/docs/groups.list.json delete mode 100644 lib/slack/web/docs/groups.mark.json delete mode 100644 lib/slack/web/docs/groups.open.json delete mode 100644 lib/slack/web/docs/groups.rename.json delete mode 100644 lib/slack/web/docs/groups.replies.json delete mode 100644 lib/slack/web/docs/groups.setPurpose.json delete mode 100644 lib/slack/web/docs/groups.setTopic.json delete mode 100644 lib/slack/web/docs/groups.unarchive.json delete mode 100644 lib/slack/web/docs/im.close.json delete mode 100644 lib/slack/web/docs/im.history.json delete mode 100644 lib/slack/web/docs/im.list.json delete mode 100644 lib/slack/web/docs/im.mark.json delete mode 100644 lib/slack/web/docs/im.open.json delete mode 100644 lib/slack/web/docs/im.replies.json create mode 100644 lib/slack/web/docs/migration.exchange.json delete mode 100644 lib/slack/web/docs/mpim.close.json delete mode 100644 lib/slack/web/docs/mpim.history.json delete mode 100644 lib/slack/web/docs/mpim.list.json delete mode 100644 lib/slack/web/docs/mpim.mark.json delete mode 100644 lib/slack/web/docs/mpim.open.json create mode 100644 lib/slack/web/docs/oauth.v2.exchange.json create mode 100644 lib/slack/web/docs/openid.connect.token.json create mode 100644 lib/slack/web/docs/openid.connect.userInfo.json delete mode 100644 lib/slack/web/docs/presence.set.json create mode 100644 lib/slack/web/docs/reminders.add.json create mode 100644 lib/slack/web/docs/reminders.complete.json create mode 100644 lib/slack/web/docs/reminders.delete.json create mode 100644 lib/slack/web/docs/reminders.info.json create mode 100644 lib/slack/web/docs/reminders.list.json create mode 100644 lib/slack/web/docs/rtm.start.json create mode 100644 lib/slack/web/docs/team.billableInfo.json create mode 100644 lib/slack/web/docs/team.billing.info.json create mode 100644 lib/slack/web/docs/team.preferences.list.json create mode 100644 lib/slack/web/docs/team.profile.get.json create mode 100644 lib/slack/web/docs/tooling.tokens.rotate.json create mode 100644 lib/slack/web/docs/users.deletePhoto.json create mode 100644 lib/slack/web/docs/users.identity.json create mode 100644 lib/slack/web/docs/users.setPhoto.json create mode 100644 lib/slack/web/docs/workflows.stepCompleted.json create mode 100644 lib/slack/web/docs/workflows.stepFailed.json create mode 100644 lib/slack/web/docs/workflows.updateStep.json diff --git a/lib/slack/web/docs/admin.analytics.getFile.json b/lib/slack/web/docs/admin.analytics.getFile.json new file mode 100644 index 0000000..ac85f69 --- /dev/null +++ b/lib/slack/web/docs/admin.analytics.getFile.json @@ -0,0 +1,90 @@ +{ + "args": { + "date": { + "desc": "Date to retrieve the analytics data for, expressed as YYYY-MM-DD in UTC.", + "example": "2020-09-01", + "name": "date", + "required": false, + "type": "string" + }, + "metadata_only": { + "desc": "Retrieve metadata for the type of analytics indicated. Can be used only with type set to public_channel analytics. See detail below. Omit the date parameter when using this argument.", + "example": "falsetrue", + "name": "metadata_only", + "required": false, + "type": "boolean" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + }, + "type": { + "desc": "The type of analytics to retrieve. The options are currently limited to member (for grid member analytics) and public_channel (for public channel analytics).", + "example": "member", + "name": "type", + "required": true, + "type": "string" + } + }, + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Retrieve analytics data for a given date, presented as a compressed JSON file", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_date": "The date argument was invalid.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "not_an_admin": "The user token does not have admin privileges.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_type": "The analytics data for the type specified weren't found.", + "metadata_only_does_not_support_date": "The metadata_only field gets the latest metadata file. The date field is not supported.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "member_analytics_disabled": "Member analytics are disabled for your organization.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "This feature is not enabled on your workspace.", + "file_not_found": "The analytics data for the date specified weren't found.", + "metadata_not_available": "Metadata not available for the analytics type you provided.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "org_level_email_display_disabled": "This API is unavailable for organizations with a 'Hide email addresses' policy.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "not_an_enterprise": "The user token does not belong to an enterprise.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "data_not_available": "The date was before the API became available.", + "token_expired": "Authentication token has expired", + "file_not_yet_available": "The analytics data for the date isn't available yet.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.analytics.getFile", + "name": "admin.analytics.getFile", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.apps.approve.json b/lib/slack/web/docs/admin.apps.approve.json index ff29556..19d9517 100644 --- a/lib/slack/web/docs/admin.apps.approve.json +++ b/lib/slack/web/docs/admin.apps.approve.json @@ -1,58 +1,100 @@ { "args": { "app_id": { - "desc": "The id of the app to approve. Required if `request_id` is missing.", + "desc": "The id of the app to approve.", "example": "A12345", - "required": false + "name": "app_id", + "required": false, + "type": "string" + }, + "enterprise_id": { + "desc": "The ID of the enterprise to approve the app on", + "example": "E12345", + "name": "enterprise_id", + "required": false, + "type": "string" }, "request_id": { - "desc": "The id of the request to approve. Required if `app_id` is missing.", + "desc": "The id of the request to approve.", "example": "Ar12345", - "required": false + "name": "request_id", + "required": false, + "type": "string" }, "team_id": { - "desc": "The id of the team to approve. Required if your Enterprise Grid org contains more than one workspace.", - "example": "A12345", - "required": false + "desc": "The ID of the workspace to approve the app on", + "example": "T12345", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" } }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], "desc": "Approve an app for installation on a workspace.", "errors": { - "account_inactive": "Authentication token is for a deleted user or workspace.", - "app_management_app_not_installed_on_org": "The app management app must be installed on the org.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "invalid_scopes": "Some of the provided scopes do not exist", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "app_management_app_not_installed_on_org": "The app management app must be installed on the org.", + "not_an_admin": "This method is only accessible by org owners and admins", + "team_not_found": "Returned when team id is not found.", + "request_id_or_app_id_is_required": "Must include a request_id or app_id", + "access_denied": "Access to a resource specified in the request is denied.", "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", - "feature_not_enabled": "Returned when the Admin APIs feature is not enabled for this team.", - "invalid_app_id": "The `app_id` passed was invalid.", + "not_authed": "No authentication token provided.", + "invalid_app_id": "The app_id passed is invalid.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", - "invalid_arguments": "The method was called with invalid arguments.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "too_many_teams_provided": "Please provide only team_id OR enterprise_id", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "Returned when the Admin APIs feature is not enabled for this team", + "request_id_required_for_custom_integrations": "A request_id is required for custom integrations", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "invalid_request_id": "The request_id passed is invalid.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "app_restricted_org_wide": "The app is already restricted org wide.", "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", - "invalid_charset": "The method was called via a `POST` request, but the `charset` specified in the `Content-Type` header was invalid. Valid charset names are: `utf-8` `iso-8859-1`.", - "invalid_form_data": "The method was called via a `POST` request with `Content-Type` `application/x-www-form-urlencoded` or `multipart/form-data`, but the form data was either missing or syntactically invalid.", - "invalid_post_type": "The method was called via a `POST` request, but the specified `Content-Type` was invalid. Valid types are: `application/json` `application/x-www-form-urlencoded` `multipart/form-data` `text/plain`.", - "invalid_request_id": "The `request_id` passed was invalid.", - "is_bot": "This method cannot be called by a bot user.", - "missing_post_type": "The method was called via a `POST` request and included a data payload, but the request did not include a `Content-Type` header.", - "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", - "not_an_admin": "This method is only accessible by org owners and admins.", - "not_authed": "No authentication token provided.", - "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", - "request_already_resolved": "The app request has already been resolved.", - "request_id_or_app_id_is_required": "Must include a `request_id` or `app_id`.", - "request_id_required_for_custom_integrations": "A `request_id` is required for custom integrations.", - "request_timeout": "The method was called via a `POST` request, but the `POST` data was either missing or truncated.", - "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", - "team_not_found": "Returned when team id is not found.", - "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed.", - "too_many_ids_provided": "Please provide only `app_id` OR `request_id`.", - "too_many_teams_provided": "Please provide only `team_id` OR `enterprise_id`." + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "request_already_resolved": "The app request has already been resolved", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "custom_integration_not_allowed_at_enterprise": "Returned when the install request is for custom integration app.", + "too_many_ids_provided": "Please provide only app_id OR request_id", + "method_deprecated": "The method has been deprecated." }, + "is_deprecated": false, + "link": "/methods/admin.apps.approve", + "name": "admin.apps.approve", "response": { "ok": true }, "warnings": { - "missing_charset": "The method was called via a `POST` request, and recommended practice for the specified `Content-Type` is to include a `charset` parameter. However, no `charset` was present. Specifically, non-form-data content types (e.g. `text/plain`) are the ones for which `charset` is recommended.", - "superfluous_charset": "The method was called via a `POST` request, and the specified `Content-Type` is not defined to understand the `charset` parameter. However, `charset` was in fact present. Specifically, form-data content types (e.g. `multipart/form-data`) are the ones for which `charset` is superfluous." + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/admin.apps.approved.list.json b/lib/slack/web/docs/admin.apps.approved.list.json new file mode 100644 index 0000000..f9ab443 --- /dev/null +++ b/lib/slack/web/docs/admin.apps.approved.list.json @@ -0,0 +1,140 @@ +{ + "args": { + "cursor": { + "desc": "Set cursor to next_cursor returned by the previous call to list items in the next page", + "example": "5c3e53d5", + "name": "cursor", + "required": false, + "type": "string" + }, + "enterprise_id": { + "desc": "", + "example": "E0AS553RN", + "name": "enterprise_id", + "required": false, + "type": "string" + }, + "limit": { + "desc": "The maximum number of items to return. Must be between 1 - 1000 both inclusive.", + "example": "100100", + "name": "limit", + "required": false, + "type": "integer" + }, + "team_id": { + "desc": "", + "example": "T0HFE6EBT", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "List approved apps for an org or workspace.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "app_management_app_not_installed_on_org": "The app management app must be installed on the org.", + "not_an_admin": "This method is only accessible by org/workspace owners and admins", + "team_not_found": "Returned when team id is not found.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "not_allowed": "The user is not allowed to access this API method", + "too_many_teams_provided": "Please provide only team_id OR enterprise_id.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "invalid_cursor": "Value passed for cursor was not valid or is no longer valid.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "Returned when the Admin APIs feature is not enabled for this team", + "invalid_actor": "The provided actor_id is not a valid user or application", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.apps.approved.list", + "name": "admin.apps.approved.list", + "response": { + "approved_apps": [ + { + "app": { + "additional_info": "", + "app_directory_url": "https://myteam.enterprise.slack.com/apps/A0W7UKG8E-my-test-app", + "app_homepage_url": "https://www.slack.com", + "description": "test app", + "developer_type": "third_party", + "help_url": "https://www.slack.com", + "icons": { + "image_1024": "https://3026743124446w96_2bd4ea1ad1f89a23c242_1024.png", + "image_128": "https://30267341249446w6_2bd4ea1ad1f89a23c242_128.png", + "image_192": "https://30267431249446w6_2bd4ea1ad1f89a23c242_192.png", + "image_32": "https://302674312496446w_2bd4ea1ad1f89a23c242_32.png", + "image_36": "https://302674312496446w_2bd4ea1ad1f89a23c242_36.png", + "image_48": "https://302674312496446w_2bd4ea1ad1f89a23c242_48.png", + "image_512": "https://30267431249446w6_2bd4ea1ad1f89a23c242_512.png", + "image_64": "https://302674312496446w_2bd4ea1ad1f89a23c242_64.png", + "image_72": "https://302674312496446w_2bd4ea1ad1f89a23c242_72.png", + "image_96": "https://302674312496446w_2bd4ea1ad1f89a23c242_96.png", + "image_original": "https://302674446w12496_2bd4ea1ad1f89a23c242_original.png" + }, + "id": "A0W7UKG8E", + "is_app_directory_approved": false, + "is_internal": false, + "name": "My Test App", + "privacy_policy_url": "https://www.slack.com", + "socket_mode_enabled": false + }, + "date_updated": 1574296707, + "last_resolved_by": { + "actor_id": "W0G82F4FD", + "actor_type": "user" + }, + "scopes": [ + { + "description": "Add the ability for people to direct message or mention @my_test_app", + "is_sensitive": true, + "name": "bot", + "token_type": "bot" + } + ] + } + ], + "ok": true, + "response_metadata": { + "next_cursor": "" + } + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.apps.clearResolution.json b/lib/slack/web/docs/admin.apps.clearResolution.json new file mode 100644 index 0000000..88c9e54 --- /dev/null +++ b/lib/slack/web/docs/admin.apps.clearResolution.json @@ -0,0 +1,86 @@ +{ + "args": { + "app_id": { + "desc": "The id of the app whose resolution you want to clear/undo.", + "example": "A12345", + "name": "app_id", + "required": true, + "type": "string" + }, + "enterprise_id": { + "desc": "The enterprise to clear the app resolution from", + "example": "E12345", + "name": "enterprise_id", + "required": false, + "type": "string" + }, + "team_id": { + "desc": "The workspace to clear the app resolution from", + "example": "T12345", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Clear an app resolution", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "app_management_app_not_installed_on_org": "The app management app must be installed on the org.", + "not_an_admin": "This method is only accessible by org owners and admins", + "team_not_found": "Returned when team id is not found.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "invalid_app_id": "The app_id passed is invalid.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "too_many_teams_provided": "Please provide only team_id OR enterprise_id", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "Returned when the Admin APIs feature is not enabled for this team", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "no_resolution_found": "No existing resolutions were found for the given team and app_id.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.apps.clearResolution", + "name": "admin.apps.clearResolution", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.apps.requests.cancel.json b/lib/slack/web/docs/admin.apps.requests.cancel.json new file mode 100644 index 0000000..e3dca12 --- /dev/null +++ b/lib/slack/web/docs/admin.apps.requests.cancel.json @@ -0,0 +1,86 @@ +{ + "args": { + "enterprise_id": { + "desc": "The ID of the enterprise where this request belongs", + "example": "E12345", + "name": "enterprise_id", + "required": false, + "type": "string" + }, + "request_id": { + "desc": "The id of the request to cancel.", + "example": "Ar12345", + "name": "request_id", + "required": true, + "type": "string" + }, + "team_id": { + "desc": "The ID of the workspace where this request belongs", + "example": "T12345", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Cancel approval request for team", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "app_management_app_not_installed_on_org": "The app management app must be installed on the org.", + "not_an_admin": "This method is only accessible by org owners and admins", + "team_not_found": "Returned when team id is not found.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "too_many_teams_provided": "Please provide only team_id OR enterprise_id", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "Returned when the Admin APIs feature is not enabled for this team", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "invalid_request_id": "The request_id passed is invalid.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "request_already_resolved": "The app request has already been resolved", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.apps.requests.cancel", + "name": "admin.apps.requests.cancel", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.apps.requests.list.json b/lib/slack/web/docs/admin.apps.requests.list.json new file mode 100644 index 0000000..056f002 --- /dev/null +++ b/lib/slack/web/docs/admin.apps.requests.list.json @@ -0,0 +1,149 @@ +{ + "args": { + "cursor": { + "desc": "Set cursor to next_cursor returned by the previous call to list items in the next page", + "example": "5c3e53d5", + "name": "cursor", + "required": false, + "type": "string" + }, + "enterprise_id": { + "desc": "", + "example": "", + "name": "enterprise_id", + "required": false, + "type": "string" + }, + "limit": { + "desc": "The maximum number of items to return. Must be between 1 - 1000 both inclusive.", + "example": "100100", + "name": "limit", + "required": false, + "type": "integer" + }, + "team_id": { + "desc": "", + "example": "", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "List app requests for a team/workspace.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "app_management_app_not_installed_on_org": "The app management app must be installed on the org.", + "not_an_admin": "This method is only accessible by org owners and admins", + "team_not_found": "Returned when team id is not found.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "not_allowed": "The user is not allowed to access this API method", + "too_many_teams_provided": "Please provide only team_id OR enterprise_id", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "enterprise_not_found": "Returned when enterprise id is not found.", + "accesslimited": "Access to this method is limited on the current network", + "invalid_cursor": "Value passed for cursor was not valid or is no longer valid.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "Returned when the Admin APIs feature is not enabled for this team", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.apps.requests.list", + "name": "admin.apps.requests.list", + "response": { + "app_requests": [ + { + "app": { + "additional_info": "", + "app_directory_url": "https://acmecorp.slack.com/apps/A061BL8RQ0-test-app", + "app_homepage_url": "", + "description": "", + "developer_type": "internal", + "help_url": "", + "icons": { + "image_1024": "/cdn/15258203/img/testapp/service_1024.png", + "image_128": "/cdn/157258203/img/testapp/service_128.png", + "image_192": "/cdn/157258203/img/testapp/service_192.png", + "image_32": "/cdn/157658203/img/testapp/service_32.png", + "image_36": "/cdn/157658203/img/testapp/service_36.png", + "image_48": "/cdn/157658203/img/testapp/service_48.png", + "image_512": "/cdn/15758203/img/testapp/service_512.png", + "image_64": "/cdn/157658203/img/testapp/service_64.png", + "image_72": "/cdn/157658203/img/testapp/service_72.png", + "image_96": "/cdn/157658203/img/testapp/service_96.png" + }, + "id": "A061BL8RQ0", + "is_app_directory_approved": true, + "is_internal": true, + "name": "Test App", + "privacy_policy_url": "https://testapp.com/privacy", + "socket_mode_enabled": false + }, + "date_created": 1578956327, + "id": "Ar0XJGFLMLS", + "is_user_app_collaborator": false, + "message": "Could you please install this app for me, it does everything I need.", + "previous_resolution": null, + "scopes": [ + { + "description": "Post messages to specific channels in Slack", + "is_sensitive": false, + "name": "incoming-webhook", + "token_type": "user" + } + ], + "team": { + "domain": "acmecorp", + "id": "T0M94LNUCR", + "name": "Acme Corp" + }, + "user": { + "email": "janedoe@example.com", + "id": "W08RA9G5HR", + "name": "Jane Doe" + } + } + ], + "ok": true, + "response_metadata": { + "next_cursor": "" + } + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.apps.restrict.json b/lib/slack/web/docs/admin.apps.restrict.json index 7fafb4c..006cb0b 100644 --- a/lib/slack/web/docs/admin.apps.restrict.json +++ b/lib/slack/web/docs/admin.apps.restrict.json @@ -1,58 +1,99 @@ { "args": { "app_id": { - "desc": "The id of the app to restrict. Required if `request_id` is missing.", + "desc": "The id of the app to restrict.", "example": "A12345", - "required": false + "name": "app_id", + "required": false, + "type": "string" + }, + "enterprise_id": { + "desc": "The ID of the enterprise to approve the app on", + "example": "E12345", + "name": "enterprise_id", + "required": false, + "type": "string" }, "request_id": { - "desc": "The id of the request to restrict. Required if `app_id` is missing.", + "desc": "The id of the request to restrict.", "example": "Ar12345", - "required": false + "name": "request_id", + "required": false, + "type": "string" }, "team_id": { - "desc": "The id of the team to restrict. Required if your Enterprise Grid org contains more than one workspace.", - "example": "A12345", - "required": false + "desc": "The ID of the workspace to approve the app on", + "example": "T12345", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" } }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], "desc": "Restrict an app for installation on a workspace.", "errors": { - "account_inactive": "Authentication token is for a deleted user or workspace.", - "app_management_app_not_installed_on_org": "The app management app must be installed on the org.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "invalid_scopes": "Some of the provided scopes do not exist", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "app_management_app_not_installed_on_org": "The app management app must be installed on the org.", + "not_an_admin": "This method is only accessible by org owners and admins", + "team_not_found": "Returned when team id is not found.", + "request_id_or_app_id_is_required": "Must include a request_id or app_id", + "access_denied": "Access to a resource specified in the request is denied.", "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", - "feature_not_enabled": "Returned when the Admin APIs feature is not enabled for this team.", - "invalid_app_id": "The `app_id` passed was invalid.", + "not_authed": "No authentication token provided.", + "invalid_app_id": "The app_id passed is invalid.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", - "invalid_arguments": "The method was called with invalid arguments.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "too_many_teams_provided": "Please provide only team_id OR enterprise_id", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "Returned when the Admin APIs feature is not enabled for this team", + "request_id_required_for_custom_integrations": "A request_id is required for custom integrations", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "invalid_request_id": "The request_id passed is invalid.", + "not_allowed_token_type": "The token type used in this request is not allowed.", "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", - "invalid_charset": "The method was called via a `POST` request, but the `charset` specified in the `Content-Type` header was invalid. Valid charset names are: `utf-8` `iso-8859-1`.", - "invalid_form_data": "The method was called via a `POST` request with `Content-Type` `application/x-www-form-urlencoded` or `multipart/form-data`, but the form data was either missing or syntactically invalid.", - "invalid_post_type": "The method was called via a `POST` request, but the specified `Content-Type` was invalid. Valid types are: `application/json` `application/x-www-form-urlencoded` `multipart/form-data` `text/plain`.", - "invalid_request_id": "The `request_id` passed was invalid.", - "is_bot": "This method cannot be called by a bot user.", - "missing_post_type": "The method was called via a `POST` request and included a data payload, but the request did not include a `Content-Type` header.", - "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", - "not_an_admin": "This method is only accessible by org owners and admins.", - "not_authed": "No authentication token provided.", - "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", - "request_already_resolved": "The app request has already been resolved.", - "request_id_or_app_id_is_required": "Must include a `request_id` or `app_id`.", - "request_id_required_for_custom_integrations": "A `request_id` is required for custom integrations.", - "request_timeout": "The method was called via a `POST` request, but the `POST` data was either missing or truncated.", - "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", - "team_not_found": "Returned when team id is not found.", - "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed.", - "too_many_ids_provided": "Please provide only `app_id` OR `request_id`.", - "too_many_teams_provided": "Please provide only `team_id` OR `enterprise_id`." + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "request_already_resolved": "The app request has already been resolved", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "custom_integration_not_allowed_at_enterprise": "Returned when the install request is for custom integration app.", + "too_many_ids_provided": "Please provide only app_id OR request_id", + "method_deprecated": "The method has been deprecated." }, + "is_deprecated": false, + "link": "/methods/admin.apps.restrict", + "name": "admin.apps.restrict", "response": { "ok": true }, "warnings": { - "missing_charset": "The method was called via a `POST` request, and recommended practice for the specified `Content-Type` is to include a `charset` parameter. However, no `charset` was present. Specifically, non-form-data content types (e.g. `text/plain`) are the ones for which `charset` is recommended.", - "superfluous_charset": "The method was called via a `POST` request, and the specified `Content-Type` is not defined to understand the `charset` parameter. However, `charset` was in fact present. Specifically, form-data content types (e.g. `multipart/form-data`) are the ones for which `charset` is superfluous." + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/admin.apps.restricted.list.json b/lib/slack/web/docs/admin.apps.restricted.list.json new file mode 100644 index 0000000..ec1f1cc --- /dev/null +++ b/lib/slack/web/docs/admin.apps.restricted.list.json @@ -0,0 +1,140 @@ +{ + "args": { + "cursor": { + "desc": "Set cursor to next_cursor returned by the previous call to list items in the next page", + "example": "5c3e53d5", + "name": "cursor", + "required": false, + "type": "string" + }, + "enterprise_id": { + "desc": "", + "example": "E0AS553RN", + "name": "enterprise_id", + "required": false, + "type": "string" + }, + "limit": { + "desc": "The maximum number of items to return. Must be between 1 - 1000 both inclusive.", + "example": "100100", + "name": "limit", + "required": false, + "type": "integer" + }, + "team_id": { + "desc": "", + "example": "T0HFE6EBT", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "List restricted apps for an org or workspace.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "app_management_app_not_installed_on_org": "The app management app must be installed on the org.", + "not_an_admin": "This method is only accessible by org/workspace owners and admins", + "team_not_found": "Returned when team id is not found.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "not_allowed": "The user is not allowed to access this API method", + "too_many_teams_provided": "Please provide only team_id OR enterprise_id.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "invalid_cursor": "Value passed for cursor was not valid or is no longer valid.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "Returned when the Admin APIs feature is not enabled for this team", + "invalid_actor": "The provided actor_id is not a valid user or application", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.apps.restricted.list", + "name": "admin.apps.restricted.list", + "response": { + "ok": true, + "response_metadata": { + "next_cursor": "" + }, + "restricted_apps": [ + { + "app": { + "additional_info": "", + "app_directory_url": "https://myteam.enterprise.slack.com/apps/A0FDLP8M2L-my-test-app", + "app_homepage_url": "https://example.com", + "description": "A fun test app for Slack", + "developer_type": "third_party", + "help_url": "https://example.com", + "icons": { + "image_1024": "https://1433265338rl878408_eb57dbc818daa4ba15d6_1024.png", + "image_128": "https://4332653438rl87808_eb57dbc818daa4ba15d6_128.png", + "image_192": "https://4332653438rl87808_eb57dbc818daa4ba15d6_192.png", + "image_32": "https://143326534038rl8788_eb57dbc818daa4ba15d6_32.png", + "image_36": "https://143326534038rl8788_eb57dbc818daa4ba15d6_36.png", + "image_48": "https://143326534038rl8788_eb57dbc818daa4ba15d6_48.png", + "image_512": "https://4332653438rl87808_eb57dbc818daa4ba15d6_512.png", + "image_64": "https://143326534038rl8788_eb57dbc818daa4ba15d6_64.png", + "image_72": "https://143326534038rl8788_eb57dbc818daa4ba15d6_72.png", + "image_96": "https://143326534038rl8788_eb57dbc818daa4ba15d6_96.png", + "image_original": "https://143338rl8782653408_eb57dbc818daa4ba15d6_original.png" + }, + "id": "A0FDLP8M2L", + "is_app_directory_approved": true, + "is_internal": false, + "name": "My Test App", + "privacy_policy_url": "https://example.com", + "socket_mode_enabled": false + }, + "date_updated": 1574296721, + "last_resolved_by": { + "actor_id": "W0G82LMFD", + "actor_type": "user" + }, + "scopes": [ + { + "description": "Upload, edit, and delete files on the user‟s behalf", + "is_sensitive": true, + "name": "files:write:user", + "token_type": "user" + } + ] + } + ] + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.apps.uninstall.json b/lib/slack/web/docs/admin.apps.uninstall.json new file mode 100644 index 0000000..cc069b4 --- /dev/null +++ b/lib/slack/web/docs/admin.apps.uninstall.json @@ -0,0 +1,88 @@ +{ + "args": { + "app_id": { + "desc": "The ID of the app to uninstall.", + "example": "A12345", + "name": "app_id", + "required": true, + "type": "string" + }, + "enterprise_id": { + "desc": "The enterprise to completely uninstall the application from (across all workspaces). With an org-level token, this or team_ids is required.", + "example": "E12345", + "name": "enterprise_id", + "required": false, + "type": "string" + }, + "team_ids": { + "desc": "IDs of the teams to uninstall from (max 100). With an org-level token, this or enterprise_id is required.", + "example": "", + "name": "team_ids", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Uninstall an app from one or many workspaces, or an entire enterprise organization.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "must_revoke_access": "Organization-deployed apps cannot be uninstalled from specific workspaces using this API.", + "permission_denied": "You do not have permission to uninstall applications from the reqeusted org or workspaces.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "too_many_teams": "Too many IDs are present in team_ids.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "teams_not_found": "One or more of the provided team_ids were not found.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "enterprise_not_found": "The provided enterprise_id was not found.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The Admin APIs feature is not enabled for this team.", + "app_not_found": "The provided app_id was not found.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "specify_enterprise_or_teams": "Provide exactly one of enterprise_id or team_ids.", + "can_not_uninstall": "This application can not be uninstalled via the API.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.apps.uninstall", + "name": "admin.apps.uninstall", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.audit.anomaly.allow.getItem.json b/lib/slack/web/docs/admin.audit.anomaly.allow.getItem.json new file mode 100644 index 0000000..55564cf --- /dev/null +++ b/lib/slack/web/docs/admin.audit.anomaly.allow.getItem.json @@ -0,0 +1,54 @@ +{ + "args": {}, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "API to allow enterprise grid admins to read the allow list of IP blocks and ASNs from the enterprise configuration.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "endpoint_unavailable": "The requested endpoint is currently unavailable.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "unsupported_action_put": "The user specified action is unsupported", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "not_an_enterprise": "The user is not an enterprise admin.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "unsupported_action_describe": "The user specified action is unsupported", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.audit.anomaly.allow.getItem", + "name": "admin.audit.anomaly.allow.getItem", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.audit.anomaly.allow.updateItem.json b/lib/slack/web/docs/admin.audit.anomaly.allow.updateItem.json new file mode 100644 index 0000000..2c5e3f1 --- /dev/null +++ b/lib/slack/web/docs/admin.audit.anomaly.allow.updateItem.json @@ -0,0 +1,70 @@ +{ + "args": { + "trusted_asns": { + "desc": "allow list of Autonomous System Numbers (ASN) in the enterprise grid configuarion", + "example": "", + "name": "trusted_asns", + "required": false, + "type": "array" + }, + "trusted_cidr": { + "desc": "allow list of IPv4 addressses using cidr notation in the enterprise grid configuarion", + "example": "", + "name": "trusted_cidr", + "required": false, + "type": "array" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "API to allow enterprise grid admins to write/overwrite the allow list of IP blocks and ASNs from the enterprise configuration.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "unable_to_process_post_request": "The user sent a malformed post request", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "invalid_field_or_data": "user attempted to write and invalid field or data to the team config", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "endpoint_unavailable": "The requested endpoint is currently unavailable.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "unsupported_action_put": "The user specified put action is unsupported", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "unsupported_action_describe": "The user specified describe action is unsupported", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.audit.anomaly.allow.updateItem", + "name": "admin.audit.anomaly.allow.updateItem", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.auth.policy.assignEntities.json b/lib/slack/web/docs/admin.auth.policy.assignEntities.json new file mode 100644 index 0000000..45388a4 --- /dev/null +++ b/lib/slack/web/docs/admin.auth.policy.assignEntities.json @@ -0,0 +1,86 @@ +{ + "args": { + "entity_ids": { + "desc": "Array of IDs to assign to the policy.", + "example": "['U12345','U27345']", + "name": "entity_ids", + "required": true, + "type": "array" + }, + "entity_type": { + "desc": "The type of entity to assign to the policy. Currently, USER is supported.", + "example": "", + "name": "entity_type", + "required": true, + "type": "string" + }, + "policy_name": { + "desc": "The name of the authentication policy to assign the entities to. Currently, email_password is the only policy that may be used with this method.", + "example": "email_password", + "name": "policy_name", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Assign entities to a particular authentication policy.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "policy_not_found": "The policy name doesn't match any of the existing org policies.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "not_an_admin": "This method is only accessible by Org Owners and Admins.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "unknown_method": "This method is currently not available.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "admin_unauthorized": "The token provided doesn't have permission to revoke a session.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "entity_not_found": "At least one entity_id was not found.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "over_max_entity_limit": "The number of entities assigned to this policy has reached its upper limit.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "This method is only available for Enterprise organizations.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.auth.policy.assignEntities", + "name": "admin.auth.policy.assignEntities", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.auth.policy.getEntities.json b/lib/slack/web/docs/admin.auth.policy.getEntities.json new file mode 100644 index 0000000..1898e49 --- /dev/null +++ b/lib/slack/web/docs/admin.auth.policy.getEntities.json @@ -0,0 +1,98 @@ +{ + "args": { + "cursor": { + "desc": "Set cursor to next_cursor returned by the previous call to list items in the next page.", + "example": "5c3e53d5", + "name": "cursor", + "required": false, + "type": "string" + }, + "entity_type": { + "desc": "The type of entity to assign to the policy. Currently, USER is supported.", + "example": "", + "name": "entity_type", + "required": false, + "type": "string" + }, + "limit": { + "desc": "The maximum number of items to return. Must be between 1 and 1000, both inclusive.", + "example": "1000100", + "name": "limit", + "required": false, + "type": "integer" + }, + "policy_name": { + "desc": "The name of the policy to fetch entities for. Currently, email_password is the only policy that may be used with this method.", + "example": "email_password", + "name": "policy_name", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Fetch all the entities assigned to a particular authentication policy by name.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "policy_not_found": "The policy_name could not be found.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "not_an_admin": "This method is only accessible by Org Owners and Admins.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "invalid_cursor": "The cursor passed was invalid.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "This method is only available for Enterprise organizations.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.auth.policy.getEntities", + "name": "admin.auth.policy.getEntities", + "response": { + "entities": [ + { + "date_added": 1620836993, + "entity_id": "U1234", + "entity_type": "USER" + } + ], + "entity_total_count": 1, + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.auth.policy.removeEntities.json b/lib/slack/web/docs/admin.auth.policy.removeEntities.json new file mode 100644 index 0000000..d2dfb55 --- /dev/null +++ b/lib/slack/web/docs/admin.auth.policy.removeEntities.json @@ -0,0 +1,83 @@ +{ + "args": { + "entity_ids": { + "desc": "Encoded IDs of the entities you'd like to remove from the policy.", + "example": "['U1234']", + "name": "entity_ids", + "required": true, + "type": "array" + }, + "entity_type": { + "desc": "The type of entity to assign to the policy. Currently, USER is supported.", + "example": "", + "name": "entity_type", + "required": true, + "type": "string" + }, + "policy_name": { + "desc": "The name of the policy to remove entities from. Currently, email_password is the only policy that may be used with this method.", + "example": "email_password", + "name": "policy_name", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Remove specified entities from a specified authentication policy.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "policy_not_found": "The policy_name could not be found.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "not_an_admin": "This method is only accessible by Org Owners and Admins.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "entity_not_found": "At least one entity_id was not found", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "This method is only available to Enterprise customers.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.auth.policy.removeEntities", + "name": "admin.auth.policy.removeEntities", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.barriers.create.json b/lib/slack/web/docs/admin.barriers.create.json new file mode 100644 index 0000000..1eee062 --- /dev/null +++ b/lib/slack/web/docs/admin.barriers.create.json @@ -0,0 +1,84 @@ +{ + "args": { + "barriered_from_usergroup_ids": { + "desc": "A list of IDP Groups ids that the primary usergroup is to be barriered from.", + "example": "", + "name": "barriered_from_usergroup_ids", + "required": true, + "type": "array" + }, + "primary_usergroup_id": { + "desc": "The id of the primary IDP Group", + "example": "", + "name": "primary_usergroup_id", + "required": true, + "type": "string" + }, + "restricted_subjects": { + "desc": "What kind of interactions are blocked by this barrier? For v1, we only support a list of all 3, eg im, mpim, call", + "example": "", + "name": "restricted_subjects", + "required": true, + "type": "array" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Create an Information Barrier", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "barriered_from_usergroups_not_found": "One or more of the ids passed in for barriered_from_usergroup_ids can’t be found.", + "primary_usergroup_not_found": "The id passed in for primary_usergroup_id can’t be found.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "not_an_admin": "The token provided is not associated with an org admin.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The information barrier feature is not enabled, please reach out to your CSM.", + "barrier_already_exists": "There already exists another barrier restricting activity between two or more of your requested usergroups.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "invalid_restricted_subjects": "The restricted subjects provided are invalid or not currently supported.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.barriers.create", + "name": "admin.barriers.create", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.barriers.delete.json b/lib/slack/web/docs/admin.barriers.delete.json new file mode 100644 index 0000000..17f30a2 --- /dev/null +++ b/lib/slack/web/docs/admin.barriers.delete.json @@ -0,0 +1,67 @@ +{ + "args": { + "barrier_id": { + "desc": "The ID of the barrier you're trying to delete", + "example": "", + "name": "barrier_id", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Delete an existing Information Barrier", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "not_an_admin": "The token provided is not associated with an org admin.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The information barrier feature is not enabled, please reach out to your CSM.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "barrier_not_found": "The barrier you're trying to delete cannot be found.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.barriers.delete", + "name": "admin.barriers.delete", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.barriers.list.json b/lib/slack/web/docs/admin.barriers.list.json new file mode 100644 index 0000000..9f36417 --- /dev/null +++ b/lib/slack/web/docs/admin.barriers.list.json @@ -0,0 +1,74 @@ +{ + "args": { + "cursor": { + "desc": "Set cursor to next_cursor returned by the previous call to list items in the next page", + "example": "5c3e53d5", + "name": "cursor", + "required": false, + "type": "string" + }, + "limit": { + "desc": "The maximum number of items to return. Must be between 1 - 1000 both inclusive", + "example": "100100", + "name": "limit", + "required": false, + "type": "integer" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Get all Information Barriers for your organization", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "not_an_admin": "The token provided is not associated with an org admin", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "invalid_cursor": "Value passed for cursor was not valid or is no longer valid.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "Feature not enabled", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.barriers.list", + "name": "admin.barriers.list", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.barriers.update.json b/lib/slack/web/docs/admin.barriers.update.json new file mode 100644 index 0000000..1c28b2f --- /dev/null +++ b/lib/slack/web/docs/admin.barriers.update.json @@ -0,0 +1,92 @@ +{ + "args": { + "barrier_id": { + "desc": "The ID of the barrier you're trying to modify", + "example": "", + "name": "barrier_id", + "required": true, + "type": "string" + }, + "barriered_from_usergroup_ids": { + "desc": "A list of IDP Groups ids that the primary usergroup is to be barriered from.", + "example": "", + "name": "barriered_from_usergroup_ids", + "required": true, + "type": "array" + }, + "primary_usergroup_id": { + "desc": "The id of the primary IDP Group", + "example": "", + "name": "primary_usergroup_id", + "required": true, + "type": "string" + }, + "restricted_subjects": { + "desc": "What kind of interactions are blocked by this barrier? For v1, we only support a list of all 3, eg im, mpim, call", + "example": "", + "name": "restricted_subjects", + "required": true, + "type": "array" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Update an existing Information Barrier", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "barriered_from_usergroups_not_found": "One or more of the ids passed in for barriered_from_usergroup_ids can’t be found.", + "primary_usergroup_not_found": "The id passed in for primary_usergroup_id can’t be found.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "not_an_admin": "The token provided is not associated with an org admin.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The information barrier feature is not enabled, please reach out to your CSM.", + "barrier_already_exists": "There already exists another barrier restricting activity between two or more of your requested usergroups.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "invalid_restricted_subjects": "The restricted subjects provided are invalid or not currently supported.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "barrier_not_found": "The barrier you're trying to update cannot be found.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.barriers.update", + "name": "admin.barriers.update", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.conversations.archive.json b/lib/slack/web/docs/admin.conversations.archive.json new file mode 100644 index 0000000..cf8346a --- /dev/null +++ b/lib/slack/web/docs/admin.conversations.archive.json @@ -0,0 +1,73 @@ +{ + "args": { + "channel_id": { + "desc": "The channel to archive.", + "example": "C12345", + "name": "channel_id", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Archive a public or private channel.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "channel_type_not_supported": "The value passed for channel was an MPDM, DM, or the 'general' channel.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "already_archived": "This channel has already been archived.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "restricted_action": "A workspace preference prevents the authenticated user from archiving this channel.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "could_not_archive_channel": "The provided channel could not be archived.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The token provided does not have access to this method.", + "cant_archive_general": "You cannot archive the 'general' channel.", + "default_org_wide_channel": "The default org-wide channel cannot be archived.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "The value passed for channel was invalid.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.conversations.archive", + "name": "admin.conversations.archive", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.conversations.convertToPrivate.json b/lib/slack/web/docs/admin.conversations.convertToPrivate.json new file mode 100644 index 0000000..8309329 --- /dev/null +++ b/lib/slack/web/docs/admin.conversations.convertToPrivate.json @@ -0,0 +1,81 @@ +{ + "args": { + "channel_id": { + "desc": "The channel to convert to private.", + "example": "C12345", + "name": "channel_id", + "required": true, + "type": "string" + }, + "name": { + "desc": "Name of private channel to create. Only respected when converting an MPIM.", + "example": "new_private_channel_name", + "name": "name", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Convert a public channel to a private channel.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "could_not_convert_channel": "This channel could not be converted to private.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "name_taken": "A private channel cannot be created with the given name.", + "channel_type_not_supported": "The value passed for channel was a DM, MPDM, private, or the 'general' channel.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "external_channel_migrating": "This external channel is migrating, so it can't be converted to private.", + "restricted_action": "A workspace preference prevents the authenticated user from creating private channels.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "method_not_supported_for_channel_type": "This type of conversation cannot be used with this method.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The provided token doesn't have access to this method.", + "default_org_wide_channel": "The default org-wide channel cannot be converted to private.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "The value passed for channel was invalid.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.conversations.convertToPrivate", + "name": "admin.conversations.convertToPrivate", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.conversations.create.json b/lib/slack/web/docs/admin.conversations.create.json new file mode 100644 index 0000000..93ee1b3 --- /dev/null +++ b/lib/slack/web/docs/admin.conversations.create.json @@ -0,0 +1,104 @@ +{ + "args": { + "description": { + "desc": "Description of the public or private channel to create.", + "example": "It's a good channel, Bront.", + "name": "description", + "required": false, + "type": "string" + }, + "is_private": { + "desc": "When true, creates a private channel instead of a public channel", + "example": "true", + "name": "is_private", + "required": true, + "type": "boolean" + }, + "name": { + "desc": "Name of the public or private channel to create.", + "example": "mychannel", + "name": "name", + "required": true, + "type": "string" + }, + "org_wide": { + "desc": "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", + "example": "falsetrue", + "name": "org_wide", + "required": false, + "type": "boolean" + }, + "team_id": { + "desc": "The workspace to create the channel in. Note: this argument is required unless you set org_wide=true.", + "example": "", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Create a public or private channel-based conversation.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "user_is_ultra_restricted": "This method cannot be called by a single channel guest.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "name_taken": "A channel cannot be created with the given name.", + "team_id_or_org_required": "You must provide a team_id or set org_wide to true.", + "team_not_found": "No workspace was found for the team_id provided.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "no_local_user_on_team": "The workspace provided had no users.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "restricted_action": "A workspace preference prevents the authenticated user from creating channels.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "could_not_create_channel": "The channel could not be created.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The token provided doesn't have access to this method.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "invalid_name": "The value passed for name was invalid.", + "invalid_team": "The provided workspace is invalid.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.conversations.create", + "name": "admin.conversations.create", + "response": { + "channel_id": "C12345", + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.conversations.delete.json b/lib/slack/web/docs/admin.conversations.delete.json new file mode 100644 index 0000000..01c6c2a --- /dev/null +++ b/lib/slack/web/docs/admin.conversations.delete.json @@ -0,0 +1,72 @@ +{ + "args": { + "channel_id": { + "desc": "The channel to delete.", + "example": "C12345", + "name": "channel_id", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Delete a public or private channel.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "channel_type_not_supported": "The provided channel_id was a DM, MPDM, or the 'general' channel.", + "not_an_admin": "The token provided is not associated with an Org Owner or Admin.", + "could_not_delete_channel": "The channel could not be deleted.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "restricted_action": "A workspace preference prevents the authenticated user from deleting this channel.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The token provided doesn't have access to this method.", + "default_org_wide_channel": "The default org-wide channel cannot be deleted.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "The value passed for channel_id was invalid.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.conversations.delete", + "name": "admin.conversations.delete", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.conversations.disconnectShared.json b/lib/slack/web/docs/admin.conversations.disconnectShared.json new file mode 100644 index 0000000..0c8f098 --- /dev/null +++ b/lib/slack/web/docs/admin.conversations.disconnectShared.json @@ -0,0 +1,84 @@ +{ + "args": { + "channel_id": { + "desc": "The channel to be disconnected from some workspaces.", + "example": "C12345", + "name": "channel_id", + "required": true, + "type": "string" + }, + "leaving_team_ids": { + "desc": "team IDs getting removed from the channel, optional if there are only two teams in the channel", + "example": "", + "name": "leaving_team_ids", + "required": false, + "type": "array" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Disconnect a connected channel from one or more workspaces.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "not_an_admin": "The token provided is not associated with an Org Admin or Owner.", + "team_not_found": "At least one of the supplied leaving_team_ids are invalid.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "leaving_team_not_in_channel": "The workspace being removed is not connected to the channel.", + "cannot_kick_team": "Only the originating workspace for a connected channel may remove other workspaces from the channel.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "restricted_action": "A workspace preference prevents the authenticated user from disconnecting a channel.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "cannot_kick_home_team": "The originating workspace cannot be kicked from the channel.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "leaving_team_required": "There are more than two teams in the channel—you must supplied a leaving_team_id parameter.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The token provided does not have access to this method.", + "not_supported": "The passed channel_id was a DM, MPDM, or the 'general' channel.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "The value passed for channel_id was invalid.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "not_an_enterprise": "This endpoint can only be called for an Enterprise organization.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "no_teams_to_disconnect": "This channel is not shared, so there are no workspaces to disconnect.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.conversations.disconnectShared", + "name": "admin.conversations.disconnectShared", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.conversations.ekm.listOriginalConnectedChannelInfo.json b/lib/slack/web/docs/admin.conversations.ekm.listOriginalConnectedChannelInfo.json new file mode 100644 index 0000000..430b77d --- /dev/null +++ b/lib/slack/web/docs/admin.conversations.ekm.listOriginalConnectedChannelInfo.json @@ -0,0 +1,99 @@ +{ + "args": { + "channel_ids": { + "desc": "A comma-separated list of channels to filter to.", + "example": "", + "name": "channel_ids", + "required": false, + "type": "string" + }, + "cursor": { + "desc": "Set cursor to next_cursor returned by the previous call to list items in the next page.", + "example": "5c3e53d5", + "name": "cursor", + "required": false, + "type": "string" + }, + "limit": { + "desc": "The maximum number of items to return. Must be between 1 - 1000 both inclusive.", + "example": "100100", + "name": "limit", + "required": false, + "type": "integer" + }, + "team_ids": { + "desc": "A comma-separated list of the workspaces to which the channels you would like returned belong.", + "example": "", + "name": "team_ids", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "List 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.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "not_an_admin": "This method is only accessible by Org owners and Admins.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "invalid_limit": "The value passed for limit was not valid.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "restricted_action": "The caller of this API is not allowed to perform this operation.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "unsupported_arguments": "The provided method arguments are not supported.", + "accesslimited": "Access to this method is limited on the current network", + "invalid_cursor": "Invalid cursor.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "not_enabled": "The API endpoint is not enabled for your team.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.conversations.ekm.listOriginalConnectedChannelInfo", + "name": "admin.conversations.ekm.listOriginalConnectedChannelInfo", + "response": { + "channels": [ + { + "id": "string", + "internal_team_ids": "array", + "original_connected_channel_id": "string", + "original_connected_host_id": "string" + } + ], + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.conversations.getConversationPrefs.json b/lib/slack/web/docs/admin.conversations.getConversationPrefs.json new file mode 100644 index 0000000..c983ea6 --- /dev/null +++ b/lib/slack/web/docs/admin.conversations.getConversationPrefs.json @@ -0,0 +1,72 @@ +{ + "args": { + "channel_id": { + "desc": "The channel to get preferences for.", + "example": "C12345", + "name": "channel_id", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Get conversation preferences for a public or private channel.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "channel_type_not_supported": "The provided channel_id was a DM, MPDM, or the 'general' channel.", + "not_an_admin": "The token provided is not associated with an Org Admin or Owner.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "restricted_action": "A workspace preference prevents the authenticated user from listing preferences.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The token provided does not have access to this method.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "could_not_get_conversation_prefs": "There was an error getting the conversation preferences for this channel.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "The value passed for channel_id was invalid.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "not_an_enterprise": "This endpoint can only be called by an Enterprise organization.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.conversations.getConversationPrefs", + "name": "admin.conversations.getConversationPrefs", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.conversations.getCustomRetention.json b/lib/slack/web/docs/admin.conversations.getCustomRetention.json new file mode 100644 index 0000000..cc1d173 --- /dev/null +++ b/lib/slack/web/docs/admin.conversations.getCustomRetention.json @@ -0,0 +1,73 @@ +{ + "args": { + "channel_id": { + "desc": "The channel to get the retention policy for.", + "example": "C12345678", + "name": "channel_id", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "This API endpoint can be used by any admin to get a channel's retention policy.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "retention_override_not_allowed": "The current org retention policy disallows modifying the retention policy of this channel.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "channel_type_not_supported": "Value given for channel_id was a #general channel.", + "not_an_admin": "The token provided is not associated with an org admin.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "restricted_action": "A team preference prevents the authenticated user from modifying the retention policy of this channel.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The Admin APIs feature is not enabled for this team.", + "default_org_wide_channel": "The channel given is a default org-wide channel.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "Value given for channel_id was invalid.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "could_not_get_retention": "The retention policy could not be retrieved.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.conversations.getCustomRetention", + "name": "admin.conversations.getCustomRetention", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.conversations.getTeams.json b/lib/slack/web/docs/admin.conversations.getTeams.json new file mode 100644 index 0000000..feb213e --- /dev/null +++ b/lib/slack/web/docs/admin.conversations.getTeams.json @@ -0,0 +1,91 @@ +{ + "args": { + "channel_id": { + "desc": "The channel to determine connected workspaces within the organization for.", + "example": "C12345", + "name": "channel_id", + "required": true, + "type": "string" + }, + "cursor": { + "desc": "Set cursor to next_cursor returned by the previous call to list items in the next page", + "example": "5c3e53d5", + "name": "cursor", + "required": false, + "type": "string" + }, + "limit": { + "desc": "The maximum number of items to return. Must be between 1 - 1000 both inclusive.", + "example": "100100", + "name": "limit", + "required": false, + "type": "integer" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Get all the workspaces a given public or private channel is connected to within this Enterprise org.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "channel_type_not_supported": "The channel_id provided was a DM, MPDM, or the 'general' channel.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "invalid_limit": "The value passed for limit wasn't valid.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "unsupported_team_type": "This endpoint can only called by Enterprise organizations.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "restricted_action": "A workspace preference prevents the authenticated user from listing the workspaces connected to a channel.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "could_not_get_teams": "Could not fetch the workspaces that the channel is shared with in this organization.", + "accesslimited": "Access to this method is limited on the current network", + "invalid_cursor": "The provided cursor wasn't valid.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The token provided doesn't have access to this method.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "The channel wasn't found or isn't connected to multiple workspaces.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.conversations.getTeams", + "name": "admin.conversations.getTeams", + "response": { + "ok": true, + "team_ids": [ + "T1234", + "T5679" + ] + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.conversations.invite.json b/lib/slack/web/docs/admin.conversations.invite.json new file mode 100644 index 0000000..b0e78c2 --- /dev/null +++ b/lib/slack/web/docs/admin.conversations.invite.json @@ -0,0 +1,79 @@ +{ + "args": { + "channel_id": { + "desc": "The channel that the users will be invited to.", + "example": "C12345", + "name": "channel_id", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + }, + "user_ids": { + "desc": "The users to invite.", + "example": "U1234,U2345,U3456", + "name": "user_ids", + "required": true, + "type": "array" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Invite a user to a public or private channel.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "channel_type_not_supported": "The provided channel_id was a DM, MPDM, or the 'general' channel.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "restricted_action": "A workspace preference prevents the authenticated user from inviting.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The token provided doesn't have access to this method.", + "default_org_wide_channel": "Users may not be invited to the default org-wide channel.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "The value passed for channel_id was invalid.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "user_must_be_admin": "The token provided must be associated with an Org Admin or Owner.", + "failed_for_some_users": "The method failed for a subset of the users passed.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.conversations.invite", + "name": "admin.conversations.invite", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.conversations.removeCustomRetention.json b/lib/slack/web/docs/admin.conversations.removeCustomRetention.json new file mode 100644 index 0000000..72b437e --- /dev/null +++ b/lib/slack/web/docs/admin.conversations.removeCustomRetention.json @@ -0,0 +1,73 @@ +{ + "args": { + "channel_id": { + "desc": "The channel to set the retention policy for.", + "example": "C12345678", + "name": "channel_id", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "This API endpoint can be used by any admin to remove a channel's retention policy.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "retention_override_not_allowed": "The current retention policy disallows modifying the retention policy of this channel.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "channel_type_not_supported": "Value given for channel_id was a #general channel.", + "not_an_admin": "The token provided is not associated with an admin.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "restricted_action": "A team preference prevents the authenticated user from modifying the retention policy of this channel.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The Admin APIs feature is not enabled for this team.", + "default_org_wide_channel": "The channel given is a default org-wide channel.", + "could_not_remove_retention": "The retention policy could not be removed.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "Value given for channel_id was invalid.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.conversations.removeCustomRetention", + "name": "admin.conversations.removeCustomRetention", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.conversations.rename.json b/lib/slack/web/docs/admin.conversations.rename.json new file mode 100644 index 0000000..42f6385 --- /dev/null +++ b/lib/slack/web/docs/admin.conversations.rename.json @@ -0,0 +1,79 @@ +{ + "args": { + "channel_id": { + "desc": "The channel to rename.", + "example": "C12345", + "name": "channel_id", + "required": true, + "type": "string" + }, + "name": { + "desc": "", + "example": "", + "name": "name", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Rename a public or private channel.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "name_taken": "The channel's name is already being used elsewhere.", + "channel_type_not_supported": "The provided channel_id was a DM, MPDM, or the 'general' channel.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "restricted_action": "A workspace preference prevents the authenticated user from renaming a channel.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The token provided doesn't have access to this method.", + "default_org_wide_channel": "The default org-wide channel can't be renamed.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "The value passed for channel_id was invalid.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "could_not_rename_channel": "The channel could not be renamed.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.conversations.rename", + "name": "admin.conversations.rename", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.conversations.restrictAccess.addGroup.json b/lib/slack/web/docs/admin.conversations.restrictAccess.addGroup.json new file mode 100644 index 0000000..572f837 --- /dev/null +++ b/lib/slack/web/docs/admin.conversations.restrictAccess.addGroup.json @@ -0,0 +1,92 @@ +{ + "args": { + "channel_id": { + "desc": "The channel to link this group to.", + "example": "", + "name": "channel_id", + "required": true, + "type": "string" + }, + "group_id": { + "desc": "The IDP Group ID to be an allowlist for the private channel.", + "example": "", + "name": "group_id", + "required": true, + "type": "string" + }, + "team_id": { + "desc": "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.", + "example": "", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Add an allowlist of IDP groups for accessing a channel", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "not_an_admin": "This token does not belong to an Org Admin or Owner.", + "cannot_add_more_channels_to_group": "The maximum number of channels have already been linked to the group.", + "group_not_found": "group_id can’t be found.", + "team_not_found": "team_id can’t be found.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "unable_to_link_idp_group_and_channel": "The IDP group and the channel cannot be linked.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "default_channel_restricted": "The channel is a default channel on the workspace.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "group_already_linked_to_channel": "The IDP group is already linked to the channel", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "group_must_not_be_empty": "The IDP group is currently empty.", + "invalid_channel": "The channel can’t be linked to an IDP group (i.e., it's a public channel or external shared channel).", + "accesslimited": "Access to this method is limited on the current network", + "channel_is_not_private": "The channel is a public channel, a multi-party direct message, a direct message, or is externally-shared.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "Feature not enabled", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "channel_id can’t be found.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "cannot_add_more_groups_to_channel": "The maximum number of groups have already been linked to the channel.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_channel_type": "The channel is a public channel, a multi-party direct message, a direct message, or is externally-shared.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.conversations.restrictAccess.addGroup", + "name": "admin.conversations.restrictAccess.addGroup", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.conversations.restrictAccess.listGroups.json b/lib/slack/web/docs/admin.conversations.restrictAccess.listGroups.json new file mode 100644 index 0000000..2cd372a --- /dev/null +++ b/lib/slack/web/docs/admin.conversations.restrictAccess.listGroups.json @@ -0,0 +1,79 @@ +{ + "args": { + "channel_id": { + "desc": "", + "example": "", + "name": "channel_id", + "required": true, + "type": "string" + }, + "team_id": { + "desc": "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.", + "example": "", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "List all IDP Groups linked to a channel", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "not_an_admin": "This token doesn't belong to an Org Admin or Owner.", + "team_not_found": "team_id wasn't found.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_channel": "The requested channel couldn’t be linked to an IDP group. It might be a public channel or an externally-shared channel.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "Feature not enabled", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "channel_id wasn't found.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.conversations.restrictAccess.listGroups", + "name": "admin.conversations.restrictAccess.listGroups", + "response": { + "group_ids": [ + "YOUR_GROUP_ID" + ], + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.conversations.restrictAccess.removeGroup.json b/lib/slack/web/docs/admin.conversations.restrictAccess.removeGroup.json new file mode 100644 index 0000000..aacfc9a --- /dev/null +++ b/lib/slack/web/docs/admin.conversations.restrictAccess.removeGroup.json @@ -0,0 +1,88 @@ +{ + "args": { + "channel_id": { + "desc": "The channel to remove the linked group from.", + "example": "", + "name": "channel_id", + "required": true, + "type": "string" + }, + "group_id": { + "desc": "The IDP Group ID to remove from the private channel.", + "example": "", + "name": "group_id", + "required": true, + "type": "string" + }, + "team_id": { + "desc": "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.", + "example": "", + "name": "team_id", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Remove a linked IDP group linked from a private channel", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "not_an_admin": "This token does not belong to an Org Admin or Owner.", + "group_not_found": "group_id can’t be found.", + "team_not_found": "team_id can’t be found.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_channel": "The channel could not be linked to an IDP group (i.e., it's a public channel or external shared channel).", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "Feature not enabled", + "unable_to_unlink_idp_group_and_channel": "The IDP group and channel cannot be unlinked.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "failed_to_remove_group_users": "Returned when could not remove the users in the channel of the group being removed", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "channel_id can’t be found.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "failed_to_unlink_channel": "Removing the link in the database failed. Please retry.", + "method_deprecated": "The method has been deprecated.", + "link_not_found": "There was no link found between the specified channel and the IDP group." + }, + "is_deprecated": false, + "link": "/methods/admin.conversations.restrictAccess.removeGroup", + "name": "admin.conversations.restrictAccess.removeGroup", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.conversations.search.json b/lib/slack/web/docs/admin.conversations.search.json new file mode 100644 index 0000000..9f2b7d0 --- /dev/null +++ b/lib/slack/web/docs/admin.conversations.search.json @@ -0,0 +1,174 @@ +{ + "args": { + "connected_team_ids": { + "desc": "Array of encoded team IDs, signifying the external orgs to search through.", + "example": "['T00000000','T00000001']", + "name": "connected_team_ids", + "required": false, + "type": "array" + }, + "cursor": { + "desc": "Set cursor to next_cursor returned by the previous call to list items in the next page.", + "example": "dXNlcjpVMEc5V0ZYTlo=", + "name": "cursor", + "required": false, + "type": "string" + }, + "limit": { + "desc": "Maximum number of items to be returned. Must be between 1 - 20 both inclusive. Default is 10.", + "example": "1020", + "name": "limit", + "required": false, + "type": "integer" + }, + "query": { + "desc": "Name of the the channel to query by.", + "example": "announcement", + "name": "query", + "required": false, + "type": "string" + }, + "search_channel_types": { + "desc": "The type of channel to include or exclude in the search. For example private will search private channels, while private_exclude will exclude them. For a full list of types, check the Types section.", + "example": "private,archived", + "name": "search_channel_types", + "required": false, + "type": "array" + }, + "sort": { + "desc": "Possible values are relevant (search ranking based on what we think is closest), name (alphabetical), member_count (number of users in the channel), and created (date channel was created). You can optionally pair this with the sort_dir arg to change how it is sorted", + "example": "member_countname", + "name": "sort", + "required": false, + "type": "string" + }, + "sort_dir": { + "desc": "Sort direction. Possible values are asc for ascending order like (1, 2, 3) or (a, b, c), and desc for descending order like (3, 2, 1) or (c, b, a)", + "example": "descasc", + "name": "sort_dir", + "required": false, + "type": "string" + }, + "team_ids": { + "desc": "Comma separated string of team IDs, signifying the internal workspaces to search through.", + "example": "T00000000,T00000001", + "name": "team_ids", + "required": false, + "type": "array" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Search for public or private channels in an Enterprise organization.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "connected_team_passed_in_is_not_top_level_team": "One of the orgs provided in the external connected teams filter is not a top level team.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "not_an_admin": "The token provided is not associated with an Org Admin or Owner.", + "external_team_not_connected_to_this_org": "One of the teams provided in the external connected teams filter is not connected to the org.", + "team_not_found": "One of the workspaces provided in the list wasn't found.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "not_allowed": "The authenticated user does not have the permission to call this method.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "invalid_cursor": "The provided cursor is not valid, often due to not urlencoding query parameters.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The token provided doesn't have access to this method.", + "invalid_sort": "The provided sort argument wasn't valid.", + "invalid_sort_dir": "The provided sort_dir argument wasn't valid.", + "invalid_search_channel_type": "An invalid search_channel_types arg was passed. Make sure there are no spaces between your args and that each is one of the enumerated options listed above.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "not_an_enterprise": "This endpoint can only be called by an Enterprise organization.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.conversations.search", + "name": "admin.conversations.search", + "response": { + "conversations": [ + { + "connected_team_ids": [], + "created": 1578423973, + "creator_id": "WPQ65MVKK", + "id": "GSEV0B5PY", + "internal_team_ids_count": 4, + "internal_team_ids_sample_team": "T013F30DBAB", + "is_archived": true, + "is_ext_shared": false, + "is_frozen": false, + "is_general": false, + "is_global_shared": true, + "is_org_default": false, + "is_org_mandatory": false, + "is_org_shared": true, + "is_pending_ext_shared": false, + "is_private": true, + "last_activity_ts": 1583198954000200, + "member_count": -1, + "name": "privacy-channel", + "pending_connected_team_ids": [], + "purpose": "Group messaging with: @rita @nwhere @meanie" + }, + { + "connected_team_ids": [], + "created": 1588786531, + "creator_id": "WPQ65MVKK", + "id": "C013JDPD6CR", + "internal_team_ids_count": 1, + "internal_team_ids_sample_team": "TPQ67R81F", + "is_archived": false, + "is_ext_shared": false, + "is_frozen": false, + "is_general": false, + "is_global_shared": false, + "is_org_default": false, + "is_org_mandatory": false, + "is_org_shared": true, + "is_pending_ext_shared": false, + "is_private": false, + "last_activity_ts": 1589854024000200, + "member_count": 1, + "name": "proj-decomposed-monolith", + "pending_connected_team_ids": [], + "purpose": "" + } + ], + "next_cursor": "aWQ6Mw==", + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.conversations.setConversationPrefs.json b/lib/slack/web/docs/admin.conversations.setConversationPrefs.json new file mode 100644 index 0000000..b895ed8 --- /dev/null +++ b/lib/slack/web/docs/admin.conversations.setConversationPrefs.json @@ -0,0 +1,81 @@ +{ + "args": { + "channel_id": { + "desc": "The channel to set the prefs for", + "example": "C1234", + "name": "channel_id", + "required": true, + "type": "string" + }, + "prefs": { + "desc": "The prefs for this channel in a stringified JSON format.", + "example": "{'who_can_post':'type:admin,user:U1234'}", + "name": "prefs", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Set the posting permissions for a public or private channel.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "channel_type_not_supported": "Value given for channel_id was a #general channel.", + "channel_mention_sync_required": "If setting channel mention restriction prefs, both mention prefs must be passed and they must be the same value.", + "not_an_admin": "The token provided is not associated with an org admin.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "restricted_action": "A workspace preference prevents the authenticated user from archiving.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_value": "Value passed for the preferences are invalid", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The Admin APIs feature is not enabled for this team.", + "default_org_wide_channel": "Returned when you try to modify a default org wide channel.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "Value passed for channel was invalid.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "could_not_set_channel_pref": "Setting the preference or permission failed.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.conversations.setConversationPrefs", + "name": "admin.conversations.setConversationPrefs", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.conversations.setCustomRetention.json b/lib/slack/web/docs/admin.conversations.setCustomRetention.json new file mode 100644 index 0000000..7a9ee35 --- /dev/null +++ b/lib/slack/web/docs/admin.conversations.setCustomRetention.json @@ -0,0 +1,81 @@ +{ + "args": { + "channel_id": { + "desc": "The channel to set the retention policy for.", + "example": "C12345678", + "name": "channel_id", + "required": true, + "type": "string" + }, + "duration_days": { + "desc": "The message retention duration in days to set for this channel", + "example": "500", + "name": "duration_days", + "required": true, + "type": "integer" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "This API endpoint can be used by any admin to set a channel's retention policy.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "retention_override_not_allowed": "The current retention policy disallows modifying the retention policy of this channel.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "channel_type_not_supported": "Value given for channel_id was a group dm, direct message, or #general channel.", + "not_an_admin": "The token provided is not associated with an admin.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "invalid_duration": "Retention duration_days must be an integer greater than 0 days and less than 36500 days (100 years).", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "restricted_action": "A team preference prevents the authenticated user from modifying the retention policy of this channel.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "could_not_set_retention": "The retention policy could not be set.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The Admin APIs feature is not enabled for this team.", + "default_org_wide_channel": "The channel given is a default org-wide channel.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "Value given for channel_id was invalid.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.conversations.setCustomRetention", + "name": "admin.conversations.setCustomRetention", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.conversations.setTeams.json b/lib/slack/web/docs/admin.conversations.setTeams.json new file mode 100644 index 0000000..22c8d7f --- /dev/null +++ b/lib/slack/web/docs/admin.conversations.setTeams.json @@ -0,0 +1,102 @@ +{ + "args": { + "channel_id": { + "desc": "The encoded channel_id to add or remove to workspaces.", + "example": "", + "name": "channel_id", + "required": true, + "type": "string" + }, + "org_channel": { + "desc": "True if channel has to be converted to an org channel", + "example": "falsetrue", + "name": "org_channel", + "required": false, + "type": "boolean" + }, + "target_team_ids": { + "desc": "A comma-separated list of workspaces to which the channel should be shared. Not required if the channel is being shared org-wide.", + "example": "T1234,T5678,T9012,T3456", + "name": "target_team_ids", + "required": false, + "type": "array" + }, + "team_id": { + "desc": "The workspace to which the channel belongs. Omit this argument if the channel is a cross-workspace shared channel.", + "example": "", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Set the workspaces in an Enterprise grid org that connect to a public or private channel.", + "errors": { + "not_allowed_for_grid_workspace": "Slack Connect is not allowed for this grid workspace", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "invalid_channel_id": "channel_id was invalid.", + "externally_shared_or_disconnected_channel": "The channel is or was externally shared.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "name_taken": "The channel's name was already used in one of the workspce.", + "could_not_set_teams_for_channel": "The requested channel_id has not been shared with the target workspace.", + "channel_type_not_supported": "The requested channel_id is not a supported type of channel.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_target_team": "Target workspace is invalid.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "restricted_action": "The caller of this API is not allowed to perform this operation.", + "too_many_target_teams": "Too many target_team_ids were provided.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "unsupported_arguments": "The provided method arguments are not supported.", + "accesslimited": "Access to this method is limited on the current network", + "channel_cannot_be_unshared": "Channel cannot be unshared from this workspace.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "default_org_wide_channel": "Default org wide channel cannot be unshared from a workspace.", + "not_enabled": "The API endpoint is not enabled for your team.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "The channel wasn't found or isn't shared to this workspace.", + "cannot_move_local_channel": "This API cannot be used to move a local channel from one workspace to another.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "cannot_add_legacy_disconnected_channel_to_workspaces": "Cannot add legacy disconnected channel to workspaces", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.conversations.setTeams", + "name": "admin.conversations.setTeams", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.conversations.unarchive.json b/lib/slack/web/docs/admin.conversations.unarchive.json new file mode 100644 index 0000000..0333eba --- /dev/null +++ b/lib/slack/web/docs/admin.conversations.unarchive.json @@ -0,0 +1,72 @@ +{ + "args": { + "channel_id": { + "desc": "The channel to unarchive.", + "example": "C12345", + "name": "channel_id", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Unarchive a public or private channel.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "channel_type_not_supported": "The value passed for channel was a DM, MPDM, or the 'general' channel", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "restricted_action": "A workspace preference prevents the authenticated user from unarchiving.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "could_not_unarchive_channel": "The channel could not be unarchived.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The token provided doesn't have access to this method.", + "channel_not_archived": "The passed channel is not currently archived.", + "default_org_wide_channel": "You can't unarchive a default org-wide channel.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "The value passed for channel_id was invalid.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.conversations.unarchive", + "name": "admin.conversations.unarchive", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.emoji.add.json b/lib/slack/web/docs/admin.emoji.add.json new file mode 100644 index 0000000..8ac2436 --- /dev/null +++ b/lib/slack/web/docs/admin.emoji.add.json @@ -0,0 +1,88 @@ +{ + "args": { + "name": { + "desc": "The name of the emoji to be added. Colons (:myemoji:) around the value are not required, although they may be included.", + "example": "", + "name": "name", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + }, + "url": { + "desc": "The URL of a file to use as an image for the emoji. Square images under 128KB and with transparent backgrounds work best.", + "example": "", + "name": "url", + "required": true, + "type": "string" + } + }, + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Add an emoji.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "error_bad_format": "Invalid image data was provided.", + "not_an_admin": "This method is only accessible by org owners and Admins.", + "emoji_limit_reached": "Unable to add emoji due to limit reached.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "error_missing_name": "Value passed for name is missing or empty.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "error_bad_upload": "There was an error uploading the image.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "error_too_big": "The image file size is too large.", + "too_many_frames": "The image has too many frames.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "resized_but_still_too_large": "The image is still too large after resizing.", + "accesslimited": "Access to this method is limited on the current network", + "error_name_taken": "Value passed for name already exists.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The Admin APIs feature is not enabled for this team.", + "failed_to_add_emoji": "Failed to add the specified emoji.", + "error_bad_wide": "The image width or height is too large.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "error_no_image": "Empty image data was provided.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "error_bad_name_i18n": "Value passed for name was invalid.", + "no_image_uploaded": "No image data was provided.", + "error_name_taken_i18n": "Value passed for name already exists.", + "failed_to_fetch_active_team": "There are no active teams on the org and we need at least one.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.emoji.add", + "name": "admin.emoji.add", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.emoji.addAlias.json b/lib/slack/web/docs/admin.emoji.addAlias.json new file mode 100644 index 0000000..a7dd4e6 --- /dev/null +++ b/lib/slack/web/docs/admin.emoji.addAlias.json @@ -0,0 +1,80 @@ +{ + "args": { + "alias_for": { + "desc": "Name of the emoji for which the alias is being made. Any wrapping whitespace or colons will be automatically trimmed.", + "example": "", + "name": "alias_for", + "required": true, + "type": "string" + }, + "name": { + "desc": "The new alias for the specified emoji. Any wrapping whitespace or colons will be automatically trimmed.", + "example": "", + "name": "name", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Add an emoji alias.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "not_an_admin": "This method is only accessible by org owners and Admins.", + "emoji_limit_reached": "Unable to add emoji due to limit reached.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "error_missing_name": "Value passed for name is missing or empty.", + "error_invalid_alias": "Value passed for alias_for does not exist.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "no_alias_selected": "Value passed for alias_for was invalid.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "error_name_taken": "Value passed for name already exists.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The Admin APIs feature is not enabled for this team.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "failed_to_alias_emoji": "Failed to alias the specified emoji.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "error_bad_name_i18n": "Value passed for name was invalid.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.emoji.addAlias", + "name": "admin.emoji.addAlias", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.emoji.list.json b/lib/slack/web/docs/admin.emoji.list.json new file mode 100644 index 0000000..8afa8a3 --- /dev/null +++ b/lib/slack/web/docs/admin.emoji.list.json @@ -0,0 +1,129 @@ +{ + "args": { + "cursor": { + "desc": "Set cursor to next_cursor returned by the previous call to list items in the next page", + "example": "5c3e53d5", + "name": "cursor", + "required": false, + "type": "string" + }, + "limit": { + "desc": "The maximum number of items to return. Must be between 1 - 1000 both inclusive.", + "example": "100100", + "name": "limit", + "required": false, + "type": "integer" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "List emoji for an Enterprise Grid organization.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "not_an_admin": "This method is only accessible by org owners and Admins.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "invalid_cursor": "Value passed for cursor was not valid or is no longer valid.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The Admin APIs feature is not enabled for this team.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.emoji.list", + "name": "admin.emoji.list", + "response": { + "emoji": { + "bc": { + "date_created": 1594854289, + "uploaded_by": "WPU7MCTFH", + "url": "https://emoji.slack-edge.com/TM315QLU8/bc/fb3dfdea697528b9.png" + }, + "ignore": { + "date_created": 1598467835, + "uploaded_by": "WPU7MCTFH", + "url": "https://emoji.slack-edge.com/TM315QLU8/ignore/9506cda43addbad8.png" + }, + "kb": { + "date_created": 1598467537, + "uploaded_by": "WPU7MCTFH", + "url": "https://emoji.slack-edge.com/TM315QLU8/kb/bab417c375703f7b.png" + }, + "people": { + "date_created": 1593383822, + "uploaded_by": "WPU7MCTFH", + "url": "https://emoji.slack-edge.com/TM315QLU8/people/0b40796ab677b47f.png" + }, + "person": { + "date_created": 1593383817, + "uploaded_by": "WPU7MCTFH", + "url": "https://emoji.slack-edge.com/TM315QLU8/person/81295a4f69d8b122.png" + }, + "plus1": { + "date_created": 1593724572, + "uploaded_by": "WPU7MCTFH", + "url": "https://emoji.slack-edge.com/TM315QLU8/plus1/42b92e57a79eb27e.png" + }, + "slackbot": { + "date_created": 1593383989, + "uploaded_by": "WPU7MCTFH", + "url": "https://emoji.slack-edge.com/TM315QLU8/slackbot/561d6e545263d92b.png" + }, + "welcome": { + "date_created": 1593383451, + "uploaded_by": "WPU7MCTFH", + "url": "https://emoji.slack-edge.com/TM315QLU8/welcome/763d3659699d2ef7.gif" + }, + "wf": { + "date_created": 1594854443, + "uploaded_by": "WPU7MCTFH", + "url": "https://emoji.slack-edge.com/TM315QLU8/wf/04dad3aa28b57cd3.png" + }, + "workflow": { + "date_created": 1591720632, + "uploaded_by": "WLWLQDAL9", + "url": "https://emoji.slack-edge.com/TM315QLU8/workflow/530de66adccc59c5.png" + } + }, + "ok": true, + "response_metadata": { + "next_cursor": "" + } + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.emoji.remove.json b/lib/slack/web/docs/admin.emoji.remove.json new file mode 100644 index 0000000..91e6dbe --- /dev/null +++ b/lib/slack/web/docs/admin.emoji.remove.json @@ -0,0 +1,68 @@ +{ + "args": { + "name": { + "desc": "The name of the emoji to be removed. Colons (:myemoji:) around the value are not required, although they may be included.", + "example": "", + "name": "name", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Remove an emoji across an Enterprise Grid organization", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "not_an_admin": "This method is only accessible by org owners and Admins.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The Admin APIs feature is not enabled for this team.", + "failure_removing_emoji": "This emoji could not be removed. It might be part of the standard Unicode set or the default Slack package.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "emoji_not_found": "Value passed for name was invalid.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.emoji.remove", + "name": "admin.emoji.remove", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.emoji.rename.json b/lib/slack/web/docs/admin.emoji.rename.json new file mode 100644 index 0000000..6b4037a --- /dev/null +++ b/lib/slack/web/docs/admin.emoji.rename.json @@ -0,0 +1,80 @@ +{ + "args": { + "name": { + "desc": "The name of the emoji to be renamed. Colons (:myemoji:) around the value are not required, although they may be included.", + "example": "", + "name": "name", + "required": true, + "type": "string" + }, + "new_name": { + "desc": "The new name of the emoji.", + "example": "", + "name": "new_name", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Rename an emoji.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "not_an_admin": "This method is only accessible by org owners and Admins.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "error_missing_name": "Value passed for name is missing or empty.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "error_name_taken": "Value passed for name already exists.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The Admin APIs feature is not enabled for this team.", + "error_invalid_emoji_to_rename": "Value passed for name was invalid.", + "failed_to_rename_emoji": "The emoji could not be renamed.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "error_bad_name_i18n": "Value passed for new_name was invalid.", + "error_name_taken_i18n": "The name has already been taken by another emoji, in the international set. Emoji must have unique names.", + "failed_to_fetch_active_team": "There are no active teams on the org and we need at least one.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.emoji.rename", + "name": "admin.emoji.rename", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.inviteRequests.approve.json b/lib/slack/web/docs/admin.inviteRequests.approve.json new file mode 100644 index 0000000..6ead4b5 --- /dev/null +++ b/lib/slack/web/docs/admin.inviteRequests.approve.json @@ -0,0 +1,78 @@ +{ + "args": { + "invite_request_id": { + "desc": "ID of the request to invite.", + "example": "Ir1234", + "name": "invite_request_id", + "required": true, + "type": "string" + }, + "team_id": { + "desc": "ID for the workspace where the invite request was made.", + "example": "", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Approve a workspace invite request.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "failed_to_send_invite": "The actual invite (separate from approval) failed to process. This may happen because the user is disabled, already in the team, etc.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "invalid_request": "The invite_request_id passed is invalid.", + "not_an_admin": "This token doesn't have admin privileges.", + "team_not_found": "The team_id specified wasn't found.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "already_processed": "The invite_request_id passed has already been approved or denied.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The Invite Request Admin APIs are not enabled for this team.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.inviteRequests.approve", + "name": "admin.inviteRequests.approve", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.inviteRequests.approved.list.json b/lib/slack/web/docs/admin.inviteRequests.approved.list.json new file mode 100644 index 0000000..4fcf80d --- /dev/null +++ b/lib/slack/web/docs/admin.inviteRequests.approved.list.json @@ -0,0 +1,82 @@ +{ + "args": { + "cursor": { + "desc": "Value of the next_cursor field sent as part of the previous API response", + "example": "5cweb43", + "name": "cursor", + "required": false, + "type": "string" + }, + "limit": { + "desc": "The number of results that will be returned by the API on each invocation. Must be between 1 - 1000, both inclusive", + "example": "100100", + "name": "limit", + "required": false, + "type": "integer" + }, + "team_id": { + "desc": "ID for the workspace where the invite requests were made.", + "example": "", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "List all approved workspace invite requests.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "not_an_admin": "This token doesn't have admin privileges.", + "team_not_found": "The team_id specified wasn't found.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The Invite Requests admin APIs feature is not enabled", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.inviteRequests.approved.list", + "name": "admin.inviteRequests.approved.list", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.inviteRequests.denied.list.json b/lib/slack/web/docs/admin.inviteRequests.denied.list.json new file mode 100644 index 0000000..9050726 --- /dev/null +++ b/lib/slack/web/docs/admin.inviteRequests.denied.list.json @@ -0,0 +1,82 @@ +{ + "args": { + "cursor": { + "desc": "Value of the next_cursor field sent as part of the previous api response", + "example": "5cweb43", + "name": "cursor", + "required": false, + "type": "string" + }, + "limit": { + "desc": "The number of results that will be returned by the API on each invocation. Must be between 1 - 1000 both inclusive", + "example": "100100", + "name": "limit", + "required": false, + "type": "integer" + }, + "team_id": { + "desc": "ID for the workspace where the invite requests were made", + "example": "T0U9RERW4", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "List all denied workspace invite requests.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "not_an_admin": "This token doesn't have admin privileges.", + "team_not_found": "The team_id specified wasn't found.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The Invite Request admin APIs feature is not enabled", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.inviteRequests.denied.list", + "name": "admin.inviteRequests.denied.list", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.inviteRequests.deny.json b/lib/slack/web/docs/admin.inviteRequests.deny.json new file mode 100644 index 0000000..f13c286 --- /dev/null +++ b/lib/slack/web/docs/admin.inviteRequests.deny.json @@ -0,0 +1,77 @@ +{ + "args": { + "invite_request_id": { + "desc": "ID of the request to invite.", + "example": "Ir1234", + "name": "invite_request_id", + "required": true, + "type": "string" + }, + "team_id": { + "desc": "ID for the workspace where the invite request was made.", + "example": "", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Deny a workspace invite request.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "invalid_request": "The invite_request_id passed is invalid.", + "not_an_admin": "This token doesn't have admin privileges.", + "team_not_found": "The team_id specified wasn't found.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "already_processed": "The request has been previously processed and is not pending anymore", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The Invite Request Admin APIs feature is not enabled", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.inviteRequests.deny", + "name": "admin.inviteRequests.deny", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.inviteRequests.list.json b/lib/slack/web/docs/admin.inviteRequests.list.json new file mode 100644 index 0000000..43eb302 --- /dev/null +++ b/lib/slack/web/docs/admin.inviteRequests.list.json @@ -0,0 +1,82 @@ +{ + "args": { + "cursor": { + "desc": "Value of the next_cursor field sent as part of the previous API response", + "example": "5cweb43", + "name": "cursor", + "required": false, + "type": "string" + }, + "limit": { + "desc": "The number of results that will be returned by the API on each invocation. Must be between 1 - 1000, both inclusive", + "example": "100100", + "name": "limit", + "required": false, + "type": "integer" + }, + "team_id": { + "desc": "ID for the workspace where the invite requests were made.", + "example": "", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "List all pending workspace invite requests.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "not_an_admin": "This token doesn't have admin privileges.", + "team_not_found": "The team_id specified wasn't found.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The Invite Request Admin APIs feature is not enabled", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.inviteRequests.list", + "name": "admin.inviteRequests.list", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.teams.admins.list.json b/lib/slack/web/docs/admin.teams.admins.list.json new file mode 100644 index 0000000..7f060a2 --- /dev/null +++ b/lib/slack/web/docs/admin.teams.admins.list.json @@ -0,0 +1,86 @@ +{ + "args": { + "cursor": { + "desc": "Set cursor to next_cursor returned by the previous call to list items in the next page.", + "example": "dXNlcjpVMEc5V0ZYTlo=", + "name": "cursor", + "required": false, + "type": "string" + }, + "limit": { + "desc": "The maximum number of items to return.", + "example": "200", + "name": "limit", + "required": false, + "type": "integer" + }, + "team_id": { + "desc": "", + "example": "", + "name": "team_id", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "List all of the admins on a given workspace.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "not_an_admin": "This method is only accessible by org owners and admins.", + "team_not_found": "team_id was not found.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "invalid_limit": "Limit must be between 1 and 1000 inclusive.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "invalid_cursor": "Invalid cursor.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The Admin APIs feature is not enabled for this team.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.teams.admins.list", + "name": "admin.teams.admins.list", + "response": { + "admin_ids": [ + "U1234" + ], + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.teams.create.json b/lib/slack/web/docs/admin.teams.create.json new file mode 100644 index 0000000..3d05c15 --- /dev/null +++ b/lib/slack/web/docs/admin.teams.create.json @@ -0,0 +1,96 @@ +{ + "args": { + "team_description": { + "desc": "Description for the team.", + "example": "", + "name": "team_description", + "required": false, + "type": "string" + }, + "team_discoverability": { + "desc": "Who can join the team. A team's discoverability can be open, closed, invite_only, or unlisted.", + "example": "", + "name": "team_discoverability", + "required": false, + "type": "string" + }, + "team_domain": { + "desc": "Team domain (for example, slacksoftballteam). Domains are limited to 21 characters.", + "example": "", + "name": "team_domain", + "required": true, + "type": "string" + }, + "team_name": { + "desc": "Team name (for example, Slack Softball Team).", + "example": "", + "name": "team_name", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Create an Enterprise team.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "bad_url": "Invalid URL. Note that domains can be at most 21 characters.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "not_an_admin": "This method is only accessible by org owners and admins.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "discoverability_setting_invalid": "The given discoverability setting is invalid.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "must_provide_team_domain": "No team domain has been provided.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "name_taken_in_org": "The team with the specified name already exists in the org.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "must_provide_team_name": "No team name has been provided.", + "accesslimited": "Access to this method is limited on the current network", + "domain_taken": "The requested domain is taken.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The Admin APIs feature is not enabled for this team.", + "could_not_create_workspace": "The workspace could not be created.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.teams.create", + "name": "admin.teams.create", + "response": { + "ok": true, + "team": "T12345" + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.teams.list.json b/lib/slack/web/docs/admin.teams.list.json new file mode 100644 index 0000000..21cccec --- /dev/null +++ b/lib/slack/web/docs/admin.teams.list.json @@ -0,0 +1,88 @@ +{ + "args": { + "cursor": { + "desc": "Set cursor to next_cursor returned by the previous call to list items in the next page.", + "example": "5c3e53d5", + "name": "cursor", + "required": false, + "type": "string" + }, + "limit": { + "desc": "The maximum number of items to return. Must be between 1 - 100 both inclusive.", + "example": "10050", + "name": "limit", + "required": false, + "type": "integer" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "List all teams on an Enterprise organization", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "not_an_admin": "This method is only accessible by org owners and admins.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "invalid_limit": "Value passed for limit was not valid.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "invalid_cursor": "Invalid cursor.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The Admin APIs feature is not enabled for this team.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.teams.list", + "name": "admin.teams.list", + "response": { + "ok": true, + "teams": [ + { + "discoverability": "hidden", + "id": "T1234", + "name": "My Team", + "primary_owner": { + "email": "bront@slack.com", + "user_id": "W1234" + }, + "team_url": "https://subarachnoid.slack.com/" + } + ] + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.teams.owners.list.json b/lib/slack/web/docs/admin.teams.owners.list.json new file mode 100644 index 0000000..aab9997 --- /dev/null +++ b/lib/slack/web/docs/admin.teams.owners.list.json @@ -0,0 +1,85 @@ +{ + "args": { + "cursor": { + "desc": "Set cursor to next_cursor returned by the previous call to list items in the next page.", + "example": "5c3e53d5", + "name": "cursor", + "required": false, + "type": "string" + }, + "limit": { + "desc": "The maximum number of items to return. Must be between 1 - 1000 both inclusive.", + "example": "100100", + "name": "limit", + "required": false, + "type": "integer" + }, + "team_id": { + "desc": "", + "example": "", + "name": "team_id", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "List all of the owners on a given workspace.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "not_an_admin": "This method is only accessible by org owners and admins.", + "team_not_found": "`team_id was not found.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "invalid_cursor": "Invalid cursor.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The Admin APIs feature is not enabled for this team.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.teams.owners.list", + "name": "admin.teams.owners.list", + "response": { + "ok": true, + "owner_ids": [ + "U1234" + ] + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.teams.settings.info.json b/lib/slack/web/docs/admin.teams.settings.info.json new file mode 100644 index 0000000..8810a0f --- /dev/null +++ b/lib/slack/web/docs/admin.teams.settings.info.json @@ -0,0 +1,78 @@ +{ + "args": { + "team_id": { + "desc": "", + "example": "", + "name": "team_id", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Fetch information about settings in a workspace", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "team_not_found": "The team_id was not found.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "failed_to_fetch_info": "There was an error fetching info for this workspace.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The Admin APIs feature is not enabled for this team.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.teams.settings.info", + "name": "admin.teams.settings.info", + "response": { + "ok": true, + "team": { + "default_channels": "array", + "domain": "string", + "email_domain": "string", + "enterprise_id": "string", + "enterprise_name": "string", + "icon": "array", + "id": "string", + "name": "string" + } + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.teams.settings.setDefaultChannels.json b/lib/slack/web/docs/admin.teams.settings.setDefaultChannels.json new file mode 100644 index 0000000..626de92 --- /dev/null +++ b/lib/slack/web/docs/admin.teams.settings.setDefaultChannels.json @@ -0,0 +1,76 @@ +{ + "args": { + "channel_ids": { + "desc": "An array of channel IDs.", + "example": "", + "name": "channel_ids", + "required": true, + "type": "array" + }, + "team_id": { + "desc": "ID for the workspace to set the default channel for.", + "example": "", + "name": "team_id", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Set the default channels of a workspace.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "one_or_more_invalid_channels": "One or more of the passed channel IDs was invalid.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "not_an_admin": "This method is only accessible by org owners and admins.", + "team_not_found": "team_id was not found.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The Admin APIs feature is not enabled for this team.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "failed_to_set_default_channels": "We encountered an error while trying to set the default channel.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.teams.settings.setDefaultChannels", + "name": "admin.teams.settings.setDefaultChannels", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.teams.settings.setDescription.json b/lib/slack/web/docs/admin.teams.settings.setDescription.json new file mode 100644 index 0000000..35c0014 --- /dev/null +++ b/lib/slack/web/docs/admin.teams.settings.setDescription.json @@ -0,0 +1,75 @@ +{ + "args": { + "description": { + "desc": "The new description for the workspace.", + "example": "", + "name": "description", + "required": true, + "type": "string" + }, + "team_id": { + "desc": "ID for the workspace to set the description for.", + "example": "", + "name": "team_id", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Set the description of a given workspace.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "team_not_found": "The requested team_id can't be found.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The Admin APIs feature is not enabled for this team.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "failed_to_set_description": "There was an error setting the description.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.teams.settings.setDescription", + "name": "admin.teams.settings.setDescription", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.teams.settings.setDiscoverability.json b/lib/slack/web/docs/admin.teams.settings.setDiscoverability.json new file mode 100644 index 0000000..45e7505 --- /dev/null +++ b/lib/slack/web/docs/admin.teams.settings.setDiscoverability.json @@ -0,0 +1,76 @@ +{ + "args": { + "discoverability": { + "desc": "This workspace's discovery setting. It must be set to one of open, invite_only, closed, or unlisted.", + "example": "", + "name": "discoverability", + "required": true, + "type": "string" + }, + "team_id": { + "desc": "The ID of the workspace to set discoverability on.", + "example": "", + "name": "team_id", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "An API method that allows admins to set the discoverability of a given workspace", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "team_not_found": "The team_id was not found.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "discoverability_setting_invalid": "The discovery setting must be set to one of open, invite_only, closed, or unlisted.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The Admin APIs feature is not enabled for this team.", + "failed_to_set_discoverability": "There was an error setting the discoverability of this workspace.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.teams.settings.setDiscoverability", + "name": "admin.teams.settings.setDiscoverability", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.teams.settings.setIcon.json b/lib/slack/web/docs/admin.teams.settings.setIcon.json new file mode 100644 index 0000000..52256ac --- /dev/null +++ b/lib/slack/web/docs/admin.teams.settings.setIcon.json @@ -0,0 +1,76 @@ +{ + "args": { + "image_url": { + "desc": "Image URL for the icon", + "example": "http://mysite.com/icon.jpeg", + "name": "image_url", + "required": true, + "type": "string" + }, + "team_id": { + "desc": "ID for the workspace to set the icon for.", + "example": "", + "name": "team_id", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Sets the icon of a workspace.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "not_an_admin": "This method is only accessible by org owners and admins.", + "team_not_found": "team_id was not found.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_url": "Invalid url.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "failed_to_set_icon": "Setting the url in the database failed. This may be transient, please try again soon.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The Admin APIs feature is not enabled for this team.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.teams.settings.setIcon", + "name": "admin.teams.settings.setIcon", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.teams.settings.setName.json b/lib/slack/web/docs/admin.teams.settings.setName.json new file mode 100644 index 0000000..106bbdb --- /dev/null +++ b/lib/slack/web/docs/admin.teams.settings.setName.json @@ -0,0 +1,75 @@ +{ + "args": { + "name": { + "desc": "The new name of the workspace.", + "example": "", + "name": "name", + "required": true, + "type": "string" + }, + "team_id": { + "desc": "ID for the workspace to set the name for.", + "example": "", + "name": "team_id", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Set the name of a given workspace.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "failed_to_set_name": "Returned when there is an error to set the name", + "team_not_found": "Returned when team_id can’t be resolved", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The Admin APIs feature is not enabled for this team.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.teams.settings.setName", + "name": "admin.teams.settings.setName", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.usergroups.addChannels.json b/lib/slack/web/docs/admin.usergroups.addChannels.json new file mode 100644 index 0000000..42ecad0 --- /dev/null +++ b/lib/slack/web/docs/admin.usergroups.addChannels.json @@ -0,0 +1,88 @@ +{ + "args": { + "channel_ids": { + "desc": "Comma separated string of channel IDs.", + "example": "C00000000,C00000001", + "name": "channel_ids", + "required": true, + "type": "array" + }, + "team_id": { + "desc": "The workspace to add default channels in.", + "example": "T00000000", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + }, + "usergroup_id": { + "desc": "ID of the IDP group to add default channels for.", + "example": "S00000000", + "name": "usergroup_id", + "required": true, + "type": "string" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Add up to one hundred default channels to an IDP group.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "invalid_channels_limit": "The number of channel IDs passed in is larger than 100.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "usergroup_not_found": "The IDP group provided was not found.", + "not_an_admin": "The token provided is not associated with an Org Admin or Owner.", + "team_not_found": "The workspace provided was not found.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "usergroup_not_linked_to_team": "The IDP group provided is not linked to the workspace.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "usergroup_team_not_provisioned": "The IDP group provided is linked to a workspace that has auto-provision disabled.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The Admin APIs feature is not enabled for this workspace.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "At least one of the provided channel IDs could not be found, or one of the channels has a type that is not supported.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "not_an_enterprise": "The token passed in does not belong to an Enterprise organization.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.usergroups.addChannels", + "name": "admin.usergroups.addChannels", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.usergroups.addTeams.json b/lib/slack/web/docs/admin.usergroups.addTeams.json new file mode 100644 index 0000000..3319b5c --- /dev/null +++ b/lib/slack/web/docs/admin.usergroups.addTeams.json @@ -0,0 +1,83 @@ +{ + "args": { + "auto_provision": { + "desc": "When true, this method automatically creates new workspace accounts for the IDP group members.", + "example": "falsetrue", + "name": "auto_provision", + "required": false, + "type": "boolean" + }, + "team_ids": { + "desc": "A comma separated list of encoded team (workspace) IDs. Each workspace MUST belong to the organization associated with the token.", + "example": "T12345678,T98765432", + "name": "team_ids", + "required": true, + "type": "array" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + }, + "usergroup_id": { + "desc": "An encoded usergroup (IDP Group) ID.", + "example": "S12345678", + "name": "usergroup_id", + "required": true, + "type": "string" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Associate one or more default workspaces with an organization-wide IDP group.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "usergroup_not_found": "usergroup_id wasn't found.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_team_ids": "One or more team IDs provided were invalid; see the errors field in the response for the list of invalid team IDs.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "no_team_ids_given": "The team_ids parameter was empty.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "auto_provision_failure": "A failure occurred while assigning IDP group members to a specific workspace; see errors element for a list of failed team IDs.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.usergroups.addTeams", + "name": "admin.usergroups.addTeams", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.usergroups.listChannels.json b/lib/slack/web/docs/admin.usergroups.listChannels.json new file mode 100644 index 0000000..2251713 --- /dev/null +++ b/lib/slack/web/docs/admin.usergroups.listChannels.json @@ -0,0 +1,112 @@ +{ + "args": { + "include_num_members": { + "desc": "Flag to include or exclude the count of members per channel.", + "example": "true", + "name": "include_num_members", + "required": false, + "type": "boolean" + }, + "team_id": { + "desc": "ID of the the workspace.", + "example": "T00000000", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + }, + "usergroup_id": { + "desc": "ID of the IDP group to list default channels for.", + "example": "S00000000", + "name": "usergroup_id", + "required": true, + "type": "string" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "List the channels linked to an org-level IDP group (user group).", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "usergroup_not_found": "The IDP group provided was not found.", + "not_an_admin": "The token provided is not associated with an Org Admin or Owner.", + "team_not_found": "The workspace was not found.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "not_allowed": "The calling user is not an admin or does not have necessary role", + "usergroup_not_linked_to_team": "The IDP group provided is not linked to the specified workspace.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The Admin APIs feature is not enabled for this workspace.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "not_an_enterprise": "The token passed in does not belong to an Enterprise organization.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_user": "The calling user is not valid.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.usergroups.listChannels", + "name": "admin.usergroups.listChannels", + "response": { + "channels": [ + { + "id": "C024BE91L", + "name": "fun", + "num_members": 34, + "team_id": "T024BE911" + }, + { + "id": "C024BE91K", + "name": "more fun", + "team_id": "T024BE912" + }, + { + "id": "C024BE91M", + "is_redacted": true, + "name": "public-channel", + "num_members": 34, + "team_id": "T024BE911" + }, + { + "id": "C024BE91N", + "name": "some more fun", + "team_id": "T024BE921" + } + ], + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.usergroups.removeChannels.json b/lib/slack/web/docs/admin.usergroups.removeChannels.json new file mode 100644 index 0000000..23f166a --- /dev/null +++ b/lib/slack/web/docs/admin.usergroups.removeChannels.json @@ -0,0 +1,78 @@ +{ + "args": { + "channel_ids": { + "desc": "Comma-separated string of channel IDs", + "example": "C00000000,C00000001", + "name": "channel_ids", + "required": true, + "type": "array" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + }, + "usergroup_id": { + "desc": "ID of the IDP Group", + "example": "S00000000", + "name": "usergroup_id", + "required": true, + "type": "string" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Remove one or more default channels from an org-level IDP group (user group).", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "invalid_channels_limit": "The number of channel IDs passed in is larger than 100.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "usergroup_not_found": "The IDP group provided was not found.", + "not_an_admin": "The token provided is not associated with an Org Admin or Owner.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The Admin APIs feature is not enabled for this workspace.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "At least one of the provided channel IDs could not be found, or one of those channels has a type that is not supported.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "not_an_enterprise": "The token passed in does not belong to an Enterprise organization.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.usergroups.removeChannels", + "name": "admin.usergroups.removeChannels", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.users.assign.json b/lib/slack/web/docs/admin.users.assign.json new file mode 100644 index 0000000..7aa4de2 --- /dev/null +++ b/lib/slack/web/docs/admin.users.assign.json @@ -0,0 +1,103 @@ +{ + "args": { + "channel_ids": { + "desc": "Comma separated values of channel IDs to add user in the new workspace.", + "example": "C123,C3456", + "name": "channel_ids", + "required": false, + "type": "string" + }, + "is_restricted": { + "desc": "True if user should be added to the workspace as a guest.", + "example": "true", + "name": "is_restricted", + "required": false, + "type": "boolean" + }, + "is_ultra_restricted": { + "desc": "True if user should be added to the workspace as a single-channel guest.", + "example": "true", + "name": "is_ultra_restricted", + "required": false, + "type": "boolean" + }, + "team_id": { + "desc": "The ID (T1234) of the workspace.", + "example": "", + "name": "team_id", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + }, + "user_id": { + "desc": "The ID of the user to add to the workspace.", + "example": "", + "name": "user_id", + "required": true, + "type": "string" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Add an Enterprise user to a workspace.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "user_not_found": "user_id was not found.", + "invited_user_not_reactivated": "The invited user could not be reactivated.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "not_an_admin": "This method wasn't called by an admin.", + "team_not_found": "`team_id was not found.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "user_already_team_member": "The given user is already active on the given team.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The Admin APIs feature is not enabled for this team", + "invalid_role_for_user": "The requested status is incompatible with the user's role on another workspace.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "invited_user_not_created": "The invited user could not be created.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "user_is_bot": "The given user is a bot from an app. This api only works with humans.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invitor_cannot_see_channel": "The invitor is not part of one or many channels that the user was requested to be added to", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.users.assign", + "name": "admin.users.assign", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.users.invite.json b/lib/slack/web/docs/admin.users.invite.json new file mode 100644 index 0000000..8a77489 --- /dev/null +++ b/lib/slack/web/docs/admin.users.invite.json @@ -0,0 +1,142 @@ +{ + "args": { + "channel_ids": { + "desc": "A comma-separated list of channel_ids for this user to join. At least one channel is required.", + "example": "C1A2B3C4D,C26Z25Y24", + "name": "channel_ids", + "required": true, + "type": "string" + }, + "custom_message": { + "desc": "An optional message to send to the user in the invite email.", + "example": "Come and join our team!", + "name": "custom_message", + "required": false, + "type": "string" + }, + "email": { + "desc": "The email address of the person to invite.", + "example": "joe@email.com", + "name": "email", + "required": true, + "type": "string" + }, + "email_password_policy_enabled": { + "desc": "Allow invited user to sign in via email and password. Only available for Enterprise Grid teams via admin invite.", + "example": "true", + "name": "email_password_policy_enabled", + "required": false, + "type": "boolean" + }, + "guest_expiration_ts": { + "desc": "Timestamp when guest account should be disabled. Only include this timestamp if you are inviting a guest user and you want their account to expire on a certain date.", + "example": "0123456789.012345", + "name": "guest_expiration_ts", + "required": false, + "type": "string" + }, + "is_restricted": { + "desc": "Is this user a multi-channel guest user? (default: false)", + "example": "true", + "name": "is_restricted", + "required": false, + "type": "boolean" + }, + "is_ultra_restricted": { + "desc": "Is this user a single channel guest user? (default: false)", + "example": "true", + "name": "is_ultra_restricted", + "required": false, + "type": "boolean" + }, + "real_name": { + "desc": "Full name of the user.", + "example": "{\"full_name\":\"Joe Smith\"}", + "name": "real_name", + "required": false, + "type": "string" + }, + "resend": { + "desc": "Allow this invite to be resent in the future if a user has not signed up yet. (default: false)", + "example": "true", + "name": "resend", + "required": false, + "type": "boolean" + }, + "team_id": { + "desc": "The ID (T1234) of the workspace.", + "example": "", + "name": "team_id", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Invite a user to a workspace.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "failed_to_validate_channels": "channel_ids was invalid.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "failed_to_send_invite": "The invite failed to send.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "already_in_team_invited_user": "The user has already been invited to the team.", + "not_an_admin": "The user token does not have admin privileges.", + "team_not_found": "team_id was not found.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "failed_to_validate_expiration": "expiration_ts was invalid.", + "failed_to_validate_caller": "The token calling this method doesn't have permission to invite a user.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "failed_looking_up_user": "We couldn't find the requested user.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The Admin APIs feature is not enabled for this team.", + "failed_to_validate_custom_message": "extra_message was invalid.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "user_disabled": "The user is disabled.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "already_in_team": "The user is already on the team.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "failed_to_validate_team": "The team calling this method was invalid.", + "invalid_email": "Email address was not valid.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.users.invite", + "name": "admin.users.invite", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.users.list.json b/lib/slack/web/docs/admin.users.list.json new file mode 100644 index 0000000..31083d8 --- /dev/null +++ b/lib/slack/web/docs/admin.users.list.json @@ -0,0 +1,94 @@ +{ + "args": { + "cursor": { + "desc": "Set cursor to next_cursor returned by the previous call to list items in the next page.", + "example": "5c3e53d5", + "name": "cursor", + "required": false, + "type": "string" + }, + "limit": { + "desc": "Limit for how many users to be retrieved per page", + "example": "10050", + "name": "limit", + "required": false, + "type": "integer" + }, + "team_id": { + "desc": "The ID (T1234) of the workspace. The team_id is required if you use an org-level token.", + "example": "", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "List users on a workspace", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "team_not_found": "team_id was not found.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "invalid_cursor": "The passed cursor could not be validated.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The Admin APIs feature is not enabled for this team.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.users.list", + "name": "admin.users.list", + "response": { + "ok": true, + "users": [ + { + "email": "bront@slack.com", + "id": "T1234", + "is_admin": false, + "is_bot": false, + "is_owner": false, + "is_primary_owner": false, + "is_restricted": false, + "is_ultra_restricted": false + } + ] + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.users.remove.json b/lib/slack/web/docs/admin.users.remove.json new file mode 100644 index 0000000..9b38967 --- /dev/null +++ b/lib/slack/web/docs/admin.users.remove.json @@ -0,0 +1,79 @@ +{ + "args": { + "team_id": { + "desc": "The ID (T1234) of the workspace.", + "example": "", + "name": "team_id", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + }, + "user_id": { + "desc": "The ID of the user to remove.", + "example": "W12345678", + "name": "user_id", + "required": true, + "type": "string" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Remove a user from a workspace.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "user_not_found": "The user was not found.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "team_not_found": "team_id was not found.", + "cannot_modify_primary_owner": "The primary owner cannot be modified.", + "access_denied": "Access to a resource specified in the request is denied.", + "failed_to_remove_user_from_workspace": "Removing this user from the workspace failed.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "invalid_permissions": "This method is only accessible by org owners and admins.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "user_already_deleted": "The requested user has already been marked as deleted.", + "feature_not_enabled": "The Admin APIs feature is not enabled for this team.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.users.remove", + "name": "admin.users.remove", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.users.session.clearSettings.json b/lib/slack/web/docs/admin.users.session.clearSettings.json new file mode 100644 index 0000000..b4fb430 --- /dev/null +++ b/lib/slack/web/docs/admin.users.session.clearSettings.json @@ -0,0 +1,71 @@ +{ + "args": { + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + }, + "user_ids": { + "desc": "The IDs of users you'd like to clear session settings for.", + "example": "['U1234']", + "name": "user_ids", + "required": true, + "type": "array" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Clear user-specific session settings—the session duration and what happens when the client closes—for a list of users.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "user_not_found": "There was an error finding a requested user.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "bots_not_allowed": "Bot users may not have their settings cleared.", + "not_an_admin": "The owner of this token isn't an Org Owner or Admin.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "unknown_method": "This method is currently not available.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "admin_unauthorized": "The owner of this token isn't authorized to clear sessions.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "This method is only available to Enterprise customers.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.users.session.clearSettings", + "name": "admin.users.session.clearSettings", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.users.session.getSettings.json b/lib/slack/web/docs/admin.users.session.getSettings.json new file mode 100644 index 0000000..4004b13 --- /dev/null +++ b/lib/slack/web/docs/admin.users.session.getSettings.json @@ -0,0 +1,79 @@ +{ + "args": { + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + }, + "user_ids": { + "desc": "The IDs of users you'd like to fetch session settings for. Note: if a user does not have any active sessions, they will not be returned in the response.", + "example": "['U1234']", + "name": "user_ids", + "required": true, + "type": "array" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Get user-specific session settings—the session duration and what happens when the client closes—given a list of users.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "user_not_found": "There was an error finding the requested user.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "bots_not_allowed": "Bot sessions are not listed by this method.", + "not_an_admin": "The owner of this token isn't an Org Owner or Admin.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "unknown_method": "This method is currently not available.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "admin_unauthorized": "The owner of this token isn't authorized to list sessions.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "This method is only available to Enterprise customers.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.users.session.getSettings", + "name": "admin.users.session.getSettings", + "response": { + "no_settings_applied": [], + "ok": true, + "session_settings": [ + { + "desktop_app_browser_quit": true, + "duration": 315569520, + "user_id": "U1234" + } + ] + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.users.session.invalidate.json b/lib/slack/web/docs/admin.users.session.invalidate.json new file mode 100644 index 0000000..ac0e971 --- /dev/null +++ b/lib/slack/web/docs/admin.users.session.invalidate.json @@ -0,0 +1,81 @@ +{ + "args": { + "session_id": { + "desc": "ID of the session to invalidate.", + "example": "12345", + "name": "session_id", + "required": true, + "type": "integer" + }, + "team_id": { + "desc": "ID of the workspace that the session belongs to.", + "example": "T1234", + "name": "team_id", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Revoke a single session for a user. The user will be forced to login to Slack.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "user_not_found": "The requested user wasn't found.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "session_invalidation_failed": "There was an error invalidating the session.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "not_an_admin": "This method must be called by an Org Owner or Admin.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "session_not_found": "The requested session wasn't found.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "unknown_method": "This method is currently not available.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "admin_unauthorized": "The token provided doesn't have permission to revoke a session.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The token provided can't call this method.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "session_expired": "The requested session has already expired.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "cannot_invalidate_primary_owner": "Only the primary owner of an organization can invalidate a primary owner's sessions.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.users.session.invalidate", + "name": "admin.users.session.invalidate", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.users.session.list.json b/lib/slack/web/docs/admin.users.session.list.json new file mode 100644 index 0000000..ebd5342 --- /dev/null +++ b/lib/slack/web/docs/admin.users.session.list.json @@ -0,0 +1,118 @@ +{ + "args": { + "cursor": { + "desc": "Set cursor to next_cursor returned by the previous call to list items in the next page.", + "example": "5c3e53d5", + "name": "cursor", + "required": false, + "type": "string" + }, + "limit": { + "desc": "The maximum number of items to return. Must be between 1 - 1000 both inclusive.", + "example": "1000100", + "name": "limit", + "required": false, + "type": "integer" + }, + "team_id": { + "desc": "The ID of the workspace you'd like active sessions for. If you pass a team_id, you'll need to pass a user_id as well.", + "example": "T1234", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + }, + "user_id": { + "desc": "The ID of user you'd like active sessions for. If you pass a user_id, you'll need to pass a team_id as well.", + "example": "U1234", + "name": "user_id", + "required": false, + "type": "string" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "List active user sessions for an organization", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "user_not_found": "There was an error finding the requested user.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "bots_not_allowed": "Bot sessions are not listed by this method.", + "not_an_admin": "The owner of this token isn't an Org Owner or Admin.", + "team_not_found": "There was an error finding the requested workspace.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "no_active_sessions": "No active sessions were found.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "unknown_method": "This method is currently not available.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "admin_unauthorized": "The owner of this token isn't authorized to list sessions.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "invalid_cursor": "The cursor passed was invalid.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "This method is only available to Enterprise customers.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "missing_user": "A user_id must be provided with a team_id.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "missing_team": "A team_id must be provided with a user_id.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.users.session.list", + "name": "admin.users.session.list", + "response": { + "active_sessions": [ + { + "created": { + "device_hardware": "Intel", + "ip": "24.6.145.138", + "os": "OS X", + "os_version": "10.15.7", + "slack_client_version": "91.0.4472.77" + }, + "recent": { + "device_hardware": "Intel", + "ip": "24.6.145.138", + "os": "OS X", + "os_version": "10.15.7", + "slack_client_version": "91.0.4472.77" + }, + "session_id": 1112275520242, + "team_id": "E011E2SBBFC", + "user_id": "U012S9M77JP" + } + ], + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.users.session.reset.json b/lib/slack/web/docs/admin.users.session.reset.json new file mode 100644 index 0000000..9732831 --- /dev/null +++ b/lib/slack/web/docs/admin.users.session.reset.json @@ -0,0 +1,86 @@ +{ + "args": { + "mobile_only": { + "desc": "Only expire mobile sessions (default: false)", + "example": "true", + "name": "mobile_only", + "required": false, + "type": "boolean" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + }, + "user_id": { + "desc": "The ID of the user to wipe sessions for", + "example": "W12345678", + "name": "user_id", + "required": true, + "type": "string" + }, + "web_only": { + "desc": "Only expire web sessions (default: false)", + "example": "true", + "name": "web_only", + "required": false, + "type": "boolean" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Wipes all valid sessions on all devices for a given user", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "user_not_found": "Error fetching user", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "not_an_admin": "This method is only accessible by org/compliance team owners and admins", + "user_session_reset_failed": "There was an error starting the session reset. Try again.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "unknown_method": "This method is currently not available", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "cannot_reset_bot": "Cannot reset bot users", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "This method is not available for this product level", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "cannot_reset_primary_owner": "Only primary owner can reset primary owner's sessions", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.users.session.reset", + "name": "admin.users.session.reset", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.users.session.resetBulk.json b/lib/slack/web/docs/admin.users.session.resetBulk.json new file mode 100644 index 0000000..47f0ae3 --- /dev/null +++ b/lib/slack/web/docs/admin.users.session.resetBulk.json @@ -0,0 +1,88 @@ +{ + "args": { + "mobile_only": { + "desc": "Only expire mobile sessions (default: false)", + "example": "true", + "name": "mobile_only", + "required": false, + "type": "boolean" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + }, + "user_ids": { + "desc": "The ID of the user to wipe sessions for", + "example": "[\"W12345678\", \"W98765432\"]", + "name": "user_ids", + "required": true, + "type": "array" + }, + "web_only": { + "desc": "Only expire web sessions (default: false)", + "example": "true", + "name": "web_only", + "required": false, + "type": "boolean" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Enqueues an asynchronous job to wipe all valid sessions on all devices for a given list of users", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "user_not_found": "Error fetching user", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "not_an_admin": "This method is only accessible by org/compliance team owners and admins", + "user_session_reset_failed": "There was an error starting the session reset. Try again.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "unknown_method": "This method is currently not available", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "cannot_reset_bot": "Cannot reset bot users", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "This method is not available for this product level", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "cannot_reset_primary_owner": "Only primary owner can reset primary owner's sessions", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "session_reset_not_allowed": "Only primary owner can reset primary owner's sessions", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "failed_for_some_users": "Some user ids failed to have their session invalidated. Details in extended comments", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.users.session.resetBulk", + "name": "admin.users.session.resetBulk", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.users.session.setSettings.json b/lib/slack/web/docs/admin.users.session.setSettings.json new file mode 100644 index 0000000..8705fcf --- /dev/null +++ b/lib/slack/web/docs/admin.users.session.setSettings.json @@ -0,0 +1,87 @@ +{ + "args": { + "desktop_app_browser_quit": { + "desc": "Terminate the session when the client—either the desktop app or a browser window—is closed.", + "example": "true", + "name": "desktop_app_browser_quit", + "required": false, + "type": "boolean" + }, + "duration": { + "desc": "The session duration, in seconds. The minimum value is 28800, which represents 8 hours; the max value is 315569520 or 10 years (that's a long Slack session).", + "example": "86400", + "name": "duration", + "required": false, + "type": "integer" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + }, + "user_ids": { + "desc": "The list of up to 1,000 user IDs to apply the session settings for", + "example": "['U12345','U67890']", + "name": "user_ids", + "required": true, + "type": "array" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Configure the user-level session settings—the session duration and what happens when the client closes—for one or more users.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "user_not_found": "At least one of the requested users doesn't exist.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "bots_not_allowed": "Bot sessions are not listed by this method.", + "not_an_admin": "This method is only accessible by Org Owners and Admins", + "unable_to_update_existing_sessions": "The session settings could not be applied to users' existing sessions.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "unknown_method": "This method is currently not available.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "admin_unauthorized": "The token provided doesn't have permission to revoke a session.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "at_least_one_session_setting_required": "At least one session setting is required.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "This method is only available for Enterprise organizations.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.users.session.setSettings", + "name": "admin.users.session.setSettings", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.users.setAdmin.json b/lib/slack/web/docs/admin.users.setAdmin.json new file mode 100644 index 0000000..9b4ef09 --- /dev/null +++ b/lib/slack/web/docs/admin.users.setAdmin.json @@ -0,0 +1,80 @@ +{ + "args": { + "team_id": { + "desc": "The ID (T1234) of the workspace.", + "example": "", + "name": "team_id", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + }, + "user_id": { + "desc": "The ID of the user to designate as an admin.", + "example": "W12345678", + "name": "user_id", + "required": true, + "type": "string" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Set an existing guest, regular user, or owner to be an admin user.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "user_not_found": "The user was not found.", + "failed_to_set_user_to_admin": "Designating this user as an admin failed.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "not_an_admin": "This method can only be accessed by org owners and admins.", + "team_not_found": "team_id was not found.", + "cannot_modify_primary_owner": "The primary owner cannot be modified.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "invalid_permissions": "This method is only accessible by org owners and admins.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The Admin APIs feature is not enabled for this team.", + "invalid_role_for_user": "The user cannot be made into an admin.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.users.setAdmin", + "name": "admin.users.setAdmin", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.users.setExpiration.json b/lib/slack/web/docs/admin.users.setExpiration.json new file mode 100644 index 0000000..1a833ce --- /dev/null +++ b/lib/slack/web/docs/admin.users.setExpiration.json @@ -0,0 +1,90 @@ +{ + "args": { + "expiration_ts": { + "desc": "Timestamp when guest account should be disabled.", + "example": "1234567890", + "name": "expiration_ts", + "required": true, + "type": "integer" + }, + "team_id": { + "desc": "The ID (T1234) of the workspace.", + "example": "", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + }, + "user_id": { + "desc": "The ID of the user to set an expiration for.", + "example": "W12345678", + "name": "user_id", + "required": true, + "type": "string" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Set an expiration for a guest user", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "user_not_found": "The user could not be found.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "failed_to_set_expiration": "The expiration could not be set for the user.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "team_id_required_for_enterprise": "Team ID required.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "team_not_found": "team_id was not found.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "failed_to_validate_expiration": "expiration_ts was invalid.", + "failed_to_validate_caller": "The token calling this method doesn't have permission to invite a user.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "failed_looking_up_user": "We couldn't find the requested user.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "user_is_already_deleted": "The user has already been deleted and disabled.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The Admin APIs feature is not enabled for this team.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "user_is_not_a_guest": "The passed user_id does not belong to a guest user.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "failed_to_validate_team": "The team calling this method was invalid.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.users.setExpiration", + "name": "admin.users.setExpiration", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.users.setOwner.json b/lib/slack/web/docs/admin.users.setOwner.json new file mode 100644 index 0000000..e5d2dff --- /dev/null +++ b/lib/slack/web/docs/admin.users.setOwner.json @@ -0,0 +1,81 @@ +{ + "args": { + "team_id": { + "desc": "The ID (T1234) of the workspace.", + "example": "", + "name": "team_id", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + }, + "user_id": { + "desc": "Id of the user to promote to owner.", + "example": "", + "name": "user_id", + "required": true, + "type": "string" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Set an existing guest, regular user, or admin user to be a workspace owner.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "user_not_found": "The requested user was not found.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "not_an_admin": "This method can only be accessed by org owners and admins.", + "team_not_found": "team_id was not found.", + "cannot_modify_primary_owner": "The primary owner cannot be modified.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "failed_to_set_user_to_owner": "The change to the user's role failed.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The Admin APIs feature is not enabled for this team.", + "invalid_role_for_user": "The user cannot be made into an owner.", + "not_supported": "This is not a supported action.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "user_must_be_in_workspace": "This user must be a member of at least one workspace.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.users.setOwner", + "name": "admin.users.setOwner", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.users.setRegular.json b/lib/slack/web/docs/admin.users.setRegular.json new file mode 100644 index 0000000..cc1ac31 --- /dev/null +++ b/lib/slack/web/docs/admin.users.setRegular.json @@ -0,0 +1,79 @@ +{ + "args": { + "team_id": { + "desc": "The ID (T1234) of the workspace.", + "example": "", + "name": "team_id", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + }, + "user_id": { + "desc": "The ID of the user to designate as a regular user.", + "example": "W12345678", + "name": "user_id", + "required": true, + "type": "string" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Set an existing guest user, admin user, or owner to be a regular user.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "user_not_found": "The requested user was not found.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "not_an_admin": "This method can only be accessed by org owners and admins.", + "team_not_found": "team_id was not found.", + "cannot_modify_primary_owner": "The primary owner cannot be modified.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "failed_to_set_user_to_regular": "Changing a user to a regular member failed.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "feature_not_enabled": "The Admin APIs feature is not enabled for this team.", + "cannot_set_this_guest_to_regular_at_team_level": "This guest is active on multiple workspaces so cannot set it to regular on one team. Set at enterprise level", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/admin.users.setRegular", + "name": "admin.users.setRegular", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/admin.users.unsupportedVersions.export.json b/lib/slack/web/docs/admin.users.unsupportedVersions.export.json new file mode 100644 index 0000000..23bb8c7 --- /dev/null +++ b/lib/slack/web/docs/admin.users.unsupportedVersions.export.json @@ -0,0 +1,73 @@ +{ + "args": { + "date_end_of_support": { + "desc": "Unix timestamp of the date of past or upcoming end of support cycles. If not provided will include all announced end of support cycles.", + "example": "0", + "name": "date_end_of_support", + "required": false, + "type": "integer" + }, + "date_sessions_started": { + "desc": "Unix timestamp of a date to start looking for user sessions. If not provided will start six months ago.", + "example": "0", + "name": "date_sessions_started", + "required": false, + "type": "integer" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Ask Slackbot to send you an export listing all workspace members using unsupported software, presented as a zipped CSV file.", + "errors": { + "access_denied": "Access to a resource specified in the request is denied.", + "accesslimited": "Access to this method is limited on the current network", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "could_not_export": "For some reason, the export could not be started", + "deprecated_endpoint": "The endpoint has been deprecated.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "invalid_team_id": "The team ID passed is invalid", + "is_bot": "This method cannot be called by a bot user.", + "method_deprecated": "The method has been deprecated.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "not_authed": "No authentication token provided.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "service_unavailable": "The service is temporarily unavailable", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_expired": "Authentication token has expired", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "two_factor_setup_required": "Two factor setup is required." + }, + "is_deprecated": false, + "link": "/methods/admin.users.unsupportedVersions.export", + "name": "admin.users.unsupportedVersions.export", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/api.test.json b/lib/slack/web/docs/api.test.json index e6ff8a8..b8e6460 100644 --- a/lib/slack/web/docs/api.test.json +++ b/lib/slack/web/docs/api.test.json @@ -3,14 +3,40 @@ "error": { "desc": "Error response to return", "example": "my_error", - "required": false - }, - "foo": { - "desc": "example property to return", - "example": "bar", - "required": false + "name": "error", + "required": false, + "type": "string" } }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], "desc": "Checks API calling code.", - "errors": {} + "errors": { + "accesslimited": "Access to this method is limited on the current network", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "service_unavailable": "The service is temporarily unavailable", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete." + }, + "is_deprecated": false, + "link": "/methods/api.test", + "name": "api.test", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } } \ No newline at end of file diff --git a/lib/slack/web/docs/apps.connections.open.json b/lib/slack/web/docs/apps.connections.open.json new file mode 100644 index 0000000..6383c3a --- /dev/null +++ b/lib/slack/web/docs/apps.connections.open.json @@ -0,0 +1,62 @@ +{ + "args": { + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Generate a temporary Socket Mode WebSocket URL that your app can connect to in order to receive events and interactive payloads over,", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "missing_args": "An app-level token wasn't provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "forbidden_team": "The authenticated team cannot use this API", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "insecure_request": "The method was not called via a POST request.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/apps.connections.open", + "name": "apps.connections.open", + "response": { + "ok": true, + "url": "wss://wss-somethiing.slack.com/link/?ticket=12348&app_id=5678" + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/apps.event.authorizations.list.json b/lib/slack/web/docs/apps.event.authorizations.list.json new file mode 100644 index 0000000..006bbf6 --- /dev/null +++ b/lib/slack/web/docs/apps.event.authorizations.list.json @@ -0,0 +1,96 @@ +{ + "args": { + "cursor": { + "desc": "", + "example": "", + "name": "cursor", + "required": false, + "type": "string" + }, + "event_context": { + "desc": "", + "example": "", + "name": "event_context", + "required": true, + "type": "string" + }, + "limit": { + "desc": "", + "example": "", + "name": "limit", + "required": false, + "type": "integer" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Get a list of authorizations for the given event context. Each authorization represents an app installation that the event is visible to.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "auth_mismatch": "The given authorization token is not associated with the app that sent this event.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_event_context": "The given event_context didn't match an event.", + "accesslimited": "Access to this method is limited on the current network", + "invalid_cursor": "The cursor argument was invalid.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/apps.event.authorizations.list", + "name": "apps.event.authorizations.list", + "response": { + "authorizations": [ + { + "enterprise_id": "string", + "is_bot": "string", + "team_id": "string", + "user_id": "string" + }, + { + "enterprise_id": "string2", + "is_bot": "string2", + "team_id": "string2", + "user_id": "string2" + } + ], + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/apps.manifest.create.json b/lib/slack/web/docs/apps.manifest.create.json new file mode 100644 index 0000000..85c16f4 --- /dev/null +++ b/lib/slack/web/docs/apps.manifest.create.json @@ -0,0 +1,78 @@ +{ + "args": { + "manifest": { + "desc": "A JSON app manifest encoded as a string. This manifest must use a valid app manifest schema - read our guide to creating one.", + "example": "", + "name": "manifest", + "required": true, + "type": "manifest object as string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Create an app from an app manifest.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_app": "An app created from the provided manifest would not be valid.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "unknown_method": "Unknown method", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "invalid_manifest": "The provided manifest file does not validate against schema. Consult the additional errors field to locate specific issues.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "failed_adding_collaborator": "Failed writing a collaborator record for this new app", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "failed_creating_app": "Failed to create the app model", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/apps.manifest.create", + "name": "apps.manifest.create", + "response": { + "app_id": "A012ABCD0A0", + "credentials": { + "client_id": "...", + "client_secret": "...", + "signing_secret": "...", + "verification_token": "..." + }, + "oauth_authorize_url": "https://slack.com/oauth/v2/authorize?client_id=...&scope=commands,workflow.steps:execute", + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/apps.manifest.delete.json b/lib/slack/web/docs/apps.manifest.delete.json new file mode 100644 index 0000000..0fac5cd --- /dev/null +++ b/lib/slack/web/docs/apps.manifest.delete.json @@ -0,0 +1,69 @@ +{ + "args": { + "app_id": { + "desc": "The ID of the app you want to delete.", + "example": "", + "name": "app_id", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Permanently deletes an app created through app manifests", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "invalid_app_id": "The app ID passed in was invalid.", + "app_not_eligible": "The specified app is not elgible for this API.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "app_not_found": "The specified app was not found.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "published_app_only": "This action is only permitted for published app IDs.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/apps.manifest.delete", + "name": "apps.manifest.delete", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/apps.manifest.export.json b/lib/slack/web/docs/apps.manifest.export.json new file mode 100644 index 0000000..c061703 --- /dev/null +++ b/lib/slack/web/docs/apps.manifest.export.json @@ -0,0 +1,132 @@ +{ + "args": { + "app_id": { + "desc": "The ID of the app whose configuration you want to export as a manifest.", + "example": "", + "name": "app_id", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Export an app manifest from an existing app", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "failed_export": "Failed to export manifest for given app ID", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "invalid_app_id": "The app ID passed is invalid.", + "app_not_eligible": "The specified app is not elgible for this API.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "unknown_method": "This method does not exist.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "app_not_found": "The specified app was not found.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/apps.manifest.export", + "name": "apps.manifest.export", + "response": { + "manifest": { + "_metadata": { + "major_version": 1, + "minor_version": 1 + }, + "display_information": { + "background_color": "#0000AA", + "description": "You are likely to be eaten by a grue.", + "long_description": "Play the Infocom classic text adventure and find your way to the end of the maze. ZORK is a game of adventure, danger, and low cunning. In it you will explore some of the most amazing territory ever seen by mortals. No workspace should be without one!", + "name": "Zork" + }, + "features": { + "app_home": { + "home_tab_enabled": true, + "messages_tab_enabled": false, + "messages_tab_read_only_enabled": false + }, + "bot_user": { + "always_online": true, + "display_name": "zork" + }, + "slash_commands": [ + { + "command": "/zork", + "description": "You are standing in an open field west of a white house, with a boarded front door. There is a small mailbox here.", + "should_escape": false, + "usage_hint": "/zork open mailbox" + } + ], + "workflow_steps": [ + { + "callback_id": "tutorial_example_step", + "name": "Example step" + } + ] + }, + "oauth_config": { + "redirect_urls": [ + "https://example.com/slack/auth" + ], + "scopes": { + "bot": [ + "commands", + "workflow.steps:execute" + ] + } + }, + "settings": { + "event_subscriptions": { + "bot_events": [ + "workflow_step_execute" + ] + }, + "interactivity": { + "is_enabled": true + }, + "is_hosted": false, + "org_deploy_enabled": false, + "socket_mode_enabled": true, + "token_rotation_enabled": false + } + }, + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/apps.manifest.update.json b/lib/slack/web/docs/apps.manifest.update.json new file mode 100644 index 0000000..22ca719 --- /dev/null +++ b/lib/slack/web/docs/apps.manifest.update.json @@ -0,0 +1,81 @@ +{ + "args": { + "app_id": { + "desc": "The ID of the app whose configuration you want to update.", + "example": "", + "name": "app_id", + "required": true, + "type": "string" + }, + "manifest": { + "desc": "A JSON app manifest encoded as a string. This manifest must use a valid app manifest schema - read our guide to creating one. As this method entirely replaces any previous configuration, manifest must contain both unmodified and modified fields.", + "example": "", + "name": "manifest", + "required": true, + "type": "manifest object as string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Update an app from an app manifest", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "invalid_app_id": "The app id passed is invalid.", + "app_not_eligible": "The specified app is not elgible for this API.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_app": "An app created from the provided manifest would not be valid.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "unknown_method": "Unknown method", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "invalid_manifest": "The provided manifest file does not validate against schema.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "failed_adding_collaborator": "Failed writing a collaborator record for this new app", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "failed_creating_app": "Failed to create the app model", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/apps.manifest.update", + "name": "apps.manifest.update", + "response": { + "app_id": "A012ABCD0A0", + "ok": true, + "permissions_updated": false + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/apps.manifest.validate.json b/lib/slack/web/docs/apps.manifest.validate.json new file mode 100644 index 0000000..5e9226e --- /dev/null +++ b/lib/slack/web/docs/apps.manifest.validate.json @@ -0,0 +1,79 @@ +{ + "args": { + "app_id": { + "desc": "The ID of the app whose configuration you want to validate.", + "example": "", + "name": "app_id", + "required": false, + "type": "string" + }, + "manifest": { + "desc": "The manifest to be validated. Will be validated against the app manifest schema - read our guide.", + "example": "", + "name": "manifest", + "required": true, + "type": "manifest object as string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Validate an app manifest", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "app_not_eligible": "The specified app is not elgible for this API.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_app": "An app created from the provided manifest would not be valid.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "unknown_method": "Unknown method", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "invalid_manifest": "The provided manifest file does not validate against schema.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "failed_adding_collaborator": "Failed writing a collaborator record for this new app", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "failed_creating_app": "Failed to create the app model", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/apps.manifest.validate", + "name": "apps.manifest.validate", + "response": { + "errors": [], + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/apps.uninstall.json b/lib/slack/web/docs/apps.uninstall.json index 9788a2d..6ac8756 100644 --- a/lib/slack/web/docs/apps.uninstall.json +++ b/lib/slack/web/docs/apps.uninstall.json @@ -2,25 +2,73 @@ "args": { "client_id": { "desc": "Issued when you created your application.", - "example": "4b39e9-752c4", - "required": true + "example": "56579136444.26251006572", + "name": "client_id", + "required": true, + "type": "string" }, "client_secret": { "desc": "Issued when you created your application.", - "example": "33fea0113f5b1", - "required": true + "example": "f25b5ceaf8a3c2a2c4f52bb4f0b0499e", + "name": "client_secret", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" } }, + "content_types": [ + "application/x-www-form-urlencoded" + ], "desc": "Uninstalls your app from a workspace.", "errors": { - "account_inactive": "Authentication token is for a deleted user or workspace.", - "bad_client_secret": "Value passed for `client_secret` was invalid.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "bad_client_secret": "Value passed for client_secret was invalid.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", "client_id_token_mismatch": "The provided client ID and token do not belong to the same app.", + "invalid_client_id": "Value passed for client_id was invalid.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", - "invalid_client_id": "Value passed for `client_id` was invalid.", - "is_bot": "This method cannot be called by a bot user.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", - "not_authed": "No authentication token provided.", - "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed." + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/apps.uninstall", + "name": "apps.uninstall", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/auth.revoke.json b/lib/slack/web/docs/auth.revoke.json index 0e97758..a256394 100644 --- a/lib/slack/web/docs/auth.revoke.json +++ b/lib/slack/web/docs/auth.revoke.json @@ -2,14 +2,64 @@ "args": { "test": { "desc": "Setting this parameter to 1 triggers a testing mode where the specified token will not actually be revoked.", - "example": true, - "required": false + "example": "true", + "name": "test", + "required": false, + "type": "boolean" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" } }, + "content_types": [ + "application/x-www-form-urlencoded" + ], "desc": "Revokes a token.", "errors": { + "access_denied": "Access to a resource specified in the request is denied.", + "accesslimited": "Access to this method is limited on the current network", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "method_deprecated": "The method has been deprecated.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_allowed_token_type": "The token type used in this request is not allowed.", "not_authed": "No authentication token provided.", - "not_bearer_token": "Incompatible token type provided" + "not_bearer_token": "Incompatible token type provided", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "service_unavailable": "The service is temporarily unavailable", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_expired": "Authentication token has expired", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "two_factor_setup_required": "Two factor setup is required." + }, + "is_deprecated": false, + "link": "/methods/auth.revoke", + "name": "auth.revoke", + "response": { + "ok": true, + "revoked": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/auth.teams.list.json b/lib/slack/web/docs/auth.teams.list.json new file mode 100644 index 0000000..6e09963 --- /dev/null +++ b/lib/slack/web/docs/auth.teams.list.json @@ -0,0 +1,93 @@ +{ + "args": { + "cursor": { + "desc": "Set cursor to next_cursor returned by the previous call to list items in the next page.", + "example": "5c3e53d5", + "name": "cursor", + "required": false, + "type": "string" + }, + "include_icon": { + "desc": "Whether to return icon paths for each workspace. An icon path represents a URI pointing to the image signifying the workspace.", + "example": "falsefalse", + "name": "include_icon", + "required": false, + "type": "boolean" + }, + "limit": { + "desc": "The maximum number of workspaces to return. Must be a positive integer no larger than 1000.", + "example": "10050", + "name": "limit", + "required": false, + "type": "integer" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "List the workspaces a token can access.", + "errors": { + "access_denied": "Access to a resource specified in the request is denied.", + "accesslimited": "Access to this method is limited on the current network", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_cursor": "Invalid cursor.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_limit": "The value passed for limit was not valid.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "is_bot": "This method cannot be called by a bot user.", + "method_deprecated": "The method has been deprecated.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "not_authed": "No authentication token provided.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "service_unavailable": "The service is temporarily unavailable", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_expired": "Authentication token has expired", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "two_factor_setup_required": "Two factor setup is required." + }, + "is_deprecated": false, + "link": "/methods/auth.teams.list", + "name": "auth.teams.list", + "response": { + "ok": true, + "response_metadata": { + "next_cursor": "dXNlcl9pZDo5MTQyOTI5Mzkz" + }, + "teams": [ + { + "id": "T12345678", + "name": "Shinichi's workspace" + }, + { + "id": "T12345679", + "name": "Migi's workspace" + } + ] + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/auth.test.json b/lib/slack/web/docs/auth.test.json index 03e6103..1ea63df 100644 --- a/lib/slack/web/docs/auth.test.json +++ b/lib/slack/web/docs/auth.test.json @@ -1,5 +1,62 @@ { - "args": {}, + "args": { + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], "desc": "Checks authentication & identity.", - "errors": {} + "errors": { + "access_denied": "Access to a resource specified in the request is denied.", + "accesslimited": "Access to this method is limited on the current network", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "method_deprecated": "The method has been deprecated.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "not_authed": "No authentication token provided.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "service_unavailable": "The service is temporarily unavailable", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_expired": "Authentication token has expired", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "two_factor_setup_required": "Two factor setup is required." + }, + "is_deprecated": false, + "link": "/methods/auth.test", + "name": "auth.test", + "response": { + "ok": true, + "team": "Subarachnoid Workspace", + "team_id": "T12345678", + "url": "https://subarachnoid.slack.com/", + "user": "grace", + "user_id": "W12345678" + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } } \ No newline at end of file diff --git a/lib/slack/web/docs/bookmarks.add.json b/lib/slack/web/docs/bookmarks.add.json new file mode 100644 index 0000000..b3fa705 --- /dev/null +++ b/lib/slack/web/docs/bookmarks.add.json @@ -0,0 +1,137 @@ +{ + "args": { + "channel_id": { + "desc": "Channel to add bookmark in.", + "example": "C1234567890", + "name": "channel_id", + "required": true, + "type": "string" + }, + "emoji": { + "desc": "Emoji tag to apply to the link.", + "example": "", + "name": "emoji", + "required": false, + "type": "string" + }, + "entity_id": { + "desc": "ID of the entity being bookmarked. Only applies to message and file types.", + "example": "", + "name": "entity_id", + "required": false, + "type": "string" + }, + "link": { + "desc": "Link to bookmark.", + "example": "", + "name": "link", + "required": false, + "type": "string" + }, + "parent_id": { + "desc": "Id of this bookmark's parent", + "example": "", + "name": "parent_id", + "required": false, + "type": "string" + }, + "title": { + "desc": "Title for the bookmark.", + "example": "", + "name": "title", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + }, + "type": { + "desc": "Type of the bookmark i.e link.", + "example": "", + "name": "type", + "required": true, + "type": "string" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Add bookmark to a channel.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "parent_with_link": "Parent bookmark should not have link.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "permission_denied": "No permission to perform this operation.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "parent_bookmark_disabled": "Parent bookmark feature flag is off.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_bookmark_type": "Bookmark type is not valid.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "invalid_child_type": "Child type is not valid.", + "invalid_entity_id": "Invalid entity_id, file or message type bookmark should have original file or message ID.", + "file_not_found": "File cannot be found.", + "invalid_parent_type": "Parent type is not valid.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "invalid_link": "Invalid link, link should begin with either http:// or https://.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "Channel cannot be found.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "not_implemented": "bookmarking not available for the user.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_emoji": "Invalid emoji, does not follow the pattern of a valid emoji name.", + "too_many_bookmarks": "Bookmark limit reached for channel.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/bookmarks.add", + "name": "bookmarks.add", + "response": { + "bookmark": { + "app_id": null, + "channel_id": "C1RQ000", + "date_created": 1644956055, + "date_updated": 0, + "emoji": ":clap:", + "entity_id": null, + "icon_url": "https://www.google.com/favicon.ico", + "id": "Bk033XFJ9BTJ", + "last_updated_by_team_id": "T018DF03GHY", + "last_updated_by_user_id": "U0334B6G6G5", + "link": "https://google.com", + "rank": "g", + "shortcut_id": null, + "title": "bookmark-1", + "type": "link" + }, + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/bookmarks.edit.json b/lib/slack/web/docs/bookmarks.edit.json new file mode 100644 index 0000000..a53f91f --- /dev/null +++ b/lib/slack/web/docs/bookmarks.edit.json @@ -0,0 +1,118 @@ +{ + "args": { + "bookmark_id": { + "desc": "Bookmark to update.", + "example": "", + "name": "bookmark_id", + "required": true, + "type": "string" + }, + "channel_id": { + "desc": "Channel to update bookmark in.", + "example": "C1234567890", + "name": "channel_id", + "required": true, + "type": "string" + }, + "emoji": { + "desc": "Emoji tag to apply to the link.", + "example": "", + "name": "emoji", + "required": false, + "type": "string" + }, + "link": { + "desc": "Link to bookmark.", + "example": "", + "name": "link", + "required": false, + "type": "string" + }, + "title": { + "desc": "Title for the bookmark.", + "example": "", + "name": "title", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Edit bookmark.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "parent_with_link": "Parent bookmark should not have link.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "permission_denied": "No permission to perform this operation.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_bookmark_type": "Bookmark type is not valid.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_found": "Bookmark cannot be found.", + "invalid_link": "Invalid link, link should begin with either http:// or https://.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "Channel cannot be found.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "not_implemented": "bookmarking not available for the user.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_emoji": "Invalid emoji, does not follow the pattern of a valid emoji name.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/bookmarks.edit", + "name": "bookmarks.edit", + "response": { + "bookmark": { + "app_id": null, + "channel_id": "C1RQ000", + "date_created": 1644956055, + "date_updated": 0, + "emoji": ":clap:", + "entity_id": null, + "icon_url": "https://www.google.com/favicon.ico", + "id": "Bk033XFJ9BTJ", + "last_updated_by_team_id": "T018DF03GHY", + "last_updated_by_user_id": "U0334B6G6G5", + "link": "https://google.com", + "rank": "g", + "shortcut_id": null, + "title": "bookmark-1", + "type": "link" + }, + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/bookmarks.list.json b/lib/slack/web/docs/bookmarks.list.json new file mode 100644 index 0000000..b05efef --- /dev/null +++ b/lib/slack/web/docs/bookmarks.list.json @@ -0,0 +1,84 @@ +{ + "args": { + "channel_id": { + "desc": "Channel to list bookmarks in.", + "example": "C1234567890", + "name": "channel_id", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "List bookmark for the channel.", + "errors": { + "access_denied": "Access to a resource specified in the request is denied.", + "accesslimited": "Access to this method is limited on the current network", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "channel_not_found": "Channel cannot be found.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "is_bot": "This method cannot be called by a bot user.", + "method_deprecated": "The method has been deprecated.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "not_authed": "No authentication token provided.", + "not_implemented": "bookmarking not available for the user.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "service_unavailable": "The service is temporarily unavailable", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_expired": "Authentication token has expired", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "two_factor_setup_required": "Two factor setup is required." + }, + "is_deprecated": false, + "link": "/methods/bookmarks.list", + "name": "bookmarks.list", + "response": { + "bookmark": { + "app_id": null, + "channel_id": "C1RQ000", + "date_created": 1644956055, + "date_updated": 0, + "emoji": ":clap:", + "entity_id": null, + "icon_url": "https://www.google.com/favicon.ico", + "id": "Bk033XFJ9BTJ", + "last_updated_by_team_id": "T018DF03GHY", + "last_updated_by_user_id": "U0334B6G6G5", + "link": "https://google.com", + "rank": "g", + "shortcut_id": null, + "title": "bookmark-1", + "type": "link" + }, + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/bookmarks.remove.json b/lib/slack/web/docs/bookmarks.remove.json new file mode 100644 index 0000000..21a1b73 --- /dev/null +++ b/lib/slack/web/docs/bookmarks.remove.json @@ -0,0 +1,77 @@ +{ + "args": { + "bookmark_id": { + "desc": "Bookmark to remove.", + "example": "", + "name": "bookmark_id", + "required": true, + "type": "string" + }, + "channel_id": { + "desc": "Channel to remove bookmark.", + "example": "C1234567890", + "name": "channel_id", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Remove bookmark from the channel.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "permission_denied": "No permission to perform this operation.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_bookmark_type": "Bookmark type is not valid.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_found": "Bookmark cannot be found.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "Channel cannot be found.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "not_implemented": "bookmarking not available for the user.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/bookmarks.remove", + "name": "bookmarks.remove", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/bots.info.json b/lib/slack/web/docs/bots.info.json index 3fd48c2..70de10b 100644 --- a/lib/slack/web/docs/bots.info.json +++ b/lib/slack/web/docs/bots.info.json @@ -3,8 +3,85 @@ "bot": { "desc": "Bot user to get info on", "example": "B12345678", - "required": false + "name": "bot", + "required": false, + "type": "string" + }, + "team_id": { + "desc": "encoded team id or enterprise id where the bot exists, required if org token is used", + "example": "T1234567890", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" } }, - "desc": "Gets information about a bot user." + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Gets information about a bot user.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "bots_not_found": "At least one value passed for bots was invalid.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "missing_argument": "A required argument is missing.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "bot_not_found": "Value passed for bot was invalid.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/bots.info", + "name": "bots.info", + "response": { + "bot": { + "app_id": "A123456", + "deleted": false, + "icons": { + "image_36": "https://...", + "image_48": "https://...", + "image_72": "https://..." + }, + "id": "B123456", + "name": "beforebot", + "updated": 1449272004, + "user_id": "U123456" + }, + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } } \ No newline at end of file diff --git a/lib/slack/web/docs/calls.add.json b/lib/slack/web/docs/calls.add.json new file mode 100644 index 0000000..412a7b4 --- /dev/null +++ b/lib/slack/web/docs/calls.add.json @@ -0,0 +1,118 @@ +{ + "args": { + "created_by": { + "desc": "The valid Slack user ID of the user who created this Call. When this method is called with a user token, the created_by field is optional and defaults to the authed user of the token. Otherwise, the field is required.", + "example": "U1H77", + "name": "created_by", + "required": false, + "type": "string" + }, + "date_start": { + "desc": "Call start time in UTC UNIX timestamp format", + "example": "1562002086", + "name": "date_start", + "required": false, + "type": "integer" + }, + "desktop_app_join_url": { + "desc": "When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL.", + "example": "callapp://join/1234567890", + "name": "desktop_app_join_url", + "required": false, + "type": "string" + }, + "external_display_id": { + "desc": "An optional, human-readable ID supplied by the 3rd-party Call provider. If supplied, this ID will be displayed in the Call object.", + "example": "705-292-868", + "name": "external_display_id", + "required": false, + "type": "string" + }, + "external_unique_id": { + "desc": "An ID supplied by the 3rd-party Call provider. It must be unique across all Calls from that service.", + "example": "025169F6-E37A-4E62-BB54-7F93A0FC4C1F", + "name": "external_unique_id", + "required": true, + "type": "string" + }, + "join_url": { + "desc": "The URL required for a client to join the Call.", + "example": "https://example.com/calls/1234567890", + "name": "join_url", + "required": true, + "type": "string" + }, + "title": { + "desc": "The name of the Call.", + "example": "Kimpossible sync up", + "name": "title", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + }, + "users": { + "desc": "The list of users to register as participants in the Call. Read more on how to specify users here.", + "example": "[{\"slack_id\": \"U1H77\"}, {\"external_id\": \"54321678\", \"display_name\": \"External User\", \"avatar_url\": \"https://example.com/users/avatar1234.jpg\"}]", + "name": "users", + "required": false, + "type": "array" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Registers a new Call.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "user_not_found": "A specified user wasn't found.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "not_authorized": "The specified user is not authorized to create a Call in this channel.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "invalid_created_by": "The created_by user ID is invalid.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "not_implemented": "This method is not available.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "invalid_start_time": "The start time is invalid.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/calls.add", + "name": "calls.add", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/calls.end.json b/lib/slack/web/docs/calls.end.json new file mode 100644 index 0000000..2c1b64a --- /dev/null +++ b/lib/slack/web/docs/calls.end.json @@ -0,0 +1,74 @@ +{ + "args": { + "duration": { + "desc": "Call duration in seconds", + "example": "1800", + "name": "duration", + "required": false, + "type": "integer" + }, + "id": { + "desc": "id returned when registering the call using the calls.add method.", + "example": "R0E69JAIF", + "name": "id", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Ends a Call.", + "errors": { + "access_denied": "Access to a resource specified in the request is denied.", + "accesslimited": "Access to this method is limited on the current network", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "inactive_call": "The Call has been already stopped.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_call_id": "Invalid Call ID.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "method_deprecated": "The method has been deprecated.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "not_authed": "No authentication token provided.", + "not_implemented": "This method is not publicly available yet.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "service_unavailable": "The service is temporarily unavailable", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_expired": "Authentication token has expired", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "two_factor_setup_required": "Two factor setup is required." + }, + "is_deprecated": false, + "link": "/methods/calls.end", + "name": "calls.end", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/calls.info.json b/lib/slack/web/docs/calls.info.json new file mode 100644 index 0000000..2ca1ea0 --- /dev/null +++ b/lib/slack/web/docs/calls.info.json @@ -0,0 +1,65 @@ +{ + "args": { + "id": { + "desc": "id of the Call returned by the calls.add method.", + "example": "R0E69JAIF", + "name": "id", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Returns information about a Call.", + "errors": { + "access_denied": "Access to a resource specified in the request is denied.", + "accesslimited": "Access to this method is limited on the current network", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "method_deprecated": "The method has been deprecated.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "not_authed": "No authentication token provided.", + "not_implemented": "This method is not available.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "service_unavailable": "The service is temporarily unavailable", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_expired": "Authentication token has expired", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "two_factor_setup_required": "Two factor setup is required." + }, + "is_deprecated": false, + "link": "/methods/calls.info", + "name": "calls.info", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/calls.participants.add.json b/lib/slack/web/docs/calls.participants.add.json new file mode 100644 index 0000000..ae40713 --- /dev/null +++ b/lib/slack/web/docs/calls.participants.add.json @@ -0,0 +1,77 @@ +{ + "args": { + "id": { + "desc": "id returned by the calls.add method.", + "example": "R0E69JAIF", + "name": "id", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + }, + "users": { + "desc": "The list of users to add as participants in the Call. Read more on how to specify users here.", + "example": "[{\"slack_id\": \"U1H77\"}, {\"external_id\": \"54321678\", \"display_name\": \"External User\", \"avatar_url\": \"https://example.com/users/avatar1234.jpg\"}]", + "name": "users", + "required": true, + "type": "array" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Registers new participants added to a Call.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "user_not_found": "At least one specified user wasn't found.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "missing_argument": "A required argument is missing.", + "inactive_call": "The Call has been already ended.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "invalid_call_id": "The specified Call wasn't found.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "bad_users": "At least one specified user is already part of the Call.", + "not_implemented": "This method is not available.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/calls.participants.add", + "name": "calls.participants.add", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/calls.participants.remove.json b/lib/slack/web/docs/calls.participants.remove.json new file mode 100644 index 0000000..69bac00 --- /dev/null +++ b/lib/slack/web/docs/calls.participants.remove.json @@ -0,0 +1,77 @@ +{ + "args": { + "id": { + "desc": "id returned by the calls.add method.", + "example": "R0E69JAIF", + "name": "id", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + }, + "users": { + "desc": "The list of users to remove as participants in the Call. Read more on how to specify users here.", + "example": "[{\"slack_id\": \"U1H77\"}, {\"external_id\": \"54321678\", \"display_name\": \"External User\", \"avatar_url\": \"https://example.com/users/avatar1234.jpg\"}]", + "name": "users", + "required": true, + "type": "array" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Registers participants removed from a Call.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "user_not_found": "At least one specified user wasn't found.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "missing_argument": "A required argument is missing.", + "inactive_call": "The Call has been already ended.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "invalid_call_id": "The specified Call wasn't found.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "bad_users": "At least one specified user is not part of the Call.", + "not_implemented": "This method is not available.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/calls.participants.remove", + "name": "calls.participants.remove", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/calls.update.json b/lib/slack/web/docs/calls.update.json new file mode 100644 index 0000000..ec8bb4b --- /dev/null +++ b/lib/slack/web/docs/calls.update.json @@ -0,0 +1,87 @@ +{ + "args": { + "desktop_app_join_url": { + "desc": "When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL.", + "example": "callapp://join/0987654321", + "name": "desktop_app_join_url", + "required": false, + "type": "string" + }, + "id": { + "desc": "id returned by the calls.add method.", + "example": "R0E69JAIF", + "name": "id", + "required": true, + "type": "string" + }, + "join_url": { + "desc": "The URL required for a client to join the Call.", + "example": "https://example.com/calls/0987654321", + "name": "join_url", + "required": false, + "type": "string" + }, + "title": { + "desc": "The name of the Call.", + "example": "Kimpossible sync up call", + "name": "title", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Updates information about a Call.", + "errors": { + "access_denied": "Access to a resource specified in the request is denied.", + "accesslimited": "Access to this method is limited on the current network", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_call_id": "The Call's id was invalid.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "method_deprecated": "The method has been deprecated.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "not_authed": "No authentication token provided.", + "not_implemented": "This method is not available.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "service_unavailable": "The service is temporarily unavailable", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_expired": "Authentication token has expired", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "two_factor_setup_required": "Two factor setup is required." + }, + "is_deprecated": false, + "link": "/methods/calls.update", + "name": "calls.update", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/channels.archive.json b/lib/slack/web/docs/channels.archive.json deleted file mode 100644 index 7ecea34..0000000 --- a/lib/slack/web/docs/channels.archive.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "args": { - "channel": { - "desc": "Channel to archive", - "required": true, - "type": "channel" - } - }, - "desc": "Archives a channel.", - "errors": { - "already_archived": "Channel has already been archived.", - "cant_archive_general": "You cannot archive the general channel", - "channel_not_found": "Value passed for `channel` was invalid.", - "last_ra_channel": "You cannot archive the last channel for a restricted account", - "restricted_action": "A team preference prevents the authenticated user from archiving." - } -} \ No newline at end of file diff --git a/lib/slack/web/docs/channels.create.json b/lib/slack/web/docs/channels.create.json deleted file mode 100644 index 0de490e..0000000 --- a/lib/slack/web/docs/channels.create.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "args": { - "name": { - "desc": "Name of channel to create", - "example": "mychannel", - "required": true - } - }, - "desc": "Creates a channel.", - "errors": { - "name_taken": "A channel cannot be created with the given name.", - "no_channel": "Value passed for `name` was empty.", - "restricted_action": "A team preference prevents the authenticated user from creating channels." - } -} \ No newline at end of file diff --git a/lib/slack/web/docs/channels.history.json b/lib/slack/web/docs/channels.history.json deleted file mode 100644 index c4164ed..0000000 --- a/lib/slack/web/docs/channels.history.json +++ /dev/null @@ -1,44 +0,0 @@ -{ - "args": { - "channel": { - "desc": "Channel to fetch history for.", - "required": true, - "type": "channel" - }, - "count": { - "default": "100", - "desc": "Number of messages to return, between 1 and 1000.", - "example": "100", - "required": false - }, - "inclusive": { - "default": 0, - "desc": "Include messages with latest or oldest timestamp in results.", - "example": 1 - }, - "latest": { - "default": "now", - "desc": "End of time range of messages to include in results.", - "required": false, - "type": "timestamp" - }, - "oldest": { - "default": "0", - "desc": "Start of time range of messages to include in results.", - "required": false, - "type": "timestamp" - }, - "unreads": { - "default": 0, - "desc": "Include `unread_count_display` in the output?", - "example": 1, - "required": false - } - }, - "desc": "Fetches history of messages and events from a channel.", - "errors": { - "channel_not_found": "Value passed for `channel` was invalid.", - "invalid_ts_latest": "Value passed for `latest` was invalid", - "invalid_ts_oldest": "Value passed for `oldest` was invalid" - } -} \ No newline at end of file diff --git a/lib/slack/web/docs/channels.info.json b/lib/slack/web/docs/channels.info.json deleted file mode 100644 index 983f24f..0000000 --- a/lib/slack/web/docs/channels.info.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "args": { - "channel": { - "desc": "Channel to get info on", - "required": true, - "type": "channel" - } - }, - "desc": "Gets information about a channel.", - "errors": { - "channel_not_found": "Value passed for `channel` was invalid." - } -} \ No newline at end of file diff --git a/lib/slack/web/docs/channels.invite.json b/lib/slack/web/docs/channels.invite.json deleted file mode 100644 index c512a13..0000000 --- a/lib/slack/web/docs/channels.invite.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "args": { - "channel": { - "desc": "Channel to invite user to.", - "required": true, - "type": "channel" - }, - "user": { - "desc": "User to invite to channel.", - "required": true, - "type": "user" - } - }, - "desc": "Invites a user to a channel.", - "errors": { - "already_in_channel": "Invited user is already in the channel.", - "cant_invite": "User cannot be invited to this channel.", - "cant_invite_self": "Authenticated user cannot invite themselves to a channel.", - "channel_not_found": "Value passed for `channel` was invalid.", - "is_archived": "Channel has been archived.", - "not_in_channel": "Authenticated user is not in the channel.", - "user_not_found": "Value passed for `user` was invalid." - } -} \ No newline at end of file diff --git a/lib/slack/web/docs/channels.join.json b/lib/slack/web/docs/channels.join.json deleted file mode 100644 index 2fa7d97..0000000 --- a/lib/slack/web/docs/channels.join.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "args": { - "name": { - "desc": "Name of channel to join", - "required": true - } - }, - "desc": "Joins a channel, creating it if needed.", - "errors": { - "channel_not_found": "Value passed for `channel` was invalid.", - "is_archived": "Channel has been archived.", - "name_taken": "A channel cannot be created with the given name.", - "no_channel": "Value passed for `name` was empty.", - "restricted_action": "A team preference prevents the authenticated user from creating channels." - } -} \ No newline at end of file diff --git a/lib/slack/web/docs/channels.kick.json b/lib/slack/web/docs/channels.kick.json deleted file mode 100644 index 11dc2b9..0000000 --- a/lib/slack/web/docs/channels.kick.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "args": { - "channel": { - "desc": "Channel to remove user from.", - "required": true, - "type": "channel" - }, - "user": { - "desc": "User to remove from channel.", - "required": true, - "type": "user" - } - }, - "desc": "Removes a user from a channel.", - "errors": { - "cant_kick_from_general": "User cannot be removed from #general.", - "cant_kick_from_last_channel": "User cannot be removed from the last channel they're in.", - "cant_kick_self": "Authenticated user can't kick themselves from a channel.", - "channel_not_found": "Value passed for `channel` was invalid.", - "not_in_channel": "User was not in the channel.", - "restricted_action": "A team preference prevents the authenticated user from kicking.", - "user_not_found": "Value passed for `user` was invalid." - } -} \ No newline at end of file diff --git a/lib/slack/web/docs/channels.leave.json b/lib/slack/web/docs/channels.leave.json deleted file mode 100644 index e2f915c..0000000 --- a/lib/slack/web/docs/channels.leave.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "args": { - "channel": { - "desc": "Channel to leave", - "required": true, - "type": "channel" - } - }, - "desc": "Leaves a channel.", - "errors": { - "cant_leave_general": "Authenticated user cannot leave the general channel", - "channel_not_found": "Value passed for `channel` was invalid.", - "is_archived": "Channel has been archived." - } -} \ No newline at end of file diff --git a/lib/slack/web/docs/channels.list.json b/lib/slack/web/docs/channels.list.json deleted file mode 100644 index bfabb55..0000000 --- a/lib/slack/web/docs/channels.list.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "args": { - "exclude_archived": { - "default": 0, - "desc": "Don't return archived channels.", - "example": 1 - } - }, - "desc": "Lists all channels in a Slack team." -} \ No newline at end of file diff --git a/lib/slack/web/docs/channels.mark.json b/lib/slack/web/docs/channels.mark.json deleted file mode 100644 index 1935f0c..0000000 --- a/lib/slack/web/docs/channels.mark.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "args": { - "channel": { - "desc": "Channel to set reading cursor in.", - "required": true, - "type": "channel" - }, - "ts": { - "desc": "Timestamp of the most recently seen message.", - "required": true, - "type": "timestamp" - } - }, - "desc": "Sets the read cursor in a channel.", - "errors": { - "channel_not_found": "Value passed for `channel` was invalid.", - "invalid_timestamp": "Value passed for `timestamp` was invalid.", - "not_in_channel": "Caller is not a member of the channel." - } -} \ No newline at end of file diff --git a/lib/slack/web/docs/channels.rename.json b/lib/slack/web/docs/channels.rename.json deleted file mode 100644 index 81f7810..0000000 --- a/lib/slack/web/docs/channels.rename.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "args": { - "channel": { - "desc": "Channel to rename", - "required": true, - "type": "channel" - }, - "name": { - "desc": "New name for channel.", - "required": true - } - }, - "desc": "Renames a channel.", - "errors": { - "channel_not_found": "Value passed for `channel` was invalid.", - "invalid_name": "New name is invalid", - "name_taken": "New channel name is taken", - "not_authorized": "Caller cannot rename this channel", - "not_in_channel": "Caller is not a member of the channel." - } -} \ No newline at end of file diff --git a/lib/slack/web/docs/channels.replies.json b/lib/slack/web/docs/channels.replies.json deleted file mode 100644 index bc9c0cd..0000000 --- a/lib/slack/web/docs/channels.replies.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "args": { - "channel": { - "desc": "Channel to fetch thread from", - "required": true, - "type": "channel" - }, - "thread_ts": { - "desc": "Unique identifier of a thread's parent message.", - "required": true - } - }, - "desc": "Retrieve a thread of messages posted to a channel.", - "errors": { - "channel_not_found": "Value passed for `channel` was invalid.", - "thread_not_found": "Value for thread_ts was missing or invalid." - } -} \ No newline at end of file diff --git a/lib/slack/web/docs/channels.setPurpose.json b/lib/slack/web/docs/channels.setPurpose.json deleted file mode 100644 index d7bcc84..0000000 --- a/lib/slack/web/docs/channels.setPurpose.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "args": { - "channel": { - "desc": "Channel to set the purpose of", - "required": true, - "type": "channel" - }, - "purpose": { - "desc": "The new purpose", - "example": "My Purpose", - "required": true - } - }, - "desc": "Sets the purpose for a channel.", - "errors": { - "channel_not_found": "Value passed for `channel` was invalid.", - "is_archived": "Channel has been archived.", - "not_in_channel": "Authenticated user is not in the channel.", - "too_long": "Purpose was longer than 250 characters.", - "user_is_restricted": "Setting the purpose is a restricted action." - } -} \ No newline at end of file diff --git a/lib/slack/web/docs/channels.setTopic.json b/lib/slack/web/docs/channels.setTopic.json deleted file mode 100644 index 60b5bdf..0000000 --- a/lib/slack/web/docs/channels.setTopic.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "args": { - "channel": { - "desc": "Channel to set the topic of", - "required": true, - "type": "channel" - }, - "topic": { - "desc": "The new topic", - "example": "My Topic", - "required": true - } - }, - "desc": "Sets the topic for a channel.", - "errors": { - "channel_not_found": "Value passed for `channel` was invalid.", - "is_archived": "Channel has been archived.", - "not_in_channel": "Authenticated user is not in the channel.", - "too_long": "Topic was longer than 250 characters.", - "user_is_restricted": "Setting the topic is a restricted action." - } -} \ No newline at end of file diff --git a/lib/slack/web/docs/channels.unarchive.json b/lib/slack/web/docs/channels.unarchive.json deleted file mode 100644 index 527fb4c..0000000 --- a/lib/slack/web/docs/channels.unarchive.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "args": { - "channel": { - "desc": "Channel to unarchive", - "required": true, - "type": "channel" - } - }, - "desc": "Unarchives a channel.", - "errors": { - "channel_not_found": "Value passed for `channel` was invalid.", - "not_archived": "Channel is not archived." - } -} \ No newline at end of file diff --git a/lib/slack/web/docs/chat.delete.json b/lib/slack/web/docs/chat.delete.json index d69560d..432769c 100644 --- a/lib/slack/web/docs/chat.delete.json +++ b/lib/slack/web/docs/chat.delete.json @@ -1,21 +1,84 @@ { "args": { + "as_user": { + "desc": "Pass true to delete the message as the authed user with chat:write:user scope. Bot users in this context are considered authed users. If unused or false, the message will be deleted with chat:write:bot scope.", + "example": "true", + "name": "as_user", + "required": false, + "type": "boolean" + }, "channel": { "desc": "Channel containing the message to be deleted.", + "example": "C1234567890", + "name": "channel", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", "required": true, - "type": "channel" + "type": "token" }, "ts": { "desc": "Timestamp of the message to be deleted.", - "example": "1405894322.002768", - "required": true + "example": "\"1405894322.002768\"", + "name": "ts", + "required": true, + "type": "string" } }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], "desc": "Deletes a message.", "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", "cant_delete_message": "Authenticated user does not have permission to delete this message.", - "channel_not_found": "Value passed for `channel` was invalid.", - "compliance_exports_prevent_deletion": "Compliance exports are on, messages can not be deleted", - "message_not_found": "No message exists with the requested timestamp." + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "Value passed for channel was invalid.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "message_not_found": "No message exists with the requested timestamp.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/chat.delete", + "name": "chat.delete", + "response": { + "channel": "C024BE91L", + "ok": true, + "ts": "1401383885.000061" + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/chat.deleteScheduledMessage.json b/lib/slack/web/docs/chat.deleteScheduledMessage.json new file mode 100644 index 0000000..fbd3372 --- /dev/null +++ b/lib/slack/web/docs/chat.deleteScheduledMessage.json @@ -0,0 +1,82 @@ +{ + "args": { + "as_user": { + "desc": "Pass true to delete the message as the authed user with chat:write:user scope. Bot users in this context are considered authed users. If unused or false, the message will be deleted with chat:write:bot scope.", + "example": "true", + "name": "as_user", + "required": false, + "type": "boolean" + }, + "channel": { + "desc": "The channel the scheduled_message is posting to", + "example": "C123456789", + "name": "channel", + "required": true, + "type": "string" + }, + "scheduled_message_id": { + "desc": "scheduled_message_id returned from call to chat.scheduleMessage", + "example": "Q1234ABCD", + "name": "scheduled_message_id", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Deletes a pending scheduled message from the queue.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "invalid_scheduled_message_id": "The scheduled_message_id passed is either an invalid ID, or the scheduled message it's referencing has already been sent or deleted.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "bad_token": "The provided token was invalid.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "The channel passed is either an invalid ID or does not exist.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/chat.deleteScheduledMessage", + "name": "chat.deleteScheduledMessage", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/chat.getPermalink.json b/lib/slack/web/docs/chat.getPermalink.json index 393c56a..dc2fd4a 100644 --- a/lib/slack/web/docs/chat.getPermalink.json +++ b/lib/slack/web/docs/chat.getPermalink.json @@ -1,19 +1,75 @@ { "args": { "channel": { - "desc": "The ID of the conversation or channel containing the message.", + "desc": "The ID of the conversation or channel containing the message", + "example": "53072", + "name": "channel", "required": true, - "type": "channel" + "type": "string" }, "message_ts": { - "desc": "A message's ts value, uniquely identifying it within a channel.", - "example": "1405894322.002768", - "required": true + "desc": "A message's ts value, uniquely identifying it within a channel", + "example": "1234567890.123456", + "name": "message_ts", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" } }, - "desc": "Retrieve a permalink URL for a specific extant message.", + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Retrieve a permalink URL for a specific extant message", "errors": { - "channel_not_found": "Value passed for `channel` was invalid.", - "message_not_found": "No message exists with the requested timestamp." + "access_denied": "Access to a resource specified in the request is denied.", + "accesslimited": "Access to this method is limited on the current network", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "channel_not_found": "Value passed for channel was invalid.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "message_not_found": "The message identified by message_ts could not be found.", + "method_deprecated": "The method has been deprecated.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "not_authed": "No authentication token provided.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "service_unavailable": "The service is temporarily unavailable", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_expired": "Authentication token has expired", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "two_factor_setup_required": "Two factor setup is required." + }, + "is_deprecated": false, + "link": "/methods/chat.getPermalink", + "name": "chat.getPermalink", + "response": { + "channel": "C1H9RESGA", + "ok": true, + "permalink": "https://ghostbusters.slack.com/archives/C1H9RESGA/p135854651500008" + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/chat.meMessage.json b/lib/slack/web/docs/chat.meMessage.json new file mode 100644 index 0000000..827b5c5 --- /dev/null +++ b/lib/slack/web/docs/chat.meMessage.json @@ -0,0 +1,80 @@ +{ + "args": { + "channel": { + "desc": "Channel to send message to. Can be a public channel, private group or IM channel. Can be an encoded ID, or a name.", + "example": "C1234567890", + "name": "channel", + "required": true, + "type": "string" + }, + "text": { + "desc": "Text of the message to send.", + "example": "Hello world", + "name": "text", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Share a me message into a channel.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "msg_too_long": "Message text is too long", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "no_text": "No message text provided", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_archived": "Channel has been archived.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "rate_limited": "Application has posted too many messages, read the Rate Limit documentation for more information", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "Value passed for channel was invalid.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "not_in_channel": "Cannot post user messages to a channel they are not in.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/chat.meMessage", + "name": "chat.meMessage", + "response": { + "channel": "C024BE7LR", + "ok": true, + "ts": "1417671948.000006" + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/chat.postEphemeral.json b/lib/slack/web/docs/chat.postEphemeral.json index 4dfb893..0e93e93 100644 --- a/lib/slack/web/docs/chat.postEphemeral.json +++ b/lib/slack/web/docs/chat.postEphemeral.json @@ -1,50 +1,153 @@ { "args": { "as_user": { - "desc": "Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See [authorship](#authorship) below.", + "desc": "Pass true to post the message as the authed user. Defaults to true if the chat:write:bot scope is not included. Otherwise, defaults to false.", "example": "true", - "required": false + "name": "as_user", + "required": false, + "type": "boolean" }, "attachments": { - "desc": "Structured message attachments.", - "example": "[{\"pretext\": \"pre-hello\", \"text\": \"text-world\"}]" + "desc": "A JSON-based array of structured attachments, presented as a URL-encoded string.", + "example": "[{\"pretext\": \"pre-hello\", \"text\": \"text-world\"}]", + "name": "attachments", + "required": false, + "type": "string" }, "blocks": { - "desc": "A JSON-based array of structured blocks, presented as a URL-encoded string", + "desc": "A JSON-based array of structured blocks, presented as a URL-encoded string.", "example": "[{\"type\": \"section\", \"text\": {\"type\": \"plain_text\", \"text\": \"Hello world\"}}]", - "required": false + "name": "blocks", + "required": false, + "type": "blocks[] as string" }, "channel": { - "desc": "Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name. See [below](#channels) for more details.", + "desc": "Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name.", + "example": "C1234567890", + "name": "channel", "required": true, - "type": "channel" + "type": "string" + }, + "icon_emoji": { + "desc": "Emoji to use as the icon for this message. Overrides icon_url. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.", + "example": ":chart_with_upwards_trend:", + "name": "icon_emoji", + "required": false, + "type": "string" + }, + "icon_url": { + "desc": "URL to an image to use as the icon for this message. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.", + "example": "http://lorempixel.com/48/48", + "name": "icon_url", + "required": false, + "type": "string" }, "link_names": { "desc": "Find and link channel names and usernames.", - "example": "1" + "example": "true", + "name": "link_names", + "required": false, + "type": "boolean" }, "parse": { - "desc": "Change how messages are treated. Defaults to `none`. See [below](#formatting).", - "example": "full" + "desc": "Change how messages are treated. Defaults to none. See below.", + "example": "full", + "name": "parse", + "required": false, + "type": "string" }, "text": { - "desc": "Text of the message to send. See below for an explanation of [formatting](#formatting).", + "desc": "How this field works and whether it is required depends on other fields you use in your API call. See below for more detail.", "example": "Hello world", - "required": true + "name": "text", + "required": true, + "type": "string" + }, + "thread_ts": { + "desc": "Provide another message's ts value to post this message in a thread. Avoid using a reply's ts value; use its parent's value instead. Ephemeral messages in threads are only shown if there is already an active thread.", + "example": "1234567890.123456", + "name": "thread_ts", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" }, "user": { - "desc": "`id` of the user who will receive the ephemeral message. The user should be in the channel specified by the `channel` argument.", + "desc": "id of the user who will receive the ephemeral message. The user should be in the channel specified by the channel argument.", + "example": "U0BPQUNTA", + "name": "user", "required": true, - "type": "user" + "type": "string" + }, + "username": { + "desc": "Set your bot's user name. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.", + "example": "My Bot", + "name": "username", + "required": false, + "type": "string" } }, - "desc": "Sends an ephemeral message to a channel.", + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Sends an ephemeral message to a user in a channel.", "errors": { - "channel_not_found": "Value passed for `channel` was invalid.", - "is_archived": "Channel has been archived.", + "invalid_blocks_format": "The blocks is not a valid JSON object or doesn't match the Block Kit syntax.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", "msg_too_long": "Message text is too long", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "messages_tab_disabled": "Messages tab for the app is disabled.", "no_text": "No message text provided", - "rate_limited": "Application has posted too many messages, [read the Rate Limit documentation](/docs/rate-limits) for more information", - "user_not_in_channel": "Cannot post user messages to a channel they are not in." + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_archived": "Channel has been archived.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "restricted_action": "A workspace preference prevents the authenticated user from posting.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "too_many_attachments": "Too many attachments were provided with this message. A maximum of 100 attachments are allowed on a message.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "user_not_in_channel": "Intended recipient is not in the specified channel.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_blocks": "Blocks submitted with this message are not valid", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "Value passed for channel was invalid.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/chat.postEphemeral", + "name": "chat.postEphemeral", + "response": { + "message_ts": "1502210682.580145", + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/chat.postMessage.json b/lib/slack/web/docs/chat.postMessage.json index 9aa3637..3861ff5 100644 --- a/lib/slack/web/docs/chat.postMessage.json +++ b/lib/slack/web/docs/chat.postMessage.json @@ -1,73 +1,191 @@ { "args": { "as_user": { - "desc": "Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See [authorship](#authorship) below.", + "desc": "Set to true to post the message as the authed user, instead of as a bot. Defaults to false. Cannot be used by new Slack apps. See authorship below.", "example": "true", - "required": false - }, - "attachments": { - "desc": "Structured message attachments.", - "example": "[{\"pretext\": \"pre-hello\", \"text\": \"text-world\"}]" - }, - "blocks": { - "desc": "A JSON-based array of structured blocks, presented as a URL-encoded string", - "example": "[{\"type\": \"section\", \"text\": {\"type\": \"plain_text\", \"text\": \"Hello world\"}}]", - "required": false + "name": "as_user", + "required": false, + "type": "boolean" }, "channel": { - "desc": "Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name. See [below](#channels) for more details.", + "desc": "Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name. See below for more details.", + "example": "C1234567890", + "name": "channel", "required": true, - "type": "channel" + "type": "string" }, "icon_emoji": { - "desc": "emoji to use as the icon for this message. Overrides `icon_url`. Must be used in conjunction with `as_user` set to false, otherwise ignored. See [authorship](#authorship) below.", + "desc": "Emoji to use as the icon for this message. Overrides icon_url. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.", "example": ":chart_with_upwards_trend:", - "required": false + "name": "icon_emoji", + "required": false, + "type": "string" }, "icon_url": { - "desc": "URL to an image to use as the icon for this message. Must be used in conjunction with `as_user` set to false, otherwise ignored. See [authorship](#authorship) below.", + "desc": "URL to an image to use as the icon for this message. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.", "example": "http://lorempixel.com/48/48", - "required": false + "name": "icon_url", + "required": false, + "type": "string" }, "link_names": { - "desc": "Find and link channel names and usernames.", - "example": "1" + "desc": "Find and link user groups. No longer supports linking individual users; use syntax shown in Mentioning Users instead.", + "example": "true", + "name": "link_names", + "required": false, + "type": "boolean" + }, + "metadata": { + "desc": "JSON object with event_type and event_payload fields, presented as a URL-encoded string. Metadata you post to Slack is accessible to any app or user who is a member of that workspace.", + "example": "{\"event_type\": \"task_created\", \"event_payload\": { \"id\": \"11223\", \"title\": \"Redesign Homepage\"}}", + "name": "metadata", + "required": false, + "type": "string" + }, + "mrkdwn": { + "desc": "Disable Slack markup parsing by setting to false. Enabled by default.", + "example": "truefalse", + "name": "mrkdwn", + "required": false, + "type": "boolean" }, "parse": { - "desc": "Change how messages are treated. Defaults to `none`. See [below](#formatting).", - "example": "full" + "desc": "Change how messages are treated. See below.", + "example": "full", + "name": "parse", + "required": false, + "type": "string" }, - "text": { - "desc": "Text of the message to send. See below for an explanation of [formatting](#formatting).", - "example": "Hello world", - "required": true + "reply_broadcast": { + "desc": "Used in conjunction with thread_ts and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to false.", + "example": "true", + "name": "reply_broadcast", + "required": false, + "type": "boolean" }, "thread_ts": { "desc": "Provide another message's ts value to make this message a reply. Avoid using a reply's ts value; use its parent instead.", - "example": "1234567890.123456", - "required": false + "example": "", + "name": "thread_ts", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" }, "unfurl_links": { "desc": "Pass true to enable unfurling of primarily text-based content.", - "example": "true" + "example": "true", + "name": "unfurl_links", + "required": false, + "type": "boolean" }, "unfurl_media": { "desc": "Pass false to disable unfurling of media content.", - "example": "false" + "example": "false", + "name": "unfurl_media", + "required": false, + "type": "boolean" }, "username": { - "desc": "Set your bot's user name. Must be used in conjunction with `as_user` set to false, otherwise ignored. See [authorship](#authorship) below.", + "desc": "Set your bot's user name. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.", "example": "My Bot", - "required": false + "name": "username", + "required": false, + "type": "string" } }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], "desc": "Sends a message to a channel.", "errors": { - "channel_not_found": "Value passed for `channel` was invalid.", - "is_archived": "Channel has been archived.", + "invalid_blocks_format": "The blocks is not a valid JSON object or doesn't match the Block Kit syntax.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", "msg_too_long": "Message text is too long", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "duplicate_channel_not_found": "Channel associated with client_msg_id was invalid.", + "messages_tab_disabled": "Messages tab for the app is disabled.", "no_text": "No message text provided", + "as_user_not_supported": "The as_user parameter does not function with workspace apps.", + "invalid_metadata_format": "Invalid metadata format provided", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "restricted_action_non_threadable_channel": "Cannot post thread replies into a non_threadable channel.", + "metadata_too_large": "Metadata exceeds size limit", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_archived": "Channel has been archived.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "too_many_contact_cards": "Too many contact_cards were provided with this message. A maximum of 10 contact cards are allowed on a message.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "restricted_action": "A workspace preference prevents the authenticated user from posting.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "duplicate_message_not_found": "No duplicate message exists associated with client_msg_id.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_metadata_schema": "Invalid metadata schema provided", + "too_many_attachments": "Too many attachments were provided with this message. A maximum of 100 attachments are allowed on a message.", + "rate_limited": "Application has posted too many messages, read the Rate Limit documentation for more information", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "restricted_action_read_only_channel": "Cannot post any message into a read-only channel.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_blocks": "Blocks submitted with this message are not valid", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "Value passed for channel was invalid.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "metadata_must_be_sent_from_app": "Message metadata can only be posted or updated using an app token", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "slack_connect_file_link_sharing_blocked": "Admin has disabled Slack File sharing in all Slack Connect communications", + "restricted_action_thread_only_channel": "Cannot post top-level messages into a thread-only channel.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", "not_in_channel": "Cannot post user messages to a channel they are not in.", - "rate_limited": "Application has posted too many messages, [read the Rate Limit documentation](/docs/rate-limits) for more information" + "restricted_action_thread_locked": "Cannot post replies to a thread that has been locked by admins.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/chat.postMessage", + "name": "chat.postMessage", + "response": { + "channel": "C123456", + "message": { + "attachments": [ + { + "fallback": "This is an attachment's fallback", + "id": 1, + "text": "This is an attachment" + } + ], + "bot_id": "B123456", + "subtype": "bot_message", + "text": "Here's a message for you", + "ts": "1503435956.000247", + "type": "message", + "username": "ecto1" + }, + "ok": true, + "ts": "1503435956.000247" + }, + "warnings": { + "message_truncated": "The text field of a message should have no more than 40,000 characters. We truncate really long messages.", + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/chat.scheduleMessage.json b/lib/slack/web/docs/chat.scheduleMessage.json index 0fdb26b..ab5096b 100644 --- a/lib/slack/web/docs/chat.scheduleMessage.json +++ b/lib/slack/web/docs/chat.scheduleMessage.json @@ -1,97 +1,168 @@ { "args": { "as_user": { - "desc": "Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See `chat.postMessage`.", + "desc": "Set to true to post the message as the authed user, instead of as a bot. Defaults to false. Cannot be used by new Slack apps. See chat.postMessage.", "example": "true", - "required": false + "name": "as_user", + "required": false, + "type": "boolean" }, "attachments": { "desc": "A JSON-based array of structured attachments, presented as a URL-encoded string.", "example": "[{\"pretext\": \"pre-hello\", \"text\": \"text-world\"}]", - "required": false + "name": "attachments", + "required": false, + "type": "string" }, "blocks": { "desc": "A JSON-based array of structured blocks, presented as a URL-encoded string.", "example": "[{\"type\": \"section\", \"text\": {\"type\": \"plain_text\", \"text\": \"Hello world\"}}]", - "required": false + "name": "blocks", + "required": false, + "type": "blocks[] as string" }, "channel": { - "desc": "Channel, private group, or DM channel to send message to. Can be an encoded ID, or a name.", + "desc": "Channel, private group, or DM channel to send message to. Can be an encoded ID, or a name. See below for more details.", "example": "C1234567890", - "required": true + "name": "channel", + "required": true, + "type": "string" }, "link_names": { - "desc": "Find and link channel names and usernames.", + "desc": "Find and link user groups. No longer supports linking individual users; use syntax shown in Mentioning Users instead.", "example": "true", - "required": false + "name": "link_names", + "required": false, + "type": "boolean" + }, + "metadata": { + "desc": "JSON object with event_type and event_payload fields, presented as a URL-encoded string. Metadata you post to Slack is accessible to any app or user who is a member of that workspace.", + "example": "{\"event_type\": \"task_created\", \"event_payload\": { \"id\": \"11223\", \"title\": \"Redesign Homepage\"}}", + "name": "metadata", + "required": false, + "type": "string" }, "parse": { - "desc": "Change how messages are treated. Defaults to none. See `chat.postMessage`.", + "desc": "Change how messages are treated. See chat.postMessage.", "example": "full", - "required": false + "name": "parse", + "required": false, + "type": "string" }, "post_at": { "desc": "Unix EPOCH timestamp of time in future to send the message.", "example": "299876400", - "required": true + "name": "post_at", + "required": true, + "type": "integer" }, "reply_broadcast": { - "desc": "Used in conjunction with `thread_ts` and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to `false`.", + "desc": "Used in conjunction with thread_ts and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to false.", "example": "true", - "required": false + "name": "reply_broadcast", + "required": false, + "type": "boolean" + }, + "text": { + "desc": "How this field works and whether it is required depends on other fields you use in your API call. See below for more detail.", + "example": "Hello world", + "name": "text", + "required": true, + "type": "string" }, "thread_ts": { - "desc": "Provide another message's `ts` value to make this message a reply. Avoid using a reply's `ts` value; use its parent instead.", - "example": "1234567890.123456", - "required": false + "desc": "Provide another message's ts value to make this message a reply. Avoid using a reply's ts value; use its parent instead.", + "example": "", + "name": "thread_ts", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" }, "unfurl_links": { "desc": "Pass true to enable unfurling of primarily text-based content.", "example": "true", - "required": false + "name": "unfurl_links", + "required": false, + "type": "boolean" }, "unfurl_media": { "desc": "Pass false to disable unfurling of media content.", "example": "false", - "required": false + "name": "unfurl_media", + "required": false, + "type": "boolean" } }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], "desc": "Schedules a message to be sent to a channel.", "errors": { - "account_inactive": "Authentication token is for a deleted user or workspace.", - "channel_not_found": "Value passed for `channel` was invalid.", - "ekm_access_denied": "Administrators have suspended the ability to post a message.", - "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", - "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", - "invalid_arguments": "The method was called with invalid arguments.", - "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", - "invalid_charset": "The method was called via a `POST` request, but the `charset` specified in the `Content-Type` header was invalid. Valid charset names are: `utf-8` `iso-8859-1`.", - "invalid_form_data": "The method was called via a `POST` request with `Content-Type` `application/x-www-form-urlencoded` or `multipart/form-data`, but the form data was either missing or syntactically invalid.", - "invalid_post_type": "The method was called via a `POST` request, but the specified `Content-Type` was invalid. Valid types are: `application/json` `application/x-www-form-urlencoded` `multipart/form-data` `text/plain`.", - "invalid_time": "value passed for `post_time` was invalid.", - "is_archived": "Channel has been archived.", - "missing_post_type": "The method was called via a `POST` request and included a data payload, but the request did not include a `Content-Type` header.", + "invalid_blocks_format": "The blocks is not a valid JSON object or doesn't match the Block Kit syntax.", "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", "msg_too_long": "Message text is too long", - "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", "no_text": "No message text provided", + "invalid_time": "value passed for post_time was invalid.", + "invalid_metadata_format": "Invalid metadata format provided", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", "not_authed": "No authentication token provided.", - "not_in_channel": "Cannot post user messages to a channel they are not in.", - "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", - "rate_limited": "Application has posted too many messages, read the Rate Limit documentation for more information", - "request_timeout": "The method was called via a `POST` request, but the `POST` data was either missing or truncated.", - "restricted_action": "A workspace preference prevents the authenticated user from posting.", "restricted_action_non_threadable_channel": "Cannot post thread replies into a non_threadable channel.", + "restricted_too_many": "Too many messages were scheduled in the channel for a given period. See usage info for additional details", + "metadata_too_large": "Metadata exceeds size limit", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_archived": "Channel has been archived.", + "time_in_past": "value passed for post_time was in the past.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "restricted_action": "A workspace preference prevents the authenticated user from posting.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_metadata_schema": "Invalid metadata schema provided", + "too_many_attachments": "Too many attachments were provided with this message. A maximum of 100 attachments are allowed on a message.", + "rate_limited": "Application has posted too many messages, read the Rate Limit documentation for more information", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", "restricted_action_read_only_channel": "Cannot post any message into a read-only channel.", + "time_too_far": "value passed for post_time was too far into the future.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_blocks": "Blocks submitted with this message are not valid", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "Value passed for channel was invalid.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "metadata_must_be_sent_from_app": "Message metadata can only be posted or updated using an app token", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "slack_connect_file_link_sharing_blocked": "Admin has disabled Slack File sharing in all Slack Connect communications", "restricted_action_thread_only_channel": "Cannot post top-level messages into a thread-only channel.", - "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", - "time_in_past": "value passed for `post_time` was in the past.", - "time_too_far": "value passed for `post_time` was too far into the future.", - "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed.", - "too_many_attachments": "Too many attachments were provided with this message. A maximum of 100 attachments are allowed on a message." + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "not_in_channel": "Cannot post user messages to a channel they are not in.", + "method_deprecated": "The method has been deprecated." }, + "is_deprecated": false, + "link": "/methods/chat.scheduleMessage", + "name": "chat.scheduleMessage", "response": { - "channel": "C1H9RESGL", + "channel": "C123456", "message": { "attachments": [ { @@ -100,7 +171,7 @@ "text": "This is an attachment" } ], - "bot_id": "B19LU7CSY", + "bot_id": "B123456", "subtype": "bot_message", "text": "Here's a message for you in the future", "type": "delayed_message", @@ -111,8 +182,8 @@ "scheduled_message_id": "Q1298393284" }, "warnings": { - "message_truncated": "The `text` field of a message should have no more than 40,000 characters. We truncate really long messages.", - "missing_charset": "The method was called via a `POST` request, and recommended practice for the specified `Content-Type` is to include a `charset` parameter. However, no `charset` was present. Specifically, non-form-data content types (e.g. `text/plain`) are the ones for which `charset` is recommended.", - "superfluous_charset": "The method was called via a `POST` request, and the specified `Content-Type` is not defined to understand the `charset` parameter. However, `charset` was in fact present. Specifically, form-data content types (e.g. `multipart/form-data`) are the ones for which `charset` is superfluous." + "message_truncated": "The text field of a message should have no more than 40,000 characters. We truncate really long messages.", + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/chat.scheduledMessages.list.json b/lib/slack/web/docs/chat.scheduledMessages.list.json new file mode 100644 index 0000000..1d55b64 --- /dev/null +++ b/lib/slack/web/docs/chat.scheduledMessages.list.json @@ -0,0 +1,115 @@ +{ + "args": { + "channel": { + "desc": "The channel of the scheduled messages", + "example": "C123456789", + "name": "channel", + "required": false, + "type": "string" + }, + "cursor": { + "desc": "For pagination purposes, this is the cursor value returned from a previous call to chat.scheduledmessages.list indicating where you want to start this call from.", + "example": "dXNlcjpVMDYxTkZUVDI=", + "name": "cursor", + "required": false, + "type": "string" + }, + "latest": { + "desc": "A UNIX timestamp of the latest value in the time range", + "example": "1562137200", + "name": "latest", + "required": false, + "type": "string" + }, + "limit": { + "desc": "Maximum number of original entries to return.", + "example": "100", + "name": "limit", + "required": false, + "type": "integer" + }, + "oldest": { + "desc": "A UNIX timestamp of the oldest value in the time range", + "example": "1562137200", + "name": "oldest", + "required": false, + "type": "string" + }, + "team_id": { + "desc": "encoded team id to list channels in, required if org token is used", + "example": "T1234567890", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Returns a list of scheduled messages.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_channel": "The channel passed is invalid", + "accesslimited": "Access to this method is limited on the current network", + "invalid_cursor": "Provided cursor is invalid", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "invalid_token": "Token is invalid", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/chat.scheduledMessages.list", + "name": "chat.scheduledMessages.list", + "response": { + "ok": true, + "response_metadata": { + "next_cursor": "" + }, + "scheduled_messages": [ + { + "channel_id": "C1H9RESGL", + "date_created": 1551891734, + "id": 1298393284, + "post_at": 1551991428, + "text": "Here's a message for you in the future" + } + ] + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/chat.unfurl.json b/lib/slack/web/docs/chat.unfurl.json index 03a5531..2d7254b 100644 --- a/lib/slack/web/docs/chat.unfurl.json +++ b/lib/slack/web/docs/chat.unfurl.json @@ -1,42 +1,92 @@ { "args": { "channel": { - "desc": "Channel ID of the message.", + "desc": "Channel ID of the message. Both channel and ts must be provided together, orunfurl_id and source must be provided together.", "example": "C1234567890", + "name": "channel", "required": true, - "type": "channel" + "type": "string" + }, + "source": { + "desc": "The source of the link to unfurl. The source may either be composer, when the link is inside the message composer, or conversations_history, when the link has been posted to a conversation.", + "example": "composer", + "name": "source", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" }, "ts": { "desc": "Timestamp of the message to add unfurl behavior to.", - "example": "1405894322.002768", - "required": true + "example": "", + "name": "ts", + "required": true, + "type": "string" + }, + "unfurl_id": { + "desc": "The ID of the link to unfurl. Both unfurl_id and source must be provided together, orchannel and ts must be provided together.", + "example": "Uxxxxxxx-909b5454-75f8-4ac4-b325-1b40e230bbd8", + "name": "unfurl_id", + "required": false, + "type": "string" }, "unfurls": { "desc": "URL-encoded JSON map with keys set to URLs featured in the the message, pointing to their unfurl blocks or message attachments.", - "required": true + "example": "", + "name": "unfurls", + "required": true, + "type": "string" + }, + "user_auth_blocks": { + "desc": "Provide a JSON based array of structured blocks presented as URL-encoded string to send as an ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior", + "example": "", + "name": "user_auth_blocks", + "required": false, + "type": "string" }, "user_auth_message": { - "desc": "Provide a simply-formatted string to send as an ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior.", - "required": false + "desc": "Provide a simply-formatted string to send as an ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior. Provides two buttons, Not now or Never ask me again.", + "example": "", + "name": "user_auth_message", + "required": false, + "type": "null" }, "user_auth_required": { - "desc": "Set to true or 1 to indicate the user must install your Slack app to trigger unfurls for this domain.", - "example": true, - "required": false + "desc": "Set to true or 1 to indicate the user must install your Slack app to trigger unfurls for this domain", + "example": "0true", + "name": "user_auth_required", + "required": false, + "type": "boolean" }, "user_auth_url": { - "desc": "Send users to this custom URL where they will complete authentication in your app to fully trigger unfurling. Value should be properly URL-encoded..", + "desc": "Send users to this custom URL where they will complete authentication in your app to fully trigger unfurling. Value should be properly URL-encoded.", "example": "https://example.com/onboarding?user_id=xxx", - "required": false + "name": "user_auth_url", + "required": false, + "type": "null" } }, - "desc": "Provide custom unfurl behavior for user-posted URLs.", + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Provide custom unfurl behavior for user-posted URLs", "errors": { "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", "ekm_access_denied": "Administrators have suspended the ability to post a message.", "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", - "account_inactive": "Authentication token is for a deleted user or workspace.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", "cannot_find_message": "The ts value in the request does not match a message.", + "cannot_auth_user": "The current user cannot be authenticated.", + "invalid_source": "The unfurl source is invalid.", + "missing_unfurl_id": "The request is missing the unfurl_id parameter.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", "not_authed": "No authentication token provided.", "missing_unfurls": "The request is missing the unfurls parameter.", @@ -44,13 +94,13 @@ "is_bot": "This method cannot be called by a bot user.", "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", "missing_channel": "The request is missing the channel parameter", - "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/json application/x-www-form-urlencoded multipart/form-data text/plain.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", "cannot_find_service": "A record of your app being allowed to unfurl for this workspace could not be found.", - "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", "deprecated_endpoint": "The endpoint has been deprecated.", "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", - "cannot_unfurl_url": "The URL cannot be unfurled. This error may be returned if you haven't acknowledged a link_shared event tied to the same URL. It is also returned when the domain appears in a workspace's administrative blacklists.", - "invalid_form_data": "The method was called via a POST request with Content-Type application/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "cannot_unfurl_url": "The URL cannot be unfurled. This error may be returned if you haven't acknowledged a link_shared event tied to the same URL. It is also returned when the domain appears in a workspace's administrative blocklists.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", "accesslimited": "Access to this method is limited on the current network", "cannot_parse_attachment": "The provided unfurls argument could not be parsed or understood.", "enterprise_is_restricted": "The method cannot be called from an Enterprise.", @@ -63,13 +113,26 @@ "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", "two_factor_setup_required": "Two factor setup is required.", "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "invalid_unfurl_id": "The unfurl ID is invalid.", "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", "service_unavailable": "The service is temporarily unavailable", "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", - "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8 iso-8859-1.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "missing_source": "The request is missing the source parameter.", "cannot_unfurl_message": "The URL cannot be unfurled because the URL provided does not appear in the message.", "cannot_find_channel": "The specified channel could not be located for this token.", "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/chat.unfurl", + "name": "chat.unfurl", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/chat.update.json b/lib/slack/web/docs/chat.update.json index b3bb8d2..98b42eb 100644 --- a/lib/slack/web/docs/chat.update.json +++ b/lib/slack/web/docs/chat.update.json @@ -1,52 +1,164 @@ { "args": { "as_user": { - "desc": "Pass true to update the message as the authed user. [Bot users](/bot-users) in this context are considered authed users.", + "desc": "Pass true to update the message as the authed user. Bot users in this context are considered authed users.", "example": "true", - "required": false + "name": "as_user", + "required": false, + "type": "boolean" }, "attachments": { - "desc": "Structured message attachments.", - "example": "[{\"pretext\": \"pre-hello\", \"text\": \"text-world\"}]" + "desc": "A JSON-based array of structured attachments, presented as a URL-encoded string. This field is required when not presenting text. If you don't include this field, the message's previous attachments will be retained. To remove previous attachments, include an empty array for this field.", + "example": "[{\"pretext\": \"pre-hello\", \"text\": \"text-world\"}]", + "name": "attachments", + "required": false, + "type": "string" }, "blocks": { - "desc": "A JSON-based array of structured blocks, presented as a URL-encoded string. If you don't include this field, the message's previous `blocks` will be retained. To remove previous `blocks`, include an empty array for this field.", + "desc": "A JSON-based array of structured blocks, presented as a URL-encoded string. If you don't include this field, the message's previous blocks will be retained. To remove previous blocks, include an empty array for this field.", "example": "[{\"type\": \"section\", \"text\": {\"type\": \"plain_text\", \"text\": \"Hello world\"}}]", - "required": false + "name": "blocks", + "required": false, + "type": "blocks[] as string" }, "channel": { "desc": "Channel containing the message to be updated.", + "example": "C1234567890", + "name": "channel", "required": true, - "type": "channel" + "type": "string" + }, + "file_ids": { + "desc": "Array of new file ids that will be sent with this message.", + "example": "F013GKY52QK,F013GL22D0T or [\"F013GKY52QK\",\"F013GL22D0T\"]", + "name": "file_ids", + "required": false, + "type": "array" }, "link_names": { - "desc": "Find and link channel names and usernames. Defaults to `none`. This parameter should be used in conjunction with `parse`. To set `link_names` to `1`, specify a `parse` mode of `full`.", - "example": "1", - "required": false + "desc": "Find and link channel names and usernames. Defaults to none. If you do not specify a value for this field, the original value set for the message will be overwritten with the default, none.", + "example": "true", + "name": "link_names", + "required": false, + "type": "boolean" + }, + "metadata": { + "desc": "JSON object with event_type and event_payload fields, presented as a URL-encoded string. If you don't include this field, the message's previous metadata will be retained. To remove previous metadata, include an empty object for this field. Metadata you post to Slack is accessible to any app or user who is a member of that workspace.", + "example": "{\"event_type\": \"task_created\", \"event_payload\": { \"id\": \"11223\", \"title\": \"Redesign Homepage\"}}", + "name": "metadata", + "required": false, + "type": "string" }, "parse": { - "desc": "Change how messages are treated. Defaults to `client`, unlike `chat.postMessage`. See [below](#formatting).", + "desc": "Change how messages are treated. Defaults to client, unlike chat.postMessage. Accepts either none or full. If you do not specify a value for this field, the original value set for the message will be overwritten with the default, client.", "example": "none", - "required": false + "name": "parse", + "required": false, + "type": "string" + }, + "reply_broadcast": { + "desc": "Broadcast an existing thread reply to make it visible to everyone in the channel or conversation.", + "example": "falsetrue", + "name": "reply_broadcast", + "required": false, + "type": "boolean" }, "text": { "desc": "New text for the message, using the default formatting rules. It's not required when presenting blocks or attachments.", "example": "Hello world", - "required": false + "name": "text", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" }, "ts": { "desc": "Timestamp of the message to be updated.", - "example": "1405894322.002768", - "required": true + "example": "\"1405894322.002768\"", + "name": "ts", + "required": true, + "type": "string" } }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], "desc": "Updates a message.", "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_dual_broadcast_content_update": "Can't broadcast an old reply and update the content at the same time.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "msg_too_long": "Message text is too long", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "no_text": "No message text provided", + "as_user_not_supported": "The as_user parameter does not function with workspace apps.", + "invalid_metadata_format": "Invalid metadata format provided", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "team_not_found": "Team associated with the message and channel could not be found.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "update_failed": "Internal update failure.", + "not_authed": "No authentication token provided.", + "metadata_too_large": "Metadata exceeds size limit", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", "cant_update_message": "Authenticated user does not have permission to update this message.", - "channel_not_found": "Value passed for `channel` was invalid.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "external_channel_migrating": "The channel is in the process of migrating and so the message cannot be updated at this time.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "cant_broadcast_message": "Unable to broadcast this message.", + "invalid_attachments": "The attachments were invalid.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_metadata_schema": "Invalid metadata schema provided", + "too_many_attachments": "Too many attachments were provided with this message. A maximum of 100 attachments are allowed on a message.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", "edit_window_closed": "The message cannot be edited due to the team message edit settings", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "is_inactive": "The message cannot be edited within a frozen, archived or deleted channel.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_blocks": "The blocks were invalid for the requesting user.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "Value passed for channel was invalid.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "metadata_must_be_sent_from_app": "Message metadata can only be posted or updated using an app token", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", "message_not_found": "No message exists with the requested timestamp.", - "msg_too_long": "Message text is too long", - "no_text": "No message text provided" + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "slack_connect_file_link_sharing_blocked": "Admin has disabled Slack File sharing in all Slack Connect communications", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/chat.update", + "name": "chat.update", + "response": { + "channel": "C024BE91L", + "message": { + "text": "Updated text you carefully authored", + "user": "U34567890" + }, + "ok": true, + "text": "Updated text you carefully authored", + "ts": "1401383885.000061" + }, + "warnings": { + "message_truncated": "The text field of a message should have no more than 40,000 characters. We truncate really long messages.", + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/conversations.acceptSharedInvite.json b/lib/slack/web/docs/conversations.acceptSharedInvite.json new file mode 100644 index 0000000..511cf0b --- /dev/null +++ b/lib/slack/web/docs/conversations.acceptSharedInvite.json @@ -0,0 +1,132 @@ +{ + "args": { + "channel_id": { + "desc": "ID of the channel that you'd like to accept. Must provide either invite_id or channel_id.", + "example": "", + "name": "channel_id", + "required": false, + "type": "string" + }, + "channel_name": { + "desc": "Name of the channel. If the channel does not exist already in your workspace, this name is the one that the channel will take.", + "example": "puppies-r-us", + "name": "channel_name", + "required": true, + "type": "string" + }, + "free_trial_accepted": { + "desc": "Whether you'd like to use your workspace's free trial to begin using Slack Connect.", + "example": "true", + "name": "free_trial_accepted", + "required": false, + "type": "boolean" + }, + "invite_id": { + "desc": "See the shared_channel_invite_received event payload for more details on how to retrieve the ID of the invitation.", + "example": "", + "name": "invite_id", + "required": false, + "type": "string" + }, + "is_private": { + "desc": "Whether the channel should be private.", + "example": "true", + "name": "is_private", + "required": false, + "type": "boolean" + }, + "team_id": { + "desc": "The ID of the workspace to accept the channel in. If an org-level token is used to call this method, the team_id argument is required.", + "example": "T1234567890", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Accepts an invitation to a Slack Connect channel.", + "errors": { + "not_allowed_for_grid_workspace": "Acceptance is not allowed for this workspace.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "user_not_found": "The user accepting the invite is not a member of the team provided in the team_id argument.", + "invalid_name_punctuation": "The value passed for channel_name contained only punctuation.", + "invalid_recipient_team": "The accepting team does not match the expected recipient team.", + "invalid_name_specials": "The value passed for channel_name contained unallowed special characters or upper case characters.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "invalid_name_required": "The value passed for channel_name was empty.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "name_taken": "The desired channel name is already taken in your workspace.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "team_not_found": "The team provided in the team_id argument does not exits.", + "invite_from_same_org": "You can't accept an invite from the same org or workspace.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_target_team": "The target workspace is invalid.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "failed_to_start_trial": "Unable to initiate a trial on shared invite acceptance", + "user_required_to_accept_as_private_but_cannot": "This uer cannot accept a private channel invitation.", + "invite_used": "This invite has already been accepted.", + "restricted_action": "A team preference prevents the authenticated user from creating private channels.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "channel_conversion_in_progress": "Unable to create a channel connection while a channel conversion is in progress", + "user_is_restricted": "This method cannot be called by a restricted user or single channel guest.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "not_paid": "This workspace doesn't have access to this feature.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "invalid_name": "The value passed for channel_name was invalid.", + "legacy_connection_limit_exceeded": "You cannot share a legacy ESC channel with a third team", + "legacy_connection_invalid_org": "Teams not previously connected to this legacy channel can't connect.", + "is_pending_connected_to_org": "A team pending to join the channel is on the org of the team trying to accept.", + "invalid_link": "We couldn't find an invite associated with the ID provided.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "connection_limit_exceeded": "This channel has hit the limit of external connections.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "has_already_connected_to_org": "A team on the workspace of the org is already in the channel.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "invalid_name_maxlength": "The value passed for channel_name exceeded the maximum length.", + "email_does_not_match": "User's email does not match the email in the invite.", + "invalid_emoji_not_allowed": "The desired name contains emoji.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_host_team": "The host workspace is invalid.", + "invite_not_found": "We couldn't find a Slack Connect channel invite with the ID provided.", + "user_cannot_create_channel": "This user is not allowed to create a channel.", + "invalid_privacy": "An invalid channel privacy was provided.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/conversations.acceptSharedInvite", + "name": "conversations.acceptSharedInvite", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/conversations.approveSharedInvite.json b/lib/slack/web/docs/conversations.approveSharedInvite.json new file mode 100644 index 0000000..a5eaad7 --- /dev/null +++ b/lib/slack/web/docs/conversations.approveSharedInvite.json @@ -0,0 +1,84 @@ +{ + "args": { + "invite_id": { + "desc": "ID of the shared channel invite to approve", + "example": "", + "name": "invite_id", + "required": true, + "type": "string" + }, + "target_team": { + "desc": "The team or enterprise id of the other party involved in the invitation you are approving", + "example": "", + "name": "target_team", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Approves an invitation to a Slack Connect channel", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "approval_not_found": "We could not find an approval associated with the invite ID provided.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "invalid_action": "This action is no longer valid, e.g., trying to approve an invite that has already been approved.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "already_approved": "This invite was already approved by this team.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "restricted_action": "A team preference prevents the authenticated user from creating private channels.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "channel_conversion_in_progress": "A channel conversion is in progress", + "missing_target_team": "The target_team parameter is required for this request.", + "user_is_restricted": "This method cannot be called by a restricted user or single channel guest.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "not_paid": "The team attempting to approve this invite is not paid and therefore not eligible.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "invalid_link": "The link provided was invalid.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "approval_inactive": "The approval associated with the invite ID is not active.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "The channel associated with this invite wasn't found.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invite_not_found": "The invite specified wasn't found.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/conversations.approveSharedInvite", + "name": "conversations.approveSharedInvite", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/conversations.archive.json b/lib/slack/web/docs/conversations.archive.json new file mode 100644 index 0000000..a4d569c --- /dev/null +++ b/lib/slack/web/docs/conversations.archive.json @@ -0,0 +1,74 @@ +{ + "args": { + "channel": { + "desc": "ID of conversation to archive", + "example": "C1234567890", + "name": "channel", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Archives a conversation.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "cant_archive_required": "You cannot archive a required channel", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "already_archived": "Channel has already been archived.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "restricted_action": "A team preference prevents the authenticated user from archiving.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "method_not_supported_for_channel_type": "This type of conversation cannot be used with this method.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "user_is_restricted": "This method cannot be called by a restricted user or single channel guest.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "cant_archive_general": "You cannot archive the general channel", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "Value passed for channel was invalid.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "not_in_channel": "The token can not be found in channel.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/conversations.archive", + "name": "conversations.archive", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/conversations.close.json b/lib/slack/web/docs/conversations.close.json index f18fa8b..008be97 100644 --- a/lib/slack/web/docs/conversations.close.json +++ b/lib/slack/web/docs/conversations.close.json @@ -3,11 +3,66 @@ "channel": { "desc": "Conversation to close.", "example": "G1234567890", - "required": true + "name": "channel", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" } }, - "desc": "Closes direct messages, multi-person or 1:1 or otherwise.", + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Closes a direct message or multi-person direct message.", "errors": { - "channel_not_found": "Value passed for `channel` was invalid" + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "method_not_supported_for_channel_type": "This type of conversation cannot be used with this method.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "Value passed for channel was invalid.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "user_does_not_own_channel": "Calling user does not own this DM channel.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/conversations.close", + "name": "conversations.close", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/conversations.create.json b/lib/slack/web/docs/conversations.create.json index 14b6b33..f505148 100644 --- a/lib/slack/web/docs/conversations.create.json +++ b/lib/slack/web/docs/conversations.create.json @@ -1,56 +1,88 @@ { "args": { "is_private": { - "desc": "Create a private channel instead of a public one.", + "desc": "Create a private channel instead of a public one", "example": "true", - "required": false + "name": "is_private", + "required": false, + "type": "boolean" }, "name": { - "desc": "Name of the public or private channel to create.", + "desc": "Name of the public or private channel to create", "example": "mychannel", - "required": true + "name": "name", + "required": true, + "type": "string" }, - "user_ids": { - "desc": "Required for workspace apps. A list of between 1 and 30 human users that will be added to the newly-created conversation. This argument has no effect when used by classic Slack apps.", - "example": "W1234567890,U2345678901,U3456789012", - "required": false + "team_id": { + "desc": "encoded team id to create the channel in, required if org token is used", + "example": "T1234567890", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" } }, - "desc": "Initiates a public or private channel-based conversation.", + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Initiates a public or private channel-based conversation", "errors": { - "account_inactive": "Authentication token is for a deleted user or workspace.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "user_is_ultra_restricted": "This method cannot be called by a single channel guest.", + "invalid_name_punctuation": "Value passed for name contained only punctuation.", + "invalid_name_specials": "Value passed for name contained unallowed special characters or upper case characters.", + "no_channel": "Value passed for name was empty.", "ekm_access_denied": "Administrators have suspended the ability to post a message.", - "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_name_required": "Value passed for name was empty.", + "too_many_convos_for_app_on_team": "This app has exceeded its per-workspace limit of public and private channels.", "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", - "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", - "invalid_arguments": "The method was called with invalid arguments.", - "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", - "invalid_charset": "The method was called via a `POST` request, but the `charset` specified in the `Content-Type` header was invalid. Valid charset names are: `utf-8` `iso-8859-1`.", - "invalid_form_data": "The method was called via a `POST` request with `Content-Type` `application/x-www-form-urlencoded` or `multipart/form-data`, but the form data was either missing or syntactically invalid.", - "invalid_name": "Value passed for `name` was invalid.", - "invalid_name_maxlength": "Value passed for `name` exceeded max length.", - "invalid_name_punctuation": "Value passed for `name` contained only punctuation.", - "invalid_name_required": "Value passed for `name` was empty.", - "invalid_name_specials": "Value passed for `name` contained unallowed special characters or upper case characters.", - "invalid_post_type": "The method was called via a `POST` request, but the specified `Content-Type` was invalid. Valid types are: `application/json` `application/x-www-form-urlencoded` `multipart/form-data` `text/plain`.", - "invalid_users": "Value passed for `user_ids` was empty or invalid.", - "is_bot": "This method cannot be called by a bot user.", - "missing_post_type": "The method was called via a `POST` request and included a data payload, but the request did not include a `Content-Type` header.", - "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", "name_taken": "A channel cannot be created with the given name.", - "no_channel": "Value passed for `name` was empty.", - "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", "not_authed": "No authentication token provided.", - "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", - "request_timeout": "The method was called via a `POST` request, but the `POST` data was either missing or truncated.", - "restricted_action": "A team preference prevents the authenticated user from creating channels.", "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", - "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed.", - "too_many_convos_for_app_on_team": "This app has exceeded its per-workspace limit of public and private channels.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "restricted_action": "A team preference prevents the authenticated user from creating channels.", + "cannot_create_channel": "This channel is unable to be created.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", "too_many_convos_for_team": "The workspace has exceeded its limit of public and private channels.", - "user_is_ultra_restricted": "This method cannot be called by a single channel guest.", - "user_not_found": "One or more users in `user_ids` was not found." + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "missing_argument": "A required argument is missing.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "invalid_name": "Value passed for name was invalid.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "invalid_name_maxlength": "Value passed for name exceeded max length.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." }, + "is_deprecated": false, + "link": "/methods/conversations.create", + "name": "conversations.create", "response": { "channel": { "created": 1504554479, @@ -92,7 +124,7 @@ "ok": true }, "warnings": { - "missing_charset": "The method was called via a `POST` request, and recommended practice for the specified `Content-Type` is to include a `charset` parameter. However, no `charset` was present. Specifically, non-form-data content types (e.g. `text/plain`) are the ones for which `charset` is recommended.", - "superfluous_charset": "The method was called via a `POST` request, and the specified `Content-Type` is not defined to understand the `charset` parameter. However, `charset` was in fact present. Specifically, form-data content types (e.g. `multipart/form-data`) are the ones for which `charset` is superfluous." + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/conversations.declineSharedInvite.json b/lib/slack/web/docs/conversations.declineSharedInvite.json new file mode 100644 index 0000000..abd3e9f --- /dev/null +++ b/lib/slack/web/docs/conversations.declineSharedInvite.json @@ -0,0 +1,79 @@ +{ + "args": { + "invite_id": { + "desc": "ID of the Slack Connect invite to decline. Subscribe to the shared_channel_invite_accepted event to receive IDs of Slack Connect channel invites that have been accepted and are awaiting approval.", + "example": "", + "name": "invite_id", + "required": true, + "type": "string" + }, + "target_team": { + "desc": "The team or enterprise id of the other party involved in the invitation you are declining", + "example": "", + "name": "target_team", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Declines a Slack Connect channel invite.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "inactive_invite": "This invitation is no longer active, it may have expired or been revoked.", + "approval_not_found": "We could not find a Slack Connect approval for the invite provided.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "restricted_action": "A team preference prevents the authenticated user from declining Slack Connect invites..", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "missing_target_team": "The target_team parameter is required for this request.", + "user_is_restricted": "This method cannot be called by a restricted user or single channel guest.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "not_paid": "The workspace is not eligible to use Slack Connect.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "approval_inactive": "This approval is no longer active, it may have expired or been declined.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invite_not_found": "We could not find a Slack Connect invite associated with the ID provided.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/conversations.declineSharedInvite", + "name": "conversations.declineSharedInvite", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/conversations.history.json b/lib/slack/web/docs/conversations.history.json index 24fb1bc..484bd81 100644 --- a/lib/slack/web/docs/conversations.history.json +++ b/lib/slack/web/docs/conversations.history.json @@ -2,41 +2,130 @@ "args": { "channel": { "desc": "Conversation ID to fetch history for.", - "example": "G1234567890", - "required": true + "example": "C1234567890", + "name": "channel", + "required": true, + "type": "string" }, "cursor": { - "desc": "Paginate through collections of data by setting the cursor parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first \"page\" of the collection. See pagination for more detail.", + "desc": "Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first \"page\" of the collection. See pagination for more detail.", "example": "dXNlcjpVMDYxTkZUVDI=", - "required": false + "name": "cursor", + "required": false, + "type": "string" + }, + "include_all_metadata": { + "desc": "Return all metadata associated with this message.", + "example": "0true", + "name": "include_all_metadata", + "required": false, + "type": "boolean" }, "inclusive": { - "default": 0, - "desc": "Include messages with latest or oldest timestamp in results only when either timestamp is specified.", - "example": "true", - "required": false + "desc": "Include messages with oldest or latest timestamps in results. Ignored unless either timestamp is specified.", + "example": "0true", + "name": "inclusive", + "required": false, + "type": "boolean" }, "latest": { - "default": "now", - "desc": "End of time range of messages to include in results.", + "desc": "Only messages before this Unix timestamp will be included in results. Default is the current time.", "example": "1234567890.123456", - "required": false + "name": "latest", + "required": false, + "type": "string" }, "limit": { - "default": 100, "desc": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.", - "example": 20, - "required": false + "example": "10020", + "name": "limit", + "required": false, + "type": "number" }, "oldest": { - "default": 0, - "desc": "Start of time range of messages to include in results.", - "example": "1234567890.123456", - "required": false + "desc": "Only messages after this Unix timestamp will be included in results.", + "example": "01234567890.123456", + "name": "oldest", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" } }, - "desc": "Returns a portion of message events from the specified conversation.\n\nBot user tokens may use this method for direct message and multi-party direct message conversations but lack sufficient permissions to use this method on public and private channels.", + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Fetches a conversation's history of messages and events.", "errors": { - "channel_not_found": "Value passed for `channel` was invalid" + "invalid_ts_oldest": "Value passed for oldest was invalid", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "pagination_not_available": "Pagination does not currently function on Enterprise Grid workspaces.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "invalid_ts_latest": "Value passed for latest was invalid", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_metadata_filter_keys": "Value passed for metadata_keys_to_include was invalid. Must be valid json array of strings.", + "accesslimited": "Access to this method is limited on the current network", + "invalid_cursor": "Value passed for cursor was not valid or is no longer valid.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "Value passed for channel was invalid.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/conversations.history", + "name": "conversations.history", + "response": { + "has_more": true, + "messages": [ + { + "text": "I find you punny and would like to smell your nose letter", + "ts": "1512085950.000216", + "type": "message", + "user": "U012AB3CDE" + }, + { + "text": "What, you want to smell my shoes better?", + "ts": "1512104434.000490", + "type": "message", + "user": "U061F7AUR" + } + ], + "ok": true, + "pin_count": 0, + "response_metadata": { + "next_cursor": "bmV4dF90czoxNTEyMDg1ODYxMDAwNTQz" + } + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/conversations.info.json b/lib/slack/web/docs/conversations.info.json index 6274327..456ef10 100644 --- a/lib/slack/web/docs/conversations.info.json +++ b/lib/slack/web/docs/conversations.info.json @@ -1,25 +1,119 @@ { "args": { "channel": { - "desc": "Conversation ID to learn more about.", - "example": "G1234567890", - "required": true + "desc": "Conversation ID to learn more about", + "example": "C1234567890", + "name": "channel", + "required": true, + "type": "string" }, "include_locale": { - "default": "false", - "desc": "Set this to `true` to receive the locale for this conversation. Defaults to `false`", + "desc": "Set this to true to receive the locale for this conversation. Defaults to false", "example": "true", - "required": false + "name": "include_locale", + "required": false, + "type": "boolean" }, "include_num_members": { - "default": "false", - "desc": "Set to `true` to include the member count for the specified conversation. Defaults to `false`", - "example": "true", - "required": false + "desc": "Set to true to include the member count for the specified conversation. Defaults to false", + "example": "falsetrue", + "name": "include_num_members", + "required": false, + "type": "boolean" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" } }, - "desc": "Returns information about a workspace conversation.", + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Retrieve information about a conversation.", "errors": { - "channel_not_found": "Value passed for `channel` was invalid" + "access_denied": "Access to a resource specified in the request is denied.", + "accesslimited": "Access to this method is limited on the current network", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "channel_not_found": "Value passed for channel was invalid.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "method_deprecated": "The method has been deprecated.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "not_authed": "No authentication token provided.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "service_unavailable": "The service is temporarily unavailable", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_expired": "Authentication token has expired", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "two_factor_setup_required": "Two factor setup is required." + }, + "is_deprecated": false, + "link": "/methods/conversations.info", + "name": "conversations.info", + "response": { + "channel": { + "created": 1449252889, + "creator": "W012A3BCD", + "id": "C012AB3CD", + "is_archived": false, + "is_channel": true, + "is_ext_shared": false, + "is_general": true, + "is_group": false, + "is_im": false, + "is_member": true, + "is_mpim": false, + "is_org_shared": false, + "is_pending_ext_shared": false, + "is_private": false, + "is_read_only": false, + "is_shared": false, + "last_read": "1502126650.228446", + "locale": "en-US", + "name": "general", + "name_normalized": "general", + "parent_conversation": null, + "pending_shared": [], + "previous_names": [ + "specifics", + "abstractions", + "etc" + ], + "purpose": { + "creator": "W012A3BCD", + "last_set": 1449709364, + "value": "This part of the workspace is for fun. Make fun here." + }, + "topic": { + "creator": "W012A3BCD", + "last_set": 1449709364, + "value": "For public discussion of generalities" + }, + "unlinked": 0 + }, + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/conversations.invite.json b/lib/slack/web/docs/conversations.invite.json index b50ee57..54e1157 100644 --- a/lib/slack/web/docs/conversations.invite.json +++ b/lib/slack/web/docs/conversations.invite.json @@ -3,48 +3,80 @@ "channel": { "desc": "The ID of the public or private channel to invite user(s) to.", "example": "C1234567890", - "required": true + "name": "channel", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" }, "users": { "desc": "A comma separated list of user IDs. Up to 1000 users may be listed.", "example": "W1234567890,U2345678901,U3456789012", - "required": true + "name": "users", + "required": true, + "type": "string" } }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], "desc": "Invites users to a channel.", "errors": { - "account_inactive": "Authentication token is for a deleted user or workspace.", - "already_in_channel": "Invited user is already in the channel.", - "cant_invite": "User cannot be invited to this channel.", - "cant_invite_self": "Authenticated user cannot invite themselves to a channel.", - "channel_not_found": "Value passed for `channel` was invalid.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "user_is_ultra_restricted": "This method cannot be called by a single channel guest.", + "user_not_found": "Value passed for users was invalid.", + "org_user_not_in_team": "One or more members invited are part of the Enterprise Grid organization but not the specific workspace you're interfacing with.", "ekm_access_denied": "Administrators have suspended the ability to post a message.", - "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", - "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", - "invalid_arguments": "The method was called with invalid arguments.", - "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", - "invalid_charset": "The method was called via a `POST` request, but the `charset` specified in the `Content-Type` header was invalid. Valid charset names are: `utf-8` `iso-8859-1`.", - "invalid_form_data": "The method was called via a `POST` request with `Content-Type` `application/x-www-form-urlencoded` or `multipart/form-data`, but the form data was either missing or syntactically invalid.", - "invalid_post_type": "The method was called via a `POST` request, but the specified `Content-Type` was invalid. Valid types are: `application/json` `application/x-www-form-urlencoded` `multipart/form-data` `text/plain`.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "ura_max_channels": "An invited user is a single-channel guest user ('ultra restricted access') that is already in the maximum number of conversations.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", "invitee_cant_see_channel": "The Grid multi-workspace channel you are inviting a user to is not shared with any workspaces the user is currently a member of.", - "is_archived": "Channel has been archived.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", "is_bot": "This method cannot be called by a bot user.", + "is_archived": "Channel has been archived.", + "already_in_channel": "Invited user is already in the channel.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", "method_not_supported_for_channel_type": "This type of conversation cannot be used with this method.", - "missing_post_type": "The method was called via a `POST` request and included a data payload, but the request did not include a `Content-Type` header.", - "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "user_is_restricted": "An invited user is a guest user that is restricted from accessing this conversation.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "Value passed for channel was invalid.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "cant_invite_self": "Authenticated user cannot invite themselves to a channel.", + "cant_invite": "User cannot be invited to this channel.", "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", - "no_user": "No value was passed for `users`.", - "not_authed": "No authentication token provided.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", "not_in_channel": "Authenticated user is not in the channel.", - "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", - "request_timeout": "The method was called via a `POST` request, but the `POST` data was either missing or truncated.", - "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", - "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed.", - "ura_max_channels": "URA is already in the maximum number of channels.", - "user_is_ultra_restricted": "This method cannot be called by a single channel guest.", - "user_not_found": "Value passed for `users` was invalid." + "no_user": "No value was passed for users.", + "method_deprecated": "The method has been deprecated." }, + "is_deprecated": false, + "link": "/methods/conversations.invite", + "name": "conversations.invite", "response": { "channel": { "created": 1449252889, @@ -64,10 +96,8 @@ "is_read_only": false, "is_shared": false, "last_read": "1502126650.228446", - "locale": "en-US", "name": "general", "name_normalized": "general", - "num_members": 23, "pending_shared": [], "previous_names": [ "specifics", @@ -89,7 +119,7 @@ "ok": true }, "warnings": { - "missing_charset": "The method was called via a `POST` request, and recommended practice for the specified `Content-Type` is to include a `charset` parameter. However, no `charset` was present. Specifically, non-form-data content types (e.g. `text/plain`) are the ones for which `charset` is recommended.", - "superfluous_charset": "The method was called via a `POST` request, and the specified `Content-Type` is not defined to understand the `charset` parameter. However, `charset` was in fact present. Specifically, form-data content types (e.g. `multipart/form-data`) are the ones for which `charset` is superfluous." + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/conversations.inviteShared.json b/lib/slack/web/docs/conversations.inviteShared.json new file mode 100644 index 0000000..57b914a --- /dev/null +++ b/lib/slack/web/docs/conversations.inviteShared.json @@ -0,0 +1,113 @@ +{ + "args": { + "channel": { + "desc": "ID of the channel on your team that you'd like to share", + "example": "C1234567890", + "name": "channel", + "required": true, + "type": "string" + }, + "emails": { + "desc": "Optional email to receive this invite. Either emails or user_ids must be provided.", + "example": "", + "name": "emails", + "required": false, + "type": "array" + }, + "external_limited": { + "desc": "Optional boolean on whether invite is to a external limited member. Defaults to true.", + "example": "true", + "name": "external_limited", + "required": false, + "type": "boolean" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + }, + "user_ids": { + "desc": "Optional user_id to receive this invite. Either emails or user_ids must be provided.", + "example": "", + "name": "user_ids", + "required": false, + "type": "array" + } + }, + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Sends an invitation to a Slack Connect channel", + "errors": { + "not_allowed_for_grid_workspace": "This workspace does not have Slack Connect enabled.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "user_not_found": "User lookup failed.", + "channel_archived": "You cannot share an archived channel.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "too_many_emails": "Too many email recipients were passed in the emails parameter.", + "member_limit_exceeded": "This channel that has hit the limit of members", + "connection_limit_exceeded_pending": "This channel already has a pending invite.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "already_in_channel": "User is already in the channel.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "ratelimit": "The rate-limit for this method has been reached. The ratelimit is applied on a per-user basis when you pass the emails parameter.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "restricted_action": "A team preference does not allow this authorization to send invites.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "cannot_share_mandatory_channel": "You cannot share #general or mandatory channels.", + "recipients_not_specified": "Bots are required to specify which users to invite.", + "user_is_restricted": "This method cannot be called by a restricted user or single channel guest.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "cannot_share_cross_workspace_channel": "You cannot share a cross-workspace or org-wide channel.", + "not_paid": "This feature is only available to paid teams.", + "not_supported": "This channel cannot be shared.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "legacy_connection_limit_exceeded": "You cannot share a legacy ESC channel with a third team", + "invite_lookup_error": "An error occurred while attempting to look for existing invites.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "connection_limit_exceeded": "This channel has hit the limit of external connections.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "The channel provided was not found.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "not_owner": "Only the host organization for a channel can request to share it.", + "url_in_message": "The message contained a URL.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "message_too_long": "The provided message was longer than 560 characters.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "invalid_email": "At least one email address provided is invalid.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invite_not_found": "An error occurred while inviting users.", + "invalid_channel_type": "You cannot share MPDMs or DMs.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/conversations.inviteShared", + "name": "conversations.inviteShared", + "response": { + "invite_id": "I02UKAJ6RJA", + "is_legacy_shared_channel": false, + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/conversations.join.json b/lib/slack/web/docs/conversations.join.json index c3db7ee..de55e5d 100644 --- a/lib/slack/web/docs/conversations.join.json +++ b/lib/slack/web/docs/conversations.join.json @@ -3,39 +3,107 @@ "channel": { "desc": "ID of conversation to join", "example": "C1234567890", - "required": true + "name": "channel", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" } }, - "desc": "Joins an existing conversation", + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Joins an existing conversation.", "errors": { - "account_inactive": "Authentication token is for a deleted user or workspace.", - "channel_not_found": "Value passed for `channel` was invalid.", - "deprecated_endpoint": "The endpoint has been deprecated.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "too_many_members": "The membership in the channel has exceeded our maximum member limit. No more users can join the channel.", "ekm_access_denied": "Administrators have suspended the ability to post a message.", - "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", - "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than `_`. If you get this error, it is typically an indication that you have made a very malformed API call.", - "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", - "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", - "invalid_charset": "The method was called via a `POST` request, but the charset specified in the `Content-Type` header was invalid. Valid charset names are: `utf-8` `iso-8859-1`.", - "invalid_form_data": "The method was called via a `POST` request with `Content-Type` `application/x-www-form-urlencoded` or `multipart/form-data`, but the form data was either missing or syntactically invalid.", - "invalid_post_type": "The method was called via a `POST` request, but the specified `Content-Type` was invalid. Valid types are: `application/json` `application/x-www-form-urlencoded` `multipart/form-data` `text/plain`.", - "is_archived": "Channel has been archived.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", "is_bot": "This method cannot be called by a bot user.", - "method_deprecated": "The method has been deprecated.", + "is_archived": "Channel has been archived.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", "method_not_supported_for_channel_type": "This type of conversation cannot be used with this method.", - "missing_post_type": "The method was called via a `POST` request and included a data payload, but the request did not include a `Content-Type` header.", - "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", - "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", - "not_allowed_token_type": "The token type used in this request is not allowed.", - "not_authed": "No authentication token provided.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "user_is_restricted": "This method cannot be called by a restricted user or single channel guest.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", - "ratelimited": "The request has been ratelimited. Refer to the `Retry-After` header for when to retry the request.", - "request_timeout": "The method was called via a `POST` request, but the `POST` data was either missing or truncated.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "Value passed for channel was invalid.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", "service_unavailable": "The service is temporarily unavailable", - "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", - "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed.", - "too_many_members": "The membership in the channel has exceeded our maximum member limit. No more users can join the channel.", - "user_is_restricted": "This method cannot be called by a restricted user or single channel guest." + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/conversations.join", + "name": "conversations.join", + "response": { + "channel": { + "created": 1449252889, + "creator": "U061F7AUR", + "id": "C061EG9SL", + "is_archived": false, + "is_channel": true, + "is_ext_shared": false, + "is_general": true, + "is_group": false, + "is_im": false, + "is_member": true, + "is_mpim": false, + "is_org_shared": false, + "is_pending_ext_shared": false, + "is_private": false, + "is_shared": false, + "name": "general", + "name_normalized": "general", + "pending_shared": [], + "previous_names": [], + "purpose": { + "creator": "", + "last_set": 0, + "value": "For widget discussion" + }, + "topic": { + "creator": "", + "last_set": 0, + "value": "Which widget do you worry about?" + }, + "unlinked": 0 + }, + "ok": true, + "response_metadata": { + "warnings": [ + "already_in_channel" + ] + }, + "warning": "already_in_channel" + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/conversations.kick.json b/lib/slack/web/docs/conversations.kick.json new file mode 100644 index 0000000..08647a9 --- /dev/null +++ b/lib/slack/web/docs/conversations.kick.json @@ -0,0 +1,82 @@ +{ + "args": { + "channel": { + "desc": "ID of conversation to remove user from.", + "example": "C1234567890", + "name": "channel", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + }, + "user": { + "desc": "User ID to be removed.", + "example": "W1234567890", + "name": "user", + "required": true, + "type": "string" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Removes a user from a conversation.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "user_not_found": "Value passed for user was invalid.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "cant_kick_from_general": "User cannot be removed from #general.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "cant_kick_self": "Authenticated user can't kick themselves from a channel.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "restricted_action": "A team preference prevents the authenticated user from kicking.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "method_not_supported_for_channel_type": "This type of conversation cannot be used with this method.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "user_is_restricted": "This method cannot be called by a restricted user or single channel guest.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "not_supported": "This is not supported for this channel and user combination.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "Value passed for channel was invalid.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "not_in_channel": "User was not in the channel.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/conversations.kick", + "name": "conversations.kick", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/conversations.leave.json b/lib/slack/web/docs/conversations.leave.json new file mode 100644 index 0000000..9f8e9c4 --- /dev/null +++ b/lib/slack/web/docs/conversations.leave.json @@ -0,0 +1,73 @@ +{ + "args": { + "channel": { + "desc": "Conversation to leave", + "example": "C1234567890", + "name": "channel", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Leaves a conversation.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "user_is_ultra_restricted": "This method cannot be called by a single channel guest.", + "cant_leave_general": "Authenticated user cannot leave the general channel", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "is_archived": "Channel has been archived.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "method_not_supported_for_channel_type": "This type of conversation cannot be used with this method.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "user_is_restricted": "Restricted and guest users cannot leave channel", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "last_member": "The last member party to a channel cannot leave the channel. Someone else must join the channel before this user is permitted to exit.", + "channel_not_found": "Value passed for channel was invalid.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/conversations.leave", + "name": "conversations.leave", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/conversations.list.json b/lib/slack/web/docs/conversations.list.json index aee2f26..aa19e84 100644 --- a/lib/slack/web/docs/conversations.list.json +++ b/lib/slack/web/docs/conversations.list.json @@ -1,34 +1,168 @@ { "args": { "cursor": { - "desc": "Paginate through collections of data by setting the cursor parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first \"page\" of the collection. See pagination for more detail.", + "desc": "Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first \"page\" of the collection. See pagination for more detail.", "example": "dXNlcjpVMDYxTkZUVDI=", - "required": false + "name": "cursor", + "required": false, + "type": "string" }, "exclude_archived": { - "default": "false", - "desc": "Set this to `true` to exclude archived channels from the list", - "example": "true", - "required": false + "desc": "Set to true to exclude archived channels from the list.", + "example": "falsetrue", + "name": "exclude_archived", + "required": false, + "type": "boolean" }, "limit": { - "default": 100, "desc": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. Must be an integer no larger than 1000.", - "example": 20, - "required": false + "example": "10020", + "name": "limit", + "required": false, + "type": "number" + }, + "team_id": { + "desc": "encoded team id to list channels in, required if token belongs to org-wide app", + "example": "T1234567890", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" }, "types": { - "default": "public_channel", - "desc": "Mix and match channel types by providing a comma-separated list of any combination of `public_channel`, `private_channel`, `mpim`, `im`", - "example": "public_channel,private_channel", - "required": false + "desc": "Mix and match channel types by providing a comma-separated list of any combination of public_channel, private_channel, mpim, im", + "example": "public_channelpublic_channel,private_channel", + "name": "types", + "required": false, + "type": "string" } }, - "desc": "Returns a list of all channel-like conversations in a workspace.", + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Lists all channels in a Slack team.", "errors": { - "invalid_cursor": "Value passed for `cursor` was invalid.", - "invalid_limit": "Value passed for `limit` was invalid.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "invalid_limit": "Value passed for limit is not understood.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", "invalid_types": "Value passed for type could not be used based on the method's capabilities or the permission scopes granted to the used token.", - "method_not_supported_for_channel_type": "This type of conversation cannot be used with this method." + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "method_not_supported_for_channel_type": "This type of conversation cannot be used with this method.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "missing_argument": "A required argument is missing.", + "accesslimited": "Access to this method is limited on the current network", + "invalid_cursor": "Value passed for cursor was not valid or is no longer valid.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/conversations.list", + "name": "conversations.list", + "response": { + "channels": [ + { + "created": 1449252889, + "creator": "U012A3CDE", + "id": "C012AB3CD", + "is_archived": false, + "is_channel": true, + "is_ext_shared": false, + "is_general": true, + "is_group": false, + "is_im": false, + "is_member": true, + "is_mpim": false, + "is_org_shared": false, + "is_pending_ext_shared": false, + "is_private": false, + "is_shared": false, + "name": "general", + "name_normalized": "general", + "num_members": 4, + "pending_shared": [], + "previous_names": [], + "purpose": { + "creator": "", + "last_set": 0, + "value": "This channel is for team-wide communication and announcements. All team members are in this channel." + }, + "topic": { + "creator": "", + "last_set": 0, + "value": "Company-wide announcements and work-based matters" + }, + "unlinked": 0 + }, + { + "created": 1449252889, + "creator": "U061F7AUR", + "id": "C061EG9T2", + "is_archived": false, + "is_channel": true, + "is_ext_shared": false, + "is_general": false, + "is_group": false, + "is_im": false, + "is_member": true, + "is_mpim": false, + "is_org_shared": false, + "is_pending_ext_shared": false, + "is_private": false, + "is_shared": false, + "name": "random", + "name_normalized": "random", + "num_members": 4, + "pending_shared": [], + "previous_names": [], + "purpose": { + "creator": "", + "last_set": 0, + "value": "A place for non-work-related flimflam, faffing, hodge-podge or jibber-jabber you'd prefer to keep out of more focused work-related channels." + }, + "topic": { + "creator": "", + "last_set": 0, + "value": "Non-work banter and water cooler conversation" + }, + "unlinked": 0 + } + ], + "ok": true, + "response_metadata": { + "next_cursor": "dGVhbTpDMDYxRkE1UEI=" + } + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/conversations.listConnectInvites.json b/lib/slack/web/docs/conversations.listConnectInvites.json new file mode 100644 index 0000000..4d12901 --- /dev/null +++ b/lib/slack/web/docs/conversations.listConnectInvites.json @@ -0,0 +1,81 @@ +{ + "args": { + "count": { + "desc": "Maximum number of invites to return", + "example": "100", + "name": "count", + "required": false, + "type": "integer" + }, + "cursor": { + "desc": "Set to next_cursor returned by previous call to list items in subsequent page", + "example": "5c3e53d5", + "name": "cursor", + "required": false, + "type": "string" + }, + "team_id": { + "desc": "Encoded team id for the workspace to retrieve invites for, required if org token is used", + "example": "T1234567890", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Lists shared channel invites that have been generated or received but have not been approved by all parties", + "errors": { + "access_denied": "Access to a resource specified in the request is denied.", + "accesslimited": "Access to this method is limited on the current network", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "is_bot": "This method cannot be called by a bot user.", + "method_deprecated": "The method has been deprecated.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "not_authed": "No authentication token provided.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "restricted_action": "A team preference prevents the authenticated user from viewing shared channel invites.", + "service_unavailable": "The service is temporarily unavailable", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_expired": "Authentication token has expired", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "two_factor_setup_required": "Two factor setup is required." + }, + "is_deprecated": false, + "link": "/methods/conversations.listConnectInvites", + "name": "conversations.listConnectInvites", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/conversations.mark.json b/lib/slack/web/docs/conversations.mark.json new file mode 100644 index 0000000..a214fc3 --- /dev/null +++ b/lib/slack/web/docs/conversations.mark.json @@ -0,0 +1,75 @@ +{ + "args": { + "channel": { + "desc": "Channel or conversation to set the read cursor for.", + "example": "C012345678", + "name": "channel", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + }, + "ts": { + "desc": "Unique identifier of message you want marked as most recently seen in this conversation.", + "example": "1593473566.000200", + "name": "ts", + "required": true, + "type": "string" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Sets the read cursor in a channel.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "invalid_timestamp": "Value passed for timestamp was invalid.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "Value passed for channel was invalid.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "not_in_channel": "Caller is not a member of the channel.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/conversations.mark", + "name": "conversations.mark", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/conversations.members.json b/lib/slack/web/docs/conversations.members.json index 3813f6c..bda54e9 100644 --- a/lib/slack/web/docs/conversations.members.json +++ b/lib/slack/web/docs/conversations.members.json @@ -2,33 +2,90 @@ "args": { "channel": { "desc": "ID of the conversation to retrieve members for", - "example": "G1234567890", - "required": true + "example": "C1234567890", + "name": "channel", + "required": true, + "type": "string" }, "cursor": { - "desc": "Paginate through collections of data by setting the cursor parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first \"page\" of the collection. See pagination for more detail.", + "desc": "Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first \"page\" of the collection. See pagination for more detail.", "example": "dXNlcjpVMDYxTkZUVDI=", - "required": false - }, - "exclude_archived": { - "default": "false", - "desc": "Set this to `true` to exclude archived channels from the list", - "example": "true", - "required": false + "name": "cursor", + "required": false, + "type": "string" }, "limit": { - "default": 100, - "desc": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached.", - "example": 20, - "required": false + "desc": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.", + "example": "10020", + "name": "limit", + "required": false, + "type": "number" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" } }, - "desc": "Returns a paginated list of members party to a conversation.", + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Retrieve members of a conversation.", "errors": { - "channel_not_found": "Value passed for `channel` was invalid.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "invalid_limit": "Value passed for limit was invalid.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", "fetch_members_failed": "Failed to fetch members for the conversation.", - "invalid_cursor": "Value passed for `cursor` was invalid.", - "invalid_limit": "Value passed for `limit` was invalid.", - "method_not_supported_for_channel_type": "This type of conversation cannot be used with this method." + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "method_not_supported_for_channel_type": "This type of conversation cannot be used with this method.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "invalid_cursor": "Value passed for cursor was invalid.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "Value passed for channel was invalid.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/conversations.members", + "name": "conversations.members", + "response": { + "members": [ + "U023BECGF", + "U061F7AUR", + "W012A3CDE" + ], + "ok": true, + "response_metadata": { + "next_cursor": "e3VzZXJfaWQ6IFcxMjM0NTY3fQ==" + } + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/conversations.open.json b/lib/slack/web/docs/conversations.open.json index 200dd02..b9a2359 100644 --- a/lib/slack/web/docs/conversations.open.json +++ b/lib/slack/web/docs/conversations.open.json @@ -1,30 +1,100 @@ { "args": { "channel": { - "desc": "Resume a conversation by supplying an `im` or `mpim`'s ID. Or provide the `users` field instead.", + "desc": "Resume a conversation by supplying an im or mpim's ID. Or provide the users field instead.", "example": "G1234567890", - "required": false + "name": "channel", + "required": false, + "type": "string" + }, + "prevent_creation": { + "desc": "Do not create a direct message or multi-person direct message. This is used to see if there is an existing dm or mpdm.", + "example": "true", + "name": "prevent_creation", + "required": false, + "type": "boolean" }, "return_im": { "desc": "Boolean, indicates you want the full IM channel definition in the response.", "example": "true", - "required": false + "name": "return_im", + "required": false, + "type": "boolean" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" }, "users": { - "desc": "Comma separated lists of users. If only one user is included, this creates a 1:1 DM. The ordering of the users is preserved whenever a multi-person direct message is returned. Supply a `channel` when not supplying `users`.", + "desc": "Comma separated lists of users. If only one user is included, this creates a 1:1 DM. The ordering of the users is preserved whenever a multi-person direct message is returned. Supply a channel when not supplying users.", "example": "W1234567890,U2345678901,U3456789012", - "required": false + "name": "users", + "required": false, + "type": "string" } }, - "desc": "Opens a multi-person direct message or just a 1:1 direct message.", + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Opens or resumes a direct message or multi-person direct message.", "errors": { - "channel_not_found": "Value passed for `channel` was invalid", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "user_not_found": "Value(s) passed for users was invalid.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", "method_not_supported_for_channel_type": "This type of conversation cannot be used with this method.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "user_not_visible": "The calling user is restricted from seeing the requested user.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", "not_enough_users": "Needs at least 2 users to open", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", "too_many_users": "Needs at most 8 users to open", - "user_disabled": "A specified `user` has been disabled", - "user_not_found": "Value(s) passed for `users` was invalid", - "user_not_visible": "The calling user is restricted from seeing the requested user.", - "users_list_not_supplied": "Missing `users` in request" + "user_disabled": "A specified user has been disabled.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "Value passed for channel was invalid.", + "users_list_not_supplied": "Missing users in request", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "invalid_user_combination": "To message people from multiple organizations, those organizations must be in at least one channel together.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/conversations.open", + "name": "conversations.open", + "response": { + "channel": { + "id": "D069C7QFK" + }, + "ok": true + }, + "warnings": { + "already_open": "The conversation was already open so Slack did nothing.", + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "no_op": "Slack did nothing when serving this request but it did not fail.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/conversations.rename.json b/lib/slack/web/docs/conversations.rename.json new file mode 100644 index 0000000..fb5e600 --- /dev/null +++ b/lib/slack/web/docs/conversations.rename.json @@ -0,0 +1,125 @@ +{ + "args": { + "channel": { + "desc": "ID of conversation to rename", + "example": "C1234567890", + "name": "channel", + "required": true, + "type": "string" + }, + "name": { + "desc": "New name for conversation.", + "example": "", + "name": "name", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Renames a conversation.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "invalid_name_punctuation": "Value passed for name contained only punctuation.", + "invalid_name_specials": "Value passed for name contained unallowed special characters or upper case characters.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "invalid_name_required": "Value passed for name was empty.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "name_taken": "New channel name is taken.", + "not_authorized": "Caller cannot rename this channel.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "is_archived": "Cannot rename archived channel.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "method_not_supported_for_channel_type": "This type of conversation cannot be used with this method.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "user_is_restricted": "This method cannot be called by a restricted user or single channel guest.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "invalid_name": "Value passed for name was invalid.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "Value passed for channel was invalid.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "invalid_name_maxlength": "Value passed for name exceeded max length.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "not_in_channel": "Caller is not a member of the channel.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/conversations.rename", + "name": "conversations.rename", + "response": { + "channel": { + "created": 1449252889, + "creator": "W012A3BCD", + "id": "C012AB3CD", + "is_archived": false, + "is_channel": true, + "is_ext_shared": false, + "is_general": true, + "is_group": false, + "is_im": false, + "is_member": true, + "is_mpim": false, + "is_org_shared": false, + "is_pending_ext_shared": false, + "is_private": false, + "is_read_only": false, + "is_shared": false, + "last_read": "1502126650.228446", + "locale": "en-US", + "name": "general", + "name_normalized": "general", + "num_members": 23, + "pending_shared": [], + "previous_names": [ + "specifics", + "abstractions", + "etc" + ], + "purpose": { + "creator": "W012A3BCD", + "last_set": 1449709364, + "value": "This part of the workspace is for fun. Make fun here." + }, + "topic": { + "creator": "W012A3BCD", + "last_set": 1449709364, + "value": "For public discussion of generalities" + }, + "unlinked": 0 + }, + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/conversations.replies.json b/lib/slack/web/docs/conversations.replies.json index d526a0e..5467aab 100644 --- a/lib/slack/web/docs/conversations.replies.json +++ b/lib/slack/web/docs/conversations.replies.json @@ -2,50 +2,152 @@ "args": { "channel": { "desc": "Conversation ID to fetch thread from.", - "example": "G1234567890", - "required": true + "example": "C1234567890", + "name": "channel", + "required": true, + "type": "string" }, "cursor": { - "desc": "Paginate through collections of data by setting the cursor parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first \"page\" of the collection. See pagination for more detail.", + "desc": "Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first \"page\" of the collection. See pagination for more detail.", "example": "dXNlcjpVMDYxTkZUVDI=", - "required": false + "name": "cursor", + "required": false, + "type": "string" }, "inclusive": { - "default": 0, - "desc": "Include messages with latest or oldest timestamp in results only when either timestamp is specified.", - "example": "true", - "required": false + "desc": "Include messages with oldest or latest timestamps in results. Ignored unless either timestamp is specified.", + "example": "0true", + "name": "inclusive", + "required": false, + "type": "boolean" }, "latest": { - "default": "now", - "desc": "End of time range of messages to include in results.", - "example": "1234567890.123456", - "required": false + "desc": "Only messages before this Unix timestamp will be included in results.", + "example": "now1234567890.123456", + "name": "latest", + "required": false, + "type": "string" }, "limit": { - "default": 100, "desc": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.", - "example": 20, - "required": false + "example": "100020", + "name": "limit", + "required": false, + "type": "number" }, "oldest": { - "default": 0, - "desc": "Start of time range of messages to include in results.", - "example": "1234567890.123456", - "required": false + "desc": "Only messages after this Unix timestamp will be included in results.", + "example": "01234567890.123456", + "name": "oldest", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" }, "ts": { - "desc": "Unique identifier of a thread's parent message.", + "desc": "Unique identifier of either a thread’s parent message or a message in the thread. ts must be the timestamp of an existing message with 0 or more replies. If there are no replies then just the single message referenced by ts will return - it is just an ordinary, unthreaded message.", "example": "1234567890.123456", - "required": true + "name": "ts", + "required": true, + "type": "string" } }, - "desc": "Returns an entire thread (a message plus all the messages in reply to it), while `conversations.history` method returns only parent messages.\n\nBot user tokens may use this method for direct message and multi-party direct message conversations but lack sufficient permissions to use this method on public and private channels.", + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Retrieve a thread of messages posted to a conversation", "errors": { - "channel_not_found": "Value for `channel` was invalid", - "invalid_cursor": "Value passed for `cursor` was invalid.", - "invalid_ts_latest": "Value passed for `latest` was invalid.", - "invalid_ts_oldest": "Value passed for `oldest` was invalid.", - "thread_not_found": "Value for `ts` was missing or invalid" + "invalid_ts_oldest": "Value passed for oldest was invalid", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "thread_not_found": "Value for ts was missing or invalid.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "invalid_ts_latest": "Value passed for latest was invalid", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_metadata_filter_keys": "Value passed for metadata_keys_to_include was invalid. Must be valid json array of strings.", + "accesslimited": "Access to this method is limited on the current network", + "invalid_cursor": "Value passed for cursor was not valid or is no longer valid.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "Value for channel was missing or invalid.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/conversations.replies", + "name": "conversations.replies", + "response": { + "has_more": true, + "messages": [ + { + "last_read": "1484678597.521003", + "reply_count": 3, + "subscribed": true, + "text": "island", + "thread_ts": "1482960137.003543", + "ts": "1482960137.003543", + "type": "message", + "unread_count": 0, + "user": "U061F7AUR" + }, + { + "parent_user_id": "U061F7AUR", + "text": "one island", + "thread_ts": "1482960137.003543", + "ts": "1483037603.017503", + "type": "message", + "user": "U061F7AUR" + }, + { + "parent_user_id": "U061F7AUR", + "text": "two island", + "thread_ts": "1482960137.003543", + "ts": "1483051909.018632", + "type": "message", + "user": "U061F7AUR" + }, + { + "parent_user_id": "U061F7AUR", + "text": "three for the land", + "thread_ts": "1482960137.003543", + "ts": "1483125339.020269", + "type": "message", + "user": "U061F7AUR" + } + ], + "ok": true, + "response_metadata": { + "next_cursor": "bmV4dF90czoxNDg0Njc4MjkwNTE3MDkx" + } + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/conversations.setPurpose.json b/lib/slack/web/docs/conversations.setPurpose.json index afe8119..c78f77b 100644 --- a/lib/slack/web/docs/conversations.setPurpose.json +++ b/lib/slack/web/docs/conversations.setPurpose.json @@ -1,23 +1,78 @@ { "args": { "channel": { - "desc": "Conversation to set the purpose of.", - "example": "G1234567890", - "required": true + "desc": "Conversation to set the purpose of", + "example": "C1234567890", + "name": "channel", + "required": true, + "type": "string" }, "purpose": { "desc": "A new, specialer purpose", "example": "My More Special Purpose", - "required": true + "name": "purpose", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" } }, - "desc": "Change the purpose of a conversation. The calling user must be a member of the conversation. Not all conversation types may have a purpose set.", + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Sets the purpose for a conversation.", "errors": { - "channel_not_found": "Value passed for `channel` was invalid", - "is_archived": "Channel has been archived", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_archived": "Channel has been archived.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", "method_not_supported_for_channel_type": "This type of conversation cannot be used with this method.", - "not_in_channel": "Authenticated user is not in the channel.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", "too_long": "Purpose was longer than 250 characters.", - "user_is_restricted": "This method cannot be called by a restricted user or single channel guest." + "user_is_restricted": "This method cannot be called by a restricted user or single channel guest.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "Value passed for channel was invalid.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "not_in_channel": "Authenticated user is not in the channel.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/conversations.setPurpose", + "name": "conversations.setPurpose", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/conversations.setTopic.json b/lib/slack/web/docs/conversations.setTopic.json index fd407b8..07e1e1b 100644 --- a/lib/slack/web/docs/conversations.setTopic.json +++ b/lib/slack/web/docs/conversations.setTopic.json @@ -1,23 +1,127 @@ { "args": { "channel": { - "desc": "Conversation to set the purpose of.", - "example": "G1234567890", - "required": true + "desc": "Conversation to set the topic of", + "example": "C1234567890", + "name": "channel", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" }, "topic": { "desc": "The new topic string. Does not support formatting or linkification.", "example": "Apply topically for best effects", - "required": true + "name": "topic", + "required": true, + "type": "string" } }, - "desc": "Change the topic of a conversation. The calling user must be a member of the conversation. Not all conversation types may have a purpose set.", + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Sets the topic for a conversation.", "errors": { - "channel_not_found": "Value passed for `channel` was invalid", - "is_archived": "Channel has been archived", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_archived": "Channel has been archived.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", "method_not_supported_for_channel_type": "This type of conversation cannot be used with this method.", - "not_in_channel": "Authenticated user is not in the channel.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", "too_long": "Topic was longer than 250 characters.", - "user_is_restricted": "This method cannot be called by a restricted user or single channel guest." + "user_is_restricted": "This method cannot be called by a restricted user or single channel guest.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "Value passed for channel was invalid.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "not_in_channel": "Authenticated user is not in the channel.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/conversations.setTopic", + "name": "conversations.setTopic", + "response": { + "channel": { + "created": 1649195947, + "creator": "U12345678", + "id": "C12345678", + "is_archived": false, + "is_channel": true, + "is_ext_shared": false, + "is_frozen": false, + "is_general": false, + "is_group": false, + "is_im": false, + "is_member": true, + "is_mpim": false, + "is_org_shared": false, + "is_pending_ext_shared": false, + "is_private": false, + "is_shared": false, + "last_read": "1649869848.627809", + "latest": { + "subtype": "channel_topic", + "text": "set the channel topic: Apply topically for best effects", + "topic": "Apply topically for best effects", + "ts": "1649952691.429799", + "type": "message", + "user": "U12345678" + }, + "name": "tips-and-tricks", + "name_normalized": "tips-and-tricks", + "parent_conversation": null, + "pending_connected_team_ids": [], + "pending_shared": [], + "previous_names": [], + "purpose": { + "creator": "", + "last_set": 0, + "value": "" + }, + "shared_team_ids": [ + "T12345678" + ], + "topic": { + "creator": "U12345678", + "last_set": 1649952691, + "value": "Apply topically for best effects" + }, + "unlinked": 0, + "unread_count": 1, + "unread_count_display": 0 + }, + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/conversations.unarchive.json b/lib/slack/web/docs/conversations.unarchive.json new file mode 100644 index 0000000..44cfeb9 --- /dev/null +++ b/lib/slack/web/docs/conversations.unarchive.json @@ -0,0 +1,70 @@ +{ + "args": { + "channel": { + "desc": "ID of conversation to unarchive", + "example": "C1234567890", + "name": "channel", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Reverses conversation archival.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "method_not_supported_for_channel_type": "This type of conversation cannot be used with this method.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "user_is_restricted": "This method cannot be called by a restricted user or single channel guest.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "Value passed for channel was invalid.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "not_archived": "Channel is not archived.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/conversations.unarchive", + "name": "conversations.unarchive", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/dialog.open.json b/lib/slack/web/docs/dialog.open.json new file mode 100644 index 0000000..35ab64b --- /dev/null +++ b/lib/slack/web/docs/dialog.open.json @@ -0,0 +1,80 @@ +{ + "args": { + "dialog": { + "desc": "The dialog definition. This must be a JSON-encoded string.", + "example": "", + "name": "dialog", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + }, + "trigger_id": { + "desc": "Exchange a trigger to post to the user.", + "example": "12345.98765.abcd2358fdea", + "name": "trigger_id", + "required": true, + "type": "string" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Open a dialog with a user", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "failed_sending_dialog": "Something exceptional occurred and the dialog could not be sent.", + "trigger_exchanged": "The provided trigger_id has already been exchanged.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "validation_errors": "The provided dialog could not be validated.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "missing_dialog": "No dialog argument was presented.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "app_missing_action_url": "The app associated with the used token doesn't have a Action URL configured in its interactive components settings.", + "missing_trigger": "No trigger_id argument was presented.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "invalid_trigger": "The provided trigger_id is invalid or cannot be used by this token.", + "cannot_create_dialog": "Something exceptional occurred and the dialog could not be created.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "trigger_expired": "The provided trigger_id was presented after the 3 second limit.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/dialog.open", + "name": "dialog.open", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/dnd.endDnd.json b/lib/slack/web/docs/dnd.endDnd.json index daa0c08..e023145 100644 --- a/lib/slack/web/docs/dnd.endDnd.json +++ b/lib/slack/web/docs/dnd.endDnd.json @@ -1,6 +1,59 @@ { + "args": { + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], "desc": "Ends the current user's Do Not Disturb session immediately.", "errors": { - "unknown_error": "There was a mysterious problem ending the user's Do Not Disturb session" + "access_denied": "Access to a resource specified in the request is denied.", + "accesslimited": "Access to this method is limited on the current network", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "is_bot": "This method cannot be called by a bot user.", + "method_deprecated": "The method has been deprecated.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "not_authed": "No authentication token provided.", + "not_in_dnd": "The auth'd user isn't in DND mode.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "service_unavailable": "The service is temporarily unavailable", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_expired": "Authentication token has expired", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "two_factor_setup_required": "Two factor setup is required." + }, + "is_deprecated": false, + "link": "/methods/dnd.endDnd", + "name": "dnd.endDnd", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/dnd.endSnooze.json b/lib/slack/web/docs/dnd.endSnooze.json index 3268b0c..45574df 100644 --- a/lib/slack/web/docs/dnd.endSnooze.json +++ b/lib/slack/web/docs/dnd.endSnooze.json @@ -1,7 +1,60 @@ { + "args": { + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], "desc": "Ends the current user's snooze mode immediately.", "errors": { + "access_denied": "Access to a resource specified in the request is denied.", + "accesslimited": "Access to this method is limited on the current network", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "is_bot": "This method cannot be called by a bot user.", + "method_deprecated": "The method has been deprecated.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "not_authed": "No authentication token provided.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "service_unavailable": "The service is temporarily unavailable", "snooze_end_failed": "There was a problem setting the user's Do Not Disturb status", - "snooze_not_active": "Snooze is not active for this user and cannot be ended" + "snooze_not_active": "Snooze is not active for this user and cannot be ended", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_expired": "Authentication token has expired", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "two_factor_setup_required": "Two factor setup is required." + }, + "is_deprecated": false, + "link": "/methods/dnd.endSnooze", + "name": "dnd.endSnooze", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/dnd.info.json b/lib/slack/web/docs/dnd.info.json index 946f7f0..b525e03 100644 --- a/lib/slack/web/docs/dnd.info.json +++ b/lib/slack/web/docs/dnd.info.json @@ -1,11 +1,73 @@ { "args": { + "team_id": { + "desc": "Encoded team id where passed in user param belongs, required if org token is used. If no user param is passed, then a team which has access to the app should be passed", + "example": "T1234567890", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + }, "user": { "desc": "User to fetch status for (defaults to current user)", "example": "U1234", + "name": "user", "required": false, "type": "string" } }, - "desc": "Retrieves a user's current Do Not Disturb status." + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Retrieves a user's current Do Not Disturb status.", + "errors": { + "access_denied": "Access to a resource specified in the request is denied.", + "accesslimited": "Access to this method is limited on the current network", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "method_deprecated": "The method has been deprecated.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "not_authed": "No authentication token provided.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "service_unavailable": "The service is temporarily unavailable", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_expired": "Authentication token has expired", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "two_factor_setup_required": "Two factor setup is required.", + "user_not_found": "Value passed for user was invalid.", + "user_not_visible": "User is not visible for this request." + }, + "is_deprecated": false, + "link": "/methods/dnd.info", + "name": "dnd.info", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } } \ No newline at end of file diff --git a/lib/slack/web/docs/dnd.setSnooze.json b/lib/slack/web/docs/dnd.setSnooze.json index f142b4d..6910722 100644 --- a/lib/slack/web/docs/dnd.setSnooze.json +++ b/lib/slack/web/docs/dnd.setSnooze.json @@ -3,13 +3,66 @@ "num_minutes": { "desc": "Number of minutes, from now, to snooze until.", "example": "60", + "name": "num_minutes", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", "required": true, - "type": "int" + "type": "token" } }, + "content_types": [ + "application/x-www-form-urlencoded" + ], "desc": "Turns on Do Not Disturb mode for the current user, or changes its duration.", "errors": { - "missing_duration": "No value provided for `num_minutes`", - "snooze_failed": "There was a problem setting the user's Do Not Disturb status" + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "missing_duration": "No value provided for num_minutes", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "too_long": "The value for num_minutes was too large", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "snooze_failed": "There was a problem setting the user's Do Not Disturb status", + "cannot_set_both_num_minutes_and_is_indefinite": "Cannot set both num_minutes and is_indefinite at the same time", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/dnd.setSnooze", + "name": "dnd.setSnooze", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/dnd.teamInfo.json b/lib/slack/web/docs/dnd.teamInfo.json index d793624..d8fef77 100644 --- a/lib/slack/web/docs/dnd.teamInfo.json +++ b/lib/slack/web/docs/dnd.teamInfo.json @@ -1,11 +1,84 @@ { "args": { + "team_id": { + "desc": "Encoded team id where passed in users belong, required if org token is used", + "example": "T1234567890", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + }, "users": { "desc": "Comma-separated list of users to fetch Do Not Disturb status for", - "example": "U1234,U4567", - "required": false, + "example": "U1234,W4567", + "name": "users", + "required": true, "type": "string" } }, - "desc": "Retrieves the Do Not Disturb status for users on a team." + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Retrieves the Do Not Disturb status for up to 50 users on a team.", + "errors": { + "access_denied": "Access to a resource specified in the request is denied.", + "accesslimited": "Access to this method is limited on the current network", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "method_deprecated": "The method has been deprecated.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "no_users_provided": "Must provide more than one user.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "not_authed": "No authentication token provided.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "service_unavailable": "The service is temporarily unavailable", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_expired": "Authentication token has expired", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "two_factor_setup_required": "Two factor setup is required." + }, + "is_deprecated": false, + "link": "/methods/dnd.teamInfo", + "name": "dnd.teamInfo", + "response": { + "ok": true, + "users": { + "U023BECGF": { + "dnd_enabled": true, + "next_dnd_end_ts": 1450423800, + "next_dnd_start_ts": 1450387800 + }, + "W058CJVAA": { + "dnd_enabled": false, + "next_dnd_end_ts": 1, + "next_dnd_start_ts": 1 + } + } + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } } \ No newline at end of file diff --git a/lib/slack/web/docs/emoji.list.json b/lib/slack/web/docs/emoji.list.json index c0e5f0e..a169819 100644 --- a/lib/slack/web/docs/emoji.list.json +++ b/lib/slack/web/docs/emoji.list.json @@ -1,5 +1,56 @@ { - "args": {}, + "args": { + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded" + ], "desc": "Lists custom emoji for a team.", - "errors": {} + "errors": { + "access_denied": "Access to a resource specified in the request is denied.", + "accesslimited": "Access to this method is limited on the current network", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "method_deprecated": "The method has been deprecated.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "not_authed": "No authentication token provided.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "service_unavailable": "The service is temporarily unavailable", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_expired": "Authentication token has expired", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "two_factor_setup_required": "Two factor setup is required." + }, + "is_deprecated": false, + "link": "/methods/emoji.list", + "name": "emoji.list", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } } \ No newline at end of file diff --git a/lib/slack/web/docs/files.comments.add.json b/lib/slack/web/docs/files.comments.add.json deleted file mode 100644 index f3aa579..0000000 --- a/lib/slack/web/docs/files.comments.add.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "args": { - "comment": { - "desc": "Text of the comment to add.", - "example": "Everyone should take a moment to read this file.", - "required": true - }, - "file": { - "desc": "File to add a comment to.", - "example": "F1234567890", - "required": true - } - }, - "desc": "Add a comment to an existing file.", - "errors": { - "file_deleted": "The requested file was previously deleted.", - "file_not_found": "The requested file could not be found.", - "no_comment": "The `comment` field was empty." - } -} \ No newline at end of file diff --git a/lib/slack/web/docs/files.comments.delete.json b/lib/slack/web/docs/files.comments.delete.json index a91eb41..5274540 100644 --- a/lib/slack/web/docs/files.comments.delete.json +++ b/lib/slack/web/docs/files.comments.delete.json @@ -3,18 +3,72 @@ "file": { "desc": "File to delete a comment from.", "example": "F1234567890", - "required": true + "name": "file", + "required": true, + "type": "string" }, "id": { "desc": "The comment to delete.", "example": "Fc1234567890", - "required": true + "name": "id", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" } }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], "desc": "Deletes an existing comment on a file.", "errors": { + "access_denied": "Access to a resource specified in the request is denied.", + "accesslimited": "Access to this method is limited on the current network", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", "cant_delete": "The requested comment could not be deleted.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", "file_deleted": "The requested file was previously deleted.", - "file_not_found": "The requested file could not be found." + "file_not_found": "The requested file could not be found.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "method_deprecated": "The method has been deprecated.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "not_authed": "No authentication token provided.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "service_unavailable": "The service is temporarily unavailable", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_expired": "Authentication token has expired", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "two_factor_setup_required": "Two factor setup is required." + }, + "is_deprecated": false, + "link": "/methods/files.comments.delete", + "name": "files.comments.delete", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/files.comments.edit.json b/lib/slack/web/docs/files.comments.edit.json deleted file mode 100644 index be6d7ff..0000000 --- a/lib/slack/web/docs/files.comments.edit.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "args": { - "comment": { - "desc": "Text of the comment to edit.", - "example": "Everyone should take a moment to read this file, seriously.", - "required": true - }, - "file": { - "desc": "File containing the comment to edit.", - "example": "F1234567890", - "required": true - }, - "id": { - "desc": "The comment to edit.", - "example": "Fc1234567890", - "required": true - } - }, - "desc": "Edit an existing file comment.", - "errors": { - "cant_edit": "The requested file could not be found.", - "edit_window_closed": "The timeframe for editing the comment has expired.", - "file_deleted": "The requested file was previously deleted.", - "file_not_found": "The requested file could not be found.", - "no_comment": "The `comment` field was empty." - } -} \ No newline at end of file diff --git a/lib/slack/web/docs/files.delete.json b/lib/slack/web/docs/files.delete.json index fe84680..5236d13 100644 --- a/lib/slack/web/docs/files.delete.json +++ b/lib/slack/web/docs/files.delete.json @@ -2,13 +2,68 @@ "args": { "file": { "desc": "ID of file to delete.", - "required": true + "example": "F1234567890", + "name": "file", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" } }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], "desc": "Deletes a file.", "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", "cant_delete_file": "Authenticated user does not have permission to delete this file.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "file_not_found": "The file does not exist, or is not visible to the calling user.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", "file_deleted": "The file has already been deleted.", - "file_not_found": "The file does not exist, or is not visible to the calling user." + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "file_deleting_disabled": "This functionality is disabled.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/files.delete", + "name": "files.delete", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/files.info.json b/lib/slack/web/docs/files.info.json index c63c9fb..3c80d9c 100644 --- a/lib/slack/web/docs/files.info.json +++ b/lib/slack/web/docs/files.info.json @@ -1,16 +1,162 @@ { "args": { + "count": { + "desc": "Number of items to return per page.", + "example": "10020", + "name": "count", + "required": false, + "type": "integer" + }, + "cursor": { + "desc": "Parameter for pagination. File comments are paginated for a single file. Set cursor equal to the next_cursor attribute returned by the previous request's response_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first \"page\" of the collection of comments. See pagination for more details.", + "example": "dXNlcjpVMDYxTkZUVDI=", + "name": "cursor", + "required": false, + "type": "string" + }, "file": { "desc": "Specify a file by providing its ID.", "example": "F2147483862", - "required": true + "name": "file", + "required": true, + "type": "string" + }, + "limit": { + "desc": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached.", + "example": "020", + "name": "limit", + "required": false, + "type": "integer" + }, + "page": { + "desc": "Page number of results to return.", + "example": "12", + "name": "page", + "required": false, + "type": "integer" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" } }, - "default_count": 100, - "desc": "Gets information about a team file.", + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Gets information about a file.", "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "not_visible": "Do not have permission to view the file", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "file_not_found": "Value passed for file was invalid", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", "file_deleted": "The requested file has been deleted", - "file_not_found": "Value passed for `file` was invalid" + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." }, - "has_paging": true + "is_deprecated": false, + "link": "/methods/files.info", + "name": "files.info", + "response": { + "comments": [], + "file": { + "original_w": 176, + "title": "tedair.gif", + "created": 1531763342, + "thumb_360": "https://.../tedair_360.png", + "username": "", + "url_private_download": "https://.../tedair.gif", + "external_type": "", + "thumb_360_h": 226, + "deanimate_gif": "https://.../tedair_deanimate_gif.png", + "permalink": "https://.../tedair.gif", + "has_rich_preview": false, + "shares": { + "public": { + "C0T8SE4AU": [ + { + "channel_name": "file-under", + "latest_reply": "1531763348.000001", + "reply_count": 1, + "reply_users": [ + "U061F7AUR" + ], + "reply_users_count": 1, + "team_id": "T061EG9R6", + "thread_ts": "1531763273.000015", + "ts": "1531763348.000001" + } + ] + } + }, + "id": "F0S43PZDF", + "permalink_public": "https://.../...", + "thumb_360_w": 176, + "filetype": "gif", + "mimetype": "image/gif", + "thumb_160": "https://.../tedair_=_160.png", + "user": "U061F7AUR", + "channels": [ + "C0T8SE4AU" + ], + "timestamp": 1531763342, + "is_public": true, + "public_url_shared": false, + "image_exif_rotation": 1, + "is_starred": false, + "name": "tedair.gif", + "thumb_80": "https://.../tedair_80.png", + "is_external": false, + "thumb_360_gif": "https://.../tedair_360.gif", + "comments_count": 0, + "url_private": "https://.../tedair.gif", + "editable": false, + "thumb_64": "https://.../tedair_64.png", + "groups": [], + "pjpeg": "https://.../tedair_pjpeg.jpg", + "original_h": 226, + "alt_txt": "tedair.gif", + "pretty_type": "GIF", + "size": 137531, + "mode": "hosted", + "display_as_bot": false, + "ims": [] + }, + "ok": true, + "response_metadata": { + "next_cursor": "dGVhbTpDMUg5UkVTR0w=" + } + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } } \ No newline at end of file diff --git a/lib/slack/web/docs/files.list.json b/lib/slack/web/docs/files.list.json index c32f802..b074245 100644 --- a/lib/slack/web/docs/files.list.json +++ b/lib/slack/web/docs/files.list.json @@ -2,38 +2,222 @@ "args": { "channel": { "desc": "Filter files appearing in a specific channel, indicated by its ID.", + "example": "C1234567890", + "name": "channel", "required": false, - "type": "channel" + "type": "string" + }, + "count": { + "desc": "Number of items to return per page.", + "example": "10020", + "name": "count", + "required": false, + "type": "integer" + }, + "files": { + "desc": "", + "example": "", + "name": "files", + "required": false, + "type": "string" + }, + "page": { + "desc": "Page number of results to return.", + "example": "12", + "name": "page", + "required": false, + "type": "integer" + }, + "show_files_hidden_by_limit": { + "desc": "Show truncated file info for files hidden due to being too old, and the team who owns the file being over the file limit.", + "example": "true", + "name": "show_files_hidden_by_limit", + "required": false, + "type": "boolean" + }, + "team_id": { + "desc": "encoded team id to list files in, required if org token is used", + "example": "T1234567890", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" }, "ts_from": { - "default": "0", "desc": "Filter files created after this timestamp (inclusive).", - "example": "123456789", - "required": false + "example": "0123456789", + "name": "ts_from", + "required": false, + "type": "string" }, "ts_to": { - "default": "now", "desc": "Filter files created before this timestamp (inclusive).", - "example": "123456789", - "required": false + "example": "now123456789", + "name": "ts_to", + "required": false, + "type": "string" }, "types": { - "default": "all", - "desc": "Filter files by type:\n\n* `all` - All files\n* `posts` - Posts\n* `snippets` - Snippets\n* `images` - Image files\n* `gdocs` - Google docs\n* `zips` - Zip files\n* `pdfs` - PDF files\n\nYou can pass multiple values in the types argument, like `types=posts,snippets`.The default value is `all`, which does not filter the list.", - "example": "images", - "required": false + "desc": "Filter files by type (see below). You can pass multiple values in the types argument, like types=spaces,snippets.The default value is all, which does not filter the list.", + "example": "allimages", + "name": "types", + "required": false, + "type": "string" }, "user": { "desc": "Filter files created by a single user.", + "example": "W1234567890", + "name": "user", "required": false, - "type": "user" + "type": "string" } }, - "default_count": 100, - "desc": "Lists & filters team files.", + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "List for a team, in a channel, or from a user with applied filters.", "errors": { - "unknown_type": "Value passed for `types` was invalid", - "user_not_found": "Value passed for `user` was invalid" + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "user_not_found": "Value passed for user was invalid", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "missing_argument": "A required argument is missing.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "unknown_type": "Value passed for types was invalid", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/files.list", + "name": "files.list", + "response": { + "files": [ + { + "original_w": 176, + "title": "billair.gif", + "created": 1531763254, + "thumb_360": "https://.../billair_360.png", + "username": "", + "url_private_download": "https://.../billair.gif", + "external_type": "", + "thumb_360_h": 226, + "deanimate_gif": "https://.../billair_deanimate_gif.png", + "permalink": "https://.../billair.gif", + "id": "F0S43P1CZ", + "permalink_public": "https://.../...", + "thumb_360_w": 176, + "filetype": "gif", + "mimetype": "image/gif", + "thumb_160": "https://.../billair_=_160.png", + "user": "U061F7AUR", + "channels": [ + "C0T8SE4AU" + ], + "timestamp": 1531763254, + "is_public": true, + "public_url_shared": false, + "image_exif_rotation": 1, + "name": "billair.gif", + "thumb_80": "https://.../billair_80.png", + "is_external": false, + "thumb_360_gif": "https://.../billair_360.gif", + "comments_count": 0, + "url_private": "https://.../billair.gif", + "editable": false, + "thumb_64": "https://.../billair_64.png", + "groups": [], + "pjpeg": "https://.../billair_pjpeg.jpg", + "original_h": 226, + "pretty_type": "GIF", + "size": 144538, + "mode": "hosted", + "display_as_bot": false, + "ims": [] + }, + { + "original_w": 176, + "title": "tedair.gif", + "created": 1531763342, + "thumb_360": "https://.../tedair_360.png", + "username": "", + "url_private_download": "https://.../tedair.gif", + "external_type": "", + "thumb_360_h": 226, + "deanimate_gif": "https://.../tedair_deanimate_gif.png", + "permalink": "https://.../tedair.gif", + "id": "F0S43PZDF", + "permalink_public": "https://.../...", + "thumb_360_w": 176, + "filetype": "gif", + "mimetype": "image/gif", + "thumb_160": "https://.../tedair_=_160.png", + "user": "U061F7AUR", + "channels": [ + "C0T8SE4AU" + ], + "timestamp": 1531763342, + "is_public": true, + "public_url_shared": false, + "image_exif_rotation": 1, + "name": "tedair.gif", + "thumb_80": "https://.../tedair_80.png", + "is_external": false, + "thumb_360_gif": "https://.../tedair_360.gif", + "comments_count": 0, + "url_private": "https://.../tedair.gif", + "editable": false, + "thumb_64": "https://.../tedair_64.png", + "groups": [], + "pjpeg": "https://.../tedair_pjpeg.jpg", + "original_h": 226, + "pretty_type": "GIF", + "size": 137531, + "mode": "hosted", + "display_as_bot": false, + "ims": [] + } + ], + "ok": true, + "paging": { + "count": 100, + "page": 1, + "pages": 1, + "total": 2 + } }, - "has_paging": true + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } } \ No newline at end of file diff --git a/lib/slack/web/docs/files.remote.add.json b/lib/slack/web/docs/files.remote.add.json new file mode 100644 index 0000000..fec167a --- /dev/null +++ b/lib/slack/web/docs/files.remote.add.json @@ -0,0 +1,104 @@ +{ + "args": { + "external_id": { + "desc": "Creator defined GUID for the file.", + "example": "123456", + "name": "external_id", + "required": true, + "type": "string" + }, + "external_url": { + "desc": "URL of the remote file.", + "example": "http://example.com/my_cloud_service_file/abc123", + "name": "external_url", + "required": true, + "type": "string" + }, + "filetype": { + "desc": "type of file", + "example": "doc", + "name": "filetype", + "required": false, + "type": "string" + }, + "indexable_file_contents": { + "desc": "A text file (txt, pdf, doc, etc.) containing textual search terms that are used to improve discovery of the remote file.", + "example": "...", + "name": "indexable_file_contents", + "required": false, + "type": "string" + }, + "preview_image": { + "desc": "Preview of the document via multipart/form-data.", + "example": "...", + "name": "preview_image", + "required": false, + "type": "string" + }, + "title": { + "desc": "Title of the file being shared.", + "example": "Danger, High Voltage!", + "name": "title", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Adds a file from a remote service", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "bad_image": "The uploaded image could not be processed - try passing a JPG or PNG", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "bad_title": "The title provided is too long.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "bot_user_required": "bot user token is required", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "too_large": "The uploaded image had excessive dimensions", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "invalid_external_id": "The external_id provided is too long.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/files.remote.add", + "name": "files.remote.add", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/files.remote.info.json b/lib/slack/web/docs/files.remote.info.json new file mode 100644 index 0000000..dbe06c0 --- /dev/null +++ b/lib/slack/web/docs/files.remote.info.json @@ -0,0 +1,75 @@ +{ + "args": { + "external_id": { + "desc": "Creator defined GUID for the file.", + "example": "123456", + "name": "external_id", + "required": false, + "type": "string" + }, + "file": { + "desc": "Specify a file by providing its ID.", + "example": "F2147483862", + "name": "file", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Retrieve information about a remote file added to Slack", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "too_many_ids": "The request specified both an external_id and a file, only one may be specified", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_args": "Invalid arguments passed to endpoint", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "no_bot_user_for_app": "Cannot call the Remote Files endpoints unless app has associated bot user", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "file_not_found": "Value passed for file or external_id was invalid", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/files.remote.info", + "name": "files.remote.info", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/files.remote.list.json b/lib/slack/web/docs/files.remote.list.json new file mode 100644 index 0000000..5a0add8 --- /dev/null +++ b/lib/slack/web/docs/files.remote.list.json @@ -0,0 +1,94 @@ +{ + "args": { + "channel": { + "desc": "Filter files appearing in a specific channel, indicated by its ID.", + "example": "C1234567890", + "name": "channel", + "required": false, + "type": "string" + }, + "cursor": { + "desc": "Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first \"page\" of the collection. See pagination for more detail.", + "example": "dXNlcjpVMDYxTkZUVDI=", + "name": "cursor", + "required": false, + "type": "string" + }, + "limit": { + "desc": "The maximum number of items to return.", + "example": "20", + "name": "limit", + "required": false, + "type": "integer" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + }, + "ts_from": { + "desc": "Filter files created after this timestamp (inclusive).", + "example": "0123456789", + "name": "ts_from", + "required": false, + "type": "string" + }, + "ts_to": { + "desc": "Filter files created before this timestamp (inclusive).", + "example": "now123456789", + "name": "ts_to", + "required": false, + "type": "string" + } + }, + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Retrieve information about a remote file added to Slack", + "errors": { + "access_denied": "Access to a resource specified in the request is denied.", + "accesslimited": "Access to this method is limited on the current network", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_cursor": "Value passed for cursor was not valid or is no longer valid.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "method_deprecated": "The method has been deprecated.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_bot_user_for_app": "Cannot call the Remote Files endpoints unless app has associated bot user", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "not_authed": "No authentication token provided.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "service_unavailable": "The service is temporarily unavailable", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_expired": "Authentication token has expired", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "two_factor_setup_required": "Two factor setup is required." + }, + "is_deprecated": false, + "link": "/methods/files.remote.list", + "name": "files.remote.list", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/files.remote.remove.json b/lib/slack/web/docs/files.remote.remove.json new file mode 100644 index 0000000..d0423f6 --- /dev/null +++ b/lib/slack/web/docs/files.remote.remove.json @@ -0,0 +1,76 @@ +{ + "args": { + "external_id": { + "desc": "Creator defined GUID for the file.", + "example": "123456", + "name": "external_id", + "required": false, + "type": "string" + }, + "file": { + "desc": "Specify a file by providing its ID.", + "example": "F2147483862", + "name": "file", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Remove a remote file.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "too_many_ids": "The request specified both an external_id and a file, only one may be specified", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "file_under_review": "File passed is tombstoned for DLP review", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_args": "Invalid arguments passed to endpoint", + "bot_user_required": "bot user token is required", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "file_not_found": "Value passed for file or external_id was invalid", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/files.remote.remove", + "name": "files.remote.remove", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/files.remote.share.json b/lib/slack/web/docs/files.remote.share.json new file mode 100644 index 0000000..4490421 --- /dev/null +++ b/lib/slack/web/docs/files.remote.share.json @@ -0,0 +1,83 @@ +{ + "args": { + "channels": { + "desc": "Comma-separated list of channel IDs where the file will be shared.", + "example": "C1234567890,C2345678901,C3456789012", + "name": "channels", + "required": true, + "type": "string" + }, + "external_id": { + "desc": "The globally unique identifier (GUID) for the file, as set by the app registering the file with Slack. Either this field or file or both are required.", + "example": "123456", + "name": "external_id", + "required": false, + "type": "string" + }, + "file": { + "desc": "Specify a file registered with Slack by providing its ID. Either this field or external_id or both are required.", + "example": "F2147483862", + "name": "file", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Share a remote file into a channel.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_args": "Invalid arguments passed to endpoint", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "no_bot_user_for_app": "Cannot call the Remote Files endpoints unless app has associated bot user", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "file_not_found": "No file with the requested ID found.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "At least one of the values passed for channels was invalid.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "not_in_channel": "Authenticated user is not in at least one of the the provided channels.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/files.remote.share", + "name": "files.remote.share", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/files.remote.update.json b/lib/slack/web/docs/files.remote.update.json new file mode 100644 index 0000000..b64a54b --- /dev/null +++ b/lib/slack/web/docs/files.remote.update.json @@ -0,0 +1,114 @@ +{ + "args": { + "external_id": { + "desc": "Creator defined GUID for the file.", + "example": "123456", + "name": "external_id", + "required": false, + "type": "string" + }, + "external_url": { + "desc": "URL of the remote file.", + "example": "http://example.com/my_cloud_service_file/abc123", + "name": "external_url", + "required": false, + "type": "string" + }, + "file": { + "desc": "Specify a file by providing its ID.", + "example": "F2147483862", + "name": "file", + "required": false, + "type": "string" + }, + "filetype": { + "desc": "type of file", + "example": "doc", + "name": "filetype", + "required": false, + "type": "string" + }, + "indexable_file_contents": { + "desc": "File containing contents that can be used to improve searchability for the remote file.", + "example": "...", + "name": "indexable_file_contents", + "required": false, + "type": "string" + }, + "preview_image": { + "desc": "Preview of the document via multipart/form-data.", + "example": "...", + "name": "preview_image", + "required": false, + "type": "string" + }, + "title": { + "desc": "Title of the file being shared.", + "example": "Danger, High Voltage!", + "name": "title", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Updates an existing remote file.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "bad_image": "The uploaded image could not be processed - try passing a JPG or PNG", + "invalid_title": "invalid title provided", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "invalid_type": "invalid type provided", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_url": "invalid url provided", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "bot_user_required": "bot user token is required", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "too_large": "The uploaded image had excessive dimensions", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "file_not_found": "Could not find the file to update.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "failed_to_unshare": "The file was either not found or it has been unshared already.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/files.remote.update", + "name": "files.remote.update", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/files.revokePublicURL.json b/lib/slack/web/docs/files.revokePublicURL.json index 9aa9cdc..ed7124b 100644 --- a/lib/slack/web/docs/files.revokePublicURL.json +++ b/lib/slack/web/docs/files.revokePublicURL.json @@ -2,12 +2,67 @@ "args": { "file": { "desc": "File to revoke", + "example": "F1234567890", + "name": "file", "required": true, - "type": "file" + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" } }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], "desc": "Revokes public/external sharing access for a file", "errors": { - "file_not_found": "Value passed for `file` was invalid" + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "user_is_restricted": "This method cannot be called by a restricted user or single channel guest.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "file_not_found": "Value passed for file was invalid", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/files.revokePublicURL", + "name": "files.revokePublicURL", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/files.sharedPublicURL.json b/lib/slack/web/docs/files.sharedPublicURL.json index 2d05924..15d4676 100644 --- a/lib/slack/web/docs/files.sharedPublicURL.json +++ b/lib/slack/web/docs/files.sharedPublicURL.json @@ -2,13 +2,69 @@ "args": { "file": { "desc": "File to share", + "example": "F1234567890", + "name": "file", "required": true, - "type": "file" + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" } }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], "desc": "Enables a file for public/external sharing.", "errors": { - "file_not_found": "Value passed for `file` was invalid", - "not_allowed": "Public sharing has been disabled for this team" + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "public_video_not_allowed": "Public sharing of videos is not available. A Free instance of Slack may encounter this error because free teams don't have the ability to share video files publicly.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "not_allowed": "Public sharing has been disabled for this team", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "user_is_restricted": "This method cannot be called by a restricted user or single channel guest.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "file_not_found": "Value passed for file was invalid", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/files.sharedPublicURL", + "name": "files.sharedPublicURL", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/files.upload.json b/lib/slack/web/docs/files.upload.json index fefc9a8..a9e833c 100644 --- a/lib/slack/web/docs/files.upload.json +++ b/lib/slack/web/docs/files.upload.json @@ -2,44 +2,177 @@ "args": { "channels": { "desc": "Comma-separated list of channel names or IDs where the file will be shared.", + "example": "C1234567890,C2345678901,C3456789012", + "name": "channels", "required": false, - "type": "channel" + "type": "string" }, "content": { - "desc": "File contents via a POST var.", + "desc": "File contents via a POST variable. If omitting this parameter, you must provide a file.", "example": "...", - "required": false + "name": "content", + "required": false, + "type": "string" }, "file": { - "desc": "File contents via `multipart/form-data`.", + "desc": "File contents via multipart/form-data. If omitting this parameter, you must submit content.", "example": "...", - "required": true, - "type": "file" + "name": "file", + "required": false, + "type": "string" }, "filename": { "desc": "Filename of file.", "example": "foo.txt", - "required": true + "name": "filename", + "required": false, + "type": "string" }, "filetype": { - "desc": "Slack-internal file type identifier.", + "desc": "A file type identifier.", "example": "php", - "required": false + "name": "filetype", + "required": false, + "type": "string" }, "initial_comment": { - "desc": "Initial comment to add to file.", + "desc": "The message text introducing the file in specified channels.", "example": "Best!", - "required": false + "name": "initial_comment", + "required": false, + "type": "string" + }, + "thread_ts": { + "desc": "Provide another message's ts value to upload this file as a reply. Never use a reply's ts value; use its parent instead.", + "example": "1234567890.123456", + "name": "thread_ts", + "required": false, + "type": "string" }, "title": { "desc": "Title of file.", "example": "My File", - "required": false + "name": "title", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" } }, + "content_types": [ + "multipart/form-data", + "application/x-www-form-urlencoded" + ], "desc": "Uploads or creates a file.", "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "slack_connect_file_upload_sharing_blocked": "Admin has disabled File uploads in all Slack Connect communications", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "slack_connect_blocked_file_type": "File uploads with certain types are blocked in all Slack Connect communications", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "slack_connect_clip_sharing_blocked": "Admin has disabled Clip sharing in Slack Connect channels", "invalid_channel": "One or more channels supplied are invalid", - "posting_to_general_channel_denied": "An admin has restricted posting to the #general channel." + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "posting_to_general_channel_denied": "An admin has restricted posting to the #general channel.", + "channel_not_found": "At least one of the values passed for channels was invalid.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "malware_detected": "This file may contain a virus or other malware and can't be uploaded to Slack", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "not_in_channel": "Authenticated user is not in the channel.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/files.upload", + "name": "files.upload", + "response": { + "file": { + "thumb_480": "https://.../dramacat_480.gif", + "original_w": 526, + "title": "dramacat", + "created": 1532293501, + "thumb_360": "https://.../dramacat_360.gif", + "username": "", + "url_private_download": "https://.../dramacat.gif", + "external_type": "", + "thumb_360_h": 250, + "permalink": "https://.../dramacat.gif", + "has_rich_preview": false, + "shares": { + "private": { + "D0L4B9P0Q": [ + { + "reply_count": 0, + "reply_users": [], + "reply_users_count": 0, + "ts": "1532293503.000001" + } + ] + } + }, + "id": "F0TD00400", + "permalink_public": "https://.../More-Path-Components", + "thumb_360_w": 360, + "filetype": "gif", + "mimetype": "image/jpeg", + "thumb_160": "https://.../dramacat_160.gif", + "user": "U0L4B9NSU", + "channels": [], + "timestamp": 1532293501, + "is_public": false, + "public_url_shared": false, + "image_exif_rotation": 1, + "is_starred": false, + "name": "dramacat.gif", + "thumb_80": "https://.../dramacat_80.gif", + "is_external": false, + "thumb_480_h": 334, + "comments_count": 0, + "url_private": "https://.../dramacat.gif", + "editable": false, + "thumb_64": "https://.../dramacat_64.gif", + "thumb_480_w": 480, + "groups": [], + "original_h": 366, + "pretty_type": "JPEG", + "size": 43518, + "mode": "hosted", + "display_as_bot": false, + "ims": [ + "D0L4B9P0Q" + ] + }, + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/groups.archive.json b/lib/slack/web/docs/groups.archive.json deleted file mode 100644 index 2c2aebc..0000000 --- a/lib/slack/web/docs/groups.archive.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "args": { - "channel": { - "desc": "Private channel to archive", - "required": true, - "type": "group" - } - }, - "desc": "Archives a private channel.", - "errors": { - "already_archived": "Group has already been archived.", - "channel_not_found": "Value passed for `channel` was invalid.", - "group_contains_others": "Restricted accounts cannot archive groups containing others.", - "last_ra_channel": "You cannot archive the last channel for a restricted account.", - "restricted_action": "A team preference prevents the authenticated user from archiving." - } -} \ No newline at end of file diff --git a/lib/slack/web/docs/groups.close.json b/lib/slack/web/docs/groups.close.json deleted file mode 100644 index bae34be..0000000 --- a/lib/slack/web/docs/groups.close.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "args": { - "channel": { - "desc": "Private channel to close.", - "required": true, - "type": "group" - } - }, - "desc": "Closes a private channel.", - "errors": { - "channel_not_found": "Value passed for `channel` was invalid." - } -} \ No newline at end of file diff --git a/lib/slack/web/docs/groups.create.json b/lib/slack/web/docs/groups.create.json deleted file mode 100644 index 7b36252..0000000 --- a/lib/slack/web/docs/groups.create.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "args": { - "name": { - "desc": "Name of private channel to create", - "required": true - } - }, - "desc": "Creates a private channel.", - "errors": { - "name_taken": "A group cannot be created with the given name.", - "no_channel": "No group name was passed.", - "restricted_action": "A team preference prevents the authenticated user from creating groups." - } -} \ No newline at end of file diff --git a/lib/slack/web/docs/groups.createChild.json b/lib/slack/web/docs/groups.createChild.json deleted file mode 100644 index b414cca..0000000 --- a/lib/slack/web/docs/groups.createChild.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "args": { - "channel": { - "desc": "Private channel to clone and archive.", - "required": true, - "type": "group" - } - }, - "desc": "Clones and archives a private channel.", - "errors": { - "already_archived": "An archived group cannot be cloned", - "channel_not_found": "Value passed for `channel` was invalid.", - "restricted_action": "A team preference prevents the authenticated user from creating groups." - } -} \ No newline at end of file diff --git a/lib/slack/web/docs/groups.history.json b/lib/slack/web/docs/groups.history.json deleted file mode 100644 index 5cc9d4f..0000000 --- a/lib/slack/web/docs/groups.history.json +++ /dev/null @@ -1,44 +0,0 @@ -{ - "args": { - "channel": { - "desc": "Private channel to fetch history for.", - "required": true, - "type": "group" - }, - "count": { - "default": "100", - "desc": "Number of messages to return, between 1 and 1000.", - "example": "100", - "required": false - }, - "inclusive": { - "default": 0, - "desc": "Include messages with latest or oldest timestamp in results.", - "example": 1 - }, - "latest": { - "default": "now", - "desc": "End of time range of messages to include in results.", - "required": false, - "type": "timestamp" - }, - "oldest": { - "default": "0", - "desc": "Start of time range of messages to include in results.", - "required": false, - "type": "timestamp" - }, - "unreads": { - "default": 0, - "desc": "Include `unread_count_display` in the output?", - "example": 1, - "required": false - } - }, - "desc": "Fetches history of messages and events from a private channel.", - "errors": { - "channel_not_found": "Value passed for `channel` was invalid.", - "invalid_ts_latest": "Value passed for `latest` was invalid", - "invalid_ts_oldest": "Value passed for `oldest` was invalid" - } -} \ No newline at end of file diff --git a/lib/slack/web/docs/groups.info.json b/lib/slack/web/docs/groups.info.json deleted file mode 100644 index adbafc5..0000000 --- a/lib/slack/web/docs/groups.info.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "args": { - "channel": { - "desc": "Private channel to get info on", - "required": true, - "type": "channel" - } - }, - "desc": "Gets information about a private channel.", - "errors": { - "channel_not_found": "Value passed for `channel` was invalid." - } -} \ No newline at end of file diff --git a/lib/slack/web/docs/groups.invite.json b/lib/slack/web/docs/groups.invite.json deleted file mode 100644 index c355a5a..0000000 --- a/lib/slack/web/docs/groups.invite.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "args": { - "channel": { - "desc": "Private channel to invite user to.", - "required": true, - "type": "group" - }, - "user": { - "desc": "User to invite.", - "required": true, - "type": "user" - } - }, - "desc": "Invites a user to a private channel.", - "errors": { - "cant_invite": "User cannot be invited to this group.", - "cant_invite_self": "Authenticated user cannot invite themselves to a group.", - "channel_not_found": "Value passed for `channel` was invalid.", - "is_archived": "Group has been archived.", - "user_not_found": "Value passed for `user` was invalid." - } -} \ No newline at end of file diff --git a/lib/slack/web/docs/groups.kick.json b/lib/slack/web/docs/groups.kick.json deleted file mode 100644 index c172e75..0000000 --- a/lib/slack/web/docs/groups.kick.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "args": { - "channel": { - "desc": "Private channel to remove user from.", - "required": true, - "type": "group" - }, - "user": { - "desc": "User to remove from private channel.", - "required": true, - "type": "user" - } - }, - "desc": "Removes a user from a private channel.", - "errors": { - "cant_kick_self": "You can't remove yourself from a group", - "channel_not_found": "Value passed for `channel` was invalid.", - "not_in_group": "User or caller were are not in the group", - "restricted_action": "A team preference prevents the authenticated user from kicking.", - "user_not_found": "Value passed for `user` was invalid." - } -} \ No newline at end of file diff --git a/lib/slack/web/docs/groups.leave.json b/lib/slack/web/docs/groups.leave.json deleted file mode 100644 index 497b972..0000000 --- a/lib/slack/web/docs/groups.leave.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "args": { - "channel": { - "desc": "Private channel to leave", - "required": true, - "type": "group" - } - }, - "desc": "Leaves a private channel.", - "errors": { - "cant_leave_last_channel": "Authenticated user cannot leave the last channel they are in", - "channel_not_found": "Value passed for `channel` was invalid.", - "is_archived": "Group has been archived.", - "last_member": "Authenticated user is the last member of a group and cannot leave it" - } -} \ No newline at end of file diff --git a/lib/slack/web/docs/groups.list.json b/lib/slack/web/docs/groups.list.json deleted file mode 100644 index 586083f..0000000 --- a/lib/slack/web/docs/groups.list.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "args": { - "exclude_archived": { - "default": 0, - "desc": "Don't return archived private channels.", - "example": 1 - } - }, - "desc": "Lists private channels that the calling user has access to." -} \ No newline at end of file diff --git a/lib/slack/web/docs/groups.mark.json b/lib/slack/web/docs/groups.mark.json deleted file mode 100644 index 1ca9bfc..0000000 --- a/lib/slack/web/docs/groups.mark.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "args": { - "channel": { - "desc": "Private channel to set reading cursor in.", - "required": true, - "type": "group" - }, - "ts": { - "desc": "Timestamp of the most recently seen message.", - "required": true, - "type": "timestamp" - } - }, - "desc": "Sets the read cursor in a private channel.", - "errors": { - "channel_not_found": "Value passed for `channel` was invalid.", - "invalid_timestamp": "Value passed for `timestamp` was invalid." - } -} \ No newline at end of file diff --git a/lib/slack/web/docs/groups.open.json b/lib/slack/web/docs/groups.open.json deleted file mode 100644 index f25d90c..0000000 --- a/lib/slack/web/docs/groups.open.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "args": { - "channel": { - "desc": "Private channel to open.", - "required": true, - "type": "group" - } - }, - "desc": "Opens a private channel.", - "errors": { - "channel_not_found": "Value passed for `channel` was invalid." - } -} \ No newline at end of file diff --git a/lib/slack/web/docs/groups.rename.json b/lib/slack/web/docs/groups.rename.json deleted file mode 100644 index 13e0024..0000000 --- a/lib/slack/web/docs/groups.rename.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "args": { - "channel": { - "desc": "Private channel to rename", - "required": true, - "type": "channel" - }, - "name": { - "desc": "New name for private channel.", - "required": true - } - }, - "desc": "Renames a private channel.", - "errors": { - "channel_not_found": "Value passed for `channel` was invalid.", - "invalid_name": "New name is invalid", - "name_taken": "New channel name is taken" - } -} \ No newline at end of file diff --git a/lib/slack/web/docs/groups.replies.json b/lib/slack/web/docs/groups.replies.json deleted file mode 100644 index 8983d4f..0000000 --- a/lib/slack/web/docs/groups.replies.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "args": { - "channel": { - "desc": "Private channel to fetch thread from", - "required": true, - "type": "channel" - }, - "thread_ts": { - "desc": "Unique identifier of a thread's parent message.", - "required": true - } - }, - "desc": "Retrieve a thread of messages posted to a private channel.", - "errors": { - "channel_not_found": "Value passed for `channel` was invalid.", - "thread_not_found": "Value for thread_ts was missing or invalid." - } -} \ No newline at end of file diff --git a/lib/slack/web/docs/groups.setPurpose.json b/lib/slack/web/docs/groups.setPurpose.json deleted file mode 100644 index 376abf4..0000000 --- a/lib/slack/web/docs/groups.setPurpose.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "args": { - "channel": { - "desc": "Private channel to set the purpose of", - "required": true, - "type": "channel" - }, - "purpose": { - "desc": "The new purpose", - "example": "My Purpose", - "required": true - } - }, - "desc": "Sets the purpose for a private channel.", - "errors": { - "channel_not_found": "Value passed for `channel` was invalid.", - "is_archived": "Private group has been archived", - "too_long": "Purpose was longer than 250 characters.", - "user_is_restricted": "Setting the purpose is a restricted action." - } -} \ No newline at end of file diff --git a/lib/slack/web/docs/groups.setTopic.json b/lib/slack/web/docs/groups.setTopic.json deleted file mode 100644 index 95dc7d3..0000000 --- a/lib/slack/web/docs/groups.setTopic.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "args": { - "channel": { - "desc": "Private channel to set the topic of", - "required": true, - "type": "channel" - }, - "topic": { - "desc": "The new topic", - "example": "My Topic", - "required": true - } - }, - "desc": "Sets the topic for a private channel.", - "errors": { - "channel_not_found": "Value passed for `channel` was invalid.", - "is_archived": "Private group has been archived", - "too_long": "Topic was longer than 250 characters.", - "user_is_restricted": "Setting the topic is a restricted action." - } -} \ No newline at end of file diff --git a/lib/slack/web/docs/groups.unarchive.json b/lib/slack/web/docs/groups.unarchive.json deleted file mode 100644 index 16c5753..0000000 --- a/lib/slack/web/docs/groups.unarchive.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "args": { - "channel": { - "desc": "Private channel to unarchive", - "required": true, - "type": "group" - } - }, - "desc": "Unarchives a private channel.", - "errors": { - "channel_not_found": "Value passed for `channel` was invalid.", - "not_archived": "Group is not archived." - } -} \ No newline at end of file diff --git a/lib/slack/web/docs/im.close.json b/lib/slack/web/docs/im.close.json deleted file mode 100644 index 2fa2832..0000000 --- a/lib/slack/web/docs/im.close.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "args": { - "channel": { - "desc": "Direct message channel to close.", - "required": true, - "type": "im" - } - }, - "desc": "Close a direct message channel.", - "errors": { - "channel_not_found": "Value passed for `channel` was invalid.", - "user_does_not_own_channel": "Calling user does not own this DM channel." - } -} \ No newline at end of file diff --git a/lib/slack/web/docs/im.history.json b/lib/slack/web/docs/im.history.json deleted file mode 100644 index b1f5848..0000000 --- a/lib/slack/web/docs/im.history.json +++ /dev/null @@ -1,44 +0,0 @@ -{ - "args": { - "channel": { - "desc": "Direct message channel to fetch history for.", - "required": true, - "type": "im" - }, - "count": { - "default": "100", - "desc": "Number of messages to return, between 1 and 1000.", - "example": "100", - "required": false - }, - "inclusive": { - "default": 0, - "desc": "Include messages with latest or oldest timestamp in results.", - "example": 1 - }, - "latest": { - "default": "now", - "desc": "End of time range of messages to include in results.", - "required": false, - "type": "timestamp" - }, - "oldest": { - "default": "0", - "desc": "Start of time range of messages to include in results.", - "required": false, - "type": "timestamp" - }, - "unreads": { - "default": 0, - "desc": "Include `unread_count_display` in the output?", - "example": 1, - "required": false - } - }, - "desc": "Fetches history of messages and events from direct message channel.", - "errors": { - "channel_not_found": "Value passed for `channel` was invalid.", - "invalid_ts_latest": "Value passed for `latest` was invalid", - "invalid_ts_oldest": "Value passed for `oldest` was invalid" - } -} \ No newline at end of file diff --git a/lib/slack/web/docs/im.list.json b/lib/slack/web/docs/im.list.json deleted file mode 100644 index fd7bc66..0000000 --- a/lib/slack/web/docs/im.list.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "desc": "Lists direct message channels for the calling user." -} \ No newline at end of file diff --git a/lib/slack/web/docs/im.mark.json b/lib/slack/web/docs/im.mark.json deleted file mode 100644 index 4df7463..0000000 --- a/lib/slack/web/docs/im.mark.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "args": { - "channel": { - "desc": "Direct message channel to set reading cursor in.", - "required": true, - "type": "im" - }, - "ts": { - "desc": "Timestamp of the most recently seen message.", - "required": true, - "type": "timestamp" - } - }, - "desc": "Sets the read cursor in a direct message channel.", - "errors": { - "channel_not_found": "Value passed for `channel` was invalid.", - "invalid_timestamp": "Value passed for `timestamp` was invalid.", - "not_in_channel": "Caller is not a member of the channel." - } -} \ No newline at end of file diff --git a/lib/slack/web/docs/im.open.json b/lib/slack/web/docs/im.open.json deleted file mode 100644 index b3290d6..0000000 --- a/lib/slack/web/docs/im.open.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "args": { - "user": { - "desc": "User to open a direct message channel with.", - "required": true, - "type": "user" - } - }, - "desc": "Opens a direct message channel.", - "errors": { - "user_disabled": "The `user` has been disabled.", - "user_not_found": "Value passed for `user` was invalid.", - "user_not_visible": "The calling user is restricted from seeing the requested user." - } -} \ No newline at end of file diff --git a/lib/slack/web/docs/im.replies.json b/lib/slack/web/docs/im.replies.json deleted file mode 100644 index 836cb2a..0000000 --- a/lib/slack/web/docs/im.replies.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "args": { - "channel": { - "desc": "Direct message channel to fetch thread from", - "required": true, - "type": "channel" - }, - "thread_ts": { - "desc": "Unique identifier of a thread's parent message.", - "required": true - } - }, - "desc": "Retrieve a thread of messages posted to a direct message conversation.", - "errors": { - "channel_not_found": "Value passed for `channel` was invalid.", - "thread_not_found": "Value for thread_ts was missing or invalid." - } -} \ No newline at end of file diff --git a/lib/slack/web/docs/migration.exchange.json b/lib/slack/web/docs/migration.exchange.json new file mode 100644 index 0000000..31f83f5 --- /dev/null +++ b/lib/slack/web/docs/migration.exchange.json @@ -0,0 +1,92 @@ +{ + "args": { + "team_id": { + "desc": "Specify team_id starts with T in case of Org Token", + "example": "T1234567890", + "name": "team_id", + "required": false, + "type": "string" + }, + "to_old": { + "desc": "Specify true to convert W global user IDs to workspace-specific U IDs. Defaults to false.", + "example": "true", + "name": "to_old", + "required": false, + "type": "boolean" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + }, + "users": { + "desc": "A comma-separated list of user ids, up to 400 per request", + "example": "", + "name": "users", + "required": true, + "type": "array" + } + }, + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "For Enterprise Grid workspaces, map local user IDs to global user IDs", + "errors": { + "access_denied": "Access to a resource specified in the request is denied.", + "accesslimited": "Access to this method is limited on the current network", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "method_deprecated": "The method has been deprecated.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "not_authed": "No authentication token provided.", + "not_enterprise_team": "The workspace associated with the token is not part of an Enterprise organization. User IDs have not changed and there is nothing to map.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "service_unavailable": "The service is temporarily unavailable", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_expired": "Authentication token has expired", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "too_many_users": "Too many user IDs provided in users. Up to 400 user IDs are allowed per request.", + "two_factor_setup_required": "Two factor setup is required." + }, + "is_deprecated": false, + "link": "/methods/migration.exchange", + "name": "migration.exchange", + "response": { + "enterprise_id": "E1KQTNXE1", + "invalid_user_ids": [ + "U21ABZZXX" + ], + "ok": true, + "team_id": "T1KR7PE1W", + "user_id_map": { + "U06UBSUN5": "W06M56XJM", + "U06UBSVB3": "W06PUUDLY", + "U06UBSVDX": "W06PUUDMW", + "U06UEB62U": "W06PTT6GH", + "W06UAZ65Q": "W06UAZ65Q" + } + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/mpim.close.json b/lib/slack/web/docs/mpim.close.json deleted file mode 100644 index 7318050..0000000 --- a/lib/slack/web/docs/mpim.close.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "args": { - "channel": { - "desc": "MPIM to close.", - "required": true, - "type": "mpim" - } - }, - "desc": "Closes a multiparty direct message channel.", - "errors": { - "channel_not_found": "Value passed for `channel` was invalid." - } -} \ No newline at end of file diff --git a/lib/slack/web/docs/mpim.history.json b/lib/slack/web/docs/mpim.history.json deleted file mode 100644 index fe86f9a..0000000 --- a/lib/slack/web/docs/mpim.history.json +++ /dev/null @@ -1,44 +0,0 @@ -{ - "args": { - "channel": { - "desc": "Multiparty direct message to fetch history for.", - "required": true, - "type": "mpim" - }, - "count": { - "default": "100", - "desc": "Number of messages to return, between 1 and 1000.", - "example": "100", - "required": false - }, - "inclusive": { - "default": 0, - "desc": "Include messages with latest or oldest timestamp in results.", - "example": 1 - }, - "latest": { - "default": "now", - "desc": "End of time range of messages to include in results.", - "required": false, - "type": "timestamp" - }, - "oldest": { - "default": "0", - "desc": "Start of time range of messages to include in results.", - "required": false, - "type": "timestamp" - }, - "unreads": { - "default": 0, - "desc": "Include `unread_count_display` in the output?", - "example": 1, - "required": false - } - }, - "desc": "Fetches history of messages and events from a multiparty direct message.", - "errors": { - "channel_not_found": "Value passed for `channel` was invalid.", - "invalid_ts_latest": "Value passed for `latest` was invalid", - "invalid_ts_oldest": "Value passed for `oldest` was invalid" - } -} \ No newline at end of file diff --git a/lib/slack/web/docs/mpim.list.json b/lib/slack/web/docs/mpim.list.json deleted file mode 100644 index de86c6b..0000000 --- a/lib/slack/web/docs/mpim.list.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "desc": "Lists multiparty direct message channels for the calling user." -} \ No newline at end of file diff --git a/lib/slack/web/docs/mpim.mark.json b/lib/slack/web/docs/mpim.mark.json deleted file mode 100644 index 7a7b187..0000000 --- a/lib/slack/web/docs/mpim.mark.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "args": { - "channel": { - "desc": "multiparty direct message channel to set reading cursor in.", - "required": true, - "type": "group" - }, - "ts": { - "desc": "Timestamp of the most recently seen message.", - "required": true, - "type": "timestamp" - } - }, - "desc": "Sets the read cursor in a multiparty direct message channel.", - "errors": { - "channel_not_found": "Value passed for `channel` was invalid.", - "invalid_timestamp": "Value passed for `timestamp` was invalid." - } -} \ No newline at end of file diff --git a/lib/slack/web/docs/mpim.open.json b/lib/slack/web/docs/mpim.open.json deleted file mode 100644 index 095a452..0000000 --- a/lib/slack/web/docs/mpim.open.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "args": { - "users": { - "desc": "Comma separated lists of users. The ordering of the users is preserved whenever a MPIM group is returned.", - "required": true, - "type": "users" - } - }, - "desc": "This method opens a multiparty direct message.", - "errors": { - "not_enough_users": "Needs at least 2 users to open", - "too_many_users": "Needs at most 8 users to open", - "users_list_not_supplied": "Missing `users` in request" - } -} \ No newline at end of file diff --git a/lib/slack/web/docs/oauth.access.json b/lib/slack/web/docs/oauth.access.json index e0ec879..1b8de7a 100644 --- a/lib/slack/web/docs/oauth.access.json +++ b/lib/slack/web/docs/oauth.access.json @@ -3,29 +3,113 @@ "client_id": { "desc": "Issued when you created your application.", "example": "4b39e9-752c4", - "required": true + "name": "client_id", + "required": false, + "type": "string" }, "client_secret": { "desc": "Issued when you created your application.", "example": "33fea0113f5b1", - "required": true + "name": "client_secret", + "required": false, + "type": "string" }, "code": { - "desc": "The `code` param returned via the OAuth callback.", + "desc": "The code param returned via the OAuth callback.", "example": "ccdaa72ad", - "required": true + "name": "code", + "required": false, + "type": "string" }, "redirect_uri": { "desc": "This must match the originally submitted URI (if one was sent).", "example": "http://example.com", - "required": false + "name": "redirect_uri", + "required": false, + "type": "string" + }, + "single_channel": { + "desc": "Request the user to add your app only to a single channel. Only valid with a legacy workspace app.", + "example": "falsetrue", + "name": "single_channel", + "required": false, + "type": "boolean" } }, - "desc": "Exchanges a temporary OAuth code for an API token.", + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Exchanges a temporary OAuth verifier code for an access token.", "errors": { - "bad_client_secret": "Value passed for `client_secret` was invalid.", - "bad_redirect_uri": "Value passed for `redirect_uri` did not match the `redirect_uri` in the original request.", - "invalid_client_id": "Value passed for `client_id` was invalid.", - "invalid_code": "Value passed for `code` was invalid." + "accesslimited": "Access to this method is limited on the current network", + "bad_client_secret": "Value passed for client_secret was invalid.", + "bad_redirect_uri": "Value passed for redirect_uri did not match the redirect_uri in the original request.", + "code_already_used": "Value passed for code was already exchanged.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_client_id": "Value passed for client_id was invalid.", + "invalid_code": "Value passed for code was invalid.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "invalid_token": "Invalid refresh token.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "missing_resource": "Missing permission resource.", + "oauth_authorization_url_mismatch": "The OAuth flow was initiated on an incorrect version of the authorization url. The flow must be initiated via /oauth/authorize.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "service_unavailable": "The service is temporarily unavailable", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete." + }, + "is_deprecated": false, + "link": "/methods/oauth.access", + "name": "oauth.access", + "response": { + "access_token": "xoxa-access-token-string", + "app_id": "A012345678", + "app_user_id": "U0NKHRW57", + "authorizing_user": { + "app_home": "D0PNCRP9N", + "user_id": "U061F7AUR" + }, + "enterprise_id": null, + "installer_user": { + "app_home": "D0PNCRP9N", + "user_id": "U061F7AUR" + }, + "ok": true, + "scopes": { + "app_home": [ + "chat:write", + "im:history", + "im:read" + ], + "channel": [ + "channels:history", + "channels:read", + "chat:write" + ], + "group": [ + "chat:write" + ], + "im": [ + "chat:write" + ], + "mpim": [ + "chat:write" + ], + "team": [], + "user": [] + }, + "team_id": "T061EG9R6", + "team_name": "Subarachnoid Workspace", + "token_type": "app" + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/oauth.v2.access.json b/lib/slack/web/docs/oauth.v2.access.json index 5f46d2b..137213b 100644 --- a/lib/slack/web/docs/oauth.v2.access.json +++ b/lib/slack/web/docs/oauth.v2.access.json @@ -3,31 +3,103 @@ "client_id": { "desc": "Issued when you created your application.", "example": "4b39e9-752c4", - "required": true + "name": "client_id", + "required": false, + "type": "string" }, "client_secret": { "desc": "Issued when you created your application.", "example": "33fea0113f5b1", - "required": true + "name": "client_secret", + "required": false, + "type": "string" }, "code": { - "desc": "The `code` param returned via the OAuth callback.", + "desc": "The code param returned via the OAuth callback.", "example": "ccdaa72ad", - "required": true + "name": "code", + "required": false, + "type": "string" + }, + "grant_type": { + "desc": "The grant_type param as described in the OAuth spec.", + "example": "authorization_code", + "name": "grant_type", + "required": false, + "type": "string" }, "redirect_uri": { "desc": "This must match the originally submitted URI (if one was sent).", "example": "http://example.com", - "required": false + "name": "redirect_uri", + "required": false, + "type": "string" + }, + "refresh_token": { + "desc": "The refresh_token param as described in the OAuth spec.", + "example": "xoxe-1-abcdefg", + "name": "refresh_token", + "required": false, + "type": "string" } }, + "content_types": [ + "application/x-www-form-urlencoded" + ], "desc": "Exchanges a temporary OAuth verifier code for an access token.", "errors": { - "bad_client_secret": "Value passed for `client_secret` was invalid.", - "bad_redirect_uri": "Value passed for `redirect_uri` did not match the `redirect_uri` in the original request.", - "invalid_client_id": "Value passed for `client_id` was invalid.", - "invalid_code": "Value passed for `code` was invalid.", + "accesslimited": "Access to this method is limited on the current network", + "bad_client_secret": "Value passed for client_secret was invalid.", + "bad_redirect_uri": "Value passed for redirect_uri did not match the redirect_uri in the original request.", + "cannot_install_an_org_installed_app": "Returned when the the org-installed app cannot be installed on a workspace.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_client_id": "Value passed for client_id was invalid.", + "invalid_code": "Value passed for code was invalid.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", "invalid_grant_type": "Value passed for grant_type was invalid.", - "oauth_authorization_url_mismatch": "The OAuth flow was initiated on an incorrect version of the authorization url. The flow must be initiated via /oauth/v2/authorize." + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "invalid_refresh_token": "The given refresh token is invalid.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "no_scopes": "Missing scope in the request.", + "oauth_authorization_url_mismatch": "The OAuth flow was initiated on an incorrect version of the authorization url. The flow must be initiated via /oauth/v2/authorize .", + "preview_feature_not_available": "Returned when the API method is not yet available on the team in context.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "service_unavailable": "The service is temporarily unavailable", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete." + }, + "is_deprecated": false, + "link": "/methods/oauth.v2.access", + "name": "oauth.v2.access", + "response": { + "access_token": "xoxb-17653672481-19874698323-pdFZKVeTuE8sk7oOcBrzbqgy", + "app_id": "A0KRD7HC3", + "authed_user": { + "access_token": "xoxp-1234", + "id": "U1234", + "scope": "chat:write", + "token_type": "user" + }, + "bot_user_id": "U0KRQLJ9H", + "enterprise": { + "id": "E12345678", + "name": "slack-sports" + }, + "ok": true, + "scope": "commands,incoming-webhook", + "team": { + "id": "T9TK3CUKW", + "name": "Slack Softball Team" + }, + "token_type": "bot" + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/oauth.v2.exchange.json b/lib/slack/web/docs/oauth.v2.exchange.json new file mode 100644 index 0000000..0049945 --- /dev/null +++ b/lib/slack/web/docs/oauth.v2.exchange.json @@ -0,0 +1,53 @@ +{ + "args": { + "client_id": { + "desc": "Issued when you created your application.", + "example": "4123121235.9872358710", + "name": "client_id", + "required": true, + "type": "string" + }, + "client_secret": { + "desc": "Issued when you created your application.", + "example": "33fea0113f5b1", + "name": "client_secret", + "required": true, + "type": "string" + } + }, + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Exchanges a legacy access token for a new expiring access token and refresh token", + "errors": { + "accesslimited": "Access to this method is limited on the current network", + "bad_client_secret": "Value passed for client_secret was invalid.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_client_id": "Value passed for client_id was invalid.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "invalid_token": "The legacy token provided cannot be exchanged for a new pair of token credentials.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "service_unavailable": "The service is temporarily unavailable", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_already_exchanged": "This token has already been exchanged for a pair of token credentials.", + "token_rotation_not_enabled": "The app does not have token rotation enabled." + }, + "is_deprecated": false, + "link": "/methods/oauth.v2.exchange", + "name": "oauth.v2.exchange", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/openid.connect.token.json b/lib/slack/web/docs/openid.connect.token.json new file mode 100644 index 0000000..99578bb --- /dev/null +++ b/lib/slack/web/docs/openid.connect.token.json @@ -0,0 +1,88 @@ +{ + "args": { + "client_id": { + "desc": "Issued when you created your application.", + "example": "4b39e9-752c4", + "name": "client_id", + "required": false, + "type": "string" + }, + "client_secret": { + "desc": "Issued when you created your application.", + "example": "33fea0113f5b1", + "name": "client_secret", + "required": false, + "type": "string" + }, + "code": { + "desc": "The code param returned via the OAuth callback.", + "example": "ccdaa72ad", + "name": "code", + "required": false, + "type": "string" + }, + "grant_type": { + "desc": "The grant_type param as described in the OAuth spec.", + "example": "authorization_code", + "name": "grant_type", + "required": false, + "type": "string" + }, + "redirect_uri": { + "desc": "This must match the originally submitted URI (if one was sent).", + "example": "http://example.com", + "name": "redirect_uri", + "required": false, + "type": "string" + }, + "refresh_token": { + "desc": "The refresh_token param as described in the OAuth spec.", + "example": "xoxe-1-abcdefg", + "name": "refresh_token", + "required": false, + "type": "string" + } + }, + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Exchanges a temporary OAuth verifier code for an access token for Sign in with Slack.", + "errors": { + "accesslimited": "Access to this method is limited on the current network", + "bad_client_secret": "The value passed for client_secret was invalid.", + "bad_redirect_uri": "The value passed for redirect_uri did not match the redirect_uri in the original request.", + "cannot_install_an_org_installed_app": "An org-installed app cannot be installed on a workspace.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_client_id": "The value passed for client_id was invalid.", + "invalid_code": "The value passed for code was invalid.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_grant_type": "The value passed for grant_type was invalid.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "invalid_refresh_token": "The given refresh token is invalid.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "oauth_authorization_url_mismatch": "The OAuth flow was initiated on an incorrect version of the authorization URL. The flow must be initiated via /openid/connect/authorize .", + "preview_feature_not_available": "The API method is not yet available on the team.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "service_unavailable": "The service is temporarily unavailable", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete." + }, + "is_deprecated": false, + "link": "/methods/openid.connect.token", + "name": "openid.connect.token", + "response": { + "access_token": "xoxp-1234", + "id_token": "eyJhbGcMjY5OTA2MzcWNrLmNvbVwvdGVhbV9p...", + "ok": true, + "token_type": "Bearer" + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/openid.connect.userInfo.json b/lib/slack/web/docs/openid.connect.userInfo.json new file mode 100644 index 0000000..c5f1add --- /dev/null +++ b/lib/slack/web/docs/openid.connect.userInfo.json @@ -0,0 +1,84 @@ +{ + "args": { + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Get the identity of a user who has authorized Sign in with Slack.", + "errors": { + "access_denied": "Access to a resource specified in the request is denied.", + "accesslimited": "Access to this method is limited on the current network", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "is_bot": "This method cannot be called by a bot user.", + "method_deprecated": "The method has been deprecated.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "not_authed": "No authentication token provided.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "service_unavailable": "The service is temporarily unavailable", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_expired": "Authentication token has expired", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "two_factor_setup_required": "Two factor setup is required." + }, + "is_deprecated": false, + "link": "/methods/openid.connect.userInfo", + "name": "openid.connect.userInfo", + "response": { + "date_email_verified": 1622128723, + "email": "krane@slack-corp.com", + "email_verified": true, + "family_name": "Labradoodle", + "given_name": "Bront", + "https://slack.com/team_domain": "kraneflannel", + "https://slack.com/team_id": "T0R7GR", + "https://slack.com/team_image_102": "...", + "https://slack.com/team_image_132": "...", + "https://slack.com/team_image_230": "...", + "https://slack.com/team_image_34": "...", + "https://slack.com/team_image_44": "...", + "https://slack.com/team_image_68": "...", + "https://slack.com/team_image_88": "...", + "https://slack.com/team_image_default": true, + "https://slack.com/team_name": "kraneflannel", + "https://slack.com/user_id": "U0R7JM", + "https://slack.com/user_image_192": "...", + "https://slack.com/user_image_24": "...", + "https://slack.com/user_image_32": "...", + "https://slack.com/user_image_48": "...", + "https://slack.com/user_image_512": "...", + "https://slack.com/user_image_72": "...", + "locale": "en-US", + "name": "krane", + "ok": true, + "picture": "https://secure.gravatar.com/....png", + "sub": "U0R7JM" + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/pins.add.json b/lib/slack/web/docs/pins.add.json index 2ba5e87..4b09171 100644 --- a/lib/slack/web/docs/pins.add.json +++ b/lib/slack/web/docs/pins.add.json @@ -1,36 +1,84 @@ { "args": { "channel": { - "desc": "Channel to pin the item in.", + "desc": "Channel to pin the messsage to. You must also include a timestamp when pinning messages.", + "example": "C1234567890", + "name": "channel", "required": true, - "type": "channel" - }, - "file": { - "desc": "File to pin.", - "required": false, - "type": "file" - }, - "file_comment": { - "desc": "File comment to pin.", - "required": false, - "type": "file_comment" + "type": "string" }, "timestamp": { - "desc": "Timestamp of the message to pin.", + "desc": "Timestamp of the message to pin. You must also include the channel.", + "example": "1234567890.123456", + "name": "timestamp", "required": false, - "type": "timestamp" + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" } }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], "desc": "Pins an item to a channel.", "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_item_specified": "One of file, file_comment, or timestamp was not specified.", + "file_not_shared": "File specified by file is not public nor shared to the channel.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "too_many_pins": "Too many pins in channel.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "permission_denied": "The user does not have permission to add pins to the channel.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "external_channel_migrating": "Channel is undergoing an active migration.", + "bad_timestamp": "Value passed for timestamp was invalid.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "file_not_found": "File not found.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_pinnable": "This message type is not pinnable.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "The channel argument was not specified or was invalid", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "message_not_found": "Message specified by channel and timestamp does not exist.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "not_in_channel": "Item is not in channel.", "already_pinned": "The specified item is already pinned to the channel.", - "bad_timestamp": "Value passed for `timestamp` was invalid.", - "channel_not_found": "The `channel` argument was not specified or was invalid", - "file_comment_not_found": "File comment specified by `file_comment` does not exist.", - "file_not_found": "File specified by `file` does not exist.", - "file_not_shared": "File specified by `file` is not public nor shared to the channel.", - "message_not_found": "Message specified by `channel` and `timestamp` does not exist.", - "no_item_specified": "One of `file`, `file_comment`, or `timestamp` was not specified.", - "permission_denied": "The user does not have permission to add pins to the channel." + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/pins.add", + "name": "pins.add", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/pins.list.json b/lib/slack/web/docs/pins.list.json index 5d71fab..07368c3 100644 --- a/lib/slack/web/docs/pins.list.json +++ b/lib/slack/web/docs/pins.list.json @@ -2,13 +2,98 @@ "args": { "channel": { "desc": "Channel to get pinned items for.", + "example": "C1234567890", + "name": "channel", "required": true, - "type": "channel" + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" } }, - "default_count": 100, + "content_types": [ + "application/x-www-form-urlencoded" + ], "desc": "Lists items pinned to a channel.", "errors": { - "channel_not_found": "Value passed for `channel` was invalid." + "access_denied": "Access to a resource specified in the request is denied.", + "accesslimited": "Access to this method is limited on the current network", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "channel_not_found": "Value passed for channel was invalid.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "method_deprecated": "The method has been deprecated.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "not_authed": "No authentication token provided.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "service_unavailable": "The service is temporarily unavailable", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_expired": "Authentication token has expired", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "two_factor_setup_required": "Two factor setup is required." + }, + "is_deprecated": false, + "link": "/methods/pins.list", + "name": "pins.list", + "response": { + "items": [ + { + "channel": "C2U86NC6H", + "created": 1508881078, + "created_by": "U2U85N1RZ", + "message": { + "permalink": "https://hitchhikers.slack.com/archives/C2U86NC6H/p1508197641000151", + "pinned_to": [ + "C2U86NC6H" + ], + "text": "What is the meaning of life?", + "ts": "1508197641.000151", + "type": "message", + "user": "U2U85N1RZ" + }, + "type": "message" + }, + { + "channel": "C2U86NC6H", + "created": 1508880991, + "created_by": "U2U85N1RZ", + "message": { + "permalink": "https://hitchhikers.slack.com/archives/C2U86NC6H/p1508284197000015", + "pinned_to": [ + "C2U86NC6H" + ], + "text": "The meaning of life, the universe, and everything is 42.", + "ts": "1503289197.000015", + "type": "message", + "user": "U2U85N1RZ" + }, + "type": "message" + } + ], + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/pins.remove.json b/lib/slack/web/docs/pins.remove.json index 803ecf5..da8818e 100644 --- a/lib/slack/web/docs/pins.remove.json +++ b/lib/slack/web/docs/pins.remove.json @@ -2,33 +2,81 @@ "args": { "channel": { "desc": "Channel where the item is pinned to.", + "example": "C1234567890", + "name": "channel", "required": true, - "type": "channel" - }, - "file": { - "desc": "File to un-pin.", - "required": false, - "type": "file" - }, - "file_comment": { - "desc": "File comment to un-pin.", - "required": false, - "type": "file_comment" + "type": "string" }, "timestamp": { "desc": "Timestamp of the message to un-pin.", + "example": "1234567890.123456", + "name": "timestamp", "required": false, - "type": "timestamp" + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" } }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], "desc": "Un-pins an item from a channel.", "errors": { - "bad_timestamp": "Value passed for `timestamp` was invalid.", - "file_comment_not_found": "File comment specified by `file_comment` does not exist.", - "file_not_found": "File specified by `file` does not exist.", - "message_not_found": "Message specified by `channel` and `timestamp` does not exist.", - "no_item_specified": "One of `file`, `file_comment`, or `timestamp` was not specified.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_pin": "The pin could not be found.", + "no_item_specified": "One of file, file_comment, or timestamp was not specified.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "permission_denied": "The user does not have permission to remove pins from the channel.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "external_channel_migrating": "Channel is undergoing an active migration.", "not_pinned": "The specified item is not pinned to the channel.", - "permission_denied": "The user does not have permission to remove pins from the channel." + "bad_timestamp": "Value passed for timestamp was invalid.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "file_comment_not_found": "File comment specified by file_comment does not exist.", + "file_not_found": "File specified by file does not exist.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "The channel argument was not specified or was invalid", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "message_not_found": "Message specified by channel and timestamp does not exist.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/pins.remove", + "name": "pins.remove", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/presence.set.json b/lib/slack/web/docs/presence.set.json deleted file mode 100644 index f1e94e4..0000000 --- a/lib/slack/web/docs/presence.set.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "args": { - "presence": { - "desc": "Either `active` or `away`", - "example": "away", - "required": true - } - }, - "deprecated": true, - "desc": "Manually set user presence", - "errors": { - "invalid_presence": "Value passed for `presence` was invalid." - } -} \ No newline at end of file diff --git a/lib/slack/web/docs/reactions.add.json b/lib/slack/web/docs/reactions.add.json index 507b5f1..c300734 100644 --- a/lib/slack/web/docs/reactions.add.json +++ b/lib/slack/web/docs/reactions.add.json @@ -2,40 +2,90 @@ "args": { "channel": { "desc": "Channel where the message to add reaction to was posted.", - "required": false, - "type": "channel" - }, - "file": { - "desc": "File to add reaction to.", - "required": false, - "type": "file" - }, - "file_comment": { - "desc": "File comment to add reaction to.", - "required": false, - "type": "file_comment" + "example": "C1234567890", + "name": "channel", + "required": true, + "type": "string" }, "name": { "desc": "Reaction (emoji) name.", "example": "thumbsup", - "required": true + "name": "name", + "required": true, + "type": "string" }, "timestamp": { "desc": "Timestamp of the message to add reaction to.", - "required": false, - "type": "timestamp" + "example": "1234567890.123456", + "name": "timestamp", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" } }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], "desc": "Adds a reaction to an item.", "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "thread_locked": "Reactions are disabled as the specified message is part of a locked thread.", + "no_item_specified": "combination of channel and timestamp was not specified.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_archived": "Channel specified has been archived.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "external_channel_migrating": "The channel is in the process of being migrated.", + "bad_timestamp": "Value passed for timestamp was invalid.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "too_many_reactions": "The limit for reactions a person may add to the item has been reached.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", "already_reacted": "The specified item already has the user/reaction combination.", - "bad_timestamp": "Value passed for `timestamp` was invalid.", - "file_comment_not_found": "File comment specified by `file_comment` does not exist.", - "file_not_found": "File specified by `file` does not exist.", - "invalid_name": "Value passed for `name` was invalid.", - "message_not_found": "Message specified by `channel` and `timestamp` does not exist.", - "no_item_specified": "`file`, `file_comment`, or combination of `channel` and `timestamp` was not specified.", + "not_reactable": "Whatever you passed in, like a file or file_comment, can't be reacted to anymore. Your app can react to messages though.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "invalid_name": "Value passed for name was invalid.", "too_many_emoji": "The limit for distinct reactions (i.e emoji) on the item has been reached.", - "too_many_reactions": "The limit for reactions a person may add to the item has been reached." + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "Value passed for channel is invalid.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "message_not_found": "Message specified by channel and timestamp does not exist.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/reactions.add", + "name": "reactions.add", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/reactions.get.json b/lib/slack/web/docs/reactions.get.json index f833305..ebe904d 100644 --- a/lib/slack/web/docs/reactions.get.json +++ b/lib/slack/web/docs/reactions.get.json @@ -2,35 +2,123 @@ "args": { "channel": { "desc": "Channel where the message to get reactions for was posted.", + "example": "C0NF841BK", + "name": "channel", "required": false, - "type": "channel" + "type": "string" }, "file": { "desc": "File to get reactions for.", + "example": "F1234567890", + "name": "file", "required": false, - "type": "file" + "type": "string" }, "file_comment": { "desc": "File comment to get reactions for.", + "example": "Fc1234567890", + "name": "file_comment", "required": false, - "type": "file_comment" + "type": "string" }, "full": { "desc": "If true always return the complete reaction list.", - "required": false + "example": "true", + "name": "full", + "required": false, + "type": "boolean" }, "timestamp": { "desc": "Timestamp of the message to get reactions for.", + "example": "1524523204.000192", + "name": "timestamp", "required": false, - "type": "timestamp" + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" } }, + "content_types": [ + "application/x-www-form-urlencoded" + ], "desc": "Gets reactions for an item.", "errors": { - "bad_timestamp": "Value passed for `timestamp` was invalid.", - "file_comment_not_found": "File comment specified by `file_comment` does not exist.", - "file_not_found": "File specified by `file` does not exist.", - "message_not_found": "Message specified by `channel` and `timestamp` does not exist.", - "no_item_specified": "`file`, `file_comment`, or combination of `channel` and `timestamp` was not specified." + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_item_specified": "file, file_comment, or combination of channel and timestamp was not specified.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "bad_timestamp": "Value passed for timestamp was invalid.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "file_comment_not_found": "File comment specified by file_comment does not exist.", + "file_not_found": "File specified by file does not exist.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "Value passed for channel was invalid.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "message_not_found": "Message specified by channel and timestamp does not exist.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/reactions.get", + "name": "reactions.get", + "response": { + "channel": "C123456", + "message": { + "permalink": "https://xxx.slack.com/archives/C123456/p1648602352215969", + "reactions": [ + { + "count": 1, + "name": "grinning", + "users": [ + "W222222" + ] + }, + { + "count": 1, + "name": "question", + "users": [ + "W333333" + ] + } + ], + "team": "T123456", + "text": "Hi there!", + "ts": "1648602352.215969", + "type": "message", + "user": "W123456" + }, + "ok": true, + "type": "message" + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/reactions.list.json b/lib/slack/web/docs/reactions.list.json index 5d62c23..5906794 100644 --- a/lib/slack/web/docs/reactions.list.json +++ b/lib/slack/web/docs/reactions.list.json @@ -1,19 +1,195 @@ { "args": { + "count": { + "desc": "Number of items to return per page.", + "example": "10020", + "name": "count", + "required": false, + "type": "integer" + }, + "cursor": { + "desc": "Parameter for pagination. Set cursor equal to the next_cursor attribute returned by the previous request's response_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first \"page\" of the collection. See pagination for more details.", + "example": "dXNlcjpVMDYxTkZUVDI=", + "name": "cursor", + "required": false, + "type": "string" + }, "full": { "desc": "If true always return the complete reaction list.", - "required": false + "example": "true", + "name": "full", + "required": false, + "type": "boolean" + }, + "limit": { + "desc": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached.", + "example": "020", + "name": "limit", + "required": false, + "type": "integer" + }, + "page": { + "desc": "Page number of results to return.", + "example": "12", + "name": "page", + "required": false, + "type": "integer" + }, + "team_id": { + "desc": "encoded team id to list reactions in, required if org token is used", + "example": "T1234567890", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" }, "user": { "desc": "Show reactions made by this user. Defaults to the authed user.", + "example": "W1234567890", + "name": "user", "required": false, - "type": "user" + "type": "string" } }, - "default_count": 100, + "content_types": [ + "application/x-www-form-urlencoded" + ], "desc": "Lists reactions made by a user.", "errors": { - "user_not_found": "Value passed for `user` was invalid." + "access_denied": "Access to a resource specified in the request is denied.", + "accesslimited": "Access to this method is limited on the current network", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "method_deprecated": "The method has been deprecated.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "not_authed": "No authentication token provided.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "service_unavailable": "The service is temporarily unavailable", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_expired": "Authentication token has expired", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "two_factor_setup_required": "Two factor setup is required.", + "user_not_found": "Value passed for user was invalid." + }, + "is_deprecated": false, + "link": "/methods/reactions.list", + "name": "reactions.list", + "response": { + "items": [ + { + "channel": "C3UKJTQAC", + "message": { + "bot_id": "B4VLRLMKJ", + "reactions": [ + { + "count": 1, + "name": "robot_face", + "users": [ + "U2U85N1RV" + ] + } + ], + "subtype": "bot_message", + "text": "Hello from Python! :tada:", + "ts": "1507849573.000090", + "username": "Shipit Notifications" + }, + "type": "message" + }, + { + "comment": { + "comment": "This is a file comment", + "created": 1508286096, + "id": "Fc7LP08P1U", + "reactions": [ + { + "count": 1, + "name": "white_check_mark", + "users": [ + "U2U85N1RV" + ] + } + ], + "timestamp": 1508286096, + "type": "file_comment", + "user": "U2U85N1RV" + }, + "file": { + "channels": [ + "C2U7V2YA2" + ], + "comments_count": 1, + "created": 1507850315, + "reactions": [ + { + "count": 1, + "name": "stuck_out_tongue_winking_eye", + "users": [ + "U2U85N1RV" + ] + } + ], + "title": "computer.gif", + "user": "U2U85N1RV", + "username": "" + } + }, + { + "file": { + "channels": [ + "C2U7V2YA2" + ], + "comments_count": 1, + "created": 1507850315, + "id": "F7H0D7ZA4", + "name": "computer.gif", + "reactions": [ + { + "count": 1, + "name": "stuck_out_tongue_winking_eye", + "users": [ + "U2U85N1RV" + ] + } + ], + "size": 1639034, + "title": "computer.gif", + "user": "U2U85N1RV", + "username": "" + }, + "type": "file" + } + ], + "ok": true, + "response_metadata": { + "next_cursor": "dGVhbTpDMUg5UkVTR0w=" + } }, - "has_paging": true + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } } \ No newline at end of file diff --git a/lib/slack/web/docs/reactions.remove.json b/lib/slack/web/docs/reactions.remove.json index 17f22f2..42371a5 100644 --- a/lib/slack/web/docs/reactions.remove.json +++ b/lib/slack/web/docs/reactions.remove.json @@ -2,38 +2,102 @@ "args": { "channel": { "desc": "Channel where the message to remove reaction from was posted.", + "example": "C1234567890", + "name": "channel", "required": false, - "type": "channel" + "type": "string" }, "file": { "desc": "File to remove reaction from.", + "example": "F1234567890", + "name": "file", "required": false, - "type": "file" + "type": "string" }, "file_comment": { "desc": "File comment to remove reaction from.", + "example": "Fc1234567890", + "name": "file_comment", "required": false, - "type": "file_comment" + "type": "string" }, "name": { "desc": "Reaction (emoji) name.", "example": "thumbsup", - "required": true + "name": "name", + "required": true, + "type": "string" }, "timestamp": { "desc": "Timestamp of the message to remove reaction from.", + "example": "1234567890.123456", + "name": "timestamp", "required": false, - "type": "timestamp" + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" } }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], "desc": "Removes a reaction from an item.", "errors": { - "bad_timestamp": "Value passed for `timestamp` was invalid.", - "file_comment_not_found": "File comment specified by `file_comment` does not exist.", - "file_not_found": "File specified by `file` does not exist.", - "invalid_name": "Value passed for `name` was invalid.", - "message_not_found": "Message specified by `channel` and `timestamp` does not exist.", - "no_item_specified": "`file`, `file_comment`, or combination of `channel` and `timestamp` was not specified.", - "no_reaction": "The specified item does not have the user/reaction combination." + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "thread_locked": "Reactions are disabled as the specified message is part of a locked thread.", + "no_item_specified": "file, file_comment, or combination of channel and timestamp was not specified.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "external_channel_migrating": "The reaction is in a channel that is being migrated", + "bad_timestamp": "Value passed for timestamp was invalid.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "no_reaction": "The specified reaction does not exist, or the requestor is not the original reaction author.", + "file_comment_not_found": "File comment specified by file_comment does not exist.", + "file_not_found": "File specified by file does not exist.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "invalid_name": "Value passed for name was invalid.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "The specified channel was not found.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "message_not_found": "Message specified by channel and timestamp does not exist.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/reactions.remove", + "name": "reactions.remove", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/reminders.add.json b/lib/slack/web/docs/reminders.add.json new file mode 100644 index 0000000..f74ec73 --- /dev/null +++ b/lib/slack/web/docs/reminders.add.json @@ -0,0 +1,102 @@ +{ + "args": { + "recurrence": { + "desc": "Specify the repeating behavior of a reminder. Available options: daily, weekly, monthly, or yearly. If weekly, may further specify the days of the week.", + "example": "{ \"frequency\": \"weekly\", \"weekdays\": [\"monday\", \"wednesday\", \"friday\"] }", + "name": "recurrence", + "required": false, + "type": "object" + }, + "team_id": { + "desc": "Encoded team id, required if org token is used", + "example": "T1234567890", + "name": "team_id", + "required": false, + "type": "string" + }, + "text": { + "desc": "The content of the reminder", + "example": "eat a banana", + "name": "text", + "required": true, + "type": "string" + }, + "time": { + "desc": "When this reminder should happen: the Unix timestamp (up to five years from now), the number of seconds until the reminder (if within 24 hours), or a natural language description (Ex. \"in 15 minutes,\" or \"every Thursday\")", + "example": "1602288000", + "name": "time", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + }, + "user": { + "desc": "The user who will receive the reminder. If no user is specified, the reminder will go to user who created it.", + "example": "U18888888", + "name": "user", + "required": false, + "type": "string" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Creates a reminder.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "user_not_found": "That user can't be found.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "cannot_add_bot": "Reminders can't be sent to bots.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "missing_argument": "An argument is missing.", + "cannot_add_others_recurring": "Recurring reminders can't be set for other team members.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "cannot_add_slackbot": "Reminders can't be sent to Slackbot.", + "cannot_parse": "The phrasing of the timing for this reminder is unclear. You must include a complete time description. Some examples that work: 1458678068, 20, in 5 minutes, tomorrow, at 3:30pm, on Tuesday, or next week.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "cannot_add_others": "Guests can't set reminders for other team members.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "cannot_add_profile_only_user": "Reminders can't be sent to profile only users.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/reminders.add", + "name": "reminders.add", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/reminders.complete.json b/lib/slack/web/docs/reminders.complete.json new file mode 100644 index 0000000..e8f5513 --- /dev/null +++ b/lib/slack/web/docs/reminders.complete.json @@ -0,0 +1,77 @@ +{ + "args": { + "reminder": { + "desc": "The ID of the reminder to be marked as complete", + "example": "Rm12345678", + "name": "reminder", + "required": true, + "type": "string" + }, + "team_id": { + "desc": "Encoded team id, required if org token is used", + "example": "T1234567890", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Marks a reminder as complete.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "missing_argument": "An argument is missing.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_found": "That reminder can't be found.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "cannot_complete_others": "Reminders for other team members can't be marked complete.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "cannot_complete_recurring": "Recurring reminders can't be marked complete.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/reminders.complete", + "name": "reminders.complete", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/reminders.delete.json b/lib/slack/web/docs/reminders.delete.json new file mode 100644 index 0000000..49bdea3 --- /dev/null +++ b/lib/slack/web/docs/reminders.delete.json @@ -0,0 +1,75 @@ +{ + "args": { + "reminder": { + "desc": "The ID of the reminder", + "example": "Rm12345678", + "name": "reminder", + "required": true, + "type": "string" + }, + "team_id": { + "desc": "Encoded team id, required if org token is used", + "example": "T1234567890", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Deletes a reminder.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "missing_argument": "An argument is missing.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_found": "That reminder can't be found.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/reminders.delete", + "name": "reminders.delete", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/reminders.info.json b/lib/slack/web/docs/reminders.info.json new file mode 100644 index 0000000..df54195 --- /dev/null +++ b/lib/slack/web/docs/reminders.info.json @@ -0,0 +1,74 @@ +{ + "args": { + "reminder": { + "desc": "The ID of the reminder", + "example": "Rm23456789", + "name": "reminder", + "required": true, + "type": "string" + }, + "team_id": { + "desc": "Encoded team id, required if org token is passed", + "example": "T1234567890", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Gets information about a reminder.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "missing_argument": "An argument is missing.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_found": "That reminder can't be found.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/reminders.info", + "name": "reminders.info", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/reminders.list.json b/lib/slack/web/docs/reminders.list.json new file mode 100644 index 0000000..1829078 --- /dev/null +++ b/lib/slack/web/docs/reminders.list.json @@ -0,0 +1,66 @@ +{ + "args": { + "team_id": { + "desc": "Encoded team id, required if org token is passed", + "example": "T1234567890", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Lists all reminders created by or for a given user.", + "errors": { + "access_denied": "Access to a resource specified in the request is denied.", + "accesslimited": "Access to this method is limited on the current network", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "is_bot": "This method cannot be called by a bot user.", + "method_deprecated": "The method has been deprecated.", + "missing_argument": "An argument is missing.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "not_authed": "No authentication token provided.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "service_unavailable": "The service is temporarily unavailable", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_expired": "Authentication token has expired", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "two_factor_setup_required": "Two factor setup is required." + }, + "is_deprecated": false, + "link": "/methods/reminders.list", + "name": "reminders.list", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/rtm.connect.json b/lib/slack/web/docs/rtm.connect.json index a7de739..0234f36 100644 --- a/lib/slack/web/docs/rtm.connect.json +++ b/lib/slack/web/docs/rtm.connect.json @@ -1,15 +1,81 @@ { "args": { "batch_presence_aware": { - "desc": "Batch presence deliveries via subscription. Enabling changes the shape of `presence_change` events. See [batch presence](https://api.slack.com/docs/presence-and-status#batching).", + "desc": "Batch presence deliveries via subscription. Enabling changes the shape of presence_change events. See batch presence.", + "example": "1", + "name": "batch_presence_aware", "required": false, - "type": "int" + "type": "boolean" }, "presence_sub": { - "desc": "Only deliver presence events when requested by subscription. See [presence subscriptions](https://api.slack.com/docs/presence-and-status#subscriptions).", + "desc": "Only deliver presence events when requested by subscription. See presence subscriptions.", + "example": "1true", + "name": "presence_sub", "required": false, - "type": "bool" + "type": "boolean" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" } }, - "desc": "Starts a Real Time Messaging session." + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Starts a Real Time Messaging session.", + "errors": { + "access_denied": "Access to a resource specified in the request is denied.", + "accesslimited": "Access to this method is limited on the current network", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "method_deprecated": "The method has been deprecated.", + "migration_in_progress": "Team is being migrated between servers. See the team_migration_started event documentation for details.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "not_authed": "No authentication token provided.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "service_unavailable": "The service is temporarily unavailable", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_expired": "Authentication token has expired", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "two_factor_setup_required": "Two factor setup is required." + }, + "is_deprecated": false, + "link": "/methods/rtm.connect", + "name": "rtm.connect", + "response": { + "ok": true, + "self": { + "id": "U4X318ZMZ", + "name": "robotoverlord" + }, + "team": { + "domain": "slackdemo", + "id": "T2U81E2FP", + "name": "SlackDemo" + }, + "url": "wss://..." + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } } \ No newline at end of file diff --git a/lib/slack/web/docs/rtm.start.json b/lib/slack/web/docs/rtm.start.json new file mode 100644 index 0000000..45906b2 --- /dev/null +++ b/lib/slack/web/docs/rtm.start.json @@ -0,0 +1,109 @@ +{ + "args": { + "batch_presence_aware": { + "desc": "Batch presence deliveries via subscription. Enabling changes the shape of presence_change events. See batch presence.", + "example": "false1", + "name": "batch_presence_aware", + "required": false, + "type": "boolean" + }, + "include_locale": { + "desc": "Set this to true to receive the locale for users and channels. Defaults to false", + "example": "true", + "name": "include_locale", + "required": false, + "type": "boolean" + }, + "mpim_aware": { + "desc": "Returns MPIMs to the client in the API response.", + "example": "true", + "name": "mpim_aware", + "required": false, + "type": "boolean" + }, + "no_latest": { + "desc": "Exclude latest timestamps for channels, groups, mpims, and ims. Automatically sets no_unreads to 1", + "example": "01", + "name": "no_latest", + "required": false, + "type": "boolean" + }, + "no_unreads": { + "desc": "Skip unread counts for each channel (improves performance).", + "example": "true", + "name": "no_unreads", + "required": false, + "type": "boolean" + }, + "presence_sub": { + "desc": "Only deliver presence events when requested by subscription. See presence subscriptions.", + "example": "truetrue", + "name": "presence_sub", + "required": false, + "type": "boolean" + }, + "simple_latest": { + "desc": "Return timestamp only for latest message object of each channel (improves performance).", + "example": "true", + "name": "simple_latest", + "required": false, + "type": "boolean" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Deprecated: Starts a Real Time Messaging session. Use rtm.connect instead.", + "errors": { + "access_denied": "Access to a resource specified in the request is denied.", + "accesslimited": "Access to this method is limited on the current network", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "method_deprecated": "The method has been deprecated.", + "migration_in_progress": "Workspace is being migrated between servers. See the team_migration_started event documentation for details.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "not_authed": "No authentication token provided.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "rtm_connect_required": "rtm.start is deprecated. Please use rtm.connect instead of rtm.start. Read https://api.slack.com/changelog/2021-10-rtm-start-to-stop for more info.", + "service_unavailable": "The service is temporarily unavailable", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_expired": "Authentication token has expired", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "two_factor_setup_required": "Two factor setup is required." + }, + "is_deprecated": false, + "link": "/methods/rtm.start", + "name": "rtm.start", + "response": { + "ok": true + }, + "warnings": { + "member_list_truncated": "A members array included in a channel object was truncated at 1500 results. Use conversations.members to retrieve all results.", + "method_deprecated": "rtm.start is deprecated. Please use rtm.connect instead of rtm.start. Read https://api.slack.com/changelog/2021-10-rtm-start-to-stop for more info.", + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/search.all.json b/lib/slack/web/docs/search.all.json index 4e3e805..74e42cf 100644 --- a/lib/slack/web/docs/search.all.json +++ b/lib/slack/web/docs/search.all.json @@ -1,29 +1,235 @@ { "args": { + "count": { + "desc": "Number of items to return per page.", + "example": "2020", + "name": "count", + "required": false, + "type": "integer" + }, "highlight": { - "desc": "Pass a value of `1` to enable query highlight markers (see below).", - "example": 1, - "required": false + "desc": "Pass a value of true to enable query highlight markers (see below).", + "example": "true", + "name": "highlight", + "required": false, + "type": "boolean" + }, + "page": { + "desc": "Page number of results to return.", + "example": "12", + "name": "page", + "required": false, + "type": "integer" }, "query": { "desc": "Search query. May contains booleans, etc.", "example": "pickleface", - "required": true + "name": "query", + "required": true, + "type": "string" }, "sort": { - "default": "score", - "desc": "Return matches sorted by either `score` or `timestamp`.", - "example": "timestamp", - "required": false + "desc": "Return matches sorted by either score or timestamp.", + "example": "scoretimestamp", + "name": "sort", + "required": false, + "type": "string" }, "sort_dir": { - "default": "desc", - "desc": "Change sort direction to ascending (`asc`) or descending (`desc`).", - "example": "asc", - "required": false + "desc": "Change sort direction to ascending (asc) or descending (desc).", + "example": "descasc", + "name": "sort_dir", + "required": false, + "type": "string" + }, + "team_id": { + "desc": "encoded team id to search in, required if org token is used", + "example": "T1234567890", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" } }, + "content_types": [ + "application/x-www-form-urlencoded" + ], "desc": "Searches for messages and files matching a query.", - "errors": {}, - "has_paging": true + "errors": { + "access_denied": "Access to a resource specified in the request is denied.", + "accesslimited": "Access to this method is limited on the current network", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "is_bot": "This method cannot be called by a bot user.", + "method_deprecated": "The method has been deprecated.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "not_authed": "No authentication token provided.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "service_unavailable": "The service is temporarily unavailable", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_expired": "Authentication token has expired", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "two_factor_setup_required": "Two factor setup is required." + }, + "is_deprecated": false, + "link": "/methods/search.all", + "name": "search.all", + "response": { + "files": { + "matches": [ + { + "original_w": 128, + "title": "slack workflow diagram", + "created": 1508804330, + "thumb_360": "https://files.slack.com/files-tmb/T2U81E2FZ-F7PKF1NR7-19f33fc256/slack_workflow_diagram_360.png", + "username": "amy", + "url_private_download": "https://files.slack.com/files-pri/T2U81E2FZ-F7PKF1NR7/download/slack_workflow_diagram.png", + "external_type": "", + "thumb_360_h": 117, + "permalink": "https://example.slack.com/files/U2U85N1RZ/F7PKF1NR7/slack_workflow_diagram.png", + "id": "F7PKF1NR7", + "permalink_public": "https://slack-files.com/T2U81E2FZ-F7PKF1NR7-bea9143f18", + "thumb_360_w": 128, + "score": "0.99982661240974", + "filetype": "png", + "mimetype": "image/png", + "thumb_160": "https://files.slack.com/files-tmb/T2U81E2FZ-F7PKF1NR7-19f33fc256/slack_workflow_diagram_160.png", + "user": "U2U85N1RZ", + "channels": [], + "timestamp": 1508804330, + "is_public": true, + "top_file": false, + "public_url_shared": false, + "image_exif_rotation": 1, + "name": "slack workflow diagram.png", + "thumb_80": "https://files.slack.com/files-tmb/T2U81E2FZ-F7PKF1NR7-19f33fc256/slack_workflow_diagram_80.png", + "is_external": false, + "preview": null, + "comments_count": 1, + "url_private": "https://files.slack.com/files-pri/T2U81E2FZ-F7PKF1NR7/slack_workflow_diagram.png", + "editable": false, + "thumb_64": "https://files.slack.com/files-tmb/T2U81E2FZ-F7PKF1NR7-19f33fc256/slack_workflow_diagram_64.png", + "initial_comment": { + "comment": "Sure! Here's the workflow diagram!", + "created": 1508804330, + "id": "Fc7NLL52E7", + "is_intro": true, + "timestamp": 1508804330, + "user": "U2U85N1RZ" + }, + "groups": [], + "original_h": 117, + "pretty_type": "PNG", + "size": 35705, + "mode": "hosted", + "display_as_bot": false, + "ims": [] + } + ], + "pagination": { + "first": 1, + "last": 1, + "page": 1, + "page_count": 1, + "per_page": 20, + "total_count": 1 + }, + "paging": { + "count": 20, + "page": 1, + "pages": 1, + "total": 1 + }, + "total": 1 + }, + "messages": { + "matches": [ + { + "channel": { + "id": "C2U86NC6M", + "is_ext_shared": false, + "is_mpim": false, + "is_org_shared": false, + "is_pending_ext_shared": false, + "is_private": false, + "is_shared": false, + "name": "general", + "pending_shared": [] + }, + "iid": "35692677-e60e-43d9-ac45-1987cea88975", + "next": { + "iid": "6f510ea1-e1d3-4f3f-bdb9-f9c6f6e9d609", + "text": "Thanks!", + "ts": "1508804378.000219", + "type": "message", + "user": "U2U85HJ7R", + "username": "john" + }, + "permalink": "https://example.slack.com/archives/C2U86NC6M/p1508804330000296", + "previous": { + "iid": "aba8603c-0543-4fb2-9118-a5ac85f3d138", + "text": "Can you send me the Slack workflow diagram?", + "ts": "1508804301.000026", + "type": "message", + "user": "U2U85HJ7R", + "username": "john" + }, + "team": "T2U81E2FZ", + "text": "uploaded a file: and commented: Sure! Here's the workflow diagram!", + "ts": "1508804330.000296", + "type": "message", + "user": "U2U85N1RZ", + "username": "amy" + } + ], + "pagination": { + "first": 1, + "last": 1, + "page": 1, + "page_count": 1, + "per_page": 20, + "total_count": 1 + }, + "paging": { + "count": 20, + "page": 1, + "pages": 1, + "total": 1 + }, + "total": 1 + }, + "ok": true, + "posts": { + "matches": [], + "total": 0 + }, + "query": "diagram" + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } } \ No newline at end of file diff --git a/lib/slack/web/docs/search.files.json b/lib/slack/web/docs/search.files.json index 06b6b83..d3ff640 100644 --- a/lib/slack/web/docs/search.files.json +++ b/lib/slack/web/docs/search.files.json @@ -1,29 +1,182 @@ { "args": { + "count": { + "desc": "Number of items to return per page.", + "example": "2020", + "name": "count", + "required": false, + "type": "integer" + }, "highlight": { - "desc": "Pass a value of `1` to enable query highlight markers (see below).", - "example": 1, - "required": false + "desc": "Pass a value of true to enable query highlight markers (see below).", + "example": "true", + "name": "highlight", + "required": false, + "type": "boolean" + }, + "page": { + "desc": "Page number of results to return.", + "example": "12", + "name": "page", + "required": false, + "type": "integer" }, "query": { - "desc": "Search query. May contain booleans, etc.", + "desc": "Search query.", "example": "pickleface", - "required": true + "name": "query", + "required": true, + "type": "string" }, "sort": { - "default": "score", - "desc": "Return matches sorted by either `score` or `timestamp`.", - "example": "timestamp", - "required": false + "desc": "Return matches sorted by either score or timestamp.", + "example": "scoretimestamp", + "name": "sort", + "required": false, + "type": "string" }, "sort_dir": { - "default": "desc", - "desc": "Change sort direction to ascending (`asc`) or descending (`desc`).", - "example": "asc", - "required": false + "desc": "Change sort direction to ascending (asc) or descending (desc).", + "example": "descasc", + "name": "sort_dir", + "required": false, + "type": "string" + }, + "team_id": { + "desc": "encoded team id to search in, required if org token is used", + "example": "T1234567890", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" } }, + "content_types": [ + "application/x-www-form-urlencoded" + ], "desc": "Searches for files matching a query.", - "errors": {}, - "has_paging": true + "errors": { + "access_denied": "Access to a resource specified in the request is denied.", + "accesslimited": "Access to this method is limited on the current network", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "is_bot": "This method cannot be called by a bot user.", + "method_deprecated": "The method has been deprecated.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "not_authed": "No authentication token provided.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "service_unavailable": "The service is temporarily unavailable", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_expired": "Authentication token has expired", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "two_factor_setup_required": "Two factor setup is required." + }, + "is_deprecated": false, + "link": "/methods/search.files", + "name": "search.files", + "response": { + "files": { + "matches": [ + { + "thumb_480": "https://files.slack.com/files-tmb/T2U81E2BB-F7H0D7ZBB-21624821e6/computer_480.png", + "original_w": 500, + "title": "computer.gif", + "created": 1507850315, + "thumb_360": "https://files.slack.com/files-tmb/T2U81E2BB-F7H0D7ZBB-21624821e6/computer_360.png", + "username": "", + "url_private_download": "https://files.slack.com/files-pri/T2U81E2BB-F7H0D7ZBB/download/computer.gif", + "external_type": "", + "thumb_360_h": 225, + "deanimate_gif": "https://files.slack.com/files-tmb/T2U81E2BB-F7H0D7ZBB-21624821e6/computer_deanimate_gif.png", + "permalink": "https://eventsdemo.slack.com/files/U2U85N1RZ/F7H0D7ZBB/computer.gif", + "id": "F7H0D7ZBB", + "permalink_public": "https://slack-files.com/T2U81E2BB-F7H0D7ZBB-85b7f5557e", + "thumb_360_w": 360, + "score": "0.38899223746309", + "filetype": "gif", + "mimetype": "image/gif", + "thumb_480_gif": "https://files.slack.com/files-tmb/T2U81E2BB-F7H0D7ZBB-21624821e6/computer_480.gif", + "thumb_160": "https://files.slack.com/files-tmb/T2U81E2BB-F7H0D7ZBB-21624821e6/computer_160.png", + "user": "U2U85N1RZ", + "channels": [], + "timestamp": 1507850315, + "is_public": true, + "top_file": false, + "public_url_shared": false, + "image_exif_rotation": 1, + "name": "computer.gif", + "thumb_80": "https://files.slack.com/files-tmb/T2U81E2BB-F7H0D7ZBB-21624821e6/computer_80.png", + "is_external": false, + "preview": null, + "thumb_480_h": 300, + "reactions": [ + { + "count": 1, + "name": "stuck_out_tongue_winking_eye", + "users": [ + "U2U85N1RZ" + ] + } + ], + "thumb_360_gif": "https://files.slack.com/files-tmb/T2U81E2BB-F7H0D7ZBB-21624821e6/computer_360.gif", + "comments_count": 1, + "url_private": "https://files.slack.com/files-pri/T2U81E2BB-F7H0D7ZBB/computer.gif", + "editable": false, + "thumb_64": "https://files.slack.com/files-tmb/T2U81E2BB-F7H0D7ZBB-21624821e6/computer_64.png", + "thumb_480_w": 480, + "groups": [], + "original_h": 313, + "pretty_type": "GIF", + "size": 1639034, + "mode": "hosted", + "display_as_bot": false, + "ims": [] + } + ], + "pagination": { + "first": 1, + "last": 3, + "page": 1, + "page_count": 1, + "per_page": 20, + "total_count": 3 + }, + "paging": { + "count": 20, + "page": 1, + "pages": 1, + "total": 3 + }, + "total": 3 + }, + "ok": true, + "query": "computer.gif" + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } } \ No newline at end of file diff --git a/lib/slack/web/docs/search.messages.json b/lib/slack/web/docs/search.messages.json index 978322e..0c28b45 100644 --- a/lib/slack/web/docs/search.messages.json +++ b/lib/slack/web/docs/search.messages.json @@ -1,29 +1,176 @@ { "args": { + "count": { + "desc": "Number of items to return per page.", + "example": "2020", + "name": "count", + "required": false, + "type": "integer" + }, + "cursor": { + "desc": "Use this when getting results with cursormark pagination. For first call send * for subsequent calls, send the value of next_cursor returned in the previous call's results", + "example": "", + "name": "cursor", + "required": false, + "type": "string" + }, "highlight": { - "desc": "Pass a value of `1` to enable query highlight markers (see below).", - "example": 1, - "required": false + "desc": "Pass a value of true to enable query highlight markers (see below).", + "example": "true", + "name": "highlight", + "required": false, + "type": "boolean" + }, + "page": { + "desc": "Page number of results to return.", + "example": "12", + "name": "page", + "required": false, + "type": "integer" }, "query": { - "desc": "Search query. May contains booleans, etc.", + "desc": "Search query.", "example": "pickleface", - "required": true + "name": "query", + "required": true, + "type": "string" }, "sort": { - "default": "score", - "desc": "Return matches sorted by either `score` or `timestamp`.", - "example": "timestamp", - "required": false + "desc": "Return matches sorted by either score or timestamp.", + "example": "scoretimestamp", + "name": "sort", + "required": false, + "type": "string" }, "sort_dir": { - "default": "desc", - "desc": "Change sort direction to ascending (`asc`) or descending (`desc`).", - "example": "asc", - "required": false + "desc": "Change sort direction to ascending (asc) or descending (desc).", + "example": "descasc", + "name": "sort_dir", + "required": false, + "type": "string" + }, + "team_id": { + "desc": "encoded team id to search in, required if org token is used", + "example": "T1234567890", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" } }, + "content_types": [ + "application/x-www-form-urlencoded" + ], "desc": "Searches for messages matching a query.", - "errors": {}, - "has_paging": true + "errors": { + "access_denied": "Access to a resource specified in the request is denied.", + "accesslimited": "Access to this method is limited on the current network", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "is_bot": "This method cannot be called by a bot user.", + "method_deprecated": "The method has been deprecated.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "not_authed": "No authentication token provided.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "service_unavailable": "The service is temporarily unavailable", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_expired": "Authentication token has expired", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "two_factor_setup_required": "Two factor setup is required." + }, + "is_deprecated": false, + "link": "/methods/search.messages", + "name": "search.messages", + "response": { + "messages": { + "matches": [ + { + "channel": { + "id": "C12345678", + "is_ext_shared": false, + "is_mpim": false, + "is_org_shared": false, + "is_pending_ext_shared": false, + "is_private": false, + "is_shared": false, + "name": "general", + "pending_shared": [] + }, + "iid": "cb64bdaa-c1e8-4631-8a91-0f78080113e9", + "permalink": "https://hitchhikers.slack.com/archives/C12345678/p1508284197000015", + "team": "T12345678", + "text": "The meaning of life the universe and everything is 42.", + "ts": "1508284197.000015", + "type": "message", + "user": "U2U85N1RV", + "username": "roach" + }, + { + "channel": { + "id": "C12345678", + "is_ext_shared": false, + "is_mpim": false, + "is_org_shared": false, + "is_pending_ext_shared": false, + "is_private": false, + "is_shared": false, + "name": "random", + "pending_shared": [] + }, + "iid": "9a00d3c9-bd2d-45b0-988b-6cff99ae2a90", + "permalink": "https://hitchhikers.slack.com/archives/C12345678/p1508795665000236", + "team": "T12345678", + "text": "The meaning of life the universe and everything is 101010", + "ts": "1508795665.000236", + "type": "message", + "user": "", + "username": "robot overlord" + } + ], + "pagination": { + "first": 1, + "last": 2, + "page": 1, + "page_count": 1, + "per_page": 20, + "total_count": 2 + }, + "paging": { + "count": 20, + "page": 1, + "pages": 1, + "total": 2 + }, + "total": 2 + }, + "ok": true, + "query": "The meaning of life the universe and everything" + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } } \ No newline at end of file diff --git a/lib/slack/web/docs/stars.add.json b/lib/slack/web/docs/stars.add.json index 7b05027..3da6f7c 100644 --- a/lib/slack/web/docs/stars.add.json +++ b/lib/slack/web/docs/stars.add.json @@ -1,34 +1,94 @@ { "args": { "channel": { - "desc": "Channel to add star to, or channel where the message to add star to was posted (used with `timestamp`).", + "desc": "Channel to add star to, or channel where the message to add star to was posted (used with timestamp).", + "example": "C1234567890", + "name": "channel", "required": false, - "type": "channel" + "type": "string" }, "file": { "desc": "File to add star to.", + "example": "F1234567890", + "name": "file", "required": false, - "type": "file" + "type": "string" }, "file_comment": { "desc": "File comment to add star to.", + "example": "Fc1234567890", + "name": "file_comment", "required": false, - "type": "file_comment" + "type": "string" }, "timestamp": { "desc": "Timestamp of the message to add star to.", + "example": "1234567890.123456", + "name": "timestamp", "required": false, - "type": "timestamp" + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" } }, - "desc": "Adds a star to an item.", + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Save an item for later. Formerly known as _adding a star_.", "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_item_specified": "file, file_comment, channel and timestamp was not specified.", "already_starred": "The specified item has already been starred by the authenticated user.", - "bad_timestamp": "Value passed for `timestamp` was invalid.", - "channel_not_found": "Channel, private group, or DM specified by `channel` does not exist", - "file_comment_not_found": "File comment specified by `file_comment` does not exist.", - "file_not_found": "File specified by `file` does not exist.", - "message_not_found": "Message specified by `channel` and `timestamp` does not exist.", - "no_item_specified": "`file`, `file_comment`, `channel` and `timestamp` was not specified." + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "external_channel_migrating": "Channel is undergoing active migration", + "bad_timestamp": "Value passed for timestamp was invalid.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "file_comment_not_found": "File comment specified by file_comment does not exist.", + "file_not_found": "File specified by file does not exist.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "Channel, private group, or DM specified by channel does not exist", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "message_not_found": "Message specified by channel and timestamp does not exist.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/stars.add", + "name": "stars.add", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/stars.list.json b/lib/slack/web/docs/stars.list.json index a4b3b76..9e6ccf2 100644 --- a/lib/slack/web/docs/stars.list.json +++ b/lib/slack/web/docs/stars.list.json @@ -1,15 +1,94 @@ { "args": { - "user": { - "desc": "Show stars by this user. Defaults to the authed user.", + "count": { + "desc": "Number of items to return per page.", + "example": "10020", + "name": "count", "required": false, - "type": "user" + "type": "integer" + }, + "cursor": { + "desc": "Parameter for pagination. Set cursor equal to the next_cursor attribute returned by the previous request's response_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first \"page\" of the collection. See pagination for more details.", + "example": "dXNlcjpVMDYxTkZUVDI=", + "name": "cursor", + "required": false, + "type": "string" + }, + "limit": { + "desc": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached.", + "example": "020", + "name": "limit", + "required": false, + "type": "integer" + }, + "page": { + "desc": "Page number of results to return.", + "example": "12", + "name": "page", + "required": false, + "type": "integer" + }, + "team_id": { + "desc": "encoded team id to list stars in, required if org token is used", + "example": "T1234567890", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" } }, - "default_count": 100, - "desc": "Lists stars for a user.", + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "List a user's saved items, formerly known as _stars_.", "errors": { - "user_not_found": "Value passed for `user` was invalid" + "access_denied": "Access to a resource specified in the request is denied.", + "accesslimited": "Access to this method is limited on the current network", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "is_bot": "This method cannot be called by a bot user.", + "method_deprecated": "The method has been deprecated.", + "missing_argument": "A required argument is missing.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "not_authed": "No authentication token provided.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "service_unavailable": "The service is temporarily unavailable", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_expired": "Authentication token has expired", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "two_factor_setup_required": "Two factor setup is required." + }, + "is_deprecated": false, + "link": "/methods/stars.list", + "name": "stars.list", + "response": { + "ok": true }, - "has_paging": true + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } } \ No newline at end of file diff --git a/lib/slack/web/docs/stars.remove.json b/lib/slack/web/docs/stars.remove.json index e9f8390..40cfc59 100644 --- a/lib/slack/web/docs/stars.remove.json +++ b/lib/slack/web/docs/stars.remove.json @@ -1,34 +1,93 @@ { "args": { "channel": { - "desc": "Channel to remove star from, or channel where the message to remove star from was posted (used with `timestamp`).", + "desc": "Channel to remove star from, or channel where the message to remove star from was posted (used with timestamp).", + "example": "C1234567890", + "name": "channel", "required": false, - "type": "channel" + "type": "string" }, "file": { "desc": "File to remove star from.", + "example": "F1234567890", + "name": "file", "required": false, - "type": "file" + "type": "string" }, "file_comment": { "desc": "File comment to remove star from.", + "example": "Fc1234567890", + "name": "file_comment", "required": false, - "type": "file_comment" + "type": "string" }, "timestamp": { "desc": "Timestamp of the message to remove star from.", + "example": "1234567890.123456", + "name": "timestamp", "required": false, - "type": "timestamp" + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" } }, - "desc": "Removes a star from an item.", + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Removes a saved item (star) from an item.", "errors": { - "bad_timestamp": "Value passed for `timestamp` was invalid.", - "channel_not_found": "Channel, private group, or DM specified by `channel` does not exist", - "file_comment_not_found": "File comment specified by `file_comment` does not exist.", - "file_not_found": "File specified by `file` does not exist.", - "message_not_found": "Message specified by `channel` and `timestamp` does not exist.", - "no_item_specified": "`file`, `file_comment`, `channel` and `timestamp` was not specified.", - "not_starred": "The specified item is not currently starred by the authenticated user." + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_item_specified": "file, file_comment, channel and timestamp was not specified.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "bad_timestamp": "Value passed for timestamp was invalid.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "not_starred": "The specified item is not currently starred by the authenticated user.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "file_comment_not_found": "File comment specified by file_comment does not exist.", + "file_not_found": "File specified by file does not exist.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "Channel, private group, or DM specified by channel does not exist", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "message_not_found": "Message specified by channel and timestamp does not exist.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/stars.remove", + "name": "stars.remove", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/team.accessLogs.json b/lib/slack/web/docs/team.accessLogs.json index c937338..70d30aa 100644 --- a/lib/slack/web/docs/team.accessLogs.json +++ b/lib/slack/web/docs/team.accessLogs.json @@ -1,10 +1,121 @@ { - "args": {}, - "default_count": 100, + "args": { + "before": { + "desc": "End of time range of logs to include in results (inclusive).", + "example": "now1457989166", + "name": "before", + "required": false, + "type": "string" + }, + "count": { + "desc": "Number of items to return per page.", + "example": "10020", + "name": "count", + "required": false, + "type": "string" + }, + "page": { + "desc": "Page number of results to return.", + "example": "12", + "name": "page", + "required": false, + "type": "string" + }, + "team_id": { + "desc": "encoded team id to get logs from, required if org token is used", + "example": "T1234567890", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded" + ], "desc": "Gets the access logs for the current team.", "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", "over_pagination_limit": "It is not possible to request more than 1000 items per page or more than 100 pages.", - "paid_only": "This is only available to paid teams." + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "missing_argument": "A required argument is missing.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "paid_only": "This is only available to paid teams.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/team.accessLogs", + "name": "team.accessLogs", + "response": { + "logins": [ + { + "count": 1, + "country": "US", + "date_first": 1422922864, + "date_last": 1422922864, + "ip": "127.0.0.1", + "isp": "BigCo ISP", + "region": "CA", + "user_agent": "SlackWeb Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2272.35 Safari/537.36", + "user_id": "U45678", + "username": "alice" + }, + { + "count": 1, + "country": "US", + "date_first": 1422922493, + "date_last": 1422922493, + "ip": "127.0.0.1", + "isp": "BigCo ISP", + "region": "CA", + "user_agent": "SlackWeb Mozilla/5.0 (iPhone; CPU iPhone OS 8_1_3 like Mac OS X) AppleWebKit/600.1.4 (KHTML, like Gecko) Version/8.0 Mobile/12B466 Safari/600.1.4", + "user_id": "U12345", + "username": "white_rabbit" + } + ], + "ok": true, + "paging": { + "count": 100, + "page": 1, + "pages": 1, + "total": 2 + } }, - "has_paging": true + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } } \ No newline at end of file diff --git a/lib/slack/web/docs/team.billableInfo.json b/lib/slack/web/docs/team.billableInfo.json new file mode 100644 index 0000000..af1ed83 --- /dev/null +++ b/lib/slack/web/docs/team.billableInfo.json @@ -0,0 +1,84 @@ +{ + "args": { + "team_id": { + "desc": "encoded team id to get the billable information from, required if org token is used", + "example": "T1234567890", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + }, + "user": { + "desc": "A user to retrieve the billable information for. Defaults to all users.", + "example": "W1234567890", + "name": "user", + "required": false, + "type": "string" + } + }, + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Gets billable users information for the current team.", + "errors": { + "access_denied": "Access to a resource specified in the request is denied.", + "accesslimited": "Access to this method is limited on the current network", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "is_bot": "This method cannot be called by a bot user.", + "method_deprecated": "The method has been deprecated.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "not_authed": "No authentication token provided.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "service_unavailable": "The service is temporarily unavailable", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_expired": "Authentication token has expired", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "two_factor_setup_required": "Two factor setup is required.", + "user_not_found": "Unable to find the requested user." + }, + "is_deprecated": false, + "link": "/methods/team.billableInfo", + "name": "team.billableInfo", + "response": { + "billable_info": { + "U02UCPE1R": { + "billing_active": true + }, + "U02UEBSD2": { + "billing_active": true + }, + "U0632EWRW": { + "billing_active": false + } + }, + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/team.billing.info.json b/lib/slack/web/docs/team.billing.info.json new file mode 100644 index 0000000..a0e7f92 --- /dev/null +++ b/lib/slack/web/docs/team.billing.info.json @@ -0,0 +1,58 @@ +{ + "args": { + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Reads a workspace's billing plan information.", + "errors": { + "access_denied": "Access to a resource specified in the request is denied.", + "accesslimited": "Access to this method is limited on the current network", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "invalid_team": "Cannot find a team associated with the authed token.", + "method_deprecated": "The method has been deprecated.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "not_authed": "No authentication token provided.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "service_unavailable": "The service is temporarily unavailable", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_expired": "Authentication token has expired", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "two_factor_setup_required": "Two factor setup is required." + }, + "is_deprecated": false, + "link": "/methods/team.billing.info", + "name": "team.billing.info", + "response": { + "ok": true, + "plan": "free" + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/team.info.json b/lib/slack/web/docs/team.info.json index 35d65d7..9b63c7a 100644 --- a/lib/slack/web/docs/team.info.json +++ b/lib/slack/web/docs/team.info.json @@ -1,5 +1,94 @@ { - "args": {}, + "args": { + "domain": { + "desc": "Query by domain instead of team (only when team is null). This only works for domains in the same enterprise as the querying team token. This also expects the domain to belong to a team and not the enterprise itself.", + "example": "", + "name": "domain", + "required": false, + "type": "string" + }, + "team": { + "desc": "Team to get info on, if omitted, will return information about the current team. Will only return team that the authenticated token is allowed to see through external shared channels", + "example": "T1234567890", + "name": "team", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded" + ], "desc": "Gets information about the current team.", - "errors": {} + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "user_not_found": "The user was not found.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "team_not_found": "The team was not found.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "team_not_on_enterprise": "Cannot query team by domain because team is not on an enterprise.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "enterprise_not_found": "The enterprise was not found.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "org_not_found": "The org was not found.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "missing_user": "The user was not found.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "fail_to_get_teams_for_restricted_user": "Failed to get teams for restricted user.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/team.info", + "name": "team.info", + "response": { + "ok": true, + "team": { + "domain": "example", + "email_domain": "example.com", + "enterprise_id": "E1234A12AB", + "enterprise_name": "Umbrella Corporation", + "icon": { + "image_102": "https://...", + "image_132": "https://...", + "image_34": "https://...", + "image_44": "https://...", + "image_68": "https://...", + "image_88": "https://...", + "image_default": true + }, + "id": "T12345", + "name": "My Team" + } + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } } \ No newline at end of file diff --git a/lib/slack/web/docs/team.integrationLogs.json b/lib/slack/web/docs/team.integrationLogs.json index 3da5988..9bc1d07 100644 --- a/lib/slack/web/docs/team.integrationLogs.json +++ b/lib/slack/web/docs/team.integrationLogs.json @@ -2,27 +2,107 @@ "args": { "app_id": { "desc": "Filter logs to this Slack app. Defaults to all logs.", + "example": "", + "name": "app_id", "required": false, - "type": "int" + "type": "string" }, "change_type": { "desc": "Filter logs with this change type. Defaults to all logs.", "example": "added", - "required": false + "name": "change_type", + "required": false, + "type": "string" + }, + "count": { + "desc": "Number of items to return per page.", + "example": "10020", + "name": "count", + "required": false, + "type": "string" + }, + "page": { + "desc": "Page number of results to return.", + "example": "12", + "name": "page", + "required": false, + "type": "string" }, "service_id": { "desc": "Filter logs to this service. Defaults to all logs.", + "example": "", + "name": "service_id", "required": false, - "type": "int" + "type": "string" + }, + "team_id": { + "desc": "encoded team id to get logs from, required if org token is used", + "example": "T1234567890", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" }, "user": { "desc": "Filter logs generated by this user’s actions. Defaults to all logs.", + "example": "W1234567890", + "name": "user", "required": false, - "type": "user" + "type": "string" } }, - "default_count": 100, + "content_types": [ + "application/x-www-form-urlencoded" + ], "desc": "Gets the integration logs for the current team.", - "errors": {}, - "has_paging": true + "errors": { + "access_denied": "Access to a resource specified in the request is denied.", + "accesslimited": "Access to this method is limited on the current network", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "is_bot": "This method cannot be called by a bot user.", + "method_deprecated": "The method has been deprecated.", + "missing_argument": "A required argument is missing.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "not_authed": "No authentication token provided.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "service_unavailable": "The service is temporarily unavailable", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_expired": "Authentication token has expired", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "two_factor_setup_required": "Two factor setup is required." + }, + "is_deprecated": false, + "link": "/methods/team.integrationLogs", + "name": "team.integrationLogs", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } } \ No newline at end of file diff --git a/lib/slack/web/docs/team.preferences.list.json b/lib/slack/web/docs/team.preferences.list.json new file mode 100644 index 0000000..9abe855 --- /dev/null +++ b/lib/slack/web/docs/team.preferences.list.json @@ -0,0 +1,62 @@ +{ + "args": { + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Retrieve a list of a workspace's team preferences.", + "errors": { + "access_denied": "Access to a resource specified in the request is denied.", + "accesslimited": "Access to this method is limited on the current network", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "invalid_team": "Cannot find a workspace associated with the presented token.", + "method_deprecated": "The method has been deprecated.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "not_authed": "No authentication token provided.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "service_unavailable": "The service is temporarily unavailable", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_expired": "Authentication token has expired", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "two_factor_setup_required": "Two factor setup is required." + }, + "is_deprecated": false, + "link": "/methods/team.preferences.list", + "name": "team.preferences.list", + "response": { + "allow_message_deletion": true, + "disable_file_uploads": "disable_all", + "display_real_names": false, + "msg_edit_window_mins": 25, + "ok": true, + "who_can_post_general": "everyone" + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/team.profile.get.json b/lib/slack/web/docs/team.profile.get.json new file mode 100644 index 0000000..b48ffe5 --- /dev/null +++ b/lib/slack/web/docs/team.profile.get.json @@ -0,0 +1,133 @@ +{ + "args": { + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + }, + "visibility": { + "desc": "Filter by visibility.", + "example": "all", + "name": "visibility", + "required": false, + "type": "string" + } + }, + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Retrieve a team's profile.", + "errors": { + "access_denied": "Access to a resource specified in the request is denied.", + "accesslimited": "Access to this method is limited on the current network", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "is_bot": "This method cannot be called by a bot user.", + "method_deprecated": "The method has been deprecated.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "not_authed": "No authentication token provided.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "service_unavailable": "The service is temporarily unavailable", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_expired": "Authentication token has expired", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "two_factor_setup_required": "Two factor setup is required." + }, + "is_deprecated": false, + "link": "/methods/team.profile.get", + "name": "team.profile.get", + "response": { + "ok": true, + "profile": { + "fields": [ + { + "hint": "Enter the extension to reach your desk", + "id": "111111ABC", + "is_hidden": false, + "label": "Phone extension", + "options": { + "is_protected": true, + "is_scim": true + }, + "ordering": 0, + "possible_values": null, + "section_id": "123ABC", + "type": "text" + }, + { + "hint": "When you were born", + "id": "222222ABC", + "is_hidden": true, + "label": "Date of birth", + "options": { + "is_protected": true, + "is_scim": true + }, + "ordering": 1, + "possible_values": null, + "section_id": "123ABC", + "type": "date" + }, + { + "hint": "Put on the sorting hat", + "id": "333333ABC", + "is_hidden": false, + "label": "House", + "options": { + "is_protected": false, + "is_scim": false + }, + "ordering": 2, + "possible_values": [ + "Gryffindor", + "Hufflepuff", + "Ravenclaw", + "Slytherin" + ], + "section_id": "456DEF", + "type": "options_list" + } + ], + "sections": [ + { + "id": "123ABC", + "is_hidden": true, + "label": "Contact Information", + "order": 1, + "section_type": "contact", + "team_id": "T123456" + }, + { + "id": "456DEF", + "is_hidden": true, + "label": "About Me", + "order": 2, + "section_type": "custom", + "team_id": "T123456" + } + ] + } + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/tooling.tokens.rotate.json b/lib/slack/web/docs/tooling.tokens.rotate.json new file mode 100644 index 0000000..b6082f4 --- /dev/null +++ b/lib/slack/web/docs/tooling.tokens.rotate.json @@ -0,0 +1,49 @@ +{ + "args": { + "refresh_token": { + "desc": "The xoxe refresh token that was issued along with the old app configuration token.", + "example": "xoxe-1-abcdefg", + "name": "refresh_token", + "required": true, + "type": "string" + } + }, + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Exchanges a refresh token for a new app configuration token.", + "errors": { + "accesslimited": "Access to this method is limited on the current network", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "invalid_refresh_token": "The given refresh token is invalid.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "service_unavailable": "The service is temporarily unavailable", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "unknown_error": "Temporary error for dev only restriction" + }, + "is_deprecated": false, + "link": "/methods/tooling.tokens.rotate", + "name": "tooling.tokens.rotate", + "response": { + "exp": 1633138860, + "iat": 1633095660, + "ok": true, + "refresh_token": "xoxe-...", + "team_id": "...", + "token": "xoxe.xoxp-...", + "user_id": "..." + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/usergroups.create.json b/lib/slack/web/docs/usergroups.create.json index 82e41fd..9b4c641 100644 --- a/lib/slack/web/docs/usergroups.create.json +++ b/lib/slack/web/docs/usergroups.create.json @@ -1,32 +1,115 @@ { "args": { "channels": { - "desc": "A comma separated string of encoded channel IDs for which the user group uses as a default.", + "desc": "A comma separated string of encoded channel IDs for which the User Group uses as a default.", + "example": "", + "name": "channels", "required": false, - "type": "string" + "type": "array" }, "description": { - "desc": "A short description of the user group.", + "desc": "A short description of the User Group.", + "example": "", + "name": "description", "required": false, "type": "string" }, "handle": { - "desc": "A mention handle. Must be unique among channels, users and user groups.", + "desc": "A mention handle. Must be unique among channels, users and User Groups.", + "example": "marketing", + "name": "handle", "required": false, "type": "string" }, "include_count": { - "desc": "Include the number of users in each user group.", - "example": "1", + "desc": "Include the number of users in each User Group.", + "example": "true", + "name": "include_count", "required": false, - "type": "int" + "type": "boolean" }, "name": { - "desc": "A name for the user group. Must be unique among user groups.", + "desc": "A name for the User Group. Must be unique among User Groups.", "example": "My Test Team", + "name": "name", "required": true, "type": "string" + }, + "team_id": { + "desc": "Encoded team id where the user group has to be created, required if org token is used.", + "example": "T1234567890", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" } }, - "desc": "Create a user group" + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Create a User Group", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "bad_handle": "Handle is invalid", + "forbidden_handle": "Handle is invalid", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "paid_teams_only": "Usergroups can only be used on paid Slack teams", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "plan_upgrade_required": "This workspace does not have access to User Groups, as that feature is only available on Standard and above plans.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_group_provided": "An invalid group ID was provided", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "permission_denied": "The user does not have permission to create a User Group.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "invalid_channel_provided": "An invalid channel ID was provided", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "missing_argument": "A required argument is missing.", + "description_too_long": "Given usergroup description is too long", + "user_is_restricted": "This method cannot be called by a restricted user or single channel guest.", + "handle_already_exists": "Handle is already in use on this workspace", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "missing_subteam_name": "Subteam name is required", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "name_too_long": "Name too long.", + "name_already_exists": "Name is already in use on this workspace", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/usergroups.create", + "name": "usergroups.create", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } } \ No newline at end of file diff --git a/lib/slack/web/docs/usergroups.disable.json b/lib/slack/web/docs/usergroups.disable.json index 491ea67..5734b5b 100644 --- a/lib/slack/web/docs/usergroups.disable.json +++ b/lib/slack/web/docs/usergroups.disable.json @@ -1,17 +1,84 @@ { "args": { "include_count": { - "desc": "Include the number of users in the user group.", - "example": "1", + "desc": "Include the number of users in the User Group.", + "example": "true", + "name": "include_count", "required": false, - "type": "int" + "type": "boolean" + }, + "team_id": { + "desc": "Encoded team id where the user group is, required if org token is used.", + "example": "T1234567890", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" }, "usergroup": { - "desc": "The encoded ID of the user group to disable.", + "desc": "The encoded ID of the User Group to disable.", "example": "S0604QSJC", + "name": "usergroup", "required": true, "type": "string" } }, - "desc": "Disable an existing user group" + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Disable an existing User Group", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "plan_upgrade_required": "This workspace does not have access to User Groups, as that feature is only available on Standard and above plans.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "permission_denied": "The user does not have permission to disables the User Group.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "missing_argument": "A required argument is missing.", + "user_is_restricted": "This method cannot be called by a restricted user or single channel guest.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/usergroups.disable", + "name": "usergroups.disable", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } } \ No newline at end of file diff --git a/lib/slack/web/docs/usergroups.enable.json b/lib/slack/web/docs/usergroups.enable.json index f5e2c5c..e43b7cc 100644 --- a/lib/slack/web/docs/usergroups.enable.json +++ b/lib/slack/web/docs/usergroups.enable.json @@ -1,17 +1,84 @@ { "args": { "include_count": { - "desc": "Include the number of users in the user group.", - "example": "1", + "desc": "Include the number of users in the User Group.", + "example": "true", + "name": "include_count", "required": false, - "type": "int" + "type": "boolean" + }, + "team_id": { + "desc": "Encoded team id where the user group is, required if org token is used.", + "example": "T1234567890", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" }, "usergroup": { - "desc": "The encoded ID of the user group to enable.", + "desc": "The encoded ID of the User Group to enable.", "example": "S0604QSJC", + "name": "usergroup", "required": true, "type": "string" } }, - "desc": "Enable a user group" + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Enable a User Group", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "plan_upgrade_required": "This workspace does not have access to User Groups, as that feature is only available on Standard and above plans.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "permission_denied": "The user does not have permission to enables the User Group.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "missing_argument": "A required argument is missing.", + "user_is_restricted": "This method cannot be called by a restricted user or single channel guest.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/usergroups.enable", + "name": "usergroups.enable", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } } \ No newline at end of file diff --git a/lib/slack/web/docs/usergroups.list.json b/lib/slack/web/docs/usergroups.list.json index ce17eec..8f49067 100644 --- a/lib/slack/web/docs/usergroups.list.json +++ b/lib/slack/web/docs/usergroups.list.json @@ -1,23 +1,154 @@ { "args": { "include_count": { - "desc": "Include the number of users in each user group.", - "example": "1", + "desc": "Include the number of users in each User Group.", + "example": "true", + "name": "include_count", "required": false, - "type": "int" + "type": "boolean" }, "include_disabled": { - "desc": "Include disabled user groups.", - "example": "1", + "desc": "Include disabled User Groups.", + "example": "true", + "name": "include_disabled", "required": false, - "type": "int" + "type": "boolean" }, "include_users": { - "desc": "Include the list of users for each user group.", - "example": "1", + "desc": "Include the list of users for each User Group.", + "example": "true", + "name": "include_users", "required": false, - "type": "int" + "type": "boolean" + }, + "team_id": { + "desc": "encoded team id to list user groups in, required if org token is used", + "example": "T1234567890", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" } }, - "desc": "List all user groups for a team" + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "List all User Groups for a team", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "plan_upgrade_required": "This workspace does not have access to User Groups, as that feature is only available on Standard and above plans.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "missing_argument": "A required argument is missing.", + "user_is_restricted": "This method cannot be called by a restricted user or single channel guest.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/usergroups.list", + "name": "usergroups.list", + "response": { + "ok": true, + "usergroups": [ + { + "auto_type": "admin", + "created_by": "USLACKBOT", + "date_create": 1446598059, + "date_delete": 0, + "date_update": 1446670362, + "deleted_by": null, + "description": "A group of all Administrators on your team.", + "handle": "admins", + "id": "S0614TZR7", + "is_external": false, + "is_usergroup": true, + "name": "Team Admins", + "prefs": { + "channels": [], + "groups": [] + }, + "team_id": "T060RNRCH", + "updated_by": "U060RNRCZ", + "user_count": "2" + }, + { + "auto_type": "owner", + "created_by": "USLACKBOT", + "date_create": 1446678371, + "date_delete": 0, + "date_update": 1446678371, + "deleted_by": null, + "description": "A group of all Owners on your team.", + "handle": "owners", + "id": "S06158AV7", + "is_external": false, + "is_usergroup": true, + "name": "Team Owners", + "prefs": { + "channels": [], + "groups": [] + }, + "team_id": "T060RNRCH", + "updated_by": "USLACKBOT", + "user_count": "1" + }, + { + "auto_type": null, + "created_by": "U060RNRCZ", + "date_create": 1446746793, + "date_delete": 1446748865, + "date_update": 1446747767, + "deleted_by": null, + "description": "Marketing gurus, PR experts and product advocates.", + "handle": "marketing-team", + "id": "S0615G0KT", + "is_external": false, + "is_usergroup": true, + "name": "Marketing Team", + "prefs": { + "channels": [], + "groups": [] + }, + "team_id": "T060RNRCH", + "updated_by": "U060RNRCZ", + "user_count": "0" + } + ] + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } } \ No newline at end of file diff --git a/lib/slack/web/docs/usergroups.update.json b/lib/slack/web/docs/usergroups.update.json index 572c214..47bd5b4 100644 --- a/lib/slack/web/docs/usergroups.update.json +++ b/lib/slack/web/docs/usergroups.update.json @@ -1,38 +1,138 @@ { "args": { "channels": { - "desc": "A comma separated string of encoded channel IDs for which the user group uses as a default.", + "desc": "A comma separated string of encoded channel IDs for which the User Group uses as a default.", + "example": "", + "name": "channels", "required": false, - "type": "string" + "type": "array" }, "description": { - "desc": "A short description of the user group.", + "desc": "A short description of the User Group.", + "example": "", + "name": "description", "required": false, "type": "string" }, "handle": { - "desc": "A mention handle. Must be unique among channels, users and user groups.", + "desc": "A mention handle. Must be unique among channels, users and User Groups.", + "example": "marketing", + "name": "handle", "required": false, "type": "string" }, "include_count": { - "desc": "Include the number of users in the user group.", - "example": "1", + "desc": "Include the number of users in the User Group.", + "example": "true", + "name": "include_count", "required": false, - "type": "int" + "type": "boolean" }, "name": { - "desc": "A name for the user group. Must be unique among user groups.", + "desc": "A name for the User Group. Must be unique among User Groups.", "example": "My Test Team", + "name": "name", "required": false, "type": "string" }, + "team_id": { + "desc": "encoded team id where the user group exists, required if org token is used", + "example": "T1234567890", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + }, "usergroup": { - "desc": "The encoded ID of the user group to update.", + "desc": "The encoded ID of the User Group to update.", "example": "S0604QSJC", + "name": "usergroup", "required": true, "type": "string" } }, - "desc": "Update an existing user group" + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Update an existing User Group", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "too_many_linked_channels": "This request exceeds the number of channels we supporting linking to a single usergroup.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "paid_teams_only": "This workspace does not have access to User Groups, as that feature is only available on Standard and above plans.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "permission_denied": "The user does not have permission to update the User Group.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "missing_argument": "A required argument is missing.", + "user_is_restricted": "This method cannot be called by a restricted user or single channel guest.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/usergroups.update", + "name": "usergroups.update", + "response": { + "ok": true, + "usergroup": { + "auto_type": null, + "created_by": "U060R4BJ4", + "date_create": 1447096577, + "date_delete": 0, + "date_update": 1447102109, + "deleted_by": null, + "description": "Marketing gurus, PR experts and product advocates.", + "handle": "marketing-team", + "id": "S0616NG6M", + "is_external": false, + "is_usergroup": true, + "name": "Marketing Team", + "prefs": { + "channels": [], + "groups": [] + }, + "team_id": "T060R4BHN", + "updated_by": "U060R4BJ4", + "user_count": 1, + "users": [ + "U060R4BJ4", + "U060RNRCZ" + ] + } + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } } \ No newline at end of file diff --git a/lib/slack/web/docs/usergroups.users.list.json b/lib/slack/web/docs/usergroups.users.list.json index cca9692..c187eea 100644 --- a/lib/slack/web/docs/usergroups.users.list.json +++ b/lib/slack/web/docs/usergroups.users.list.json @@ -1,17 +1,86 @@ { "args": { "include_disabled": { - "desc": "Allow results that involve disabled user groups.", - "example": "1", + "desc": "Allow results that involve disabled User Groups.", + "example": "true", + "name": "include_disabled", "required": false, - "type": "int" + "type": "boolean" + }, + "team_id": { + "desc": "encoded team id where the user group exists, required if org token is used", + "example": "T1234567890", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" }, "usergroup": { - "desc": "The encoded ID of the user group to update.", + "desc": "The encoded ID of the User Group to update.", "example": "S0604QSJC", + "name": "usergroup", "required": true, "type": "string" } }, - "desc": "List all users in a user group" + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "List all users in a User Group", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "plan_upgrade_required": "This workspace does not have access to User Groups, as that feature is only available on Standard and above plans.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "no_such_subteam": "No usergroup found with the given Id", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "user_is_restricted": "This method cannot be called by a restricted user or single channel guest.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/usergroups.users.list", + "name": "usergroups.users.list", + "response": { + "ok": true, + "users": [ + "U060R4BJ4", + "W123A4BC5" + ] + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } } \ No newline at end of file diff --git a/lib/slack/web/docs/usergroups.users.update.json b/lib/slack/web/docs/usergroups.users.update.json index f49e87d..9b4f7d6 100644 --- a/lib/slack/web/docs/usergroups.users.update.json +++ b/lib/slack/web/docs/usergroups.users.update.json @@ -1,23 +1,119 @@ { "args": { "include_count": { - "desc": "Include the number of users in the user group.", - "example": "1", + "desc": "Include the number of users in the User Group.", + "example": "true", + "name": "include_count", "required": false, - "type": "int" + "type": "boolean" + }, + "team_id": { + "desc": "encoded team id where the user group exists, required if org token is used", + "example": "T1234567890", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" }, "usergroup": { - "desc": "The encoded ID of the user group to update.", + "desc": "The encoded ID of the User Group to update.", "example": "S0604QSJC", + "name": "usergroup", "required": true, "type": "string" }, "users": { - "desc": "A comma separated string of encoded user IDs that represent the entire list of users for the user group.", + "desc": "A comma separated string of encoded user IDs that represent the entire list of users for the User Group.", "example": "U060R4BJ4,U060RNRCZ", + "name": "users", "required": true, - "type": "string" + "type": "array" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Update the list of users for a User Group", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "invalid_users": "Value passed for users was empty or invalid.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "plan_upgrade_required": "This workspace does not have access to User Groups, as that feature is only available on Standard and above plans.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "permission_denied": "The user does not have permission to update the list of users for a User Group.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "no_users_provided": "Either the users field wasn't provided or an empty value was passed.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "missing_argument": "A required argument is missing.", + "user_is_restricted": "This method cannot be called by a restricted user or single channel guest.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "subteam_max_users_exceeded": "Exceeds maximum supported number of users per subteam.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/usergroups.users.update", + "name": "usergroups.users.update", + "response": { + "ok": true, + "usergroup": { + "auto_type": null, + "created_by": "U060R4BJ4", + "date_create": 1447096577, + "date_delete": 0, + "date_update": 1447102109, + "deleted_by": null, + "description": "Marketing gurus, PR experts and product advocates.", + "handle": "marketing-team", + "id": "S0616NG6M", + "is_external": false, + "is_usergroup": true, + "name": "Marketing Team", + "prefs": { + "channels": [], + "groups": [] + }, + "team_id": "T060R4BHN", + "updated_by": "U060R4BJ4", + "user_count": 1, + "users": [ + "U060R4BJ4", + "U060RNRCZ" + ] } }, - "desc": "Update the list of users for a user group" + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } } \ No newline at end of file diff --git a/lib/slack/web/docs/users.conversations.json b/lib/slack/web/docs/users.conversations.json index c89c73b..90d2db1 100644 --- a/lib/slack/web/docs/users.conversations.json +++ b/lib/slack/web/docs/users.conversations.json @@ -1,36 +1,171 @@ { "args": { "cursor": { - "desc": "Paginate through collections of data by setting the cursor parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first \"page\" of the collection. See pagination for more detail.", + "desc": "Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first \"page\" of the collection. See pagination for more detail.", "example": "dXNlcjpVMDYxTkZUVDI=", - "required": false + "name": "cursor", + "required": false, + "type": "string" }, "exclude_archived": { - "default": "false", - "desc": "Set this to `true` to exclude archived channels from the list", - "example": "true", - "required": false + "desc": "Set to true to exclude archived channels from the list", + "example": "falsetrue", + "name": "exclude_archived", + "required": false, + "type": "boolean" }, "limit": { - "default": 100, "desc": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. Must be an integer no larger than 1000.", - "example": 20, - "required": false + "example": "10020", + "name": "limit", + "required": false, + "type": "number" + }, + "team_id": { + "desc": "encoded team id to list conversations in, required if org token is used", + "example": "T1234567890", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" }, "types": { - "default": "public_channel", - "desc": "Mix and match channel types by providing a comma-separated list of any combination of `public_channel`, `private_channel`, `mpim`, `im`", - "example": "public_channel,private_channel", - "required": false + "desc": "Mix and match channel types by providing a comma-separated list of any combination of public_channel, private_channel, mpim, im", + "example": "public_channelim,mpim", + "name": "types", + "required": false, + "type": "string" }, "user": { "desc": "Browse conversations by a specific user ID's membership. Non-public channels are restricted to those where the calling user shares membership.", "example": "W0B2345D", - "required": false + "name": "user", + "required": false, + "type": "string" } }, - "desc": "Returns a list of all channel-like conversations accessible to the user or app tied to the presented token, as part of Conversations API.", + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "List conversations the calling user may access.", "errors": { - "method_not_supported_for_channel_type": "This type of conversation cannot be used with this method." + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "invalid_limit": "Value passed for limit is not understood.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_types": "Value passed for type could not be used based on the method's capabilities or the permission scopes granted to the used token.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "method_not_supported_for_channel_type": "This type of conversation cannot be used with this method.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "missing_argument": "A required argument is missing.", + "accesslimited": "Access to this method is limited on the current network", + "invalid_cursor": "Value passed for cursor was not valid or is no longer valid.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/users.conversations", + "name": "users.conversations", + "response": { + "channels": [ + { + "created": 1449252889, + "creator": "U012A3CDE", + "id": "C012AB3CD", + "is_archived": false, + "is_channel": true, + "is_ext_shared": false, + "is_general": true, + "is_group": false, + "is_im": false, + "is_mpim": false, + "is_org_shared": false, + "is_pending_ext_shared": false, + "is_private": false, + "is_shared": false, + "name": "general", + "name_normalized": "general", + "pending_shared": [], + "previous_names": [], + "purpose": { + "creator": "", + "last_set": 0, + "value": "This channel is for team-wide communication and announcements. All team members are in this channel." + }, + "topic": { + "creator": "", + "last_set": 0, + "value": "Company-wide announcements and work-based matters" + }, + "unlinked": 0 + }, + { + "created": 1449252889, + "creator": "U061F7AUR", + "id": "C061EG9T2", + "is_archived": false, + "is_channel": true, + "is_ext_shared": false, + "is_general": false, + "is_group": false, + "is_im": false, + "is_mpim": false, + "is_org_shared": false, + "is_pending_ext_shared": false, + "is_private": false, + "is_shared": false, + "name": "random", + "name_normalized": "random", + "pending_shared": [], + "previous_names": [], + "purpose": { + "creator": "", + "last_set": 0, + "value": "A place for non-work-related flimflam, faffing, hodge-podge or jibber-jabber you'd prefer to keep out of more focused work-related channels." + }, + "topic": { + "creator": "", + "last_set": 0, + "value": "Non-work banter and water cooler conversation" + }, + "unlinked": 0 + } + ], + "ok": true, + "response_metadata": { + "next_cursor": "dGVhbTpDMDYxRkE1UEI=" + } + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/users.deletePhoto.json b/lib/slack/web/docs/users.deletePhoto.json new file mode 100644 index 0000000..d38dd58 --- /dev/null +++ b/lib/slack/web/docs/users.deletePhoto.json @@ -0,0 +1,57 @@ +{ + "args": { + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Delete the user profile photo", + "errors": { + "access_denied": "Access to a resource specified in the request is denied.", + "accesslimited": "Access to this method is limited on the current network", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "is_bot": "This method cannot be called by a bot user.", + "method_deprecated": "The method has been deprecated.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "not_authed": "No authentication token provided.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "service_unavailable": "The service is temporarily unavailable", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_expired": "Authentication token has expired", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "two_factor_setup_required": "Two factor setup is required." + }, + "is_deprecated": false, + "link": "/methods/users.deletePhoto", + "name": "users.deletePhoto", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/users.getPresence.json b/lib/slack/web/docs/users.getPresence.json index 3a5668a..0407ed0 100644 --- a/lib/slack/web/docs/users.getPresence.json +++ b/lib/slack/web/docs/users.getPresence.json @@ -1,11 +1,64 @@ { "args": { + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + }, "user": { "desc": "User to get presence info on. Defaults to the authed user.", - "required": true, - "type": "user" + "example": "W1234567890", + "name": "user", + "required": false, + "type": "string" } }, + "content_types": [ + "application/x-www-form-urlencoded" + ], "desc": "Gets user presence information.", - "errors": {} + "errors": { + "access_denied": "Access to a resource specified in the request is denied.", + "accesslimited": "Access to this method is limited on the current network", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "method_deprecated": "The method has been deprecated.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "not_authed": "No authentication token provided.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "service_unavailable": "The service is temporarily unavailable", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_expired": "Authentication token has expired", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "two_factor_setup_required": "Two factor setup is required." + }, + "is_deprecated": false, + "link": "/methods/users.getPresence", + "name": "users.getPresence", + "response": { + "ok": true, + "presence": "active" + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } } \ No newline at end of file diff --git a/lib/slack/web/docs/users.identity.json b/lib/slack/web/docs/users.identity.json new file mode 100644 index 0000000..bd173c7 --- /dev/null +++ b/lib/slack/web/docs/users.identity.json @@ -0,0 +1,65 @@ +{ + "args": { + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Get a user's identity.", + "errors": { + "access_denied": "Access to a resource specified in the request is denied.", + "accesslimited": "Access to this method is limited on the current network", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "invalid_user_id": "Invalid user id provided", + "is_bot": "This method cannot be called by a bot user.", + "method_deprecated": "The method has been deprecated.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "not_authed": "No authentication token provided.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "service_unavailable": "The service is temporarily unavailable", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_expired": "Authentication token has expired", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "two_factor_setup_required": "Two factor setup is required." + }, + "is_deprecated": false, + "link": "/methods/users.identity", + "name": "users.identity", + "response": { + "ok": true, + "team": { + "id": "T0G9PQBBK" + }, + "user": { + "id": "U0G9QF9C6", + "name": "Sonny Whether" + } + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/users.info.json b/lib/slack/web/docs/users.info.json index 927f852..d5712e1 100644 --- a/lib/slack/web/docs/users.info.json +++ b/lib/slack/web/docs/users.info.json @@ -1,14 +1,111 @@ { "args": { + "include_locale": { + "desc": "Set this to true to receive the locale for this user. Defaults to false", + "example": "true", + "name": "include_locale", + "required": false, + "type": "boolean" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + }, "user": { "desc": "User to get info on", + "example": "W1234567890", + "name": "user", "required": true, - "type": "user" + "type": "string" } }, + "content_types": [ + "application/x-www-form-urlencoded" + ], "desc": "Gets information about a user.", "errors": { - "user_not_found": "Value passed for `user` was invalid.", + "access_denied": "Access to a resource specified in the request is denied.", + "accesslimited": "Access to this method is limited on the current network", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "method_deprecated": "The method has been deprecated.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "not_authed": "No authentication token provided.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "service_unavailable": "The service is temporarily unavailable", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_expired": "Authentication token has expired", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "too_many_users": "Too many users.", + "two_factor_setup_required": "Two factor setup is required.", + "user_not_found": "Value passed for user was invalid.", "user_not_visible": "The requested user is not visible to the calling user" + }, + "is_deprecated": false, + "link": "/methods/users.info", + "name": "users.info", + "response": { + "ok": true, + "user": { + "color": "9f69e7", + "deleted": false, + "has_2fa": false, + "id": "W012A3CDE", + "is_admin": true, + "is_app_user": false, + "is_bot": false, + "is_owner": false, + "is_primary_owner": false, + "is_restricted": false, + "is_ultra_restricted": false, + "name": "spengler", + "profile": { + "avatar_hash": "ge3b51ca72de", + "display_name": "spengler", + "display_name_normalized": "spengler", + "email": "spengler@ghostbusters.example.com", + "image_192": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", + "image_24": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", + "image_32": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", + "image_48": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", + "image_512": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", + "image_72": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", + "image_original": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", + "real_name": "Egon Spengler", + "real_name_normalized": "Egon Spengler", + "status_emoji": ":books:", + "status_text": "Print is dead", + "team": "T012AB3C4" + }, + "real_name": "Egon Spengler", + "team_id": "T012AB3C4", + "tz": "America/Los_Angeles", + "tz_label": "Pacific Daylight Time", + "tz_offset": -25200, + "updated": 1502138686 + } + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/users.list.json b/lib/slack/web/docs/users.list.json index 75dee7a..f4b0054 100644 --- a/lib/slack/web/docs/users.list.json +++ b/lib/slack/web/docs/users.list.json @@ -1,10 +1,171 @@ { "args": { - "presence": { - "desc": "Whether to include presence data in the output", - "example": 1, - "required": false + "cursor": { + "desc": "Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first \"page\" of the collection. See pagination for more detail.", + "example": "dXNlcjpVMDYxTkZUVDI=", + "name": "cursor", + "required": false, + "type": "string" + }, + "include_locale": { + "desc": "Set this to true to receive the locale for users. Defaults to false", + "example": "true", + "name": "include_locale", + "required": false, + "type": "boolean" + }, + "limit": { + "desc": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached. Providing no limit value will result in Slack attempting to deliver you the entire result set. If the collection is too large you may experience limit_required or HTTP 500 errors.", + "example": "020", + "name": "limit", + "required": false, + "type": "number" + }, + "team_id": { + "desc": "encoded team id to list users in, required if org token is used", + "example": "T1234567890", + "name": "team_id", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" } }, - "desc": "Lists all users in a Slack team." + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Lists all users in a Slack team.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "limit_required": "For large teams a limit is required.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "missing_argument": "A required argument is missing.", + "accesslimited": "Access to this method is limited on the current network", + "invalid_cursor": "Value passed for cursor was not valid or is no longer valid.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/users.list", + "name": "users.list", + "response": { + "cache_ts": 1498777272, + "members": [ + { + "color": "9f69e7", + "deleted": false, + "has_2fa": false, + "id": "W012A3CDE", + "is_admin": true, + "is_app_user": false, + "is_bot": false, + "is_owner": false, + "is_primary_owner": false, + "is_restricted": false, + "is_ultra_restricted": false, + "name": "spengler", + "profile": { + "avatar_hash": "ge3b51ca72de", + "display_name": "spengler", + "display_name_normalized": "spengler", + "email": "spengler@ghostbusters.example.com", + "image_192": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", + "image_24": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", + "image_32": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", + "image_48": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", + "image_512": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", + "image_72": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", + "real_name": "Egon Spengler", + "real_name_normalized": "Egon Spengler", + "status_emoji": ":books:", + "status_text": "Print is dead", + "team": "T012AB3C4" + }, + "real_name": "spengler", + "team_id": "T012AB3C4", + "tz": "America/Los_Angeles", + "tz_label": "Pacific Daylight Time", + "tz_offset": -25200, + "updated": 1502138686 + }, + { + "color": "9f69e7", + "deleted": false, + "has_2fa": false, + "id": "W07QCRPA4", + "is_admin": true, + "is_bot": false, + "is_owner": false, + "is_primary_owner": false, + "is_restricted": false, + "is_ultra_restricted": false, + "name": "glinda", + "profile": { + "avatar_hash": "8fbdd10b41c6", + "display_name": "Glinda the Fairly Good", + "display_name_normalized": "Glinda the Fairly Good", + "email": "glenda@south.oz.coven", + "first_name": "Glinda", + "image_1024": "https://a.slack-edge.com...png", + "image_192": "https://a.slack-edge.com...png", + "image_24": "https://a.slack-edge.com...png", + "image_32": "https://a.slack-edge.com...png", + "image_48": "https://a.slack-edge.com...png", + "image_512": "https://a.slack-edge.com...png", + "image_72": "https://a.slack-edge.com...png", + "image_original": "https://a.slack-edge.com...png", + "last_name": "Southgood", + "phone": "", + "real_name": "Glinda Southgood", + "real_name_normalized": "Glinda Southgood", + "skype": "", + "title": "Glinda the Good" + }, + "real_name": "Glinda Southgood", + "team_id": "T0G9PQBBK", + "tz": "America/Los_Angeles", + "tz_label": "Pacific Daylight Time", + "tz_offset": -25200, + "updated": 1480527098 + } + ], + "ok": true, + "response_metadata": { + "next_cursor": "dXNlcjpVMEc5V0ZYTlo=" + } + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } } \ No newline at end of file diff --git a/lib/slack/web/docs/users.lookupByEmail.json b/lib/slack/web/docs/users.lookupByEmail.json index 47b5de7..691a531 100644 --- a/lib/slack/web/docs/users.lookupByEmail.json +++ b/lib/slack/web/docs/users.lookupByEmail.json @@ -1,14 +1,101 @@ { "args": { "email": { - "desc": "User's email address", + "desc": "An email address belonging to a user in the workspace", + "example": "spengler@ghostbusters.example.com", + "name": "email", "required": true, "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" } }, - "desc": "Retrieve a single user by looking them up by their registered email address. Requires `users:read.email`.", + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Find a user with an email address.", "errors": { - "missing_scope": "The token used is not granted the specific scope permissions required to complete this request. Need: `users:read.email`.", - "user_not_found": "Value passed for `user` was invalid." + "access_denied": "Access to a resource specified in the request is denied.", + "accesslimited": "Access to this method is limited on the current network", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "method_deprecated": "The method has been deprecated.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "not_authed": "No authentication token provided.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "service_unavailable": "The service is temporarily unavailable", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_expired": "Authentication token has expired", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "two_factor_setup_required": "Two factor setup is required.", + "users_not_found": "Value passed for user was invalid." + }, + "is_deprecated": false, + "link": "/methods/users.lookupByEmail", + "name": "users.lookupByEmail", + "response": { + "ok": true, + "user": { + "color": "9f69e7", + "deleted": false, + "has_2fa": false, + "id": "W012A3CDE", + "is_admin": true, + "is_app_user": false, + "is_bot": false, + "is_owner": false, + "is_primary_owner": false, + "is_restricted": false, + "is_ultra_restricted": false, + "name": "spengler", + "profile": { + "avatar_hash": "ge3b51ca72de", + "display_name": "spengler", + "display_name_normalized": "spengler", + "email": "spengler@ghostbusters.example.com", + "image_192": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", + "image_24": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", + "image_32": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", + "image_48": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", + "image_512": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", + "image_72": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", + "real_name": "Egon Spengler", + "real_name_normalized": "Egon Spengler", + "status_emoji": ":books:", + "status_text": "Print is dead", + "team": "T012AB3C4" + }, + "real_name": "Egon Spengler", + "team_id": "T012AB3C4", + "tz": "America/Los_Angeles", + "tz_label": "Pacific Daylight Time", + "tz_offset": -25200, + "updated": 1502138686 + } + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/users.profile.get.json b/lib/slack/web/docs/users.profile.get.json index e4b6fdd..50d1b15 100644 --- a/lib/slack/web/docs/users.profile.get.json +++ b/lib/slack/web/docs/users.profile.get.json @@ -1,20 +1,111 @@ { "args": { "include_labels": { - "desc": "Include labels for each ID in custom profile fields", - "example": true, + "desc": "Include labels for each ID in custom profile fields. Using this parameter will heavily rate-limit your requests and is not recommended.", + "example": "falsetrue", + "name": "include_labels", "required": false, "type": "boolean" }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + }, "user": { "desc": "User to retrieve profile info for", "example": "W1234567890", + "name": "user", "required": false, - "type": "user" + "type": "string" } }, - "desc": "Retrieves a user's profile information.", + "content_types": [ + "application/x-www-form-urlencoded" + ], + "desc": "Retrieve a user's profile information, including their custom status.", "errors": { - "user_not_found": "Value passed for `user` was invalid." + "access_denied": "Access to a resource specified in the request is denied.", + "accesslimited": "Access to this method is limited on the current network", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "is_bot": "This method cannot be called by a bot user.", + "method_deprecated": "The method has been deprecated.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "not_authed": "No authentication token provided.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "service_unavailable": "The service is temporarily unavailable", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_expired": "Authentication token has expired", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "two_factor_setup_required": "Two factor setup is required.", + "user_not_found": "Value passed for user was invalid." + }, + "is_deprecated": false, + "link": "/methods/users.profile.get", + "name": "users.profile.get", + "response": { + "ok": true, + "profile": { + "avatar_hash": "123xyz", + "display_name": "john", + "display_name_normalized": "john", + "email": "johnsmith@example.com", + "fields": { + "Xf0111111": { + "alt": "", + "value": "Barista" + }, + "Xf0222222": { + "alt": "", + "value": "2022-04-11" + }, + "Xf0333333": { + "alt": "", + "value": "https://example.com" + } + }, + "first_name": "john", + "huddle_state": "default_unset", + "huddle_state_expiration_ts": 0, + "image_192": "https://.../....-192png", + "image_24": "https://.../...-24.png", + "image_32": "https://.../...-32.png", + "image_48": "https://.../...-48.png", + "image_512": "https://.../...-512.png", + "image_72": "https://.../...-72.png", + "last_name": "smith", + "phone": "", + "real_name": "John Smith", + "real_name_normalized": "John Smith", + "skype": "", + "status_emoji": ":coffee:", + "status_emoji_display_info": [], + "status_expiration": 0, + "status_text": "Watching cold brew steep", + "title": "Head of Coffee Production" + } + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/users.profile.set.json b/lib/slack/web/docs/users.profile.set.json index 2cbf975..3d7178a 100644 --- a/lib/slack/web/docs/users.profile.set.json +++ b/lib/slack/web/docs/users.profile.set.json @@ -1,34 +1,135 @@ { "args": { "name": { - "desc": "Name of a single key to set. Usable only if `profile` is not passed.", + "desc": "Name of a single key to set. Usable only if profile is not passed.", "example": "first_name", - "required": false + "name": "name", + "required": false, + "type": "string" }, "profile": { "desc": "Collection of key:value pairs presented as a URL-encoded JSON hash. At most 50 fields may be set. Each field name is limited to 255 characters.", - "example": "`{ first_name: \"John\", ... }`", - "required": false + "example": "{ first_name: \"John\", ... }", + "name": "profile", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" }, "user": { - "desc": "User to retrieve profile info for", + "desc": "ID of user to change. This argument may only be specified by team admins on paid teams.", "example": "W1234567890", + "name": "user", "required": false, - "type": "user" + "type": "string" }, "value": { - "desc": "Value to set a single key to. Usable only if `profile` is not passed.", + "desc": "Value to set a single key to. Usable only if profile is not passed.", "example": "John", - "required": false + "name": "value", + "required": false, + "type": "string" } }, - "desc": "Set the profile information for a user.", + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Set a user's profile information, including custom status.", "errors": { - "cannot_update_admin_user": "Only a primary owner can update the profile of an admin.", - "invalid_profile": "Profile object passed in is not valid JSON (make sure it is URL encoded!).", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "email_taken": "email taken", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "must_clear_both_status_text_and_status_emoji": "Clearing the status requires setting both status_text and status_emoji to ''.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "profile_set_failed": "Failed to set user profile.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "partial_profile_set_failed": "Failed to set user profile.", + "too_long": "You attempted to set a custom status but it was longer than the maximum allowed, 100.", + "accesslimited": "Access to this method is limited on the current network", + "reserved_name": "First or last name are reserved.", "not_admin": "Only admins can update the profile of another user. Some fields, like email may only be updated by an admin.", + "invalid_profile": "Profile object passed in is not valid JSON (make sure it is URL encoded!).", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "cannot_update_admin_user": "Only a primary owner can update the profile of an admin.", "not_app_admin": "Only team owners and selected members can update the profile of a bot user.", - "profile_set_failed": "Failed to set user profile.", - "reserved_name": "First or last name are reserved." + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/users.profile.set", + "name": "users.profile.set", + "response": { + "ok": true, + "profile": { + "avatar_hash": "123xyz", + "display_name": "john", + "display_name_normalized": "john", + "email": "johnsmith@example.com", + "fields": { + "Xf0111111": { + "alt": "", + "value": "Barista" + }, + "Xf0222222": { + "alt": "", + "value": "2022-04-11" + }, + "Xf0333333": { + "alt": "", + "value": "https://example.com" + } + }, + "first_name": "john", + "huddle_state": "default_unset", + "huddle_state_expiration_ts": 0, + "image_192": "https://.../....-192png", + "image_24": "https://.../...-24.png", + "image_32": "https://.../...-32.png", + "image_48": "https://.../...-48.png", + "image_512": "https://.../...-512.png", + "image_72": "https://.../...-72.png", + "last_name": "smith", + "phone": "", + "real_name": "John Smith", + "real_name_normalized": "John Smith", + "skype": "", + "status_emoji": ":coffee:", + "status_emoji_display_info": [], + "status_expiration": 0, + "status_text": "Watching cold brew steep", + "title": "Head of Coffee Production" + } + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/users.setActive.json b/lib/slack/web/docs/users.setActive.json index 492ca74..781df9a 100644 --- a/lib/slack/web/docs/users.setActive.json +++ b/lib/slack/web/docs/users.setActive.json @@ -1,5 +1,57 @@ { - "args": {}, - "desc": "Marks a user as active.", - "errors": {} + "args": { + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Marked a user as active. Deprecated and non-functional.", + "errors": { + "access_denied": "Access to a resource specified in the request is denied.", + "accesslimited": "Access to this method is limited on the current network", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "method_deprecated": "The method has been deprecated.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "not_authed": "No authentication token provided.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "service_unavailable": "The service is temporarily unavailable", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_expired": "Authentication token has expired", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "two_factor_setup_required": "Two factor setup is required." + }, + "is_deprecated": false, + "link": "/methods/users.setActive", + "name": "users.setActive", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } } \ No newline at end of file diff --git a/lib/slack/web/docs/users.setPhoto.json b/lib/slack/web/docs/users.setPhoto.json new file mode 100644 index 0000000..8e99419 --- /dev/null +++ b/lib/slack/web/docs/users.setPhoto.json @@ -0,0 +1,89 @@ +{ + "args": { + "crop_w": { + "desc": "Width/height of crop box (always square)", + "example": "100", + "name": "crop_w", + "required": false, + "type": "string" + }, + "crop_x": { + "desc": "X coordinate of top-left corner of crop box", + "example": "10", + "name": "crop_x", + "required": false, + "type": "string" + }, + "crop_y": { + "desc": "Y coordinate of top-left corner of crop box", + "example": "15", + "name": "crop_y", + "required": false, + "type": "string" + }, + "image": { + "desc": "File contents via multipart/form-data.", + "example": "...", + "name": "image", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + } + }, + "content_types": [ + "multipart/form-data", + "application/x-www-form-urlencoded" + ], + "desc": "Set the user profile photo", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "bad_image": "The uploaded image could not be processed - try passing a JPEG, GIF or PNG", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "too_many_frames": "An animated GIF with too many frames was uploaded", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "too_large": "The uploaded image had excessive dimensions", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/users.setPhoto", + "name": "users.setPhoto", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/users.setPresence.json b/lib/slack/web/docs/users.setPresence.json index 84b85e0..0b5762a 100644 --- a/lib/slack/web/docs/users.setPresence.json +++ b/lib/slack/web/docs/users.setPresence.json @@ -1,13 +1,65 @@ { "args": { "presence": { - "desc": "Either `auto` or `away`", + "desc": "Either auto or away", "example": "away", - "required": true + "name": "presence", + "required": true, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" } }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], "desc": "Manually sets user presence.", "errors": { - "invalid_presence": "Value passed for `presence` was invalid." + "access_denied": "Access to a resource specified in the request is denied.", + "accesslimited": "Access to this method is limited on the current network", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "invalid_presence": "Value passed for presence was invalid.", + "method_deprecated": "The method has been deprecated.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "not_authed": "No authentication token provided.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "service_unavailable": "The service is temporarily unavailable", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "token_expired": "Authentication token has expired", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "two_factor_setup_required": "Two factor setup is required." + }, + "is_deprecated": false, + "link": "/methods/users.setPresence", + "name": "users.setPresence", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/views.open.json b/lib/slack/web/docs/views.open.json index 539ba63..207c0ae 100644 --- a/lib/slack/web/docs/views.open.json +++ b/lib/slack/web/docs/views.open.json @@ -1,38 +1,72 @@ { "args": { + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + }, "trigger_id": { "desc": "Exchange a trigger to post to the user.", "example": "12345.98765.abcd2358fdea", - "required": true + "name": "trigger_id", + "required": true, + "type": "string" }, "view": { "desc": "A view payload. This must be a JSON-encoded string.", - "example": "Ar12345", - "required": true + "example": "", + "name": "view", + "required": true, + "type": "view as string" } }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], "desc": "Open a view for a user.", "errors": { - "account_inactive": "Authentication token is for a deleted user or workspace.", - "duplicate_external_id": "Error returned when the given `external_id` has already be used.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "duplicate_external_id": "Error returned when the given external_id has already be used.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", - "invalid_arguments": "The method was called with invalid arguments.", + "expired_trigger_id": "The trigger_id is expired.", + "exchanged_trigger_id": "The trigger_id was already exchanged in a previous call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "view_too_large": "Error returned if the provided view is greater than 250kb.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "invalid_trigger_id": "The trigger_id is invalid. The expected format for the trigger_id argument is \"132456.7890123.abcdef\".", + "not_allowed_token_type": "The token type used in this request is not allowed.", "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", - "invalid_charset": "The method was called via a `POST` request, but the `charset` specified in the `Content-Type` header was invalid. Valid charset names are: `utf-8` `iso-8859-1`.", - "invalid_form_data": "The method was called via a `POST` request with `Content-Type` `application/x-www-form-urlencoded` or `multipart/form-data`, but the form data was either missing or syntactically invalid.", - "invalid_post_type": "The method was called via a `POST` request, but the specified `Content-Type` was invalid. Valid types are: `application/json` `application/x-www-form-urlencoded` `multipart/form-data` `text/plain`.", - "missing_post_type": "The method was called via a `POST` request and included a data payload, but the request did not include a `Content-Type` header.", - "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", - "not_authed": "No authentication token provided.", - "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", - "request_timeout": "The method was called via a `POST` request, but the `POST` data was either missing or truncated.", - "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", - "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed.", - "view_too_large": "Error returned if the provided view is greater than 250kb." + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." }, + "is_deprecated": false, + "link": "/methods/views.open", + "name": "views.open", "response": { "ok": true, "view": { @@ -63,7 +97,7 @@ "private_metadata": "Shh it is a secret", "root_view_id": "VMHU10V25", "state": { - "values": [] + "values": {} }, "submit": { "text": "Create", @@ -78,7 +112,7 @@ } }, "warnings": { - "missing_charset": "The method was called via a `POST` request, and recommended practice for the specified `Content-Type` is to include a `charset` parameter. However, no `charset` was present. Specifically, non-form-data content types (e.g. `text/plain`) are the ones for which `charset` is recommended.", - "superfluous_charset": "The method was called via a `POST` request, and the specified `Content-Type` is not defined to understand the `charset` parameter. However, `charset` was in fact present. Specifically, form-data content types (e.g. `multipart/form-data`) are the ones for which `charset` is superfluous." + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/views.publish.json b/lib/slack/web/docs/views.publish.json index c9bddfd..1339cf9 100644 --- a/lib/slack/web/docs/views.publish.json +++ b/lib/slack/web/docs/views.publish.json @@ -3,44 +3,77 @@ "hash": { "desc": "A string that represents view state to protect against possible race conditions.", "example": "156772938.1827394", - "required": false + "name": "hash", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" }, "user_id": { - "desc": "`id` of the user you want publish a view to.", + "desc": "id of the user you want publish a view to.", "example": "U0BPQUNTA", - "required": true + "name": "user_id", + "required": true, + "type": "string" }, "view": { "desc": "A view payload. This must be a JSON-encoded string.", - "example": "Ar12345", - "required": true + "example": "", + "name": "view", + "required": true, + "type": "view as string" } }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], "desc": "Publish a static view for a User.", "errors": { - "account_inactive": "Authentication token is for a deleted user or workspace.", - "duplicate_external_id": "Error returned when the given `external_id` has already be used.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "duplicate_external_id": "Error returned when the given external_id has already be used.", + "hash_conflict": "Error returned when the provided hash doesn't match the current stored value.", + "access_denied": "Access to a resource specified in the request is denied.", "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", - "hash_conflict": "Error returned when the provided `hash` doesn't match the current stored value.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", - "invalid_arguments": "The method was called with invalid arguments.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "view_too_large": "Error returned if the provided view is greater than 250kb.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "not_enabled": "Error returned if a home view is published but the Home tab isn't enabled for the app.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_allowed_token_type": "The token type used in this request is not allowed.", "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", - "invalid_charset": "The method was called via a `POST` request, but the `charset` specified in the `Content-Type` header was invalid. Valid charset names are: `utf-8` `iso-8859-1`.", - "invalid_form_data": "The method was called via a `POST` request with `Content-Type` `application/x-www-form-urlencoded` or `multipart/form-data`, but the form data was either missing or syntactically invalid.", - "invalid_post_type": "The method was called via a `POST` request, but the specified `Content-Type` was invalid. Valid types are: `application/json` `application/x-www-form-urlencoded` `multipart/form-data` `text/plain`.", - "missing_post_type": "The method was called via a `POST` request and included a data payload, but the request did not include a `Content-Type` header.", - "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", - "not_allowed_token_type": "The type of token your app used when requesting this method is not allowed.", - "not_authed": "No authentication token provided.", - "not_enabled": "Error returned if a `home` view is published but the Home tab isn't enabled for the app.", - "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", - "request_timeout": "The method was called via a `POST` request, but the `POST` data was either missing or truncated.", - "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", - "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed.", - "view_too_large": "Error returned if the provided view is greater than 250kb." + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "not_implemented": "The profile view experiment is not enabled for this user.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "missing_profile_id": "A profile id was not provided when trying to publish a view of type profile.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." }, + "is_deprecated": false, + "link": "/methods/views.publish", + "name": "views.publish", "response": { "ok": true, "view": { @@ -68,7 +101,7 @@ "private_metadata": "Shh it is a secret", "root_view_id": "VMHU10V25", "state": { - "values": [] + "values": {} }, "submit": null, "team_id": "T8N4K1JN", @@ -76,7 +109,7 @@ } }, "warnings": { - "missing_charset": "The method was called via a `POST` request, and recommended practice for the specified `Content-Type` is to include a `charset` parameter. However, no `charset` was present. Specifically, non-form-data content types (e.g. `text/plain`) are the ones for which `charset` is recommended.", - "superfluous_charset": "The method was called via a `POST` request, and the specified `Content-Type` is not defined to understand the `charset` parameter. However, `charset` was in fact present. Specifically, form-data content types (e.g. `multipart/form-data`) are the ones for which `charset` is superfluous." + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/views.push.json b/lib/slack/web/docs/views.push.json index e00a6a3..86e5c4b 100644 --- a/lib/slack/web/docs/views.push.json +++ b/lib/slack/web/docs/views.push.json @@ -1,39 +1,74 @@ { "args": { + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + }, "trigger_id": { "desc": "Exchange a trigger to post to the user.", "example": "12345.98765.abcd2358fdea", - "required": true + "name": "trigger_id", + "required": true, + "type": "string" }, "view": { "desc": "A view payload. This must be a JSON-encoded string.", - "example": "Ar12345", - "required": true + "example": "", + "name": "view", + "required": true, + "type": "view as string" } }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], "desc": "Push a view onto the stack of a root view.", "errors": { - "account_inactive": "Authentication token is for a deleted user or workspace.", - "duplicate_external_id": "Error returned when the given `external_id` has already be used.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "duplicate_external_id": "Error returned when the given external_id has already be used.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", - "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", - "invalid_arguments": "The method was called with invalid arguments.", - "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", - "invalid_charset": "The method was called via a `POST` request, but the `charset` specified in the `Content-Type` header was invalid. Valid charset names are: `utf-8` `iso-8859-1`.", - "invalid_form_data": "The method was called via a `POST` request with `Content-Type` `application/x-www-form-urlencoded` or `multipart/form-data`, but the form data was either missing or syntactically invalid.", - "invalid_post_type": "The method was called via a `POST` request, but the specified `Content-Type` was invalid. Valid types are: `application/json` `application/x-www-form-urlencoded` `multipart/form-data` `text/plain`.", - "missing_post_type": "The method was called via a `POST` request and included a data payload, but the request did not include a `Content-Type` header.", - "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", - "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", "not_authed": "No authentication token provided.", - "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", "push_limit_reached": "Error returned when the max push limit has been reached for views. Currently the limit is 3.", - "request_timeout": "The method was called via a `POST` request, but the `POST` data was either missing or truncated.", "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", - "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed.", - "view_too_large": "Error returned if the provided view is greater than 250kb." + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "expired_trigger_id": "The trigger_id is expired.", + "exchanged_trigger_id": "The trigger_id was already exchanged in a previous call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "view_too_large": "Error returned if the provided view is greater than 250kb.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_found": "Error returned when the requested view can't be found.", + "invalid_trigger_id": "The trigger_id is invalid. The expected format for the trigger_id argument is \"132456.7890123.abcdef\".", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." }, + "is_deprecated": false, + "link": "/methods/views.push", + "name": "views.push", "response": { "ok": true, "view": { @@ -43,12 +78,12 @@ "block_id": "edit_details", "element": { "action_id": "detail_input", - "label": { - "text": "Edit details", - "type": "plain_text" - }, "type": "plain_text_input" }, + "label": { + "text": "Edit details", + "type": "plain_text" + }, "type": "input" } ], @@ -68,7 +103,7 @@ "private_metadata": "", "root_view_id": "VNN729E3U", "state": { - "values": [] + "values": {} }, "submit": { "emoji": true, @@ -85,7 +120,7 @@ } }, "warnings": { - "missing_charset": "The method was called via a `POST` request, and recommended practice for the specified `Content-Type` is to include a `charset` parameter. However, no `charset` was present. Specifically, non-form-data content types (e.g. `text/plain`) are the ones for which `charset` is recommended.", - "superfluous_charset": "The method was called via a `POST` request, and the specified `Content-Type` is not defined to understand the `charset` parameter. However, `charset` was in fact present. Specifically, form-data content types (e.g. `multipart/form-data`) are the ones for which `charset` is superfluous." + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/views.update.json b/lib/slack/web/docs/views.update.json index fbbca0c..fee2b5a 100644 --- a/lib/slack/web/docs/views.update.json +++ b/lib/slack/web/docs/views.update.json @@ -1,50 +1,71 @@ { "args": { - "external_id": { - "desc": "A unique identifier of the view set by the developer. Must be unique for all views on a team. Max length of 255 characters. Either `view_id` or `external_id` is required.", - "example": "bmarley_view2", - "required": false - }, "hash": { "desc": "A string that represents view state to protect against possible race conditions.", "example": "156772938.1827394", - "required": false + "name": "hash", + "required": false, + "type": "string" }, - "view": { - "desc": "A view payload. This must be a JSON-encoded string.", - "example": "Ar12345", - "required": true + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" }, - "view_id": { - "desc": "A unique identifier of the view to be updated. Either `view_id` or `external_id` is required.", - "example": "VMM512F2U", - "required": false + "view": { + "desc": "A view object. This must be a JSON-encoded string.", + "example": "", + "name": "view", + "required": true, + "type": "view as string" } }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], "desc": "Update an existing view.", "errors": { - "account_inactive": "Authentication token is for a deleted user or workspace.", - "duplicate_external_id": "Error returned when the given `external_id` has already be used.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "duplicate_external_id": "Error returned when the given external_id has already be used.", + "hash_conflict": "Error returned when the provided hash doesn't match the current stored value.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "access_denied": "Access to a resource specified in the request is denied.", "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", - "hash_conflict": "Error returned when the provided `hash` doesn't match the current stored value.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", - "invalid_arguments": "The method was called with invalid arguments.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "view_too_large": "Error returned if the provided view is greater than 250kb.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_found": "Error returned when the given view_id or external_id doesn't exist.", + "not_allowed_token_type": "The token type used in this request is not allowed.", "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", - "invalid_charset": "The method was called via a `POST` request, but the `charset` specified in the `Content-Type` header was invalid. Valid charset names are: `utf-8` `iso-8859-1`.", - "invalid_form_data": "The method was called via a `POST` request with `Content-Type` `application/x-www-form-urlencoded` or `multipart/form-data`, but the form data was either missing or syntactically invalid.", - "invalid_post_type": "The method was called via a `POST` request, but the specified `Content-Type` was invalid. Valid types are: `application/json` `application/x-www-form-urlencoded` `multipart/form-data` `text/plain`.", - "missing_post_type": "The method was called via a `POST` request and included a data payload, but the request did not include a `Content-Type` header.", - "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", - "not_authed": "No authentication token provided.", - "not_found": "Error returned when the given `view_id` or `external_id` doesn't exist.", - "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", - "request_timeout": "The method was called via a `POST` request, but the `POST` data was either missing or truncated.", - "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", - "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed.", - "view_too_large": "Error returned if the provided view is greater than 250kb." + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." }, + "is_deprecated": false, + "link": "/methods/views.update", + "name": "views.update", "response": { "ok": true, "view": { @@ -84,7 +105,7 @@ "private_metadata": "", "root_view_id": "VNN729E3U", "state": { - "values": [] + "values": {} }, "submit": null, "team_id": "T9M4RL1JM", @@ -97,7 +118,7 @@ } }, "warnings": { - "missing_charset": "The method was called via a `POST` request, and recommended practice for the specified `Content-Type` is to include a `charset` parameter. However, no `charset` was present. Specifically, non-form-data content types (e.g. `text/plain`) are the ones for which `charset` is recommended.", - "superfluous_charset": "The method was called via a `POST` request, and the specified `Content-Type` is not defined to understand the `charset` parameter. However, `charset` was in fact present. Specifically, form-data content types (e.g. `multipart/form-data`) are the ones for which `charset` is superfluous." + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." } } \ No newline at end of file diff --git a/lib/slack/web/docs/workflows.stepCompleted.json b/lib/slack/web/docs/workflows.stepCompleted.json new file mode 100644 index 0000000..08ee6c0 --- /dev/null +++ b/lib/slack/web/docs/workflows.stepCompleted.json @@ -0,0 +1,79 @@ +{ + "args": { + "outputs": { + "desc": "Key-value object of outputs from your step. Keys of this object reflect the configured key properties of your outputs array from your workflow_step object.", + "example": "", + "name": "outputs", + "required": false, + "type": "object" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + }, + "workflow_step_execute_id": { + "desc": "Context identifier that maps to the correct workflow step execution.", + "example": "", + "name": "workflow_step_execute_id", + "required": true, + "type": "string" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Indicate that an app's step in a workflow completed execution.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "user_not_found": "Error returned when the value for an output of type user could not be found.", + "trigger_exchanged": "Error returned when the provided workflow_step_execute_id has already been used.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_step_status": "Error returned when the current status of this step is not 'started'.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_found": "Error returned when the context_id is invalid.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "channel_not_found": "Error returned when the value for an output of type channel could not be found.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "invalid_outputs": "The outputs provided do not match those specified at step configuration.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "invalid_token": "Error returned when the token used is invalid.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/workflows.stepCompleted", + "name": "workflows.stepCompleted", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/workflows.stepFailed.json b/lib/slack/web/docs/workflows.stepFailed.json new file mode 100644 index 0000000..ee81c8c --- /dev/null +++ b/lib/slack/web/docs/workflows.stepFailed.json @@ -0,0 +1,76 @@ +{ + "args": { + "error": { + "desc": "A JSON-based object with a message property that should contain a human readable error message.", + "example": "", + "name": "error", + "required": true, + "type": "object" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + }, + "workflow_step_execute_id": { + "desc": "Context identifier that maps to the correct workflow step execution.", + "example": "", + "name": "workflow_step_execute_id", + "required": true, + "type": "string" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Indicate that an app's step in a workflow failed to execute.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "trigger_exchanged": "Error returned when the provided workflow_step_execute_id has already been used.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_found": "Error returned when the workflow_step_execute_id is invalid.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "invalid_outputs": "The outputs provided do not match those specified at step configuration.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "invalid_token": "Error returned when the token used is invalid.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/workflows.stepFailed", + "name": "workflows.stepFailed", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/lib/slack/web/docs/workflows.updateStep.json b/lib/slack/web/docs/workflows.updateStep.json new file mode 100644 index 0000000..813959e --- /dev/null +++ b/lib/slack/web/docs/workflows.updateStep.json @@ -0,0 +1,100 @@ +{ + "args": { + "inputs": { + "desc": "A JSON key-value map of inputs required from a user during configuration. This is the data your app expects to receive when the workflow step starts. Please note: the embedded variable format is set and replaced by the workflow system. You cannot create custom variables that will be replaced at runtime. Read more about variables in workflow steps here.", + "example": "{\"title\":{\"value\":\"The Title\"},\"submitter\":{\"value\":\"{{user}}\"}}", + "name": "inputs", + "required": false, + "type": "object" + }, + "outputs": { + "desc": "An JSON array of output objects used during step execution. This is the data your app agrees to provide when your workflow step was executed.", + "example": "[{\"name\":\"ticket_id\",\"type\":\"text\",\"label\":\"Ticket ID\"},{\"name\":\"title\",\"type\":\"text\",\"label\":\"Title\"}]", + "name": "outputs", + "required": false, + "type": "array" + }, + "step_image_url": { + "desc": "An optional field that can be used to override app image that is shown in the Workflow Builder.", + "example": "", + "name": "step_image_url", + "required": false, + "type": "string" + }, + "step_name": { + "desc": "An optional field that can be used to override the step name that is shown in the Workflow Builder.", + "example": "", + "name": "step_name", + "required": false, + "type": "string" + }, + "token": { + "desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.", + "example": "xxxx-xxxxxxxxx-xxxx", + "name": "token", + "required": true, + "type": "token" + }, + "workflow_step_edit_id": { + "desc": "A context identifier provided with view_submission payloads used to call back to workflows.updateStep.", + "example": "", + "name": "workflow_step_edit_id", + "required": true, + "type": "string" + } + }, + "content_types": [ + "application/x-www-form-urlencoded", + "application/json" + ], + "desc": "Update the configuration for a workflow step.", + "errors": { + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "invalid_inputs": "Error returned when an input is missing the required value key", + "unsupported_context_type": "The context_type is unsupported", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "access_denied": "Access to a resource specified in the request is denied.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "not_authed": "No authentication token provided.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.", + "is_bot": "This method cannot be called by a bot user.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/jsonapplication/x-www-form-urlencodedmultipart/form-datatext/plain.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_form_data": "The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "accesslimited": "Access to this method is limited on the current network", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "invalid_trigger": "Error returned when the provided workflow_step_edit_id does not match any steps in the workflow", + "invalid_payload": "Error returned when the payload is invalid", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "not_found": "Error returned when the context_id is invalid", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.", + "two_factor_setup_required": "Two factor setup is required.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "trigger_expired": "Error returned when there was a timeout between view submission and workflows.updateStep call", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "service_unavailable": "The service is temporarily unavailable", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "invalid_token": "Error returned when the token used is invalid.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "token_expired": "Authentication token has expired", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.", + "method_deprecated": "The method has been deprecated." + }, + "is_deprecated": false, + "link": "/methods/workflows.updateStep", + "name": "workflows.updateStep", + "response": { + "ok": true + }, + "warnings": { + "missing_charset": "The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.", + "superfluous_charset": "The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous." + } +} \ No newline at end of file diff --git a/mix.exs b/mix.exs index f62953f..7de2910 100644 --- a/mix.exs +++ b/mix.exs @@ -34,7 +34,8 @@ defmodule Slack.Mixfile do {:ex_doc, ">= 0.0.0", only: :dev, runtime: false}, {:credo, "~> 0.5", only: [:dev, :test]}, {:plug, "~> 1.6", only: :test}, - {:cowboy, "~> 1.0.0", only: :test} + {:cowboy, "~> 1.0.0", only: :test}, + {:slack_api_docs, "~> 0.1.1", only: [:dev], runtime: false} ] end diff --git a/mix.lock b/mix.lock index c29fe60..5d941cc 100644 --- a/mix.lock +++ b/mix.lock @@ -1,28 +1,31 @@ %{ "bunt": {:hex, :bunt, "0.2.0", "951c6e801e8b1d2cbe58ebbd3e616a869061ddadcc4863d0a2182541acae9a38", [:mix], [], "hexpm", "7af5c7e09fe1d40f76c8e4f9dd2be7cebd83909f31fee7cd0e9eadc567da8353"}, - "certifi": {:hex, :certifi, "2.3.1", "d0f424232390bf47d82da8478022301c561cf6445b5b5fb6a84d49a9e76d2639", [:rebar3], [{:parse_trans, "3.2.0", [hex: :parse_trans, repo: "hexpm", optional: false]}], "hexpm", "e12d667d042c11d130594bae2b0097e63836fe8b1e6d6b2cc48f8bb7a2cf7d68"}, + "certifi": {:hex, :certifi, "2.9.0", "6f2a475689dd47f19fb74334859d460a2dc4e3252a3324bd2111b8f0429e7e21", [:rebar3], [], "hexpm", "266da46bdb06d6c6d35fde799bcb28d36d985d424ad7c08b5bb48f5b5cdd4641"}, "cowboy": {:hex, :cowboy, "1.0.4", "a324a8df9f2316c833a470d918aaf73ae894278b8aa6226ce7a9bf699388f878", [:make, :rebar], [{:cowlib, "~> 1.0.0", [hex: :cowlib, repo: "hexpm", optional: false]}, {:ranch, "~> 1.0", [hex: :ranch, repo: "hexpm", optional: false]}], "hexpm", "6a0edee96885fae3a8dd0ac1f333538a42e807db638a9453064ccfdaa6b9fdac"}, "cowlib": {:hex, :cowlib, "1.0.2", "9d769a1d062c9c3ac753096f868ca121e2730b9a377de23dec0f7e08b1df84ee", [:make], [], "hexpm", "db622da03aa039e6366ab953e31186cc8190d32905e33788a1acb22744e6abd2"}, "credo": {:hex, :credo, "0.10.0", "66234a95effaf9067edb19fc5d0cd5c6b461ad841baac42467afed96c78e5e9e", [:mix], [{:bunt, "~> 0.2.0", [hex: :bunt, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "893f53d5a5cb0bb6f96bde8732c20376e24be208fa052bdefd49119f77b64df6"}, "earmark": {:hex, :earmark, "1.3.1", "73812f447f7a42358d3ba79283cfa3075a7580a3a2ed457616d6517ac3738cb9", [:mix], [], "hexpm", "000aaeff08919e95e7aea13e4af7b2b9734577b3e6a7c50ee31ee88cab6ec4fb"}, "earmark_parser": {:hex, :earmark_parser, "1.4.13", "0c98163e7d04a15feb62000e1a891489feb29f3d10cb57d4f845c405852bbef8", [:mix], [], "hexpm", "d602c26af3a0af43d2f2645613f65841657ad6efc9f0e361c3b6c06b578214ba"}, "ex_doc": {:hex, :ex_doc, "0.24.2", "e4c26603830c1a2286dae45f4412a4d1980e1e89dc779fcd0181ed1d5a05c8d9", [:mix], [{:earmark_parser, "~> 1.4.0", [hex: :earmark_parser, repo: "hexpm", optional: false]}, {:makeup_elixir, "~> 0.14", [hex: :makeup_elixir, repo: "hexpm", optional: false]}, {:makeup_erlang, "~> 0.1", [hex: :makeup_erlang, repo: "hexpm", optional: false]}], "hexpm", "e134e1d9e821b8d9e4244687fb2ace58d479b67b282de5158333b0d57c6fb7da"}, - "hackney": {:hex, :hackney, "1.13.0", "24edc8cd2b28e1c652593833862435c80661834f6c9344e84b6a2255e7aeef03", [:rebar3], [{:certifi, "2.3.1", [hex: :certifi, repo: "hexpm", optional: false]}, {:idna, "5.1.2", [hex: :idna, repo: "hexpm", optional: false]}, {:metrics, "1.0.1", [hex: :metrics, repo: "hexpm", optional: false]}, {:mimerl, "1.0.2", [hex: :mimerl, repo: "hexpm", optional: false]}, {:ssl_verify_fun, "1.1.1", [hex: :ssl_verify_fun, repo: "hexpm", optional: false]}], "hexpm", "4d605d33dd07ee1b82b105033cccb02379515105fceb1850746591814b00c205"}, - "httpoison": {:hex, :httpoison, "1.2.0", "2702ed3da5fd7a8130fc34b11965c8cfa21ade2f232c00b42d96d4967c39a3a3", [:mix], [{:hackney, "~> 1.8", [hex: :hackney, repo: "hexpm", optional: false]}], "hexpm", "712d9b1dfde2470ed000dff4b2faddaf56d038e5ac1944abc0a81c901a368391"}, - "idna": {:hex, :idna, "5.1.2", "e21cb58a09f0228a9e0b95eaa1217f1bcfc31a1aaa6e1fdf2f53a33f7dbd9494", [:rebar3], [{:unicode_util_compat, "0.3.1", [hex: :unicode_util_compat, repo: "hexpm", optional: false]}], "hexpm", "8fddb3aec4692c71647d67de72536254bce9069851754e370a99f2aae69fbdf4"}, - "jason": {:hex, :jason, "1.1.1", "d3ccb840dfb06f2f90a6d335b536dd074db748b3e7f5b11ab61d239506585eb2", [:mix], [{:decimal, "~> 1.0", [hex: :decimal, repo: "hexpm", optional: true]}], "hexpm", "639645cfac325e34938167b272bae0791fea3a34cf32c29525abf1d323ed4c18"}, + "floki": {:hex, :floki, "0.33.1", "f20f1eb471e726342b45ccb68edb9486729e7df94da403936ea94a794f072781", [:mix], [{:html_entities, "~> 0.5.0", [hex: :html_entities, repo: "hexpm", optional: false]}], "hexpm", "461035fd125f13fdf30f243c85a0b1e50afbec876cbf1ceefe6fddd2e6d712c6"}, + "hackney": {:hex, :hackney, "1.18.1", "f48bf88f521f2a229fc7bae88cf4f85adc9cd9bcf23b5dc8eb6a1788c662c4f6", [:rebar3], [{:certifi, "~>2.9.0", [hex: :certifi, repo: "hexpm", optional: false]}, {:idna, "~>6.1.0", [hex: :idna, repo: "hexpm", optional: false]}, {:metrics, "~>1.0.0", [hex: :metrics, repo: "hexpm", optional: false]}, {:mimerl, "~>1.1", [hex: :mimerl, repo: "hexpm", optional: false]}, {:parse_trans, "3.3.1", [hex: :parse_trans, repo: "hexpm", optional: false]}, {:ssl_verify_fun, "~>1.1.0", [hex: :ssl_verify_fun, repo: "hexpm", optional: false]}, {:unicode_util_compat, "~>0.7.0", [hex: :unicode_util_compat, repo: "hexpm", optional: false]}], "hexpm", "a4ecdaff44297e9b5894ae499e9a070ea1888c84afdd1fd9b7b2bc384950128e"}, + "html_entities": {:hex, :html_entities, "0.5.2", "9e47e70598da7de2a9ff6af8758399251db6dbb7eebe2b013f2bbd2515895c3c", [:mix], [], "hexpm", "c53ba390403485615623b9531e97696f076ed415e8d8058b1dbaa28181f4fdcc"}, + "httpoison": {:hex, :httpoison, "1.8.2", "9eb9c63ae289296a544842ef816a85d881d4a31f518a0fec089aaa744beae290", [:mix], [{:hackney, "~> 1.17", [hex: :hackney, repo: "hexpm", optional: false]}], "hexpm", "2bb350d26972e30c96e2ca74a1aaf8293d61d0742ff17f01e0279fef11599921"}, + "idna": {:hex, :idna, "6.1.1", "8a63070e9f7d0c62eb9d9fcb360a7de382448200fbbd1b106cc96d3d8099df8d", [:rebar3], [{:unicode_util_compat, "~>0.7.0", [hex: :unicode_util_compat, repo: "hexpm", optional: false]}], "hexpm", "92376eb7894412ed19ac475e4a86f7b413c1b9fbb5bd16dccd57934157944cea"}, + "jason": {:hex, :jason, "1.3.0", "fa6b82a934feb176263ad2df0dbd91bf633d4a46ebfdffea0c8ae82953714946", [:mix], [{:decimal, "~> 1.0 or ~> 2.0", [hex: :decimal, repo: "hexpm", optional: true]}], "hexpm", "53fc1f51255390e0ec7e50f9cb41e751c260d065dcba2bf0d08dc51a4002c2ac"}, "makeup": {:hex, :makeup, "1.0.5", "d5a830bc42c9800ce07dd97fa94669dfb93d3bf5fcf6ea7a0c67b2e0e4a7f26c", [:mix], [{:nimble_parsec, "~> 0.5 or ~> 1.0", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "cfa158c02d3f5c0c665d0af11512fed3fba0144cf1aadee0f2ce17747fba2ca9"}, "makeup_elixir": {:hex, :makeup_elixir, "0.15.1", "b5888c880d17d1cc3e598f05cdb5b5a91b7b17ac4eaf5f297cb697663a1094dd", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}, {:nimble_parsec, "~> 1.1", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "db68c173234b07ab2a07f645a5acdc117b9f99d69ebf521821d89690ae6c6ec8"}, "makeup_erlang": {:hex, :makeup_erlang, "0.1.1", "3fcb7f09eb9d98dc4d208f49cc955a34218fc41ff6b84df7c75b3e6e533cc65f", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}], "hexpm", "174d0809e98a4ef0b3309256cbf97101c6ec01c4ab0b23e926a9e17df2077cbb"}, "metrics": {:hex, :metrics, "1.0.1", "25f094dea2cda98213cecc3aeff09e940299d950904393b2a29d191c346a8486", [:rebar3], [], "hexpm", "69b09adddc4f74a40716ae54d140f93beb0fb8978d8636eaded0c31b6f099f16"}, "mime": {:hex, :mime, "1.3.0", "5e8d45a39e95c650900d03f897fbf99ae04f60ab1daa4a34c7a20a5151b7a5fe", [:mix], [], "hexpm", "5e839994289d60326aa86020c4fbd9c6938af188ecddab2579f07b66cd665328"}, - "mimerl": {:hex, :mimerl, "1.0.2", "993f9b0e084083405ed8252b99460c4f0563e41729ab42d9074fd5e52439be88", [:rebar3], [], "hexpm", "7a4c8e1115a2732a67d7624e28cf6c9f30c66711a9e92928e745c255887ba465"}, + "mimerl": {:hex, :mimerl, "1.2.0", "67e2d3f571088d5cfd3e550c383094b47159f3eee8ffa08e64106cdf5e981be3", [:rebar3], [], "hexpm", "f278585650aa581986264638ebf698f8bb19df297f66ad91b18910dfc6e19323"}, "nimble_parsec": {:hex, :nimble_parsec, "1.1.0", "3a6fca1550363552e54c216debb6a9e95bd8d32348938e13de5eda962c0d7f89", [:mix], [], "hexpm", "08eb32d66b706e913ff748f11694b17981c0b04a33ef470e33e11b3d3ac8f54b"}, - "parse_trans": {:hex, :parse_trans, "3.2.0", "2adfa4daf80c14dc36f522cf190eb5c4ee3e28008fc6394397c16f62a26258c2", [:rebar3], [], "hexpm", "578b1d484720749499db5654091ddac818ea0b6d568f2c99c562d2a6dd4aa117"}, + "parse_trans": {:hex, :parse_trans, "3.3.1", "16328ab840cc09919bd10dab29e431da3af9e9e7e7e6f0089dd5a2d2820011d8", [:rebar3], [], "hexpm", "07cd9577885f56362d414e8c4c4e6bdf10d43a8767abb92d24cbe8b24c54888b"}, "plug": {:hex, :plug, "1.6.2", "e06a7bd2bb6de5145da0dd950070110dce88045351224bd98e84edfdaaf5ffee", [:mix], [{:cowboy, "~> 1.0.1 or ~> 1.1 or ~> 2.4", [hex: :cowboy, repo: "hexpm", optional: true]}, {:mime, "~> 1.0", [hex: :mime, repo: "hexpm", optional: false]}], "hexpm", "b2713c085797012661a6c10e1898a009f0cc2bae556cc00341b69600074c757b"}, "poison": {:hex, :poison, "4.0.1", "bcb755a16fac91cad79bfe9fc3585bb07b9331e50cfe3420a24bcc2d735709ae", [:mix], [], "hexpm", "ba8836feea4b394bb718a161fc59a288fe0109b5006d6bdf97b6badfcf6f0f25"}, "ranch": {:hex, :ranch, "1.6.0", "92ac674645ec5dd23c6f0aeb9fff0aae1dd4e94a0af8407ff4d14f750a4cd7cf", [:rebar3], [], "hexpm", "eb6170a697659046f517ceef15e568993d314591f05e73611e05605d4ac937f7"}, - "ssl_verify_fun": {:hex, :ssl_verify_fun, "1.1.1", "28a4d65b7f59893bc2c7de786dec1e1555bd742d336043fe644ae956c3497fbe", [:make, :rebar], [], "hexpm", "4f8805eb5c8a939cf2359367cb651a3180b27dfb48444846be2613d79355d65e"}, - "unicode_util_compat": {:hex, :unicode_util_compat, "0.3.1", "a1f612a7b512638634a603c8f401892afbf99b8ce93a45041f8aaca99cadb85e", [:rebar3], [], "hexpm", "da1d9bef8a092cc7e1e51f1298037a5ddfb0f657fe862dfe7ba4c5807b551c29"}, + "slack_api_docs": {:hex, :slack_api_docs, "0.1.1", "1c787bfad3dc150a95958e5b9c0c25a8376de9674af18d148a7c0d1fe0e26187", [:mix], [{:floki, "~> 0.33.0", [hex: :floki, repo: "hexpm", optional: false]}, {:httpoison, "~> 1.8", [hex: :httpoison, repo: "hexpm", optional: false]}, {:jason, "~> 1.3", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "df1349fc26f3aaae1a7e4d2b963754f082371d430e2dbfd56059faf0e6be54b3"}, + "ssl_verify_fun": {:hex, :ssl_verify_fun, "1.1.6", "cf344f5692c82d2cd7554f5ec8fd961548d4fd09e7d22f5b62482e5aeaebd4b0", [:make, :mix, :rebar3], [], "hexpm", "bdb0d2471f453c88ff3908e7686f86f9be327d065cc1ec16fa4540197ea04680"}, + "unicode_util_compat": {:hex, :unicode_util_compat, "0.7.0", "bc84380c9ab48177092f43ac89e4dfa2c6d62b40b8bd132b1059ecc7232f9a78", [:rebar3], [], "hexpm", "25eee6d67df61960cf6a794239566599b09e17e668d3700247bc498638152521"}, "websocket_client": {:hex, :websocket_client, "1.2.4", "14ec1ca4b6d247b44ccd9a80af8f6ca98328070f6c1d52a5cb00bc9d939d63b8", [:rebar3], [], "hexpm", "295a79cce15c208e03a545073f1318e97e7780aa9f2415e825cb9e338aecc305"}, } From 0dcca1e886c6c39d80f628240e3aca89cee99e55 Mon Sep 17 00:00:00 2001 From: Inooid Date: Tue, 9 Aug 2022 19:10:43 +0200 Subject: [PATCH 3/8] Filter out "token" argument As most methods require it, we can remove it as a "required" prop --- lib/slack/web/documentation.ex | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/lib/slack/web/documentation.ex b/lib/slack/web/documentation.ex index a058949..1e6df61 100644 --- a/lib/slack/web/documentation.ex +++ b/lib/slack/web/documentation.ex @@ -94,11 +94,18 @@ defmodule Slack.Web.Documentation do defp get_params_with_required(%{"args" => args}, required) do args - |> Enum.filter(fn {_, meta} -> - if required do - meta["required"] - else - !meta["required"] + |> Enum.filter(fn {name, meta} -> + cond do + # Almost all methods in the Documentation require the "token" argument + # and we always sent the token argument anyways. + name == "token" && -> + false + + ^required -> + meta["required"] + + _ -> + !meta["required"] end end) |> Enum.map(fn {name, _meta} -> From b4f942a372b27fbf04bb5147e588a99acdf67e7e Mon Sep 17 00:00:00 2001 From: Inooid Date: Tue, 9 Aug 2022 19:18:04 +0200 Subject: [PATCH 4/8] Update slack_api_docs generation --- .../web/docs/admin.analytics.getFile.json | 2 +- .../web/docs/admin.apps.approved.list.json | 2 +- .../web/docs/admin.apps.requests.list.json | 2 +- .../web/docs/admin.apps.restricted.list.json | 2 +- .../docs/admin.auth.policy.getEntities.json | 2 +- lib/slack/web/docs/admin.barriers.list.json | 2 +- .../web/docs/admin.conversations.create.json | 2 +- ....ekm.listOriginalConnectedChannelInfo.json | 2 +- .../docs/admin.conversations.getTeams.json | 2 +- .../web/docs/admin.conversations.search.json | 6 ++--- .../docs/admin.conversations.setTeams.json | 2 +- lib/slack/web/docs/admin.emoji.list.json | 2 +- .../admin.inviteRequests.approved.list.json | 2 +- .../admin.inviteRequests.denied.list.json | 2 +- .../web/docs/admin.inviteRequests.list.json | 2 +- lib/slack/web/docs/admin.teams.list.json | 2 +- .../web/docs/admin.teams.owners.list.json | 2 +- .../web/docs/admin.usergroups.addTeams.json | 2 +- lib/slack/web/docs/admin.users.list.json | 2 +- .../web/docs/admin.users.session.list.json | 2 +- ...dmin.users.unsupportedVersions.export.json | 4 ++-- lib/slack/web/docs/auth.teams.list.json | 4 ++-- lib/slack/web/docs/chat.postMessage.json | 23 ++++++++++++++++++- lib/slack/web/docs/chat.unfurl.json | 2 +- lib/slack/web/docs/chat.update.json | 2 +- lib/slack/web/docs/conversations.history.json | 8 +++---- lib/slack/web/docs/conversations.info.json | 2 +- lib/slack/web/docs/conversations.list.json | 6 ++--- .../conversations.listConnectInvites.json | 2 +- lib/slack/web/docs/conversations.members.json | 2 +- lib/slack/web/docs/conversations.replies.json | 8 +++---- lib/slack/web/docs/files.info.json | 6 ++--- lib/slack/web/docs/files.list.json | 10 ++++---- lib/slack/web/docs/files.remote.list.json | 4 ++-- lib/slack/web/docs/oauth.access.json | 2 +- lib/slack/web/docs/reactions.list.json | 6 ++--- lib/slack/web/docs/rtm.connect.json | 2 +- lib/slack/web/docs/rtm.start.json | 6 ++--- lib/slack/web/docs/search.all.json | 8 +++---- lib/slack/web/docs/search.files.json | 8 +++---- lib/slack/web/docs/search.messages.json | 8 +++---- lib/slack/web/docs/stars.list.json | 6 ++--- lib/slack/web/docs/team.accessLogs.json | 6 ++--- lib/slack/web/docs/team.integrationLogs.json | 4 ++-- lib/slack/web/docs/users.conversations.json | 6 ++--- lib/slack/web/docs/users.list.json | 2 +- lib/slack/web/docs/users.profile.get.json | 2 +- lib/slack/web/docs/views.update.json | 14 +++++++++++ mix.exs | 2 +- mix.lock | 2 +- 50 files changed, 123 insertions(+), 88 deletions(-) diff --git a/lib/slack/web/docs/admin.analytics.getFile.json b/lib/slack/web/docs/admin.analytics.getFile.json index ac85f69..5d8c0cd 100644 --- a/lib/slack/web/docs/admin.analytics.getFile.json +++ b/lib/slack/web/docs/admin.analytics.getFile.json @@ -9,7 +9,7 @@ }, "metadata_only": { "desc": "Retrieve metadata for the type of analytics indicated. Can be used only with type set to public_channel analytics. See detail below. Omit the date parameter when using this argument.", - "example": "falsetrue", + "example": "true", "name": "metadata_only", "required": false, "type": "boolean" diff --git a/lib/slack/web/docs/admin.apps.approved.list.json b/lib/slack/web/docs/admin.apps.approved.list.json index f9ab443..bd99d99 100644 --- a/lib/slack/web/docs/admin.apps.approved.list.json +++ b/lib/slack/web/docs/admin.apps.approved.list.json @@ -16,7 +16,7 @@ }, "limit": { "desc": "The maximum number of items to return. Must be between 1 - 1000 both inclusive.", - "example": "100100", + "example": "100", "name": "limit", "required": false, "type": "integer" diff --git a/lib/slack/web/docs/admin.apps.requests.list.json b/lib/slack/web/docs/admin.apps.requests.list.json index 056f002..7fdabdd 100644 --- a/lib/slack/web/docs/admin.apps.requests.list.json +++ b/lib/slack/web/docs/admin.apps.requests.list.json @@ -16,7 +16,7 @@ }, "limit": { "desc": "The maximum number of items to return. Must be between 1 - 1000 both inclusive.", - "example": "100100", + "example": "100", "name": "limit", "required": false, "type": "integer" diff --git a/lib/slack/web/docs/admin.apps.restricted.list.json b/lib/slack/web/docs/admin.apps.restricted.list.json index ec1f1cc..f2046d2 100644 --- a/lib/slack/web/docs/admin.apps.restricted.list.json +++ b/lib/slack/web/docs/admin.apps.restricted.list.json @@ -16,7 +16,7 @@ }, "limit": { "desc": "The maximum number of items to return. Must be between 1 - 1000 both inclusive.", - "example": "100100", + "example": "100", "name": "limit", "required": false, "type": "integer" diff --git a/lib/slack/web/docs/admin.auth.policy.getEntities.json b/lib/slack/web/docs/admin.auth.policy.getEntities.json index 1898e49..3a3ae08 100644 --- a/lib/slack/web/docs/admin.auth.policy.getEntities.json +++ b/lib/slack/web/docs/admin.auth.policy.getEntities.json @@ -16,7 +16,7 @@ }, "limit": { "desc": "The maximum number of items to return. Must be between 1 and 1000, both inclusive.", - "example": "1000100", + "example": "100", "name": "limit", "required": false, "type": "integer" diff --git a/lib/slack/web/docs/admin.barriers.list.json b/lib/slack/web/docs/admin.barriers.list.json index 9f36417..8241deb 100644 --- a/lib/slack/web/docs/admin.barriers.list.json +++ b/lib/slack/web/docs/admin.barriers.list.json @@ -9,7 +9,7 @@ }, "limit": { "desc": "The maximum number of items to return. Must be between 1 - 1000 both inclusive", - "example": "100100", + "example": "100", "name": "limit", "required": false, "type": "integer" diff --git a/lib/slack/web/docs/admin.conversations.create.json b/lib/slack/web/docs/admin.conversations.create.json index 93ee1b3..5f6c765 100644 --- a/lib/slack/web/docs/admin.conversations.create.json +++ b/lib/slack/web/docs/admin.conversations.create.json @@ -23,7 +23,7 @@ }, "org_wide": { "desc": "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", - "example": "falsetrue", + "example": "true", "name": "org_wide", "required": false, "type": "boolean" diff --git a/lib/slack/web/docs/admin.conversations.ekm.listOriginalConnectedChannelInfo.json b/lib/slack/web/docs/admin.conversations.ekm.listOriginalConnectedChannelInfo.json index 430b77d..4103dc3 100644 --- a/lib/slack/web/docs/admin.conversations.ekm.listOriginalConnectedChannelInfo.json +++ b/lib/slack/web/docs/admin.conversations.ekm.listOriginalConnectedChannelInfo.json @@ -16,7 +16,7 @@ }, "limit": { "desc": "The maximum number of items to return. Must be between 1 - 1000 both inclusive.", - "example": "100100", + "example": "100", "name": "limit", "required": false, "type": "integer" diff --git a/lib/slack/web/docs/admin.conversations.getTeams.json b/lib/slack/web/docs/admin.conversations.getTeams.json index feb213e..1c66092 100644 --- a/lib/slack/web/docs/admin.conversations.getTeams.json +++ b/lib/slack/web/docs/admin.conversations.getTeams.json @@ -16,7 +16,7 @@ }, "limit": { "desc": "The maximum number of items to return. Must be between 1 - 1000 both inclusive.", - "example": "100100", + "example": "100", "name": "limit", "required": false, "type": "integer" diff --git a/lib/slack/web/docs/admin.conversations.search.json b/lib/slack/web/docs/admin.conversations.search.json index 9f2b7d0..2ca5b38 100644 --- a/lib/slack/web/docs/admin.conversations.search.json +++ b/lib/slack/web/docs/admin.conversations.search.json @@ -16,7 +16,7 @@ }, "limit": { "desc": "Maximum number of items to be returned. Must be between 1 - 20 both inclusive. Default is 10.", - "example": "1020", + "example": "20", "name": "limit", "required": false, "type": "integer" @@ -37,14 +37,14 @@ }, "sort": { "desc": "Possible values are relevant (search ranking based on what we think is closest), name (alphabetical), member_count (number of users in the channel), and created (date channel was created). You can optionally pair this with the sort_dir arg to change how it is sorted", - "example": "member_countname", + "example": "name", "name": "sort", "required": false, "type": "string" }, "sort_dir": { "desc": "Sort direction. Possible values are asc for ascending order like (1, 2, 3) or (a, b, c), and desc for descending order like (3, 2, 1) or (c, b, a)", - "example": "descasc", + "example": "asc", "name": "sort_dir", "required": false, "type": "string" diff --git a/lib/slack/web/docs/admin.conversations.setTeams.json b/lib/slack/web/docs/admin.conversations.setTeams.json index 22c8d7f..defb628 100644 --- a/lib/slack/web/docs/admin.conversations.setTeams.json +++ b/lib/slack/web/docs/admin.conversations.setTeams.json @@ -9,7 +9,7 @@ }, "org_channel": { "desc": "True if channel has to be converted to an org channel", - "example": "falsetrue", + "example": "true", "name": "org_channel", "required": false, "type": "boolean" diff --git a/lib/slack/web/docs/admin.emoji.list.json b/lib/slack/web/docs/admin.emoji.list.json index 8afa8a3..8a6c28d 100644 --- a/lib/slack/web/docs/admin.emoji.list.json +++ b/lib/slack/web/docs/admin.emoji.list.json @@ -9,7 +9,7 @@ }, "limit": { "desc": "The maximum number of items to return. Must be between 1 - 1000 both inclusive.", - "example": "100100", + "example": "100", "name": "limit", "required": false, "type": "integer" diff --git a/lib/slack/web/docs/admin.inviteRequests.approved.list.json b/lib/slack/web/docs/admin.inviteRequests.approved.list.json index 4fcf80d..c5ae38f 100644 --- a/lib/slack/web/docs/admin.inviteRequests.approved.list.json +++ b/lib/slack/web/docs/admin.inviteRequests.approved.list.json @@ -9,7 +9,7 @@ }, "limit": { "desc": "The number of results that will be returned by the API on each invocation. Must be between 1 - 1000, both inclusive", - "example": "100100", + "example": "100", "name": "limit", "required": false, "type": "integer" diff --git a/lib/slack/web/docs/admin.inviteRequests.denied.list.json b/lib/slack/web/docs/admin.inviteRequests.denied.list.json index 9050726..b9a7c93 100644 --- a/lib/slack/web/docs/admin.inviteRequests.denied.list.json +++ b/lib/slack/web/docs/admin.inviteRequests.denied.list.json @@ -9,7 +9,7 @@ }, "limit": { "desc": "The number of results that will be returned by the API on each invocation. Must be between 1 - 1000 both inclusive", - "example": "100100", + "example": "100", "name": "limit", "required": false, "type": "integer" diff --git a/lib/slack/web/docs/admin.inviteRequests.list.json b/lib/slack/web/docs/admin.inviteRequests.list.json index 43eb302..562c160 100644 --- a/lib/slack/web/docs/admin.inviteRequests.list.json +++ b/lib/slack/web/docs/admin.inviteRequests.list.json @@ -9,7 +9,7 @@ }, "limit": { "desc": "The number of results that will be returned by the API on each invocation. Must be between 1 - 1000, both inclusive", - "example": "100100", + "example": "100", "name": "limit", "required": false, "type": "integer" diff --git a/lib/slack/web/docs/admin.teams.list.json b/lib/slack/web/docs/admin.teams.list.json index 21cccec..64cd65b 100644 --- a/lib/slack/web/docs/admin.teams.list.json +++ b/lib/slack/web/docs/admin.teams.list.json @@ -9,7 +9,7 @@ }, "limit": { "desc": "The maximum number of items to return. Must be between 1 - 100 both inclusive.", - "example": "10050", + "example": "50", "name": "limit", "required": false, "type": "integer" diff --git a/lib/slack/web/docs/admin.teams.owners.list.json b/lib/slack/web/docs/admin.teams.owners.list.json index aab9997..d1cee17 100644 --- a/lib/slack/web/docs/admin.teams.owners.list.json +++ b/lib/slack/web/docs/admin.teams.owners.list.json @@ -9,7 +9,7 @@ }, "limit": { "desc": "The maximum number of items to return. Must be between 1 - 1000 both inclusive.", - "example": "100100", + "example": "100", "name": "limit", "required": false, "type": "integer" diff --git a/lib/slack/web/docs/admin.usergroups.addTeams.json b/lib/slack/web/docs/admin.usergroups.addTeams.json index 3319b5c..23c89eb 100644 --- a/lib/slack/web/docs/admin.usergroups.addTeams.json +++ b/lib/slack/web/docs/admin.usergroups.addTeams.json @@ -2,7 +2,7 @@ "args": { "auto_provision": { "desc": "When true, this method automatically creates new workspace accounts for the IDP group members.", - "example": "falsetrue", + "example": "true", "name": "auto_provision", "required": false, "type": "boolean" diff --git a/lib/slack/web/docs/admin.users.list.json b/lib/slack/web/docs/admin.users.list.json index 31083d8..e8d61ec 100644 --- a/lib/slack/web/docs/admin.users.list.json +++ b/lib/slack/web/docs/admin.users.list.json @@ -9,7 +9,7 @@ }, "limit": { "desc": "Limit for how many users to be retrieved per page", - "example": "10050", + "example": "50", "name": "limit", "required": false, "type": "integer" diff --git a/lib/slack/web/docs/admin.users.session.list.json b/lib/slack/web/docs/admin.users.session.list.json index ebd5342..abc56b7 100644 --- a/lib/slack/web/docs/admin.users.session.list.json +++ b/lib/slack/web/docs/admin.users.session.list.json @@ -9,7 +9,7 @@ }, "limit": { "desc": "The maximum number of items to return. Must be between 1 - 1000 both inclusive.", - "example": "1000100", + "example": "100", "name": "limit", "required": false, "type": "integer" diff --git a/lib/slack/web/docs/admin.users.unsupportedVersions.export.json b/lib/slack/web/docs/admin.users.unsupportedVersions.export.json index 23bb8c7..ed06cca 100644 --- a/lib/slack/web/docs/admin.users.unsupportedVersions.export.json +++ b/lib/slack/web/docs/admin.users.unsupportedVersions.export.json @@ -2,14 +2,14 @@ "args": { "date_end_of_support": { "desc": "Unix timestamp of the date of past or upcoming end of support cycles. If not provided will include all announced end of support cycles.", - "example": "0", + "example": "", "name": "date_end_of_support", "required": false, "type": "integer" }, "date_sessions_started": { "desc": "Unix timestamp of a date to start looking for user sessions. If not provided will start six months ago.", - "example": "0", + "example": "", "name": "date_sessions_started", "required": false, "type": "integer" diff --git a/lib/slack/web/docs/auth.teams.list.json b/lib/slack/web/docs/auth.teams.list.json index 6e09963..c8f73bd 100644 --- a/lib/slack/web/docs/auth.teams.list.json +++ b/lib/slack/web/docs/auth.teams.list.json @@ -9,14 +9,14 @@ }, "include_icon": { "desc": "Whether to return icon paths for each workspace. An icon path represents a URI pointing to the image signifying the workspace.", - "example": "falsefalse", + "example": "false", "name": "include_icon", "required": false, "type": "boolean" }, "limit": { "desc": "The maximum number of workspaces to return. Must be a positive integer no larger than 1000.", - "example": "10050", + "example": "50", "name": "limit", "required": false, "type": "integer" diff --git a/lib/slack/web/docs/chat.postMessage.json b/lib/slack/web/docs/chat.postMessage.json index 3861ff5..d2ce3ef 100644 --- a/lib/slack/web/docs/chat.postMessage.json +++ b/lib/slack/web/docs/chat.postMessage.json @@ -7,6 +7,20 @@ "required": false, "type": "boolean" }, + "attachments": { + "desc": "Required unless `blocks`, `text` is passed. A JSON-based array of structured attachments, presented as a URL-encoded string.", + "example": "[{\"pretext\": \"pre-hello\", \"text\": \"text-world\"}]", + "name": "attachments", + "required": false, + "type": "string" + }, + "blocks": { + "desc": "Required unless `attachments`, `text` is passed. A JSON-based array of structured blocks, presented as a URL-encoded string.", + "example": "[{\"type\": \"section\", \"text\": {\"type\": \"plain_text\", \"text\": \"Hello world\"}}]", + "name": "blocks", + "required": false, + "type": "blocks[] as string" + }, "channel": { "desc": "Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name. See below for more details.", "example": "C1234567890", @@ -44,7 +58,7 @@ }, "mrkdwn": { "desc": "Disable Slack markup parsing by setting to false. Enabled by default.", - "example": "truefalse", + "example": "false", "name": "mrkdwn", "required": false, "type": "boolean" @@ -63,6 +77,13 @@ "required": false, "type": "boolean" }, + "text": { + "desc": "Required unless `attachments`, `blocks` is passed. The formatted text of the message to be published. If blocks are included, this will become the fallback text used in notifications.", + "example": "Hello world", + "name": "text", + "required": false, + "type": "string" + }, "thread_ts": { "desc": "Provide another message's ts value to make this message a reply. Avoid using a reply's ts value; use its parent instead.", "example": "", diff --git a/lib/slack/web/docs/chat.unfurl.json b/lib/slack/web/docs/chat.unfurl.json index 2d7254b..ef9608d 100644 --- a/lib/slack/web/docs/chat.unfurl.json +++ b/lib/slack/web/docs/chat.unfurl.json @@ -58,7 +58,7 @@ }, "user_auth_required": { "desc": "Set to true or 1 to indicate the user must install your Slack app to trigger unfurls for this domain", - "example": "0true", + "example": "true", "name": "user_auth_required", "required": false, "type": "boolean" diff --git a/lib/slack/web/docs/chat.update.json b/lib/slack/web/docs/chat.update.json index 98b42eb..9fe80d5 100644 --- a/lib/slack/web/docs/chat.update.json +++ b/lib/slack/web/docs/chat.update.json @@ -58,7 +58,7 @@ }, "reply_broadcast": { "desc": "Broadcast an existing thread reply to make it visible to everyone in the channel or conversation.", - "example": "falsetrue", + "example": "true", "name": "reply_broadcast", "required": false, "type": "boolean" diff --git a/lib/slack/web/docs/conversations.history.json b/lib/slack/web/docs/conversations.history.json index 484bd81..fb85ef1 100644 --- a/lib/slack/web/docs/conversations.history.json +++ b/lib/slack/web/docs/conversations.history.json @@ -16,14 +16,14 @@ }, "include_all_metadata": { "desc": "Return all metadata associated with this message.", - "example": "0true", + "example": "true", "name": "include_all_metadata", "required": false, "type": "boolean" }, "inclusive": { "desc": "Include messages with oldest or latest timestamps in results. Ignored unless either timestamp is specified.", - "example": "0true", + "example": "true", "name": "inclusive", "required": false, "type": "boolean" @@ -37,14 +37,14 @@ }, "limit": { "desc": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.", - "example": "10020", + "example": "20", "name": "limit", "required": false, "type": "number" }, "oldest": { "desc": "Only messages after this Unix timestamp will be included in results.", - "example": "01234567890.123456", + "example": "1234567890.123456", "name": "oldest", "required": false, "type": "string" diff --git a/lib/slack/web/docs/conversations.info.json b/lib/slack/web/docs/conversations.info.json index 456ef10..9196828 100644 --- a/lib/slack/web/docs/conversations.info.json +++ b/lib/slack/web/docs/conversations.info.json @@ -16,7 +16,7 @@ }, "include_num_members": { "desc": "Set to true to include the member count for the specified conversation. Defaults to false", - "example": "falsetrue", + "example": "true", "name": "include_num_members", "required": false, "type": "boolean" diff --git a/lib/slack/web/docs/conversations.list.json b/lib/slack/web/docs/conversations.list.json index aa19e84..6069988 100644 --- a/lib/slack/web/docs/conversations.list.json +++ b/lib/slack/web/docs/conversations.list.json @@ -9,14 +9,14 @@ }, "exclude_archived": { "desc": "Set to true to exclude archived channels from the list.", - "example": "falsetrue", + "example": "true", "name": "exclude_archived", "required": false, "type": "boolean" }, "limit": { "desc": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. Must be an integer no larger than 1000.", - "example": "10020", + "example": "20", "name": "limit", "required": false, "type": "number" @@ -37,7 +37,7 @@ }, "types": { "desc": "Mix and match channel types by providing a comma-separated list of any combination of public_channel, private_channel, mpim, im", - "example": "public_channelpublic_channel,private_channel", + "example": "public_channel,private_channel", "name": "types", "required": false, "type": "string" diff --git a/lib/slack/web/docs/conversations.listConnectInvites.json b/lib/slack/web/docs/conversations.listConnectInvites.json index 4d12901..c07d429 100644 --- a/lib/slack/web/docs/conversations.listConnectInvites.json +++ b/lib/slack/web/docs/conversations.listConnectInvites.json @@ -2,7 +2,7 @@ "args": { "count": { "desc": "Maximum number of invites to return", - "example": "100", + "example": "", "name": "count", "required": false, "type": "integer" diff --git a/lib/slack/web/docs/conversations.members.json b/lib/slack/web/docs/conversations.members.json index bda54e9..1c62ca0 100644 --- a/lib/slack/web/docs/conversations.members.json +++ b/lib/slack/web/docs/conversations.members.json @@ -16,7 +16,7 @@ }, "limit": { "desc": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.", - "example": "10020", + "example": "20", "name": "limit", "required": false, "type": "number" diff --git a/lib/slack/web/docs/conversations.replies.json b/lib/slack/web/docs/conversations.replies.json index 5467aab..9038e82 100644 --- a/lib/slack/web/docs/conversations.replies.json +++ b/lib/slack/web/docs/conversations.replies.json @@ -16,28 +16,28 @@ }, "inclusive": { "desc": "Include messages with oldest or latest timestamps in results. Ignored unless either timestamp is specified.", - "example": "0true", + "example": "true", "name": "inclusive", "required": false, "type": "boolean" }, "latest": { "desc": "Only messages before this Unix timestamp will be included in results.", - "example": "now1234567890.123456", + "example": "1234567890.123456", "name": "latest", "required": false, "type": "string" }, "limit": { "desc": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.", - "example": "100020", + "example": "20", "name": "limit", "required": false, "type": "number" }, "oldest": { "desc": "Only messages after this Unix timestamp will be included in results.", - "example": "01234567890.123456", + "example": "1234567890.123456", "name": "oldest", "required": false, "type": "string" diff --git a/lib/slack/web/docs/files.info.json b/lib/slack/web/docs/files.info.json index 3c80d9c..6519e35 100644 --- a/lib/slack/web/docs/files.info.json +++ b/lib/slack/web/docs/files.info.json @@ -2,7 +2,7 @@ "args": { "count": { "desc": "Number of items to return per page.", - "example": "10020", + "example": "20", "name": "count", "required": false, "type": "integer" @@ -23,14 +23,14 @@ }, "limit": { "desc": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached.", - "example": "020", + "example": "20", "name": "limit", "required": false, "type": "integer" }, "page": { "desc": "Page number of results to return.", - "example": "12", + "example": "2", "name": "page", "required": false, "type": "integer" diff --git a/lib/slack/web/docs/files.list.json b/lib/slack/web/docs/files.list.json index b074245..f2adaf5 100644 --- a/lib/slack/web/docs/files.list.json +++ b/lib/slack/web/docs/files.list.json @@ -9,7 +9,7 @@ }, "count": { "desc": "Number of items to return per page.", - "example": "10020", + "example": "20", "name": "count", "required": false, "type": "integer" @@ -23,7 +23,7 @@ }, "page": { "desc": "Page number of results to return.", - "example": "12", + "example": "2", "name": "page", "required": false, "type": "integer" @@ -51,21 +51,21 @@ }, "ts_from": { "desc": "Filter files created after this timestamp (inclusive).", - "example": "0123456789", + "example": "123456789", "name": "ts_from", "required": false, "type": "string" }, "ts_to": { "desc": "Filter files created before this timestamp (inclusive).", - "example": "now123456789", + "example": "123456789", "name": "ts_to", "required": false, "type": "string" }, "types": { "desc": "Filter files by type (see below). You can pass multiple values in the types argument, like types=spaces,snippets.The default value is all, which does not filter the list.", - "example": "allimages", + "example": "images", "name": "types", "required": false, "type": "string" diff --git a/lib/slack/web/docs/files.remote.list.json b/lib/slack/web/docs/files.remote.list.json index 5a0add8..ce30422 100644 --- a/lib/slack/web/docs/files.remote.list.json +++ b/lib/slack/web/docs/files.remote.list.json @@ -30,14 +30,14 @@ }, "ts_from": { "desc": "Filter files created after this timestamp (inclusive).", - "example": "0123456789", + "example": "123456789", "name": "ts_from", "required": false, "type": "string" }, "ts_to": { "desc": "Filter files created before this timestamp (inclusive).", - "example": "now123456789", + "example": "123456789", "name": "ts_to", "required": false, "type": "string" diff --git a/lib/slack/web/docs/oauth.access.json b/lib/slack/web/docs/oauth.access.json index 1b8de7a..3c124e6 100644 --- a/lib/slack/web/docs/oauth.access.json +++ b/lib/slack/web/docs/oauth.access.json @@ -30,7 +30,7 @@ }, "single_channel": { "desc": "Request the user to add your app only to a single channel. Only valid with a legacy workspace app.", - "example": "falsetrue", + "example": "true", "name": "single_channel", "required": false, "type": "boolean" diff --git a/lib/slack/web/docs/reactions.list.json b/lib/slack/web/docs/reactions.list.json index 5906794..c573cd9 100644 --- a/lib/slack/web/docs/reactions.list.json +++ b/lib/slack/web/docs/reactions.list.json @@ -2,7 +2,7 @@ "args": { "count": { "desc": "Number of items to return per page.", - "example": "10020", + "example": "20", "name": "count", "required": false, "type": "integer" @@ -23,14 +23,14 @@ }, "limit": { "desc": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached.", - "example": "020", + "example": "20", "name": "limit", "required": false, "type": "integer" }, "page": { "desc": "Page number of results to return.", - "example": "12", + "example": "2", "name": "page", "required": false, "type": "integer" diff --git a/lib/slack/web/docs/rtm.connect.json b/lib/slack/web/docs/rtm.connect.json index 0234f36..7ba0966 100644 --- a/lib/slack/web/docs/rtm.connect.json +++ b/lib/slack/web/docs/rtm.connect.json @@ -9,7 +9,7 @@ }, "presence_sub": { "desc": "Only deliver presence events when requested by subscription. See presence subscriptions.", - "example": "1true", + "example": "true", "name": "presence_sub", "required": false, "type": "boolean" diff --git a/lib/slack/web/docs/rtm.start.json b/lib/slack/web/docs/rtm.start.json index 45906b2..8ef5ccf 100644 --- a/lib/slack/web/docs/rtm.start.json +++ b/lib/slack/web/docs/rtm.start.json @@ -2,7 +2,7 @@ "args": { "batch_presence_aware": { "desc": "Batch presence deliveries via subscription. Enabling changes the shape of presence_change events. See batch presence.", - "example": "false1", + "example": "1", "name": "batch_presence_aware", "required": false, "type": "boolean" @@ -23,7 +23,7 @@ }, "no_latest": { "desc": "Exclude latest timestamps for channels, groups, mpims, and ims. Automatically sets no_unreads to 1", - "example": "01", + "example": "1", "name": "no_latest", "required": false, "type": "boolean" @@ -37,7 +37,7 @@ }, "presence_sub": { "desc": "Only deliver presence events when requested by subscription. See presence subscriptions.", - "example": "truetrue", + "example": "true", "name": "presence_sub", "required": false, "type": "boolean" diff --git a/lib/slack/web/docs/search.all.json b/lib/slack/web/docs/search.all.json index 74e42cf..6cacd2c 100644 --- a/lib/slack/web/docs/search.all.json +++ b/lib/slack/web/docs/search.all.json @@ -2,7 +2,7 @@ "args": { "count": { "desc": "Number of items to return per page.", - "example": "2020", + "example": "20", "name": "count", "required": false, "type": "integer" @@ -16,7 +16,7 @@ }, "page": { "desc": "Page number of results to return.", - "example": "12", + "example": "2", "name": "page", "required": false, "type": "integer" @@ -30,14 +30,14 @@ }, "sort": { "desc": "Return matches sorted by either score or timestamp.", - "example": "scoretimestamp", + "example": "timestamp", "name": "sort", "required": false, "type": "string" }, "sort_dir": { "desc": "Change sort direction to ascending (asc) or descending (desc).", - "example": "descasc", + "example": "asc", "name": "sort_dir", "required": false, "type": "string" diff --git a/lib/slack/web/docs/search.files.json b/lib/slack/web/docs/search.files.json index d3ff640..e8df602 100644 --- a/lib/slack/web/docs/search.files.json +++ b/lib/slack/web/docs/search.files.json @@ -2,7 +2,7 @@ "args": { "count": { "desc": "Number of items to return per page.", - "example": "2020", + "example": "20", "name": "count", "required": false, "type": "integer" @@ -16,7 +16,7 @@ }, "page": { "desc": "Page number of results to return.", - "example": "12", + "example": "2", "name": "page", "required": false, "type": "integer" @@ -30,14 +30,14 @@ }, "sort": { "desc": "Return matches sorted by either score or timestamp.", - "example": "scoretimestamp", + "example": "timestamp", "name": "sort", "required": false, "type": "string" }, "sort_dir": { "desc": "Change sort direction to ascending (asc) or descending (desc).", - "example": "descasc", + "example": "asc", "name": "sort_dir", "required": false, "type": "string" diff --git a/lib/slack/web/docs/search.messages.json b/lib/slack/web/docs/search.messages.json index 0c28b45..8cf831b 100644 --- a/lib/slack/web/docs/search.messages.json +++ b/lib/slack/web/docs/search.messages.json @@ -2,7 +2,7 @@ "args": { "count": { "desc": "Number of items to return per page.", - "example": "2020", + "example": "20", "name": "count", "required": false, "type": "integer" @@ -23,7 +23,7 @@ }, "page": { "desc": "Page number of results to return.", - "example": "12", + "example": "2", "name": "page", "required": false, "type": "integer" @@ -37,14 +37,14 @@ }, "sort": { "desc": "Return matches sorted by either score or timestamp.", - "example": "scoretimestamp", + "example": "timestamp", "name": "sort", "required": false, "type": "string" }, "sort_dir": { "desc": "Change sort direction to ascending (asc) or descending (desc).", - "example": "descasc", + "example": "asc", "name": "sort_dir", "required": false, "type": "string" diff --git a/lib/slack/web/docs/stars.list.json b/lib/slack/web/docs/stars.list.json index 9e6ccf2..ac8707c 100644 --- a/lib/slack/web/docs/stars.list.json +++ b/lib/slack/web/docs/stars.list.json @@ -2,7 +2,7 @@ "args": { "count": { "desc": "Number of items to return per page.", - "example": "10020", + "example": "20", "name": "count", "required": false, "type": "integer" @@ -16,14 +16,14 @@ }, "limit": { "desc": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached.", - "example": "020", + "example": "20", "name": "limit", "required": false, "type": "integer" }, "page": { "desc": "Page number of results to return.", - "example": "12", + "example": "2", "name": "page", "required": false, "type": "integer" diff --git a/lib/slack/web/docs/team.accessLogs.json b/lib/slack/web/docs/team.accessLogs.json index 70d30aa..2690c33 100644 --- a/lib/slack/web/docs/team.accessLogs.json +++ b/lib/slack/web/docs/team.accessLogs.json @@ -2,21 +2,21 @@ "args": { "before": { "desc": "End of time range of logs to include in results (inclusive).", - "example": "now1457989166", + "example": "1457989166", "name": "before", "required": false, "type": "string" }, "count": { "desc": "Number of items to return per page.", - "example": "10020", + "example": "20", "name": "count", "required": false, "type": "string" }, "page": { "desc": "Page number of results to return.", - "example": "12", + "example": "2", "name": "page", "required": false, "type": "string" diff --git a/lib/slack/web/docs/team.integrationLogs.json b/lib/slack/web/docs/team.integrationLogs.json index 9bc1d07..6c39834 100644 --- a/lib/slack/web/docs/team.integrationLogs.json +++ b/lib/slack/web/docs/team.integrationLogs.json @@ -16,14 +16,14 @@ }, "count": { "desc": "Number of items to return per page.", - "example": "10020", + "example": "20", "name": "count", "required": false, "type": "string" }, "page": { "desc": "Page number of results to return.", - "example": "12", + "example": "2", "name": "page", "required": false, "type": "string" diff --git a/lib/slack/web/docs/users.conversations.json b/lib/slack/web/docs/users.conversations.json index 90d2db1..194980e 100644 --- a/lib/slack/web/docs/users.conversations.json +++ b/lib/slack/web/docs/users.conversations.json @@ -9,14 +9,14 @@ }, "exclude_archived": { "desc": "Set to true to exclude archived channels from the list", - "example": "falsetrue", + "example": "true", "name": "exclude_archived", "required": false, "type": "boolean" }, "limit": { "desc": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. Must be an integer no larger than 1000.", - "example": "10020", + "example": "20", "name": "limit", "required": false, "type": "number" @@ -37,7 +37,7 @@ }, "types": { "desc": "Mix and match channel types by providing a comma-separated list of any combination of public_channel, private_channel, mpim, im", - "example": "public_channelim,mpim", + "example": "im,mpim", "name": "types", "required": false, "type": "string" diff --git a/lib/slack/web/docs/users.list.json b/lib/slack/web/docs/users.list.json index f4b0054..9bc636d 100644 --- a/lib/slack/web/docs/users.list.json +++ b/lib/slack/web/docs/users.list.json @@ -16,7 +16,7 @@ }, "limit": { "desc": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached. Providing no limit value will result in Slack attempting to deliver you the entire result set. If the collection is too large you may experience limit_required or HTTP 500 errors.", - "example": "020", + "example": "20", "name": "limit", "required": false, "type": "number" diff --git a/lib/slack/web/docs/users.profile.get.json b/lib/slack/web/docs/users.profile.get.json index 50d1b15..1ad3f08 100644 --- a/lib/slack/web/docs/users.profile.get.json +++ b/lib/slack/web/docs/users.profile.get.json @@ -2,7 +2,7 @@ "args": { "include_labels": { "desc": "Include labels for each ID in custom profile fields. Using this parameter will heavily rate-limit your requests and is not recommended.", - "example": "falsetrue", + "example": "true", "name": "include_labels", "required": false, "type": "boolean" diff --git a/lib/slack/web/docs/views.update.json b/lib/slack/web/docs/views.update.json index fee2b5a..f2f2104 100644 --- a/lib/slack/web/docs/views.update.json +++ b/lib/slack/web/docs/views.update.json @@ -1,5 +1,12 @@ { "args": { + "external_id": { + "desc": "Required unless `view_id` is passed. A unique identifier of the view set by the developer. Must be unique for all views on a team. Max length of 255 characters. Either view_id or external_id is required.", + "example": "bmarley_view2", + "name": "external_id", + "required": false, + "type": "string" + }, "hash": { "desc": "A string that represents view state to protect against possible race conditions.", "example": "156772938.1827394", @@ -20,6 +27,13 @@ "name": "view", "required": true, "type": "view as string" + }, + "view_id": { + "desc": "Required unless `external_id` is passed. A unique identifier of the view to be updated. Either view_id or external_id is required.", + "example": "VMM512F2U", + "name": "view_id", + "required": false, + "type": "string" } }, "content_types": [ diff --git a/mix.exs b/mix.exs index 7de2910..9dd998b 100644 --- a/mix.exs +++ b/mix.exs @@ -35,7 +35,7 @@ defmodule Slack.Mixfile do {:credo, "~> 0.5", only: [:dev, :test]}, {:plug, "~> 1.6", only: :test}, {:cowboy, "~> 1.0.0", only: :test}, - {:slack_api_docs, "~> 0.1.1", only: [:dev], runtime: false} + {:slack_api_docs, "~> 0.1.2", only: [:dev], runtime: false} ] end diff --git a/mix.lock b/mix.lock index 5d941cc..27521df 100644 --- a/mix.lock +++ b/mix.lock @@ -24,7 +24,7 @@ "plug": {:hex, :plug, "1.6.2", "e06a7bd2bb6de5145da0dd950070110dce88045351224bd98e84edfdaaf5ffee", [:mix], [{:cowboy, "~> 1.0.1 or ~> 1.1 or ~> 2.4", [hex: :cowboy, repo: "hexpm", optional: true]}, {:mime, "~> 1.0", [hex: :mime, repo: "hexpm", optional: false]}], "hexpm", "b2713c085797012661a6c10e1898a009f0cc2bae556cc00341b69600074c757b"}, "poison": {:hex, :poison, "4.0.1", "bcb755a16fac91cad79bfe9fc3585bb07b9331e50cfe3420a24bcc2d735709ae", [:mix], [], "hexpm", "ba8836feea4b394bb718a161fc59a288fe0109b5006d6bdf97b6badfcf6f0f25"}, "ranch": {:hex, :ranch, "1.6.0", "92ac674645ec5dd23c6f0aeb9fff0aae1dd4e94a0af8407ff4d14f750a4cd7cf", [:rebar3], [], "hexpm", "eb6170a697659046f517ceef15e568993d314591f05e73611e05605d4ac937f7"}, - "slack_api_docs": {:hex, :slack_api_docs, "0.1.1", "1c787bfad3dc150a95958e5b9c0c25a8376de9674af18d148a7c0d1fe0e26187", [:mix], [{:floki, "~> 0.33.0", [hex: :floki, repo: "hexpm", optional: false]}, {:httpoison, "~> 1.8", [hex: :httpoison, repo: "hexpm", optional: false]}, {:jason, "~> 1.3", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "df1349fc26f3aaae1a7e4d2b963754f082371d430e2dbfd56059faf0e6be54b3"}, + "slack_api_docs": {:hex, :slack_api_docs, "0.1.2", "880f7a068fbe6450b6858ef2a378ab8fbcdf78e7fa04f01743648fe1bb6cd500", [:mix], [{:floki, "~> 0.33.0", [hex: :floki, repo: "hexpm", optional: false]}, {:httpoison, "~> 1.8", [hex: :httpoison, repo: "hexpm", optional: false]}, {:jason, "~> 1.3", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "eac1d7c13505f638f5e4da249a248f1767f035f1470033c60ce685e7958be906"}, "ssl_verify_fun": {:hex, :ssl_verify_fun, "1.1.6", "cf344f5692c82d2cd7554f5ec8fd961548d4fd09e7d22f5b62482e5aeaebd4b0", [:make, :mix, :rebar3], [], "hexpm", "bdb0d2471f453c88ff3908e7686f86f9be327d065cc1ec16fa4540197ea04680"}, "unicode_util_compat": {:hex, :unicode_util_compat, "0.7.0", "bc84380c9ab48177092f43ac89e4dfa2c6d62b40b8bd132b1059ecc7232f9a78", [:rebar3], [], "hexpm", "25eee6d67df61960cf6a794239566599b09e17e668d3700247bc498638152521"}, "websocket_client": {:hex, :websocket_client, "1.2.4", "14ec1ca4b6d247b44ccd9a80af8f6ca98328070f6c1d52a5cb00bc9d939d63b8", [:rebar3], [], "hexpm", "295a79cce15c208e03a545073f1318e97e7780aa9f2415e825cb9e338aecc305"}, From 268bede0cb9594323c9e9f00822ce673ccd86791 Mon Sep 17 00:00:00 2001 From: Inooid Date: Tue, 9 Aug 2022 19:22:32 +0200 Subject: [PATCH 5/8] Fix condition --- lib/slack/web/documentation.ex | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/slack/web/documentation.ex b/lib/slack/web/documentation.ex index 1e6df61..60883c9 100644 --- a/lib/slack/web/documentation.ex +++ b/lib/slack/web/documentation.ex @@ -98,7 +98,7 @@ defmodule Slack.Web.Documentation do cond do # Almost all methods in the Documentation require the "token" argument # and we always sent the token argument anyways. - name == "token" && -> + name == "token" -> false ^required -> From 237492f07ae5c713cd962c1015cad78247cc788a Mon Sep 17 00:00:00 2001 From: Inooid Date: Tue, 9 Aug 2022 19:35:34 +0200 Subject: [PATCH 6/8] Add test case for filtering out `:token` argument --- lib/slack/web/documentation.ex | 4 ++-- test/slack/web/documentation_test.exs | 12 ++++++++++++ 2 files changed, 14 insertions(+), 2 deletions(-) diff --git a/lib/slack/web/documentation.ex b/lib/slack/web/documentation.ex index 60883c9..673f686 100644 --- a/lib/slack/web/documentation.ex +++ b/lib/slack/web/documentation.ex @@ -101,10 +101,10 @@ defmodule Slack.Web.Documentation do name == "token" -> false - ^required -> + required == true -> meta["required"] - _ -> + true -> !meta["required"] end end) diff --git a/test/slack/web/documentation_test.exs b/test/slack/web/documentation_test.exs index 2d57093..e509b75 100644 --- a/test/slack/web/documentation_test.exs +++ b/test/slack/web/documentation_test.exs @@ -34,6 +34,18 @@ defmodule Slack.Web.DocumentationTest do assert {:info, 1} in module_functions end + test "filters out required `:token` argument" do + file_content = + "#{__DIR__}/../../../lib/slack/web/docs/chat.postMessage.json" + |> File.read!() + |> Jason.decode!() + + doc = Documentation.new(file_content, "chat.postMessage.json") + + refute :token in doc.required_params, + "required params contains `:token`, but this should be ignored" + end + test "accepts versioned endpoints" do file_content = "#{__DIR__}/../../../lib/slack/web/docs/oauth.v2.access.json" From e2a8a61fcce0764f72de775b0cf38e62967a8e9b Mon Sep 17 00:00:00 2001 From: Inooid Date: Tue, 9 Aug 2022 19:35:46 +0200 Subject: [PATCH 7/8] Update failing test due to json changes --- test/slack/web/documentation_test.exs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/test/slack/web/documentation_test.exs b/test/slack/web/documentation_test.exs index e509b75..0ec314b 100644 --- a/test/slack/web/documentation_test.exs +++ b/test/slack/web/documentation_test.exs @@ -60,8 +60,8 @@ defmodule Slack.Web.DocumentationTest do module_functions = Slack.Web.Oauth.V2.__info__(:functions) - assert {:access, 3} in module_functions - assert {:access, 4} in module_functions + assert {:access, 0} in module_functions + assert {:access, 1} in module_functions end end end From 8005acaf43b84207e41a6ca92496c69badf77882 Mon Sep 17 00:00:00 2001 From: Inooid Date: Tue, 9 Aug 2022 19:47:11 +0200 Subject: [PATCH 8/8] Add test for required_arguments --- test/slack/web/documentation_test.exs | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/test/slack/web/documentation_test.exs b/test/slack/web/documentation_test.exs index 0ec314b..c2927d6 100644 --- a/test/slack/web/documentation_test.exs +++ b/test/slack/web/documentation_test.exs @@ -34,6 +34,29 @@ defmodule Slack.Web.DocumentationTest do assert {:info, 1} in module_functions end + test "generates function params based on required arguments from json" do + file_content = + "#{__DIR__}/../../../lib/slack/web/docs/conversations.replies.json" + |> File.read!() + |> Jason.decode!() + + doc = Documentation.new(file_content, "conversations.replies.json") + + assert doc.module == "conversations" + assert doc.endpoint == "conversations.replies" + assert doc.function == :replies + + module_functions = Slack.Web.Conversations.__info__(:functions) + + required_args_count = Enum.count(doc.required_params) + + # Without optional arguments + assert {:replies, required_args_count} in module_functions + + # With optional arguments + assert {:replies, required_args_count + 1} in module_functions + end + test "filters out required `:token` argument" do file_content = "#{__DIR__}/../../../lib/slack/web/docs/chat.postMessage.json"