slack-api-sdk-apimatic 1.1.1__py3-none-any.whl

slackwebapi/controllers/users_profile_controller.py

@@ -0,0 +1,165 @@
+"""slackwebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: D410, E501, E101, D206
+from apimatic_core.authentication.multiple.single_auth import (
+    Single,
+)
+from apimatic_core.request_builder import RequestBuilder
+from apimatic_core.response_handler import ResponseHandler
+from apimatic_core.types.parameter import Parameter
+
+from slackwebapi.api_helper import APIHelper
+from slackwebapi.configuration import Server
+from slackwebapi.controllers.base_controller import (
+    BaseController,
+)
+from slackwebapi.exceptions.users_profile_get_error_schema_exception import (
+    UsersProfileGetErrorSchemaException,
+)
+from slackwebapi.exceptions.users_profile_set_error_schema_exception import (
+    UsersProfileSetErrorSchemaException,
+)
+from slackwebapi.http.http_method_enum import (
+    HttpMethodEnum,
+)
+from slackwebapi.models.users_profile_get_schema import (
+    UsersProfileGetSchema,
+)
+from slackwebapi.models.users_profile_set_schema import (
+    UsersProfileSetSchema,
+)
+
+
+class UsersProfileController(BaseController):
+    """A Controller to access Endpoints in the slackwebapi API."""
+
+    def __init__(self, config):
+        """Initialize UsersProfileController object."""
+        super(UsersProfileController, self).__init__(config)
+
+    def users_profile_get(self,
+                          token,
+                          include_labels=None,
+                          user=None):
+        """Perform a GET request to /users.profile.get.
+
+        Retrieves a user's profile information.
+
+        Args:
+            token (str): Authentication token. Requires scope: `users.profile:read`
+            include_labels (bool, optional): Include labels for each ID in custom
+                profile fields
+            user (str, optional): User to retrieve profile info for
+
+        Returns:
+            ApiResponse: An object with the response value as well as other useful
+                information such as status codes and headers. Typical success response
+
+        Raises:
+            ApiException: When an error occurs while fetching the data from the
+                remote API. This exception includes the HTTP Response code, an error
+                message, and the HTTP body that was received in the request.
+
+        """
+        return super().new_api_call_builder.request(
+            RequestBuilder().server(Server.DEFAULT)
+            .path("/users.profile.get")
+            .http_method(HttpMethodEnum.GET)
+            .query_param(Parameter()
+                .key("token")
+                .value(token)
+                .is_required(True))
+            .header_param(Parameter()
+                .key("Content-Type")
+                .value("application/x-www-form-urlencoded"))
+            .query_param(Parameter()
+                .key("include_labels")
+                .value(include_labels))
+            .query_param(Parameter()
+                .key("user")
+                .value(user))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .auth(Single("slackAuth")),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(UsersProfileGetSchema.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Typical error response",
+                UsersProfileGetErrorSchemaException),
+        ).execute()
+
+    def users_profile_set(self,
+                          token,
+                          name=None,
+                          profile=None,
+                          user=None,
+                          value=None):
+        """Perform a POST request to /users.profile.set.
+
+        Set the profile information for a user.
+
+        Args:
+            token (str): Authentication token. Requires scope: `users.profile:write`
+            name (str, optional): Name of a single key to set. Usable only if
+                `profile` is not passed.
+            profile (str, optional): 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.
+            user (str, optional): ID of user to change. This argument may only be
+                specified by team admins on paid teams.
+            value (str, optional): Value to set a single key to. Usable only if
+                `profile` is not passed.
+
+        Returns:
+            ApiResponse: An object with the response value as well as other useful
+                information such as status codes and headers. Typical success response
+
+        Raises:
+            ApiException: When an error occurs while fetching the data from the
+                remote API. This exception includes the HTTP Response code, an error
+                message, and the HTTP body that was received in the request.
+
+        """
+        return super().new_api_call_builder.request(
+            RequestBuilder().server(Server.DEFAULT)
+            .path("/users.profile.set")
+            .http_method(HttpMethodEnum.POST)
+            .header_param(Parameter()
+                .key("token")
+                .value(token)
+                .is_required(True))
+            .form_param(Parameter()
+                .key("name")
+                .value(name))
+            .form_param(Parameter()
+                .key("profile")
+                .value(profile))
+            .form_param(Parameter()
+                .key("user")
+                .value(user))
+            .form_param(Parameter()
+                .key("value")
+                .value(value))
+            .header_param(Parameter()
+                            .key("content-type")
+                            .value("application/x-www-form-urlencoded"))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .auth(Single("slackAuth")),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(UsersProfileSetSchema.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Typical error response",
+                UsersProfileSetErrorSchemaException),
+        ).execute()

slackwebapi/controllers/views_controller.py

@@ -0,0 +1,287 @@
+"""slackwebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: D410, E501, E101, D206
+from apimatic_core.authentication.multiple.single_auth import (
+    Single,
+)
+from apimatic_core.request_builder import RequestBuilder
+from apimatic_core.response_handler import ResponseHandler
+from apimatic_core.types.parameter import Parameter
+
+from slackwebapi.api_helper import APIHelper
+from slackwebapi.configuration import Server
+from slackwebapi.controllers.base_controller import (
+    BaseController,
+)
+from slackwebapi.exceptions.default_error_template_exception import (
+    DefaultErrorTemplateException,
+)
+from slackwebapi.http.http_method_enum import (
+    HttpMethodEnum,
+)
+from slackwebapi.models.default_success_template import (
+    DefaultSuccessTemplate,
+)
+
+
+class ViewsController(BaseController):
+    """A Controller to access Endpoints in the slackwebapi API."""
+
+    def __init__(self, config):
+        """Initialize ViewsController object."""
+        super(ViewsController, self).__init__(config)
+
+    def views_open(self,
+                   token,
+                   trigger_id,
+                   view):
+        """Perform a GET request to /views.open.
+
+        Open a view for a user.
+
+        Args:
+            token (str): Authentication token. Requires scope: `none`
+            trigger_id (str): Exchange a trigger to post to the user.
+            view (str): A [view payload](/reference/surfaces/views). This must be a
+                JSON-encoded string.
+
+        Returns:
+            ApiResponse: An object with the response value as well as other useful
+                information such as status codes and headers. Typical success
+                response includes the opened view payload.
+
+        Raises:
+            ApiException: When an error occurs while fetching the data from the
+                remote API. This exception includes the HTTP Response code, an error
+                message, and the HTTP body that was received in the request.
+
+        """
+        return super().new_api_call_builder.request(
+            RequestBuilder().server(Server.DEFAULT)
+            .path("/views.open")
+            .http_method(HttpMethodEnum.GET)
+            .header_param(Parameter()
+                .key("token")
+                .value(token)
+                .is_required(True))
+            .query_param(Parameter()
+                .key("trigger_id")
+                .value(trigger_id)
+                .is_required(True))
+            .query_param(Parameter()
+                .key("view")
+                .value(view)
+                .is_required(True))
+            .header_param(Parameter()
+                .key("Content-Type")
+                .value("application/x-www-form-urlencoded"))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .auth(Single("slackAuth")),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(DefaultSuccessTemplate.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Typical error response, before getting to any possible validation er"
+                "rors.",
+                DefaultErrorTemplateException),
+        ).execute()
+
+    def views_publish(self,
+                      token,
+                      user_id,
+                      view,
+                      hash=None):
+        """Perform a GET request to /views.publish.
+
+        Publish a static view for a User.
+
+        Args:
+            token (str): Authentication token. Requires scope: `none`
+            user_id (str): `id` of the user you want publish a view to.
+            view (str): A [view payload](/reference/surfaces/views). This must be a
+                JSON-encoded string.
+            hash (str, optional): A string that represents view state to protect
+                against possible race conditions.
+
+        Returns:
+            ApiResponse: An object with the response value as well as other useful
+                information such as status codes and headers. Typical success
+                response includes the published view payload.
+
+        Raises:
+            ApiException: When an error occurs while fetching the data from the
+                remote API. This exception includes the HTTP Response code, an error
+                message, and the HTTP body that was received in the request.
+
+        """
+        return super().new_api_call_builder.request(
+            RequestBuilder().server(Server.DEFAULT)
+            .path("/views.publish")
+            .http_method(HttpMethodEnum.GET)
+            .header_param(Parameter()
+                .key("token")
+                .value(token)
+                .is_required(True))
+            .query_param(Parameter()
+                .key("user_id")
+                .value(user_id)
+                .is_required(True))
+            .query_param(Parameter()
+                .key("view")
+                .value(view)
+                .is_required(True))
+            .header_param(Parameter()
+                .key("Content-Type")
+                .value("application/x-www-form-urlencoded"))
+            .query_param(Parameter()
+                .key("hash")
+                .value(hash))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .auth(Single("slackAuth")),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(DefaultSuccessTemplate.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Typical error response, before getting to any possible validation er"
+                "rors.",
+                DefaultErrorTemplateException),
+        ).execute()
+
+    def views_push(self,
+                   token,
+                   trigger_id,
+                   view):
+        """Perform a GET request to /views.push.
+
+        Push a view onto the stack of a root view.
+
+        Args:
+            token (str): Authentication token. Requires scope: `none`
+            trigger_id (str): Exchange a trigger to post to the user.
+            view (str): A [view payload](/reference/surfaces/views). This must be a
+                JSON-encoded string.
+
+        Returns:
+            ApiResponse: An object with the response value as well as other useful
+                information such as status codes and headers. Typical success
+                response includes the pushed view payload.
+
+        Raises:
+            ApiException: When an error occurs while fetching the data from the
+                remote API. This exception includes the HTTP Response code, an error
+                message, and the HTTP body that was received in the request.
+
+        """
+        return super().new_api_call_builder.request(
+            RequestBuilder().server(Server.DEFAULT)
+            .path("/views.push")
+            .http_method(HttpMethodEnum.GET)
+            .header_param(Parameter()
+                .key("token")
+                .value(token)
+                .is_required(True))
+            .query_param(Parameter()
+                .key("trigger_id")
+                .value(trigger_id)
+                .is_required(True))
+            .query_param(Parameter()
+                .key("view")
+                .value(view)
+                .is_required(True))
+            .header_param(Parameter()
+                .key("Content-Type")
+                .value("application/x-www-form-urlencoded"))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .auth(Single("slackAuth")),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(DefaultSuccessTemplate.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Typical error response.",
+                DefaultErrorTemplateException),
+        ).execute()
+
+    def views_update(self,
+                     token,
+                     view_id=None,
+                     external_id=None,
+                     view=None,
+                     hash=None):
+        """Perform a GET request to /views.update.
+
+        Update an existing view.
+
+        Args:
+            token (str): Authentication token. Requires scope: `none`
+            view_id (str, optional): A unique identifier of the view to be updated.
+                Either `view_id` or `external_id` is required.
+            external_id (str, optional): 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.
+            view (str, optional): A [view object](/reference/surfaces/views). This
+                must be a JSON-encoded string.
+            hash (str, optional): A string that represents view state to protect
+                against possible race conditions.
+
+        Returns:
+            ApiResponse: An object with the response value as well as other useful
+                information such as status codes and headers. Typical success
+                response includes the updated view payload.
+
+        Raises:
+            ApiException: When an error occurs while fetching the data from the
+                remote API. This exception includes the HTTP Response code, an error
+                message, and the HTTP body that was received in the request.
+
+        """
+        return super().new_api_call_builder.request(
+            RequestBuilder().server(Server.DEFAULT)
+            .path("/views.update")
+            .http_method(HttpMethodEnum.GET)
+            .header_param(Parameter()
+                .key("token")
+                .value(token)
+                .is_required(True))
+            .header_param(Parameter()
+                .key("Content-Type")
+                .value("application/x-www-form-urlencoded"))
+            .query_param(Parameter()
+                .key("view_id")
+                .value(view_id))
+            .query_param(Parameter()
+                .key("external_id")
+                .value(external_id))
+            .query_param(Parameter()
+                .key("view")
+                .value(view))
+            .query_param(Parameter()
+                .key("hash")
+                .value(hash))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .auth(Single("slackAuth")),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(DefaultSuccessTemplate.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Typical error response.",
+                DefaultErrorTemplateException),
+        ).execute()

slackwebapi/controllers/workflows_controller.py

@@ -0,0 +1,237 @@
+"""slackwebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: D410, E501, E101, D206
+from apimatic_core.authentication.multiple.single_auth import (
+    Single,
+)
+from apimatic_core.request_builder import RequestBuilder
+from apimatic_core.response_handler import ResponseHandler
+from apimatic_core.types.parameter import Parameter
+
+from slackwebapi.api_helper import APIHelper
+from slackwebapi.configuration import Server
+from slackwebapi.controllers.base_controller import (
+    BaseController,
+)
+from slackwebapi.exceptions.default_error_template_exception import (
+    DefaultErrorTemplateException,
+)
+from slackwebapi.http.http_method_enum import (
+    HttpMethodEnum,
+)
+from slackwebapi.models.default_success_template import (
+    DefaultSuccessTemplate,
+)
+
+
+class WorkflowsController(BaseController):
+    """A Controller to access Endpoints in the slackwebapi API."""
+
+    def __init__(self, config):
+        """Initialize WorkflowsController object."""
+        super(WorkflowsController, self).__init__(config)
+
+    def workflows_step_completed(self,
+                                 token,
+                                 workflow_step_execute_id,
+                                 outputs=None):
+        """Perform a GET request to /workflows.stepCompleted.
+
+        Indicate that an app's step in a workflow completed execution.
+
+        Args:
+            token (str): Authentication token. Requires scope:
+                `workflow.steps:execute`
+            workflow_step_execute_id (str): Context identifier that maps to the
+                correct workflow step execution.
+            outputs (str, optional): Key-value object of outputs from your step. Keys
+                of this object reflect the configured `key` properties of your
+                [`outputs`](/reference/workflows/workflow_step#output) array from
+                your `workflow_step` object.
+
+        Returns:
+            ApiResponse: An object with the response value as well as other useful
+                information such as status codes and headers. Typical success response
+
+        Raises:
+            ApiException: When an error occurs while fetching the data from the
+                remote API. This exception includes the HTTP Response code, an error
+                message, and the HTTP body that was received in the request.
+
+        """
+        return super().new_api_call_builder.request(
+            RequestBuilder().server(Server.DEFAULT)
+            .path("/workflows.stepCompleted")
+            .http_method(HttpMethodEnum.GET)
+            .header_param(Parameter()
+                .key("token")
+                .value(token)
+                .is_required(True))
+            .query_param(Parameter()
+                .key("workflow_step_execute_id")
+                .value(workflow_step_execute_id)
+                .is_required(True))
+            .header_param(Parameter()
+                .key("Content-Type")
+                .value("application/x-www-form-urlencoded"))
+            .query_param(Parameter()
+                .key("outputs")
+                .value(outputs))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .auth(Single("slackAuth")),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(DefaultSuccessTemplate.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Typical error response",
+                DefaultErrorTemplateException),
+        ).execute()
+
+    def workflows_step_failed(self,
+                              token,
+                              workflow_step_execute_id,
+                              error):
+        """Perform a GET request to /workflows.stepFailed.
+
+        Indicate that an app's step in a workflow failed to execute.
+
+        Args:
+            token (str): Authentication token. Requires scope:
+                `workflow.steps:execute`
+            workflow_step_execute_id (str): Context identifier that maps to the
+                correct workflow step execution.
+            error (str): A JSON-based object with a `message` property that should
+                contain a human readable error message.
+
+        Returns:
+            ApiResponse: An object with the response value as well as other useful
+                information such as status codes and headers. Typical success response
+
+        Raises:
+            ApiException: When an error occurs while fetching the data from the
+                remote API. This exception includes the HTTP Response code, an error
+                message, and the HTTP body that was received in the request.
+
+        """
+        return super().new_api_call_builder.request(
+            RequestBuilder().server(Server.DEFAULT)
+            .path("/workflows.stepFailed")
+            .http_method(HttpMethodEnum.GET)
+            .header_param(Parameter()
+                .key("token")
+                .value(token)
+                .is_required(True))
+            .query_param(Parameter()
+                .key("workflow_step_execute_id")
+                .value(workflow_step_execute_id)
+                .is_required(True))
+            .query_param(Parameter()
+                .key("error")
+                .value(error)
+                .is_required(True))
+            .header_param(Parameter()
+                .key("Content-Type")
+                .value("application/x-www-form-urlencoded"))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .auth(Single("slackAuth")),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(DefaultSuccessTemplate.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Typical error response",
+                DefaultErrorTemplateException),
+        ).execute()
+
+    def workflows_update_step(self,
+                              token,
+                              workflow_step_edit_id,
+                              inputs=None,
+                              outputs=None,
+                              step_name=None,
+                              step_image_url=None):
+        """Perform a GET request to /workflows.updateStep.
+
+        Update the configuration for a workflow extension step.
+
+        Args:
+            token (str): Authentication token. Requires scope:
+                `workflow.steps:execute`
+            workflow_step_edit_id (str): A context identifier provided with
+                `view_submission` payloads used to call back to
+                `workflows.updateStep`.
+            inputs (str, optional): 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](/workflows/steps#variables).
+            outputs (str, optional): 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.
+            step_name (str, optional): An optional field that can be used to override
+                the step name that is shown in the Workflow Builder.
+            step_image_url (str, optional): An optional field that can be used to
+                override app image that is shown in the Workflow Builder.
+
+        Returns:
+            ApiResponse: An object with the response value as well as other useful
+                information such as status codes and headers. Typical success response
+
+        Raises:
+            ApiException: When an error occurs while fetching the data from the
+                remote API. This exception includes the HTTP Response code, an error
+                message, and the HTTP body that was received in the request.
+
+        """
+        return super().new_api_call_builder.request(
+            RequestBuilder().server(Server.DEFAULT)
+            .path("/workflows.updateStep")
+            .http_method(HttpMethodEnum.GET)
+            .header_param(Parameter()
+                .key("token")
+                .value(token)
+                .is_required(True))
+            .query_param(Parameter()
+                .key("workflow_step_edit_id")
+                .value(workflow_step_edit_id)
+                .is_required(True))
+            .header_param(Parameter()
+                .key("Content-Type")
+                .value("application/x-www-form-urlencoded"))
+            .query_param(Parameter()
+                .key("inputs")
+                .value(inputs))
+            .query_param(Parameter()
+                .key("outputs")
+                .value(outputs))
+            .query_param(Parameter()
+                .key("step_name")
+                .value(step_name))
+            .query_param(Parameter()
+                .key("step_image_url")
+                .value(step_image_url))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .auth(Single("slackAuth")),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(DefaultSuccessTemplate.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Typical error response",
+                DefaultErrorTemplateException),
+        ).execute()