text: # Auto-generated at 2021-09-27T17:01:25.582345+08:00
  # from: Justice Iam Service (4.1.0)
  
  # Copyright (c) 2018 - 2021 AccelByte Inc. All Rights Reserved.
  # This is licensed software from AccelByte Inc, for limitations
  # and restrictions contact your company contract manager.
  
  # pylint: disable=duplicate-code
  # pylint: disable=line-too-long
  # pylint: disable=missing-function-docstring
  # pylint: disable=missing-module-docstring
  # pylint: disable=too-many-arguments
  # pylint: disable=too-many-branches
  # pylint: disable=too-many-instance-attributes
  # pylint: disable=too-many-lines
  # pylint: disable=too-many-locals
  # pylint: disable=too-many-public-methods
  # pylint: disable=too-many-return-statements
  # pylint: disable=too-many-statements
  # pylint: disable=unused-import
  
  from __future__ import annotations
  from typing import Any, Dict, List, Optional, Tuple, Union
  
  from .....core import Operation
  from .....core import HttpResponse
  
  
  class PlatformAuthenticateSAMLV3Handler(Operation):
      """SAML platform Authentication API (platformAuthenticateSAMLV3Handler)
  
      Properties:
          url: /iam/v3/sso/saml/platforms/{platformId}/authenticate
  
          method: POST
  
          tags: SSO SAML 2.0
  
          consumes: ["application/x-www-form-urlencoded"]
  
          produces: []
  
          security: bearer
  
          location query: PLACEHOLDER
  
          platform_id: (platformId) REQUIRED str in path
  
          state: (state) REQUIRED str in query
  
          code: (code) OPTIONAL str in query
  
          error: (error) OPTIONAL str in query
  
      Responses:
          302: Found - (Found. Redirect to clients redirection URL with either code or error on the query parameter)
      """
  
      # region fields
  
      _url: str = "/iam/v3/sso/saml/platforms/{platformId}/authenticate"
      _method: str = "POST"
      _consumes: List[str] = ["application/x-www-form-urlencoded"]
      _produces: List[str] = []
      _security: Optional[str] = "bearer"
      _location_query: str = "PLACEHOLDER"
  
      platform_id: str                                                                               # REQUIRED in [path]
      state: str                                                                                     # REQUIRED in [query]
      code: str                                                                                      # OPTIONAL in [query]
      error: str                                                                                     # OPTIONAL in [query]
  
      # endregion fields
  
      # region properties
  
      @property
      def url(self) -> str:
          return self._url
  
      @property
      def method(self) -> str:
          return self._method
  
      @property
      def consumes(self) -> List[str]:
          return self._consumes
  
      @property
      def produces(self) -> List[str]:
          return self._produces
  
      @property
      def security(self) -> Optional[str]:
          return self._security
  
      @property
      def location_query(self) -> str:
          return self._location_query
  
      # endregion properties
  
      # region get methods
  
      def get_full_url(self, base_url: Union[None, str] = None) -> str:
          result = base_url if base_url is not None else ""
  
          # path params
          url = self.url
          for k, v in self.get_path_params().items():
              url = url.replace(f"{{{k}}}", v)
          result += url
  
          # query params
          result += "?" + "&".join([f"{k}={v}" for k, v in self.get_query_params().items()])
  
          return result
  
      # noinspection PyMethodMayBeStatic
      def get_all_required_fields(self) -> List[str]:
          return [
              "platform_id",
              "state",
          ]
  
      # endregion get methods
  
      # region get_x_params methods
  
      def get_all_params(self) -> dict:
          return {
              "path": self.get_path_params(),
              "query": self.get_query_params(),
          }
  
      def get_path_params(self) -> dict:
          result = {}
          if hasattr(self, "platform_id"):
              result["platformId"] = self.platform_id
          return result
  
      def get_query_params(self) -> dict:
          result = {}
          if hasattr(self, "state"):
              result["state"] = self.state
          if hasattr(self, "code"):
              result["code"] = self.code
          if hasattr(self, "error"):
              result["error"] = self.error
          return result
  
      # endregion get_x_params methods
  
      # region is/has methods
  
      def is_valid(self) -> bool:
          if not hasattr(self, "platform_id") or self.platform_id is None:
              return False
          if not hasattr(self, "state") or self.state is None:
              return False
          return True
  
      # noinspection PyMethodMayBeStatic
      def has_redirects(self) -> bool:
          """Returns True if this operation has redirects, otherwise False.
  
          302: Found - (Found. Redirect to clients redirection URL with either code or error on the query parameter)
          """
          return True
  
      # endregion is/has methods
  
      # region with_x methods
  
      def with_platform_id(self, value: str) -> PlatformAuthenticateSAMLV3Handler:
          self.platform_id = value
          return self
  
      def with_state(self, value: str) -> PlatformAuthenticateSAMLV3Handler:
          self.state = value
          return self
  
      def with_code(self, value: str) -> PlatformAuthenticateSAMLV3Handler:
          self.code = value
          return self
  
      def with_error(self, value: str) -> PlatformAuthenticateSAMLV3Handler:
          self.error = value
          return self
  
      # endregion with_x methods
  
      # region to methods
  
      def to_dict(self, include_empty: bool = False) -> dict:
          result = {}
          if hasattr(self, "platform_id") and self.platform_id:
              result["platformId"] = str(self.platform_id)
          elif include_empty:
              result["platformId"] = str()
          if hasattr(self, "state") and self.state:
              result["state"] = str(self.state)
          elif include_empty:
              result["state"] = str()
          if hasattr(self, "code") and self.code:
              result["code"] = str(self.code)
          elif include_empty:
              result["code"] = str()
          if hasattr(self, "error") and self.error:
              result["error"] = str(self.error)
          elif include_empty:
              result["error"] = str()
          return result
  
      # endregion to methods
  
      # region response methods
  
      # noinspection PyMethodMayBeStatic
      def parse_response(self, code: int, content_type: str, content: Any) -> Tuple[Union[None, HttpResponse], Union[None, HttpResponse]]:
          """Parse the given response.
  
          302: Found - (Found. Redirect to clients redirection URL with either code or error on the query parameter)
          """
          if code == 302:
              return HttpResponse.create_redirect(code, content), None
          was_handled, undocumented_response = HttpResponse.try_create_undocumented_response(code, content)
          if was_handled:
              return None, undocumented_response
          return None, HttpResponse.create_unhandled_error()
  
      # endregion response methods
  
      # region static methods
  
      @classmethod
      def create(
          cls,
          platform_id: str,
          state: str,
          code: Optional[str] = None,
          error: Optional[str] = None,
      ) -> PlatformAuthenticateSAMLV3Handler:
          instance = cls()
          instance.platform_id = platform_id
          instance.state = state
          if code is not None:
              instance.code = code
          if error is not None:
              instance.error = error
          return instance
  
      @classmethod
      def create_from_dict(cls, dict_: dict, include_empty: bool = False) -> PlatformAuthenticateSAMLV3Handler:
          instance = cls()
          if "platformId" in dict_ and dict_["platformId"] is not None:
              instance.platform_id = str(dict_["platformId"])
          elif include_empty:
              instance.platform_id = str()
          if "state" in dict_ and dict_["state"] is not None:
              instance.state = str(dict_["state"])
          elif include_empty:
              instance.state = str()
          if "code" in dict_ and dict_["code"] is not None:
              instance.code = str(dict_["code"])
          elif include_empty:
              instance.code = str()
          if "error" in dict_ and dict_["error"] is not None:
              instance.error = str(dict_["error"])
          elif include_empty:
              instance.error = str()
          return instance
  
      @staticmethod
      def get_field_info() -> Dict[str, str]:
          return {
              "platformId": "platform_id",
              "state": "state",
              "code": "code",
              "error": "error",
          }
  
      # endregion static methods
  