jaxl-python 0.0.1__py3-none-any.whl

jaxl/api/client/models/ivr_menu_response.py

@@ -0,0 +1,140 @@
+"""
+Copyright (c) 2010-present by Jaxl Innovations Private Limited.
+
+All rights reserved.
+
+Redistribution and use in source and binary forms,
+with or without modification, is strictly prohibited.
+"""
+
+from typing import TYPE_CHECKING, Any, Dict, List, Type, TypeVar, Union, cast
+
+import attr
+
+from ..models.ivr_menu_response_status_enum import IVRMenuResponseStatusEnum
+from ..types import UNSET, Unset
+
+
+if TYPE_CHECKING:
+    from ..models.analytic import Analytic
+
+
+T = TypeVar("T", bound="IVRMenuResponse")
+
+
+@attr.s(auto_attribs=True)
+class IVRMenuResponse:
+    """
+    Attributes:
+        id (int):
+        name (str): Name of this IVR menu as shown/spoken to user before following up with options
+        status (IVRMenuResponseStatusEnum):
+        avg_time_spent (int):
+        analytics (List['Analytic']):
+        created_by (int):
+        hangup (Union[Unset, bool]): Whether the call should be ended after speaking out the greeting message
+        phone (Union[Unset, List[int]]):
+    """
+
+    id: int
+    name: str
+    status: IVRMenuResponseStatusEnum
+    avg_time_spent: int
+    analytics: List["Analytic"]
+    created_by: int
+    hangup: Union[Unset, bool] = UNSET
+    phone: Union[Unset, List[int]] = UNSET
+    additional_properties: Dict[str, Any] = attr.ib(init=False, factory=dict)
+
+    def to_dict(self) -> Dict[str, Any]:
+        id = self.id
+        name = self.name
+        status = self.status.value
+
+        avg_time_spent = self.avg_time_spent
+        analytics = []
+        for analytics_item_data in self.analytics:
+            analytics_item = analytics_item_data.to_dict()
+
+            analytics.append(analytics_item)
+
+        created_by = self.created_by
+        hangup = self.hangup
+        phone: Union[Unset, List[int]] = UNSET
+        if not isinstance(self.phone, Unset):
+            phone = self.phone
+
+        field_dict: Dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "id": id,
+                "name": name,
+                "status": status,
+                "avg_time_spent": avg_time_spent,
+                "analytics": analytics,
+                "created_by": created_by,
+            }
+        )
+        if hangup is not UNSET:
+            field_dict["hangup"] = hangup
+        if phone is not UNSET:
+            field_dict["phone"] = phone
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
+        from ..models.analytic import Analytic
+
+        d = src_dict.copy()
+        id = d.pop("id")
+
+        name = d.pop("name")
+
+        status = IVRMenuResponseStatusEnum(d.pop("status"))
+
+        avg_time_spent = d.pop("avg_time_spent")
+
+        analytics = []
+        _analytics = d.pop("analytics")
+        for analytics_item_data in _analytics:
+            analytics_item = Analytic.from_dict(analytics_item_data)
+
+            analytics.append(analytics_item)
+
+        created_by = d.pop("created_by")
+
+        hangup = d.pop("hangup", UNSET)
+
+        phone = cast(List[int], d.pop("phone", UNSET))
+
+        ivr_menu_response = cls(
+            id=id,
+            name=name,
+            status=status,
+            avg_time_spent=avg_time_spent,
+            analytics=analytics,
+            created_by=created_by,
+            hangup=hangup,
+            phone=phone,
+        )
+
+        ivr_menu_response.additional_properties = d
+        return ivr_menu_response
+
+    @property
+    def additional_keys(self) -> List[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

jaxl/api/client/models/ivr_menu_response_status_enum.py

@@ -0,0 +1,20 @@
+"""
+Copyright (c) 2010-present by Jaxl Innovations Private Limited.
+
+All rights reserved.
+
+Redistribution and use in source and binary forms,
+with or without modification, is strictly prohibited.
+"""
+
+from enum import Enum
+
+
+class IVRMenuResponseStatusEnum(str, Enum):
+    ARCHIVED = "ARCHIVED"
+    DELETED = "DELETED"
+    DRAFT = "DRAFT"
+    READY_TO_ASSIGN = "READY_TO_ASSIGN"
+
+    def __str__(self) -> str:
+        return str(self.value)

jaxl/api/client/models/ivr_options_invalid_response.py

@@ -0,0 +1,67 @@
+"""
+Copyright (c) 2010-present by Jaxl Innovations Private Limited.
+
+All rights reserved.
+
+Redistribution and use in source and binary forms,
+with or without modification, is strictly prohibited.
+"""
+
+from typing import Any, Dict, List, Type, TypeVar
+
+import attr
+
+
+T = TypeVar("T", bound="IVROptionsInvalidResponse")
+
+
+@attr.s(auto_attribs=True)
+class IVROptionsInvalidResponse:
+    """
+    Attributes:
+        message (str):
+    """
+
+    message: str
+    additional_properties: Dict[str, Any] = attr.ib(init=False, factory=dict)
+
+    def to_dict(self) -> Dict[str, Any]:
+        message = self.message
+
+        field_dict: Dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "message": message,
+            }
+        )
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
+        d = src_dict.copy()
+        message = d.pop("message")
+
+        ivr_options_invalid_response = cls(
+            message=message,
+        )
+
+        ivr_options_invalid_response.additional_properties = d
+        return ivr_options_invalid_response
+
+    @property
+    def additional_keys(self) -> List[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

jaxl/api/client/models/ivr_options_request.py

@@ -0,0 +1,116 @@
+"""
+Copyright (c) 2010-present by Jaxl Innovations Private Limited.
+
+All rights reserved.
+
+Redistribution and use in source and binary forms,
+with or without modification, is strictly prohibited.
+"""
+
+from typing import TYPE_CHECKING, Any, Dict, List, Type, TypeVar, Union
+
+import attr
+
+from ..types import UNSET, Unset
+
+
+if TYPE_CHECKING:
+    from ..models.next_or_cta_request import NextOrCTARequest
+
+
+T = TypeVar("T", bound="IVROptionsRequest")
+
+
+@attr.s(auto_attribs=True)
+class IVROptionsRequest:
+    """
+    Attributes:
+        name (str): Public name of this option
+        input_ (str): Input required to visit this options sub-menu or invoke CTA
+        next_or_cta (NextOrCTARequest):
+        enabled (Union[Unset, bool]): Whether this object is currently enabled or disabled
+        needs_data_prompt (Union[Unset, None, str]): Provide iff system must prompt user with the provided text for more
+            input after they have chosen this option
+        confirmation (Union[Unset, None, bool]): Whether to ask for confirmation to verify input data. Can only be
+            enabled when needs_data_prompt is non-null.
+    """
+
+    name: str
+    input_: str
+    next_or_cta: "NextOrCTARequest"
+    enabled: Union[Unset, bool] = UNSET
+    needs_data_prompt: Union[Unset, None, str] = UNSET
+    confirmation: Union[Unset, None, bool] = UNSET
+    additional_properties: Dict[str, Any] = attr.ib(init=False, factory=dict)
+
+    def to_dict(self) -> Dict[str, Any]:
+        name = self.name
+        input_ = self.input_
+        next_or_cta = self.next_or_cta.to_dict()
+
+        enabled = self.enabled
+        needs_data_prompt = self.needs_data_prompt
+        confirmation = self.confirmation
+
+        field_dict: Dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "name": name,
+                "input": input_,
+                "next_or_cta": next_or_cta,
+            }
+        )
+        if enabled is not UNSET:
+            field_dict["enabled"] = enabled
+        if needs_data_prompt is not UNSET:
+            field_dict["needs_data_prompt"] = needs_data_prompt
+        if confirmation is not UNSET:
+            field_dict["confirmation"] = confirmation
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
+        from ..models.next_or_cta_request import NextOrCTARequest
+
+        d = src_dict.copy()
+        name = d.pop("name")
+
+        input_ = d.pop("input")
+
+        next_or_cta = NextOrCTARequest.from_dict(d.pop("next_or_cta"))
+
+        enabled = d.pop("enabled", UNSET)
+
+        needs_data_prompt = d.pop("needs_data_prompt", UNSET)
+
+        confirmation = d.pop("confirmation", UNSET)
+
+        ivr_options_request = cls(
+            name=name,
+            input_=input_,
+            next_or_cta=next_or_cta,
+            enabled=enabled,
+            needs_data_prompt=needs_data_prompt,
+            confirmation=confirmation,
+        )
+
+        ivr_options_request.additional_properties = d
+        return ivr_options_request
+
+    @property
+    def additional_keys(self) -> List[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

jaxl/api/client/models/ivr_options_response.py

@@ -0,0 +1,145 @@
+"""
+Copyright (c) 2010-present by Jaxl Innovations Private Limited.
+
+All rights reserved.
+
+Redistribution and use in source and binary forms,
+with or without modification, is strictly prohibited.
+"""
+
+from typing import TYPE_CHECKING, Any, Dict, List, Type, TypeVar, Union
+
+import attr
+
+from ..types import UNSET, Unset
+
+
+if TYPE_CHECKING:
+    from ..models.cta import CTA
+
+
+T = TypeVar("T", bound="IVROptionsResponse")
+
+
+@attr.s(auto_attribs=True)
+class IVROptionsResponse:
+    """
+    Attributes:
+        id (int):
+        name (str): Public name of this option
+        menu (int): IVR Menu to which this option belongs to
+        input_ (str): Input required to visit this options sub-menu or invoke CTA
+        enabled (bool):
+        next_ (Union[Unset, None, int]): Optionally, next menu to present after receiving input
+        cta (Union[Unset, CTA]):
+        needs_data_prompt (Union[Unset, None, str]): Provide iff system must prompt user with the provided text for more
+            input after they have chosen this option
+        confirmation (Union[Unset, None, bool]): Whether to ask for confirmation to verify input data. Can only be
+            enabled when needs_data_prompt is non-null.
+    """
+
+    id: int
+    name: str
+    menu: int
+    input_: str
+    enabled: bool
+    next_: Union[Unset, None, int] = UNSET
+    cta: Union[Unset, "CTA"] = UNSET
+    needs_data_prompt: Union[Unset, None, str] = UNSET
+    confirmation: Union[Unset, None, bool] = UNSET
+    additional_properties: Dict[str, Any] = attr.ib(init=False, factory=dict)
+
+    def to_dict(self) -> Dict[str, Any]:
+        id = self.id
+        name = self.name
+        menu = self.menu
+        input_ = self.input_
+        enabled = self.enabled
+        next_ = self.next_
+        cta: Union[Unset, Dict[str, Any]] = UNSET
+        if not isinstance(self.cta, Unset):
+            cta = self.cta.to_dict()
+
+        needs_data_prompt = self.needs_data_prompt
+        confirmation = self.confirmation
+
+        field_dict: Dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "id": id,
+                "name": name,
+                "menu": menu,
+                "input": input_,
+                "enabled": enabled,
+            }
+        )
+        if next_ is not UNSET:
+            field_dict["next"] = next_
+        if cta is not UNSET:
+            field_dict["cta"] = cta
+        if needs_data_prompt is not UNSET:
+            field_dict["needs_data_prompt"] = needs_data_prompt
+        if confirmation is not UNSET:
+            field_dict["confirmation"] = confirmation
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
+        from ..models.cta import CTA
+
+        d = src_dict.copy()
+        id = d.pop("id")
+
+        name = d.pop("name")
+
+        menu = d.pop("menu")
+
+        input_ = d.pop("input")
+
+        enabled = d.pop("enabled")
+
+        next_ = d.pop("next", UNSET)
+
+        _cta = d.pop("cta", UNSET)
+        cta: Union[Unset, CTA]
+        if isinstance(_cta, Unset) or _cta is None:
+            cta = UNSET
+        else:
+            cta = CTA.from_dict(_cta)
+
+        needs_data_prompt = d.pop("needs_data_prompt", UNSET)
+
+        confirmation = d.pop("confirmation", UNSET)
+
+        ivr_options_response = cls(
+            id=id,
+            name=name,
+            menu=menu,
+            input_=input_,
+            enabled=enabled,
+            next_=next_,
+            cta=cta,
+            needs_data_prompt=needs_data_prompt,
+            confirmation=confirmation,
+        )
+
+        ivr_options_response.additional_properties = d
+        return ivr_options_response
+
+    @property
+    def additional_keys(self) -> List[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

jaxl/api/client/models/ivr_simulation_state_request.py

@@ -0,0 +1,81 @@
+"""
+Copyright (c) 2010-present by Jaxl Innovations Private Limited.
+
+All rights reserved.
+
+Redistribution and use in source and binary forms,
+with or without modification, is strictly prohibited.
+"""
+
+from typing import Any, Dict, List, Type, TypeVar
+
+import attr
+
+
+T = TypeVar("T", bound="IVRSimulationStateRequest")
+
+
+@attr.s(auto_attribs=True)
+class IVRSimulationStateRequest:
+    """
+    Attributes:
+        call_id (int):
+        from_number (str):
+        to_number (str):
+    """
+
+    call_id: int
+    from_number: str
+    to_number: str
+    additional_properties: Dict[str, Any] = attr.ib(init=False, factory=dict)
+
+    def to_dict(self) -> Dict[str, Any]:
+        call_id = self.call_id
+        from_number = self.from_number
+        to_number = self.to_number
+
+        field_dict: Dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "call_id": call_id,
+                "from_number": from_number,
+                "to_number": to_number,
+            }
+        )
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
+        d = src_dict.copy()
+        call_id = d.pop("call_id")
+
+        from_number = d.pop("from_number")
+
+        to_number = d.pop("to_number")
+
+        ivr_simulation_state_request = cls(
+            call_id=call_id,
+            from_number=from_number,
+            to_number=to_number,
+        )
+
+        ivr_simulation_state_request.additional_properties = d
+        return ivr_simulation_state_request
+
+    @property
+    def additional_keys(self) -> List[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

jaxl/api/client/models/ivr_state.py

@@ -0,0 +1,117 @@
+"""
+Copyright (c) 2010-present by Jaxl Innovations Private Limited.
+
+All rights reserved.
+
+Redistribution and use in source and binary forms,
+with or without modification, is strictly prohibited.
+"""
+
+from typing import TYPE_CHECKING, Any, Dict, List, Type, TypeVar, Union
+
+import attr
+
+from ..types import UNSET, Unset
+
+
+if TYPE_CHECKING:
+    from ..models.cta import CTA
+
+
+T = TypeVar("T", bound="IVRState")
+
+
+@attr.s(auto_attribs=True)
+class IVRState:
+    """
+    Attributes:
+        timeout_url (str):
+        url (Union[Unset, None, str]):
+        cta (Union[Unset, None, CTA]):
+        wait_for (Union[Unset, None, str]):
+        min_input_character_length (Union[Unset, None, int]):
+    """
+
+    timeout_url: str
+    url: Union[Unset, None, str] = UNSET
+    cta: Union[Unset, None, "CTA"] = UNSET
+    wait_for: Union[Unset, None, str] = UNSET
+    min_input_character_length: Union[Unset, None, int] = UNSET
+    additional_properties: Dict[str, Any] = attr.ib(init=False, factory=dict)
+
+    def to_dict(self) -> Dict[str, Any]:
+        timeout_url = self.timeout_url
+        url = self.url
+        cta: Union[Unset, None, Dict[str, Any]] = UNSET
+        if not isinstance(self.cta, Unset):
+            cta = self.cta.to_dict() if self.cta else None
+
+        wait_for = self.wait_for
+        min_input_character_length = self.min_input_character_length
+
+        field_dict: Dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "timeout_url": timeout_url,
+            }
+        )
+        if url is not UNSET:
+            field_dict["url"] = url
+        if cta is not UNSET:
+            field_dict["cta"] = cta
+        if wait_for is not UNSET:
+            field_dict["wait_for"] = wait_for
+        if min_input_character_length is not UNSET:
+            field_dict["min_input_character_length"] = min_input_character_length
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
+        from ..models.cta import CTA
+
+        d = src_dict.copy()
+        timeout_url = d.pop("timeout_url")
+
+        url = d.pop("url", UNSET)
+
+        _cta = d.pop("cta", UNSET)
+        cta: Union[Unset, None, CTA]
+        if _cta is None:
+            cta = None
+        elif isinstance(_cta, Unset):
+            cta = UNSET
+        else:
+            cta = CTA.from_dict(_cta)
+
+        wait_for = d.pop("wait_for", UNSET)
+
+        min_input_character_length = d.pop("min_input_character_length", UNSET)
+
+        ivr_state = cls(
+            timeout_url=timeout_url,
+            url=url,
+            cta=cta,
+            wait_for=wait_for,
+            min_input_character_length=min_input_character_length,
+        )
+
+        ivr_state.additional_properties = d
+        return ivr_state
+
+    @property
+    def additional_keys(self) -> List[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties