From af3a0a38203eefa8a3c6ee2dfbbff21d66df212b Mon Sep 17 00:00:00 2001 From: Slack API Ref Buildbot Date: Mon, 15 Jan 2024 22:29:38 +0000 Subject: [PATCH] Updated from Slack docs, 2024/01/15 --- groups/functions.json | 3 + .../functions/functions.completeError.json | 60 ++++++++++++++++++ .../functions/functions.completeSuccess.json | 63 +++++++++++++++++++ 3 files changed, 126 insertions(+) create mode 100644 groups/functions.json create mode 100644 methods/functions/functions.completeError.json create mode 100644 methods/functions/functions.completeSuccess.json diff --git a/groups/functions.json b/groups/functions.json new file mode 100644 index 00000000..968847a7 --- /dev/null +++ b/groups/functions.json @@ -0,0 +1,3 @@ +{ + "name": "functions" +} \ No newline at end of file diff --git a/methods/functions/functions.completeError.json b/methods/functions/functions.completeError.json new file mode 100644 index 00000000..16d1701e --- /dev/null +++ b/methods/functions/functions.completeError.json @@ -0,0 +1,60 @@ +{ + "group": "functions", + "name": "functions.completeError", + "deprecated": false, + "desc": "Signal that a function failed to complete", + "args": { + "error": { + "required": true, + "desc": "A human-readable error message that contains information about why the function failed to complete.", + "type": "string" + }, + "function_execution_id": { + "required": true, + "example": "Fx12345ABCDE", + "desc": "Context identifier that maps to the executed function.", + "type": "string" + } + }, + "response": { + "examples": [ + "{\n \"ok\": true\n}", + "{\n \"ok\": false,\n \"error\": \"function_execution_not_found\"\n}" + ] + }, + "errors": { + "unknown_method": "This method does not exist.", + "function_execution_not_found": "The specified function execution cannot be found.", + "access_denied": "Access to a resource specified in the request is denied.", + "execution_not_in_running_state": "The function execution is no longer in a state to be completed.", + "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.", + "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.", + "method_deprecated": "The method has been deprecated.", + "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.", + "not_authed": "No authentication token 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.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration 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.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "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 is 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-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.", + "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." + } +} \ No newline at end of file diff --git a/methods/functions/functions.completeSuccess.json b/methods/functions/functions.completeSuccess.json new file mode 100644 index 00000000..3da56ba2 --- /dev/null +++ b/methods/functions/functions.completeSuccess.json @@ -0,0 +1,63 @@ +{ + "group": "functions", + "name": "functions.completeSuccess", + "deprecated": false, + "desc": "Signal the successful completion of a function", + "args": { + "function_execution_id": { + "required": true, + "example": "Fx12345ABCDE", + "desc": "Context identifier that maps to the executed function.", + "type": "string" + }, + "outputs": { + "required": true, + "example": "{\"customer_id\": \"U0BPQUNTA\"}", + "desc": "A JSON-based object that conforms to the output parameters schema for the custom function defined in the manifest.", + "type": "object", + "format": "json" + } + }, + "response": { + "examples": [ + "{\n \"ok\": true\n}", + "{\n \"ok\": false,\n \"error\": \"function_execution_not_found\"\n}" + ] + }, + "errors": { + "unknown_method": "This method does not exist.", + "function_execution_not_found": "The specified function execution cannot be found.", + "access_denied": "Access to a resource specified in the request is denied.", + "execution_not_in_running_state": "The function execution is no longer in a state to be completed.", + "parameter_validation_failed": "There were problems when validating the outputs against the Function parameters. See API response for more details.", + "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.", + "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.", + "method_deprecated": "The method has been deprecated.", + "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.", + "not_authed": "No authentication token 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.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration 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.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "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 is 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-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.", + "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." + } +} \ No newline at end of file