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

slackwebapi/configuration.py

@@ -0,0 +1,252 @@
+"""slackwebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+import os
+from enum import Enum
+
+from apimatic_core.http.configurations.http_client_configuration import (
+    HttpClientConfiguration,
+)
+from apimatic_requests_client_adapter.requests_client import (
+    RequestsClient,
+)
+from dotenv import load_dotenv
+
+from slackwebapi.http.proxy_settings import (
+    ProxySettings,
+)
+from slackwebapi.logging.configuration.api_logging_configuration import (
+    LoggingConfiguration,
+)
+
+
+class Environment(Enum):
+    """An enum for SDK environments."""
+
+    PRODUCTION = 0
+
+    @classmethod
+    def from_value(cls, value, default=None):
+        """Convert a value (string or int) to an Environment enum member.
+
+        Args:
+            value (Union[str, int]): The value to convert.
+            default (Environment): The fallback enum member if conversion fails.
+
+        Returns:
+            Environment: Matching enum member or fallback if invalid.
+
+        """
+        if value is None:
+            return default
+
+        # Try to match directly by enum member
+        if isinstance(value, cls):
+            return value
+
+        # Handle integer or string conversion
+        for member in cls:
+            if (str(member.value).lower() == str(value).lower()
+                or member.name.lower() == str(value).lower()):
+                return member
+
+        # Fallback to provided default
+        return default
+
+
+class Server(Enum):
+    """An enum for API servers."""
+
+    DEFAULT = 0
+    AUTH_SERVER = 1
+
+    @classmethod
+    def from_value(cls, value, default=None):
+        """Convert a value (string or int) to a Server enum member.
+
+        Args:
+            value (Union[str, int]): The value to convert.
+            default (Server): The fallback enum member if conversion fails.
+
+        Returns:
+            Server: Matching enum member or fallback if invalid.
+
+        """
+        if value is None:
+            return default
+
+        # Try to match directly by enum member
+        if isinstance(value, cls):
+            return value
+
+        # Handle integer or string conversion
+        for member in cls:
+            if (str(member.value).lower() == str(value).lower()
+                or member.name.lower() == str(value).lower()):
+                return member
+
+        # Fallback to provided default
+        return default
+
+
+class Configuration(HttpClientConfiguration):
+    """A class used for configuring the SDK by a user."""
+
+    @property
+    def environment(self):
+        """Return current environment."""
+        return self._environment
+
+    @property
+    def authorization_code_auth_credentials(self):
+        """Return AuthorizationCodeAuthCredentials."""
+        return self._authorization_code_auth_credentials
+
+    def __init__(self, http_client_instance=None,
+                 override_http_client_configuration=False, http_call_back=None,
+                 timeout=30, max_retries=0, backoff_factor=2, retry_statuses=None,
+                 retry_methods=None, proxy_settings=None, logging_configuration=None,
+                 environment=Environment.PRODUCTION,
+                 authorization_code_auth_credentials=None):
+        """Initialize Configuration object."""
+        if retry_methods is None:
+            retry_methods = ["GET", "PUT"]
+
+        if retry_statuses is None:
+            retry_statuses = [408, 413, 429, 500, 502, 503, 504, 521,
+                522, 524]
+
+        super().__init__(
+            http_client_instance=http_client_instance,
+            override_http_client_configuration=override_http_client_configuration,
+            http_call_back=http_call_back, timeout=timeout,
+            max_retries=max_retries, backoff_factor=backoff_factor,
+            retry_statuses=retry_statuses, retry_methods=retry_methods,
+            proxy_settings=proxy_settings,
+            logging_configuration=logging_configuration,
+        )
+
+        # Current API environment
+        self._environment = environment
+
+        self._authorization_code_auth_credentials = authorization_code_auth_credentials
+
+        # The Http Client to use for making requests.
+        self.set_http_client(self.create_http_client())
+
+    def clone_with(self, http_client_instance=None,
+                   override_http_client_configuration=None, http_call_back=None,
+                   timeout=None, max_retries=None, backoff_factor=None,
+                   retry_statuses=None, retry_methods=None, proxy_settings=None,
+                   logging_configuration=None, environment=None,
+                   authorization_code_auth_credentials=None):
+        """Clone configuration with overrides."""
+        http_client_instance = http_client_instance or self.http_client_instance
+        override_http_client_configuration =\
+            (override_http_client_configuration
+            or self.override_http_client_configuration)
+        http_call_back = http_call_back or self.http_callback
+        timeout = timeout or self.timeout
+        max_retries = max_retries or self.max_retries
+        backoff_factor = backoff_factor or self.backoff_factor
+        retry_statuses = retry_statuses or self.retry_statuses
+        retry_methods = retry_methods or self.retry_methods
+        proxy_settings = proxy_settings or self.proxy_settings
+        logging_configuration = logging_configuration or self.logging_configuration
+        environment = environment or self.environment
+        authorization_code_auth_credentials =\
+            (authorization_code_auth_credentials
+            or self.authorization_code_auth_credentials)
+        return Configuration(
+            http_client_instance=http_client_instance,
+            override_http_client_configuration=override_http_client_configuration,
+            http_call_back=http_call_back, timeout=timeout, max_retries=max_retries,
+            backoff_factor=backoff_factor, retry_statuses=retry_statuses,
+            retry_methods=retry_methods, proxy_settings=proxy_settings,
+            logging_configuration=logging_configuration, environment=environment,
+            authorization_code_auth_credentials=authorization_code_auth_credentials,
+        )
+
+    def create_http_client(self):
+        """Create the HTTP client instance."""
+        return RequestsClient(
+            timeout=self.timeout, max_retries=self.max_retries,
+            backoff_factor=self.backoff_factor, retry_statuses=self.retry_statuses,
+            retry_methods=self.retry_methods,
+            http_client_instance=self.http_client_instance,
+            override_http_client_configuration=self.override_http_client_configuration,
+            response_factory=self.http_response_factory,
+            proxies=self.proxy_settings.to_proxies() if self.proxy_settings else None,
+        )
+
+    # All the environments the SDK can run in
+    environments = {
+        Environment.PRODUCTION: {
+            Server.DEFAULT: "https://slack.com/api",
+            Server.AUTH_SERVER: "https://slack.com/oauth",
+        },
+    }
+
+    def get_base_uri(self, server=Server.DEFAULT):
+        """Generate the appropriate base URI for the environment and the server.
+
+        Args:
+            server (Configuration.Server): The server enum for which the base
+            URI is required.
+
+        Returns:
+            String: The base URI.
+
+        """
+        return self.environments[self.environment][server]
+
+    @classmethod
+    def from_environment(cls, dotenv_path=None, **overrides):
+        """Create Configuration object from .env and environment variables.
+
+        Args:
+            dotenv_path (str, optional): Path to the .env file to load.
+             If None, the default .env file is used.
+            **overrides: Optional values overriding setting from environment variables.
+
+        Returns:
+            Configuration: A configuration object populated with the resolved values.
+
+        """
+        # load .env automatically
+        load_dotenv(dotenv_path or None, override=True)
+
+        override_http_client_configuration = os.getenv(
+            "OVERRIDE_HTTP_CLIENT_CONFIGURATION", "false").lower() == "true"
+        timeout = int(os.getenv("TIMEOUT", "30"))
+        max_retries = int(os.getenv("MAX_RETRIES", "0"))
+        backoff_factor = float(os.getenv("BACKOFF_FACTOR", "2"))
+        statuses = os.getenv("RETRY_STATUSES", None)
+        retry_statuses = [int(v.strip()) for v in statuses.split(",")
+                          if v.strip().isdigit()] if statuses else None
+        methods = os.getenv("RETRY_METHODS", None)
+        retry_methods = [v.strip() for v in methods.split(",") if v.strip()]\
+            if methods else None
+        environment = Environment.from_value(
+            os.getenv("ENVIRONMENT"), Environment.PRODUCTION)
+
+        from slackwebapi.http.auth.oauth_2 import AuthorizationCodeAuthCredentials
+
+        # Preparing default configuration
+        default_config = cls(
+            override_http_client_configuration=override_http_client_configuration,
+            timeout=timeout,
+            max_retries=max_retries,
+            backoff_factor=backoff_factor,
+            retry_statuses=retry_statuses,
+            retry_methods=retry_methods,
+            environment=environment,
+            proxy_settings=ProxySettings.from_environment(),
+            logging_configuration=LoggingConfiguration.from_environment(),
+            authorization_code_auth_credentials=AuthorizationCodeAuthCredentials.from_environment(),
+        )
+
+        return default_config.clone_with(**overrides)

slackwebapi/controllers/__init__.py

@@ -0,0 +1,61 @@
+# ruff: noqa: D104 | Missing docstring in public package
+# ruff: noqa: RUF022 | `__all__` is not sorted
+__all__ = [
+    "admin_apps_approved_controller",
+    "admin_apps_controller",
+    "admin_apps_requests_controller",
+    "admin_apps_restricted_controller",
+    "admin_conversations_controller",
+    "admin_conversations_ekm_controller",
+    "admin_conversations_restrict_access_controller",
+    "admin_emoji_controller",
+    "admin_invite_requests_approved_controller",
+    "admin_invite_requests_controller",
+    "admin_invite_requests_denied_controller",
+    "admin_teams_admins_controller",
+    "admin_teams_controller",
+    "admin_teams_owners_controller",
+    "admin_teams_settings_controller",
+    "admin_usergroups_controller",
+    "admin_users_controller",
+    "admin_users_session_controller",
+    "api_controller",
+    "apps_controller",
+    "apps_event_authorizations_controller",
+    "apps_permissions_controller",
+    "apps_permissions_resources_controller",
+    "apps_permissions_scopes_controller",
+    "apps_permissions_users_controller",
+    "auth_controller",
+    "base_controller",
+    "bots_controller",
+    "calls_controller",
+    "calls_participants_controller",
+    "chat_controller",
+    "chat_scheduled_messages_controller",
+    "conversations_controller",
+    "dialog_controller",
+    "dnd_controller",
+    "emoji_controller",
+    "files_comments_controller",
+    "files_controller",
+    "files_remote_controller",
+    "migration_controller",
+    "oauth_authorization_controller",
+    "oauth_controller",
+    "oauth_v_2_controller",
+    "pins_controller",
+    "reactions_controller",
+    "reminders_controller",
+    "rtm_controller",
+    "search_controller",
+    "stars_controller",
+    "team_controller",
+    "team_profile_controller",
+    "usergroups_controller",
+    "usergroups_users_controller",
+    "users_controller",
+    "users_profile_controller",
+    "views_controller",
+    "workflows_controller",
+]

slackwebapi/controllers/admin_apps_approved_controller.py

@@ -0,0 +1,101 @@
+"""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 AdminAppsApprovedController(BaseController):
+    """A Controller to access Endpoints in the slackwebapi API."""
+
+    def __init__(self, config):
+        """Initialize AdminAppsApprovedController object."""
+        super(AdminAppsApprovedController, self).__init__(config)
+
+    def admin_apps_approved_list(self,
+                                 token,
+                                 limit=None,
+                                 cursor=None,
+                                 team_id=None,
+                                 enterprise_id=None):
+        """Perform a GET request to /admin.apps.approved.list.
+
+        List approved apps for an org or workspace.
+
+        Args:
+            token (str): Authentication token. Requires scope: `admin.apps:read`
+            limit (int, optional): The maximum number of items to return. Must be
+                between 1 - 1000 both inclusive.
+            cursor (str, optional): Set `cursor` to `next_cursor` returned by the
+                previous call to list items in the next page
+            team_id (str, optional): The request query parameter.
+            enterprise_id (str, optional): The request query parameter.
+
+        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("/admin.apps.approved.list")
+            .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("limit")
+                .value(limit))
+            .query_param(Parameter()
+                .key("cursor")
+                .value(cursor))
+            .query_param(Parameter()
+                .key("team_id")
+                .value(team_id))
+            .query_param(Parameter()
+                .key("enterprise_id")
+                .value(enterprise_id))
+            .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/admin_apps_controller.py

@@ -0,0 +1,153 @@
+"""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 AdminAppsController(BaseController):
+    """A Controller to access Endpoints in the slackwebapi API."""
+
+    def __init__(self, config):
+        """Initialize AdminAppsController object."""
+        super(AdminAppsController, self).__init__(config)
+
+    def admin_apps_approve(self,
+                           token,
+                           app_id=None,
+                           request_id=None,
+                           team_id=None):
+        """Perform a POST request to /admin.apps.approve.
+
+        Approve an app for installation on a workspace.
+
+        Args:
+            token (str): Authentication token. Requires scope: `admin.apps:write`
+            app_id (str, optional): The id of the app to approve.
+            request_id (str, optional): The id of the request to approve.
+            team_id (str, optional): The request form parameter.
+
+        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("/admin.apps.approve")
+            .http_method(HttpMethodEnum.POST)
+            .header_param(Parameter()
+                .key("token")
+                .value(token)
+                .is_required(True))
+            .form_param(Parameter()
+                .key("app_id")
+                .value(app_id))
+            .form_param(Parameter()
+                .key("request_id")
+                .value(request_id))
+            .form_param(Parameter()
+                .key("team_id")
+                .value(team_id))
+            .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 admin_apps_restrict(self,
+                            token,
+                            app_id=None,
+                            request_id=None,
+                            team_id=None):
+        """Perform a POST request to /admin.apps.restrict.
+
+        Restrict an app for installation on a workspace.
+
+        Args:
+            token (str): Authentication token. Requires scope: `admin.apps:write`
+            app_id (str, optional): The id of the app to restrict.
+            request_id (str, optional): The id of the request to restrict.
+            team_id (str, optional): The request form parameter.
+
+        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("/admin.apps.restrict")
+            .http_method(HttpMethodEnum.POST)
+            .header_param(Parameter()
+                .key("token")
+                .value(token)
+                .is_required(True))
+            .form_param(Parameter()
+                .key("app_id")
+                .value(app_id))
+            .form_param(Parameter()
+                .key("request_id")
+                .value(request_id))
+            .form_param(Parameter()
+                .key("team_id")
+                .value(team_id))
+            .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()

slackwebapi/controllers/admin_apps_requests_controller.py

@@ -0,0 +1,96 @@
+"""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 AdminAppsRequestsController(BaseController):
+    """A Controller to access Endpoints in the slackwebapi API."""
+
+    def __init__(self, config):
+        """Initialize AdminAppsRequestsController object."""
+        super(AdminAppsRequestsController, self).__init__(config)
+
+    def admin_apps_requests_list(self,
+                                 token,
+                                 limit=None,
+                                 cursor=None,
+                                 team_id=None):
+        """Perform a GET request to /admin.apps.requests.list.
+
+        List app requests for a team/workspace.
+
+        Args:
+            token (str): Authentication token. Requires scope: `admin.apps:read`
+            limit (int, optional): The maximum number of items to return. Must be
+                between 1 - 1000 both inclusive.
+            cursor (str, optional): Set `cursor` to `next_cursor` returned by the
+                previous call to list items in the next page
+            team_id (str, optional): The request query parameter.
+
+        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("/admin.apps.requests.list")
+            .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("limit")
+                .value(limit))
+            .query_param(Parameter()
+                .key("cursor")
+                .value(cursor))
+            .query_param(Parameter()
+                .key("team_id")
+                .value(team_id))
+            .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()