# 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, field_validator
from typing_extensions import Self


class ApplicationCredentialsUsernameTemplate(BaseModel):
    """
    The template used to generate the username when the app is assigned through a group or directly to a user
    """  # noqa: E501

    push_status: Optional[StrictStr] = Field(
        default=None,
        description="Determines if the username is pushed to the app on updates for CUSTOM `type`",
        alias="pushStatus",
    )
    template: Optional[StrictStr] = Field(
        default="${source.login}",
        description="Mapping expression used to generate usernames.  The following are supported mapping expressions that "
        "are used with the `BUILT_IN` template type:  | Name                            | Template Expression    "
        "                        | | ------------------------------- | "
        "---------------------------------------------- | | AD Employee ID                  | `${"
        "source.employeeID}`                         | | AD SAM Account Name             | `${"
        "source.samAccountName}`                     | | AD SAM Account Name (lowercase) | `${fn:toLowerCase("
        "source.samAccountName)}`     | | AD User Principal Name          | `${source.userName}`                 "
        '          | | AD User Principal Name prefix   | `${fn:substringBefore(source.userName, "@")}`  | | '
        "Email                           | `${source.email}`                              | | Email (lowercase)  "
        "             | `${fn:toLowerCase(source.email)}`              | | Email prefix                    | `${"
        'fn:substringBefore(source.email, "@")}`     | | LDAP UID + custom suffix        | `${source.userName}${'
        "instance.userSuffix}`     | | Okta username                   | `${source.login}`                       "
        '       | | Okta username prefix            | `${fn:substringBefore(source.login, "@")}`     |',
    )
    type: Optional[StrictStr] = Field(
        default="BUILT_IN",
        description="Type of mapping expression. Empty string is allowed.",
    )
    user_suffix: Optional[StrictStr] = Field(
        default=None,
        description="An optional suffix appended to usernames for `BUILT_IN` mapping expressions",
        alias="userSuffix",
    )
    __properties: ClassVar[List[str]] = ["pushStatus", "template", "type", "userSuffix"]

    @field_validator("push_status")
    def push_status_validate_enum(cls, value):
        """Validates the enum"""
        if value is None:
            return value

        if value not in set(["PUSH", "DONT_PUSH", "NOT_CONFIGURED"]):
            raise ValueError(
                "must be one of enum values ('PUSH', 'DONT_PUSH', 'NOT_CONFIGURED')"
            )
        return value

    @field_validator("type")
    def type_validate_enum(cls, value):
        """Validates the enum"""
        if value is None:
            return value

        if value not in set(["NONE", "BUILT_IN", "CUSTOM"]):
            raise ValueError(
                "must be one of enum values ('NONE', 'BUILT_IN', 'CUSTOM')"
            )
        return value

    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 ApplicationCredentialsUsernameTemplate 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,
        )
        return _dict

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

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

        _obj = cls.model_validate(
            {
                "pushStatus": obj.get("pushStatus"),
                "template": (
                    obj.get("template")
                    if obj.get("template") is not None
                    else "${source.login}"
                ),
                "type": obj.get("type") if obj.get("type") is not None else "BUILT_IN",
                "userSuffix": obj.get("userSuffix"),
            }
        )
        return _obj
