# The Okta software accompanied by this notice is provided pursuant to the following terms:
# Copyright © 2025-Present, Okta, Inc.
# Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the
# License.
# You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.
# Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS
# IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and limitations under the License.
# coding: utf-8

"""
Okta Admin Management

Allows customers to easily access the Okta Management APIs

The version of the OpenAPI document: 5.1.0
Contact: devex-public@okta.com
Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.
"""  # noqa: E501

from __future__ import annotations

import json
import pprint
import re  # noqa: F401
from typing import Any, ClassVar, Dict, List
from typing import Optional, Set

from pydantic import BaseModel, ConfigDict, Field, StrictStr
from typing_extensions import Annotated
from typing_extensions import Self

from okta.models.policy_subject_match_type import PolicySubjectMatchType
from okta.models.policy_user_name_template import PolicyUserNameTemplate


class PolicySubject(BaseModel):
    """
    Specifies the behavior for establishing, validating, and matching a username for an IdP user
    """  # noqa: E501

    filter: Optional[Annotated[str, Field(strict=True, max_length=1024)]] = Field(
        default=None,
        description="Optional [regular expression pattern]("
        "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Regular_expressions) used to filter "
        "untrusted IdP usernames. * As a best security practice, you should define a regular expression pattern "
        "to filter untrusted IdP usernames. This is especially important if multiple IdPs are connected to your "
        "org. The filter prevents an IdP from issuing an assertion for any user, including partners or directory "
        "users in your Okta org. * For example, the filter pattern `(\\S+@example\\.com)` allows only Users that "
        "have an `@example.com` username suffix. It rejects assertions that have any other suffix such as "
        "`@corp.example.com` or `@partner.com`. * Only `SAML2` and `OIDC` IdP providers support the `filter` "
        "property.",
    )
    match_attribute: Optional[StrictStr] = Field(
        default=None,
        description="Okta user profile attribute for matching a transformed IdP username. Only for matchType "
        "`CUSTOM_ATTRIBUTE`. The `matchAttribute` must be a valid Okta user profile attribute of one of the "
        "following types: * String (with no format or 'email' format only) * Integer * Number",
        alias="matchAttribute",
    )
    match_type: Optional[PolicySubjectMatchType] = Field(
        default=None, alias="matchType"
    )
    user_name_template: Optional[PolicyUserNameTemplate] = Field(
        default=None, alias="userNameTemplate"
    )
    __properties: ClassVar[List[str]] = [
        "filter",
        "matchAttribute",
        "matchType",
        "userNameTemplate",
    ]

    model_config = ConfigDict(
        populate_by_name=True,
        validate_assignment=True,
        protected_namespaces=(),
    )

    def to_str(self) -> str:
        """Returns the string representation of the model using alias"""
        return pprint.pformat(self.model_dump(by_alias=True))

    def to_json(self) -> str:
        """Returns the JSON representation of the model using alias"""
        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
        return json.dumps(self.to_dict())

    @classmethod
    def from_json(cls, json_str: str) -> Optional[Self]:
        """Create an instance of PolicySubject from a JSON string"""
        return cls.from_dict(json.loads(json_str))

    def to_dict(self) -> Dict[str, Any]:
        """Return the dictionary representation of the model using alias.

        This has the following differences from calling pydantic's
        `self.model_dump(by_alias=True)`:

        * `None` is only added to the output dict for nullable fields that
          were set at model initialization. Other fields with value `None`
          are ignored.
        """
        excluded_fields: Set[str] = set([])

        _dict = self.model_dump(
            by_alias=True,
            exclude=excluded_fields,
            exclude_none=True,
        )
        # override the default output from pydantic by calling `to_dict()` of user_name_template
        if self.user_name_template:
            if not isinstance(self.user_name_template, dict):
                _dict["userNameTemplate"] = self.user_name_template.to_dict()
            else:
                _dict["userNameTemplate"] = self.user_name_template

        return _dict

    @classmethod
    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
        """Create an instance of PolicySubject from a dict"""
        if obj is None:
            return None

        if not isinstance(obj, dict):
            return cls.model_validate(obj)

        _obj = cls.model_validate(
            {
                "filter": obj.get("filter"),
                "matchAttribute": obj.get("matchAttribute"),
                "matchType": obj.get("matchType"),
                "userNameTemplate": (
                    PolicyUserNameTemplate.from_dict(obj["userNameTemplate"])
                    if obj.get("userNameTemplate") is not None
                    else None
                ),
            }
        )
        return _obj
