"""

    AUTHOR:

        Khushal P Soonderji

    DATE:

        Monday, 9th Dec., 2024.

    OBJECTIVE:

        To provide a structure to receive API calls to send SMS messages from various third-party clients.

    REFERENCES:

        N/A

    DOWNLOADS:

        N/A

"""


#   *****************************************************************************************************************
#  *****                                                                                                          ****
# ***                                                   IMPORT                                                      ***
#  *****                                                                                                          ****
#   *****************************************************************************************************************


# To make sibling directories accessible for imports:
import sys
sys.path.append(".")
sys.path.append("..")

# For making data behaviour_models:
from pydantic import BaseModel, Field, field_validator, PastDatetime
from typing import Optional, Literal, Union

# My utils:
from utils_v2.string import regex
from utils_v2.date_time import date_time

# To work with date and time:
import datetime

# To work with MongoDB:
from bson.objectid import ObjectId


#   *****************************************************************************************************************
#  *****                                                                                                          ****
# ***                                           MACROS / ONE-TIME INIT                                              ***
#  *****                                                                                                          ****
#   *****************************************************************************************************************


# RegEx Patterns:
REGEX_SESSION_TOKEN = r"^[a-f0-9]{8}-[a-f0-9]{4}-[1-5][a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$"


#   *****************************************************************************************************************
#  *****                                                                                                          ****
# ***                                                VARIABLES                                                      ***
#  *****                                                                                                          ****
#   *****************************************************************************************************************


# --- Nothing Yet


#   *****************************************************************************************************************
#  *****                                                                                                          ****
# ***                                                  FUNCTIONS                                                    ***
#  *****                                                                                                          ****
#   *****************************************************************************************************************


class NimbusSMSIndiaMessage(BaseModel):

    recipientNo: str = Field(
        description = "the phone no. of the target recipient",
        pattern = r"\+?\d{0,3}\s*\(?\d{3}\)?[-.\s]?\d{3}[-.\s]?\d{4}",
        frozen = True
    )

    text: str = Field(
        description = "the actual text that you want to send",
        min_length = 1,
        frozen = True
    )

    templateId: str = Field(
        description = "the id of the template that you are trying to use to send the message",
        min_length = 1,
        frozen = True
    )

    # ┏┓    ┏•
    # ┃ ┏┓┏┓╋┓┏┓
    # ┗┛┗┛┛┗┛┗┗┫
    #          ┛

    class Config:
        extra = "forbid"

    # ┓┏  ┓• ┓   •
    # ┃┃┏┓┃┓┏┫┏┓╋┓┏┓┏┓
    # ┗┛┗┻┗┗┗┻┗┻┗┗┗┛┛┗

    @field_validator("recipientNo", mode = "before")
    def validate_contact_nos(cls, value):
        value = regex.replace(text = str(value), pattern = r"[^\d]", substitute_text = "")
        if len(value) > 10: value = regex.replace(text = str(value), pattern = r"^(91)", substitute_text = "")
        value = regex.find_first(text = str(value), pattern = r"^[\d]{10}")
        return value


# ---------------------------------------------------------------------------------------------------------------------


class SavvyBulkSMSKenyaMessage(BaseModel):

    recipientNo: str = Field(
        description = "the phone no. of the target recipient",
        min_length = 1,
        frozen = True
    )

    text: str = Field(
        description = "the actual text that you want to send",
        min_length = 1,
        frozen = True
    )

    # ┏┓    ┏•
    # ┃ ┏┓┏┓╋┓┏┓
    # ┗┛┗┛┛┗┛┗┗┫
    #          ┛

    class Config:
        extra = "forbid"


# ---------------------------------------------------------------------------------------------------------------------


class SMSSendRequestHeaders(BaseModel):

    sessionToken: str = Field(
        description = "the session token of the user who is requesting the service",
        pattern = REGEX_SESSION_TOKEN,
        frozen = True,
        alias = "X-Session-Token"
    )

    # ┏┓    ┏•
    # ┃ ┏┓┏┓╋┓┏┓
    # ┗┛┗┛┛┗┛┗┗┫
    #          ┛

    class Config:
        extra = "allow"

    def model_dump(self, *args, **kwargs):
        return super().model_dump(*args, by_alias = True, **kwargs)


# ---------------------------------------------------------------------------------------------------------------------


class SMSSendRequestData(BaseModel):

    tokenId: ObjectId = Field(description = "the auth token to use to send this message")
    message: Union[NimbusSMSIndiaMessage, SavvyBulkSMSKenyaMessage]

    # ┏┓    ┏•
    # ┃ ┏┓┏┓╋┓┏┓
    # ┗┛┗┛┛┗┛┗┗┫
    #          ┛

    class Config:
        extra = "forbid"
        arbitrary_types_allowed = True

    # ┓┏  ┓• ┓   •
    # ┃┃┏┓┃┓┏┫┏┓╋┓┏┓┏┓
    # ┗┛┗┻┗┗┗┻┗┻┗┗┗┛┛┗

    @field_validator("tokenId", mode = "before")
    def parse_oid(cls, value):
        try: value = ObjectId(value)
        except: pass
        return value


#   *****************************************************************************************************************
#  *****                                                                                                          ****
# ***                                               MAIN PROGRAM                                                    ***
#  *****                                                                                                          ****
#   *****************************************************************************************************************


if __name__ == "__main__":

    from utils_v2.string import json

    my_request = SMSSendRequestData(
        tokenId = "670f580d7cda4ebc1adc3444",
        message = NimbusSMSIndiaMessage(
            recipientNo = "+.9.1    --->     93261 3642fgnn193261",
            text = "Hello, Nimbus!",
            templateId = "12345678"
        )
    )

    print("NIMBUS SMS API MODEL:", json.to_string(my_request.model_dump(), default = str))