r"""
    This code was generated by
   ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
    |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
    |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \

    Twilio - Numbers
    This is the public Twilio REST API.

    NOTE: This class is auto generated by OpenAPI Generator.
    https://openapi-generator.tech
    Do not edit the class manually.
"""

from typing import Any, Dict, List, Optional, Union, Iterator, AsyncIterator
from twilio.base import values
from twilio.base.instance_context import InstanceContext
from twilio.base.instance_resource import InstanceResource
from twilio.base.list_resource import ListResource
from twilio.base.version import Version
from twilio.base.page import Page


class ApplicationInstance(InstanceResource):

    class CreateShortCodeApplicationRequest(object):
        """
        :ivar friendly_name: The friendly name for the short code application.
        :ivar iso_country: The ISO country code.
        :ivar business_information:
        :ivar setup:
        """

        def __init__(self, payload: Dict[str, Any]):

            self.friendly_name: Optional[str] = payload.get("friendly_name")
            self.iso_country: Optional[str] = payload.get("iso_country")
            self.business_information: Optional[
                ApplicationList.CreateShortCodeApplicationRequestBusinessInformation
            ] = payload.get("business_information")
            self.setup: Optional[
                ApplicationList.CreateShortCodeApplicationRequestSetup
            ] = payload.get("setup")

        def to_dict(self):
            return {
                "friendly_name": self.friendly_name,
                "iso_country": self.iso_country,
                "business_information": (
                    self.business_information.to_dict()
                    if self.business_information is not None
                    else None
                ),
                "setup": self.setup.to_dict() if self.setup is not None else None,
            }

    class CreateShortCodeApplicationRequestBusinessInformation(object):
        """
        :ivar customer_facing_profile: The Compliance Profile SID for the customer-facing business profile.
        """

        def __init__(self, payload: Dict[str, Any]):

            self.customer_facing_profile: Optional[str] = payload.get(
                "customer_facing_profile"
            )

        def to_dict(self):
            return {
                "customer_facing_profile": self.customer_facing_profile,
            }

    class CreateShortCodeApplicationRequestSetup(object):
        """
        :ivar charges_apply:
        """

        def __init__(self, payload: Dict[str, Any]):

            self.charges_apply: Optional[bool] = payload.get("charges_apply")

        def to_dict(self):
            return {
                "charges_apply": self.charges_apply,
            }

    """
    :ivar sid: The unique identifier of the Short Code Application.
    :ivar bundle_sid: The Bundle SID for regulatory compliance.
    :ivar application_requirements_sid: The Application Requirements SID.
    :ivar friendly_name: The friendly name of the application.
    :ivar iso_country: The ISO country code.
    :ivar state: The state of the application.
    """

    def __init__(
        self, version: Version, payload: Dict[str, Any], sid: Optional[str] = None
    ):
        super().__init__(version)

        self.sid: Optional[str] = payload.get("sid")
        self.bundle_sid: Optional[str] = payload.get("bundle_sid")
        self.application_requirements_sid: Optional[str] = payload.get(
            "application_requirements_sid"
        )
        self.friendly_name: Optional[str] = payload.get("friendly_name")
        self.iso_country: Optional[str] = payload.get("iso_country")
        self.state: Optional[str] = payload.get("state")

        self._solution = {
            "sid": sid or self.sid,
        }
        self._context: Optional[ApplicationContext] = None

    @property
    def _proxy(self) -> "ApplicationContext":
        """
        Generate an instance context for the instance, the context is capable of
        performing various actions. All instance actions are proxied to the context

        :returns: ApplicationContext for this ApplicationInstance
        """
        if self._context is None:
            self._context = ApplicationContext(
                self._version,
                sid=self._solution["sid"],
            )
        return self._context

    def fetch(self) -> "ApplicationInstance":
        """
        Fetch the ApplicationInstance


        :returns: The fetched ApplicationInstance
        """
        return self._proxy.fetch()

    async def fetch_async(self) -> "ApplicationInstance":
        """
        Asynchronous coroutine to fetch the ApplicationInstance


        :returns: The fetched ApplicationInstance
        """
        return await self._proxy.fetch_async()

    def __repr__(self) -> str:
        """
        Provide a friendly representation

        :returns: Machine friendly representation
        """
        context = " ".join("{}={}".format(k, v) for k, v in self._solution.items())
        return "<Twilio.Numbers.V2.ApplicationInstance {}>".format(context)


class ApplicationContext(InstanceContext):

    class CreateShortCodeApplicationRequest(object):
        """
        :ivar friendly_name: The friendly name for the short code application.
        :ivar iso_country: The ISO country code.
        :ivar business_information:
        :ivar setup:
        """

        def __init__(self, payload: Dict[str, Any]):

            self.friendly_name: Optional[str] = payload.get("friendly_name")
            self.iso_country: Optional[str] = payload.get("iso_country")
            self.business_information: Optional[
                ApplicationList.CreateShortCodeApplicationRequestBusinessInformation
            ] = payload.get("business_information")
            self.setup: Optional[
                ApplicationList.CreateShortCodeApplicationRequestSetup
            ] = payload.get("setup")

        def to_dict(self):
            return {
                "friendly_name": self.friendly_name,
                "iso_country": self.iso_country,
                "business_information": (
                    self.business_information.to_dict()
                    if self.business_information is not None
                    else None
                ),
                "setup": self.setup.to_dict() if self.setup is not None else None,
            }

    class CreateShortCodeApplicationRequestBusinessInformation(object):
        """
        :ivar customer_facing_profile: The Compliance Profile SID for the customer-facing business profile.
        """

        def __init__(self, payload: Dict[str, Any]):

            self.customer_facing_profile: Optional[str] = payload.get(
                "customer_facing_profile"
            )

        def to_dict(self):
            return {
                "customer_facing_profile": self.customer_facing_profile,
            }

    class CreateShortCodeApplicationRequestSetup(object):
        """
        :ivar charges_apply:
        """

        def __init__(self, payload: Dict[str, Any]):

            self.charges_apply: Optional[bool] = payload.get("charges_apply")

        def to_dict(self):
            return {
                "charges_apply": self.charges_apply,
            }

    def __init__(self, version: Version, sid: str):
        """
        Initialize the ApplicationContext

        :param version: Version that contains the resource
        :param sid: The unique string that identifies the Short Code Application resource.
        """
        super().__init__(version)

        # Path Solution
        self._solution = {
            "sid": sid,
        }
        self._uri = "/ShortCodes/Applications/{sid}".format(**self._solution)

    def fetch(self) -> ApplicationInstance:
        """
        Fetch the ApplicationInstance


        :returns: The fetched ApplicationInstance
        """

        headers = values.of({})

        headers["Accept"] = "application/json"

        payload = self._version.fetch(method="GET", uri=self._uri, headers=headers)

        return ApplicationInstance(
            self._version,
            payload,
            sid=self._solution["sid"],
        )

    async def fetch_async(self) -> ApplicationInstance:
        """
        Asynchronous coroutine to fetch the ApplicationInstance


        :returns: The fetched ApplicationInstance
        """

        headers = values.of({})

        headers["Accept"] = "application/json"

        payload = await self._version.fetch_async(
            method="GET", uri=self._uri, headers=headers
        )

        return ApplicationInstance(
            self._version,
            payload,
            sid=self._solution["sid"],
        )

    def __repr__(self) -> str:
        """
        Provide a friendly representation

        :returns: Machine friendly representation
        """
        context = " ".join("{}={}".format(k, v) for k, v in self._solution.items())
        return "<Twilio.Numbers.V2.ApplicationContext {}>".format(context)


class ApplicationPage(Page):

    def get_instance(self, payload: Dict[str, Any]) -> ApplicationInstance:
        """
        Build an instance of ApplicationInstance

        :param payload: Payload response from the API
        """
        return ApplicationInstance(self._version, payload)

    def __repr__(self) -> str:
        """
        Provide a friendly representation

        :returns: Machine friendly representation
        """
        return "<Twilio.Numbers.V2.ApplicationPage>"


class ApplicationList(ListResource):

    class CreateShortCodeApplicationRequest(object):
        """
        :ivar friendly_name: The friendly name for the short code application.
        :ivar iso_country: The ISO country code.
        :ivar business_information:
        :ivar setup:
        """

        def __init__(self, payload: Dict[str, Any]):

            self.friendly_name: Optional[str] = payload.get("friendly_name")
            self.iso_country: Optional[str] = payload.get("iso_country")
            self.business_information: Optional[
                ApplicationList.CreateShortCodeApplicationRequestBusinessInformation
            ] = payload.get("business_information")
            self.setup: Optional[
                ApplicationList.CreateShortCodeApplicationRequestSetup
            ] = payload.get("setup")

        def to_dict(self):
            return {
                "friendly_name": self.friendly_name,
                "iso_country": self.iso_country,
                "business_information": (
                    self.business_information.to_dict()
                    if self.business_information is not None
                    else None
                ),
                "setup": self.setup.to_dict() if self.setup is not None else None,
            }

    class CreateShortCodeApplicationRequestBusinessInformation(object):
        """
        :ivar customer_facing_profile: The Compliance Profile SID for the customer-facing business profile.
        """

        def __init__(self, payload: Dict[str, Any]):

            self.customer_facing_profile: Optional[str] = payload.get(
                "customer_facing_profile"
            )

        def to_dict(self):
            return {
                "customer_facing_profile": self.customer_facing_profile,
            }

    class CreateShortCodeApplicationRequestSetup(object):
        """
        :ivar charges_apply:
        """

        def __init__(self, payload: Dict[str, Any]):

            self.charges_apply: Optional[bool] = payload.get("charges_apply")

        def to_dict(self):
            return {
                "charges_apply": self.charges_apply,
            }

    def __init__(self, version: Version):
        """
        Initialize the ApplicationList

        :param version: Version that contains the resource

        """
        super().__init__(version)

        self._uri = "/ShortCodes/Applications"

    def create(
        self, create_short_code_application_request: CreateShortCodeApplicationRequest
    ) -> ApplicationInstance:
        """
        Create the ApplicationInstance

        :param create_short_code_application_request:

        :returns: The created ApplicationInstance
        """
        data = create_short_code_application_request.to_dict()

        headers = values.of({"Content-Type": "application/x-www-form-urlencoded"})

        headers["Content-Type"] = "application/json"

        headers["Accept"] = "application/json"

        payload = self._version.create(
            method="POST", uri=self._uri, data=data, headers=headers
        )

        return ApplicationInstance(self._version, payload)

    async def create_async(
        self, create_short_code_application_request: CreateShortCodeApplicationRequest
    ) -> ApplicationInstance:
        """
        Asynchronously create the ApplicationInstance

        :param create_short_code_application_request:

        :returns: The created ApplicationInstance
        """
        data = create_short_code_application_request.to_dict()

        headers = values.of({"Content-Type": "application/x-www-form-urlencoded"})

        headers["Content-Type"] = "application/json"

        headers["Accept"] = "application/json"

        payload = await self._version.create_async(
            method="POST", uri=self._uri, data=data, headers=headers
        )

        return ApplicationInstance(self._version, payload)

    def stream(
        self,
        limit: Optional[int] = None,
        page_size: Optional[int] = None,
    ) -> Iterator[ApplicationInstance]:
        """
        Streams ApplicationInstance records from the API as a generator stream.
        This operation lazily loads records as efficiently as possible until the limit
        is reached.
        The results are returned as a generator, so this operation is memory efficient.

        :param limit: Upper limit for the number of records to return. stream()
                      guarantees to never return more than limit.  Default is no limit
        :param page_size: Number of records to fetch per request, when not set will use
                          the default value of 50 records.  If no page_size is defined
                          but a limit is defined, stream() will attempt to read the
                          limit with the most efficient page size, i.e. min(limit, 1000)

        :returns: Generator that will yield up to limit results
        """
        limits = self._version.read_limits(limit, page_size)
        page = self.page(page_size=limits["page_size"])

        return self._version.stream(page, limits["limit"])

    async def stream_async(
        self,
        limit: Optional[int] = None,
        page_size: Optional[int] = None,
    ) -> AsyncIterator[ApplicationInstance]:
        """
        Asynchronously streams ApplicationInstance records from the API as a generator stream.
        This operation lazily loads records as efficiently as possible until the limit
        is reached.
        The results are returned as a generator, so this operation is memory efficient.

        :param limit: Upper limit for the number of records to return. stream()
                      guarantees to never return more than limit.  Default is no limit
        :param page_size: Number of records to fetch per request, when not set will use
                          the default value of 50 records.  If no page_size is defined
                          but a limit is defined, stream() will attempt to read the
                          limit with the most efficient page size, i.e. min(limit, 1000)

        :returns: Generator that will yield up to limit results
        """
        limits = self._version.read_limits(limit, page_size)
        page = await self.page_async(page_size=limits["page_size"])

        return self._version.stream_async(page, limits["limit"])

    def list(
        self,
        limit: Optional[int] = None,
        page_size: Optional[int] = None,
    ) -> List[ApplicationInstance]:
        """
        Lists ApplicationInstance records from the API as a list.
        Unlike stream(), this operation is eager and will load `limit` records into
        memory before returning.

        :param limit: Upper limit for the number of records to return. list() guarantees
                      never to return more than limit.  Default is no limit
        :param page_size: Number of records to fetch per request, when not set will use
                          the default value of 50 records.  If no page_size is defined
                          but a limit is defined, list() will attempt to read the limit
                          with the most efficient page size, i.e. min(limit, 1000)

        :returns: list that will contain up to limit results
        """
        return list(
            self.stream(
                limit=limit,
                page_size=page_size,
            )
        )

    async def list_async(
        self,
        limit: Optional[int] = None,
        page_size: Optional[int] = None,
    ) -> List[ApplicationInstance]:
        """
        Asynchronously lists ApplicationInstance records from the API as a list.
        Unlike stream(), this operation is eager and will load `limit` records into
        memory before returning.

        :param limit: Upper limit for the number of records to return. list() guarantees
                      never to return more than limit.  Default is no limit
        :param page_size: Number of records to fetch per request, when not set will use
                          the default value of 50 records.  If no page_size is defined
                          but a limit is defined, list() will attempt to read the limit
                          with the most efficient page size, i.e. min(limit, 1000)

        :returns: list that will contain up to limit results
        """
        return [
            record
            async for record in await self.stream_async(
                limit=limit,
                page_size=page_size,
            )
        ]

    def page(
        self,
        page_token: Union[str, object] = values.unset,
        page_number: Union[int, object] = values.unset,
        page_size: Union[int, object] = values.unset,
    ) -> ApplicationPage:
        """
        Retrieve a single page of ApplicationInstance records from the API.
        Request is executed immediately

        :param page_token: PageToken provided by the API
        :param page_number: Page Number, this value is simply for client state
        :param page_size: Number of records to return, defaults to 50

        :returns: Page of ApplicationInstance
        """
        data = values.of(
            {
                "PageToken": page_token,
                "Page": page_number,
                "PageSize": page_size,
            }
        )

        headers = values.of({"Content-Type": "application/x-www-form-urlencoded"})

        headers["Accept"] = "application/json"

        response = self._version.page(
            method="GET", uri=self._uri, params=data, headers=headers
        )
        return ApplicationPage(self._version, response)

    async def page_async(
        self,
        page_token: Union[str, object] = values.unset,
        page_number: Union[int, object] = values.unset,
        page_size: Union[int, object] = values.unset,
    ) -> ApplicationPage:
        """
        Asynchronously retrieve a single page of ApplicationInstance records from the API.
        Request is executed immediately

        :param page_token: PageToken provided by the API
        :param page_number: Page Number, this value is simply for client state
        :param page_size: Number of records to return, defaults to 50

        :returns: Page of ApplicationInstance
        """
        data = values.of(
            {
                "PageToken": page_token,
                "Page": page_number,
                "PageSize": page_size,
            }
        )

        headers = values.of({"Content-Type": "application/x-www-form-urlencoded"})

        headers["Accept"] = "application/json"

        response = await self._version.page_async(
            method="GET", uri=self._uri, params=data, headers=headers
        )
        return ApplicationPage(self._version, response)

    def get_page(self, target_url: str) -> ApplicationPage:
        """
        Retrieve a specific page of ApplicationInstance records from the API.
        Request is executed immediately

        :param target_url: API-generated URL for the requested results page

        :returns: Page of ApplicationInstance
        """
        response = self._version.domain.twilio.request("GET", target_url)
        return ApplicationPage(self._version, response)

    async def get_page_async(self, target_url: str) -> ApplicationPage:
        """
        Asynchronously retrieve a specific page of ApplicationInstance records from the API.
        Request is executed immediately

        :param target_url: API-generated URL for the requested results page

        :returns: Page of ApplicationInstance
        """
        response = await self._version.domain.twilio.request_async("GET", target_url)
        return ApplicationPage(self._version, response)

    def get(self, sid: str) -> ApplicationContext:
        """
        Constructs a ApplicationContext

        :param sid: The unique string that identifies the Short Code Application resource.
        """
        return ApplicationContext(self._version, sid=sid)

    def __call__(self, sid: str) -> ApplicationContext:
        """
        Constructs a ApplicationContext

        :param sid: The unique string that identifies the Short Code Application resource.
        """
        return ApplicationContext(self._version, sid=sid)

    def __repr__(self) -> str:
        """
        Provide a friendly representation

        :returns: Machine friendly representation
        """
        return "<Twilio.Numbers.V2.ApplicationList>"