wavix-python-sdk 1.0.0__py3-none-any.whl

wavix/ten_dlc/brands/types/update_brands_response.py

@@ -0,0 +1,143 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .update_brands_response_entity_type import UpdateBrandsResponseEntityType
+from .update_brands_response_status import UpdateBrandsResponseStatus
+
+
+class UpdateBrandsResponse(UniversalBaseModel):
+    """
+    Represents a 10DLC brand registered for application-to-person messaging. A Brand identifies the business behind one or more messaging campaigns.
+    """
+
+    brand_id: str = pydantic.Field()
+    """
+    Unique identifier of the Brand assigned by the registry.
+    """
+
+    dba_name: str = pydantic.Field()
+    """
+    Doing-business-as name, or the public-facing brand name.
+    """
+
+    company_name: str = pydantic.Field()
+    """
+    Registered legal name of the company that owns the Brand.
+    """
+
+    entity_type: UpdateBrandsResponseEntityType = pydantic.Field()
+    """
+    Company entity type.
+    """
+
+    vertical: str = pydantic.Field()
+    """
+    Industry vertical the Brand operates in.
+    """
+
+    ein_taxid: str = pydantic.Field()
+    """
+    IRS Employer Identification Number (EIN) or other tax ID of the company.
+    """
+
+    ein_taxid_country: str = pydantic.Field()
+    """
+    ISO 3166-1 alpha-2 country code where the Tax ID was issued.
+    """
+
+    status: UpdateBrandsResponseStatus = pydantic.Field()
+    """
+    Brand identity verification status.
+    """
+
+    website: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Business website URL.
+    """
+
+    stock_symbol: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Stock ticker symbol of the company. Required for publicly traded companies.
+    """
+
+    stock_exchange: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Code of the stock exchange the company is listed on. Required for publicly traded companies.
+    """
+
+    first_name: str = pydantic.Field()
+    """
+    Business contact first name.
+    """
+
+    last_name: str = pydantic.Field()
+    """
+    Business contact last name.
+    """
+
+    phone_number: str = pydantic.Field()
+    """
+    Support contact phone number in E.164 format.
+    """
+
+    email: str = pydantic.Field()
+    """
+    Support contact email address.
+    """
+
+    street_address: str = pydantic.Field()
+    """
+    Street address of the business.
+    """
+
+    city: str = pydantic.Field()
+    """
+    City of the business address.
+    """
+
+    state_or_province: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    State or province of the business address.
+    """
+
+    country: str = pydantic.Field()
+    """
+    ISO 3166-1 alpha-2 country code of the business address.
+    """
+
+    zip: str = pydantic.Field()
+    """
+    ZIP or postal code of the business address.
+    """
+
+    feedback: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Feedback from the identity verification process explaining the current `status`.
+    """
+
+    mock: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates whether the Brand is a mock brand for testing.
+    """
+
+    created_at: str = pydantic.Field()
+    """
+    Timestamp when the Brand was created, in ISO 8601 format.
+    """
+
+    updated_at: str = pydantic.Field()
+    """
+    Timestamp when the Brand was last updated, in ISO 8601 format.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

wavix/ten_dlc/brands/types/update_brands_response_entity_type.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+UpdateBrandsResponseEntityType = typing.Union[
+    typing.Literal["PRIVATE_PROFIT", "PUBLIC_PROFIT", "NON_PROFIT", "GOVERNMENT"], typing.Any
+]

wavix/ten_dlc/brands/types/update_brands_response_status.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+UpdateBrandsResponseStatus = typing.Union[
+    typing.Literal["REVIEW", "VERIFIED", "UNVERIFIED", "VETTED_VERIFIED", "SUSPENDED"], typing.Any
+]

wavix/ten_dlc/campaign_numbers/__init__.py

@@ -0,0 +1,38 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+import typing
+from importlib import import_module
+
+if typing.TYPE_CHECKING:
+    from .types import LinkCampaignNumbersResponse, ListCampaignNumbersResponse, UnlinkCampaignNumbersResponse
+_dynamic_imports: typing.Dict[str, str] = {
+    "LinkCampaignNumbersResponse": ".types",
+    "ListCampaignNumbersResponse": ".types",
+    "UnlinkCampaignNumbersResponse": ".types",
+}
+
+
+def __getattr__(attr_name: str) -> typing.Any:
+    module_name = _dynamic_imports.get(attr_name)
+    if module_name is None:
+        raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}")
+    try:
+        module = import_module(module_name, __package__)
+        if module_name == f".{attr_name}":
+            return module
+        else:
+            return getattr(module, attr_name)
+    except ImportError as e:
+        raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e
+    except AttributeError as e:
+        raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e
+
+
+def __dir__():
+    lazy_attrs = list(_dynamic_imports.keys())
+    return sorted(lazy_attrs)
+
+
+__all__ = ["LinkCampaignNumbersResponse", "ListCampaignNumbersResponse", "UnlinkCampaignNumbersResponse"]

wavix/ten_dlc/campaign_numbers/client.py

@@ -0,0 +1,304 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ...core.request_options import RequestOptions
+from .raw_client import AsyncRawCampaignNumbersClient, RawCampaignNumbersClient
+from .types.link_campaign_numbers_response import LinkCampaignNumbersResponse
+from .types.list_campaign_numbers_response import ListCampaignNumbersResponse
+from .types.unlink_campaign_numbers_response import UnlinkCampaignNumbersResponse
+
+
+class CampaignNumbersClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawCampaignNumbersClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawCampaignNumbersClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawCampaignNumbersClient
+        """
+        return self._raw_client
+
+    def link(
+        self, brand_id: str, campaign_id: str, number: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> LinkCampaignNumbersResponse:
+        """
+        Links a phone number to a 10DLC Campaign. Wavix automatically creates a Sender ID once the number is approved.
+
+        Parameters
+        ----------
+        brand_id : str
+            The unique ID of the 10DLC Brand.
+
+        campaign_id : str
+            The unique ID of the 10DLC Campaign.
+
+        number : str
+            The phone number to link to the Campaign, in E.164 format.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        LinkCampaignNumbersResponse
+            Returns a success confirmation. The phone number is linked to the Campaign.
+
+        Examples
+        --------
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.ten_dlc.campaign_numbers.link(
+            brand_id="B9FXYNH",
+            campaign_id="CSJ4TV0",
+            number="17029641104",
+        )
+        """
+        _response = self._raw_client.link(brand_id, campaign_id, number, request_options=request_options)
+        return _response.data
+
+    def unlink(
+        self, brand_id: str, campaign_id: str, number: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> UnlinkCampaignNumbersResponse:
+        """
+        Unlinks a phone number from a 10DLC Campaign. The associated Sender ID is also deleted.
+
+        Parameters
+        ----------
+        brand_id : str
+            The unique ID of the 10DLC Brand.
+
+        campaign_id : str
+            The unique ID of the 10DLC Campaign.
+
+        number : str
+            The phone number to unlink from the Campaign, in E.164 format.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        UnlinkCampaignNumbersResponse
+            Returns a success confirmation. The phone number is unlinked from the Campaign.
+
+        Examples
+        --------
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.ten_dlc.campaign_numbers.unlink(
+            brand_id="B9FXYNH",
+            campaign_id="CSJ4TV0",
+            number="17029641104",
+        )
+        """
+        _response = self._raw_client.unlink(brand_id, campaign_id, number, request_options=request_options)
+        return _response.data
+
+    def list(
+        self, brand_id: str, campaign_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> ListCampaignNumbersResponse:
+        """
+        Returns the phone numbers linked to the 10DLC Campaign identified by `campaign_id`.
+
+        Parameters
+        ----------
+        brand_id : str
+            The unique ID of the 10DLC Brand.
+
+        campaign_id : str
+            The unique ID of the 10DLC Campaign.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ListCampaignNumbersResponse
+            Returns the phone numbers linked to the Campaign.
+
+        Examples
+        --------
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.ten_dlc.campaign_numbers.list(
+            brand_id="B9FXYNH",
+            campaign_id="CSJ4TV0",
+        )
+        """
+        _response = self._raw_client.list(brand_id, campaign_id, request_options=request_options)
+        return _response.data
+
+
+class AsyncCampaignNumbersClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawCampaignNumbersClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawCampaignNumbersClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawCampaignNumbersClient
+        """
+        return self._raw_client
+
+    async def link(
+        self, brand_id: str, campaign_id: str, number: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> LinkCampaignNumbersResponse:
+        """
+        Links a phone number to a 10DLC Campaign. Wavix automatically creates a Sender ID once the number is approved.
+
+        Parameters
+        ----------
+        brand_id : str
+            The unique ID of the 10DLC Brand.
+
+        campaign_id : str
+            The unique ID of the 10DLC Campaign.
+
+        number : str
+            The phone number to link to the Campaign, in E.164 format.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        LinkCampaignNumbersResponse
+            Returns a success confirmation. The phone number is linked to the Campaign.
+
+        Examples
+        --------
+        import asyncio
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.ten_dlc.campaign_numbers.link(
+                brand_id="B9FXYNH",
+                campaign_id="CSJ4TV0",
+                number="17029641104",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.link(brand_id, campaign_id, number, request_options=request_options)
+        return _response.data
+
+    async def unlink(
+        self, brand_id: str, campaign_id: str, number: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> UnlinkCampaignNumbersResponse:
+        """
+        Unlinks a phone number from a 10DLC Campaign. The associated Sender ID is also deleted.
+
+        Parameters
+        ----------
+        brand_id : str
+            The unique ID of the 10DLC Brand.
+
+        campaign_id : str
+            The unique ID of the 10DLC Campaign.
+
+        number : str
+            The phone number to unlink from the Campaign, in E.164 format.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        UnlinkCampaignNumbersResponse
+            Returns a success confirmation. The phone number is unlinked from the Campaign.
+
+        Examples
+        --------
+        import asyncio
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.ten_dlc.campaign_numbers.unlink(
+                brand_id="B9FXYNH",
+                campaign_id="CSJ4TV0",
+                number="17029641104",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.unlink(brand_id, campaign_id, number, request_options=request_options)
+        return _response.data
+
+    async def list(
+        self, brand_id: str, campaign_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> ListCampaignNumbersResponse:
+        """
+        Returns the phone numbers linked to the 10DLC Campaign identified by `campaign_id`.
+
+        Parameters
+        ----------
+        brand_id : str
+            The unique ID of the 10DLC Brand.
+
+        campaign_id : str
+            The unique ID of the 10DLC Campaign.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ListCampaignNumbersResponse
+            Returns the phone numbers linked to the Campaign.
+
+        Examples
+        --------
+        import asyncio
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.ten_dlc.campaign_numbers.list(
+                brand_id="B9FXYNH",
+                campaign_id="CSJ4TV0",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.list(brand_id, campaign_id, request_options=request_options)
+        return _response.data