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

wavix/sms_and_mms/messages/types/__init__.py

@@ -0,0 +1,47 @@
+# 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 .get_messages_response import GetMessagesResponse
+    from .list_all_messages_request_message_type import ListAllMessagesRequestMessageType
+    from .list_messages_request_message_type import ListMessagesRequestMessageType
+    from .list_messages_response import ListMessagesResponse
+_dynamic_imports: typing.Dict[str, str] = {
+    "GetMessagesResponse": ".get_messages_response",
+    "ListAllMessagesRequestMessageType": ".list_all_messages_request_message_type",
+    "ListMessagesRequestMessageType": ".list_messages_request_message_type",
+    "ListMessagesResponse": ".list_messages_response",
+}
+
+
+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__ = [
+    "GetMessagesResponse",
+    "ListAllMessagesRequestMessageType",
+    "ListMessagesRequestMessageType",
+    "ListMessagesResponse",
+]

wavix/sms_and_mms/messages/types/get_messages_response.py

@@ -0,0 +1,97 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ....core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ....core.serialization import FieldMetadata
+from ....types.message_body import MessageBody
+from ....types.message_delivery_status import MessageDeliveryStatus
+
+
+class GetMessagesResponse(UniversalBaseModel):
+    message_id: str = pydantic.Field()
+    """
+    Message ID.
+    """
+
+    message_type: str = pydantic.Field()
+    """
+    Message type. Possible values are `sms`, `mms`.
+    """
+
+    from_: typing_extensions.Annotated[
+        str, FieldMetadata(alias="from"), pydantic.Field(alias="from", description="Sender ID.")
+    ]
+    to: str = pydantic.Field()
+    """
+    Recipient phone number.
+    """
+
+    direction: str = pydantic.Field()
+    """
+    Message direction. Possible values are `outbound`, `inbound`.
+    """
+
+    mcc: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Mobile country code.
+    """
+
+    mnc: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Mobile network code.
+    """
+
+    message_body: MessageBody
+    tag: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Tag to group messages, such as for a specific campaign.
+    """
+
+    status: MessageDeliveryStatus
+    segments: int = pydantic.Field()
+    """
+    Number of SMS segments. Always 1 for MMS.
+    """
+
+    charge: str = pydantic.Field()
+    """
+    Total charge for the message in USD.
+    """
+
+    submitted_at: str = pydantic.Field()
+    """
+    Date and time the message was accepted in ISO 8601 format.
+    """
+
+    sent_at: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Date and time the message was sent in ISO 8601 format. For mobile-terminated messages only.
+    """
+
+    delivered_at: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Date and time the message was delivered in ISO 8601 format. Refers to DLR reception for mobile-terminated messages
+     or webhook relay for mobile-originated messages.
+    """
+
+    error_message: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Human-readable error message.
+    """
+
+    carrier_fees: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Mobile carrier fees in USD.
+    """
+
+    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/sms_and_mms/messages/types/list_all_messages_request_message_type.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ListAllMessagesRequestMessageType = typing.Union[typing.Literal["sms", "mms"], typing.Any]

wavix/sms_and_mms/messages/types/list_messages_request_message_type.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ListMessagesRequestMessageType = typing.Union[typing.Literal["sms", "mms"], typing.Any]

wavix/sms_and_mms/messages/types/list_messages_response.py

@@ -0,0 +1,26 @@
+# 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 ....types.message import Message
+from ....types.pagination import Pagination
+
+
+class ListMessagesResponse(UniversalBaseModel):
+    items: typing.List[Message] = pydantic.Field()
+    """
+    Messages that match the request.
+    """
+
+    pagination: Pagination
+
+    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/sms_and_mms/opt_outs/__init__.py

@@ -0,0 +1,34 @@
+# 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 CreateOptOutsResponse
+_dynamic_imports: typing.Dict[str, str] = {"CreateOptOutsResponse": ".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__ = ["CreateOptOutsResponse"]

wavix/sms_and_mms/opt_outs/client.py

@@ -0,0 +1,277 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ...core.request_options import RequestOptions
+from ...types.opt_out import OptOut
+from ...types.opt_outs_list_response import OptOutsListResponse
+from .raw_client import AsyncRawOptOutsClient, RawOptOutsClient
+from .types.create_opt_outs_response import CreateOptOutsResponse
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class OptOutsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawOptOutsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawOptOutsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawOptOutsClient
+        """
+        return self._raw_client
+
+    def list(
+        self,
+        *,
+        sender_id: typing.Optional[str] = None,
+        campaign_id: typing.Optional[str] = None,
+        created_after: typing.Optional[dt.date] = None,
+        created_before: typing.Optional[dt.date] = None,
+        page: typing.Optional[int] = None,
+        per_page: typing.Optional[int] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> OptOutsListResponse:
+        """
+        Returns a paginated list of phone numbers that have opted out of receiving messages from the authenticated account.
+
+        Parameters
+        ----------
+        sender_id : typing.Optional[str]
+            Filters opt-outs by the Sender ID they apply to.
+
+        campaign_id : typing.Optional[str]
+            Filters opt-outs by the 10DLC campaign ID they apply to.
+
+        created_after : typing.Optional[dt.date]
+            Returns opt-outs created on or after this date, in `YYYY-MM-DD` format.
+
+        created_before : typing.Optional[dt.date]
+            Returns opt-outs created on or before this date, in `YYYY-MM-DD` format.
+
+        page : typing.Optional[int]
+            Page number to retrieve. Minimum `1`, default `1`.
+
+        per_page : typing.Optional[int]
+            Number of records to return per page. Default `25`, maximum `100`.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        OptOutsListResponse
+            Returns a paginated list of opted-out phone numbers.
+
+        Examples
+        --------
+        import datetime
+
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.sms_and_mms.opt_outs.list(
+            sender_id="MySender",
+            campaign_id="C123456",
+            created_after=datetime.date.fromisoformat(
+                "2024-01-01",
+            ),
+            created_before=datetime.date.fromisoformat(
+                "2024-12-31",
+            ),
+        )
+        """
+        _response = self._raw_client.list(
+            sender_id=sender_id,
+            campaign_id=campaign_id,
+            created_after=created_after,
+            created_before=created_before,
+            page=page,
+            per_page=per_page,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def create(
+        self, *, opt_out: OptOut, request_options: typing.Optional[RequestOptions] = None
+    ) -> CreateOptOutsResponse:
+        """
+        Opts a phone number out of receiving messages from a Sender ID, a 10DLC campaign, or all outbound messages.
+
+        Parameters
+        ----------
+        opt_out : OptOut
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreateOptOutsResponse
+            Returns a success confirmation. The opt-out is created.
+
+        Examples
+        --------
+        from wavix import OptOut, Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.sms_and_mms.opt_outs.create(
+            opt_out=OptOut(
+                number="16419252149",
+                sender_id="15072429497",
+            ),
+        )
+        """
+        _response = self._raw_client.create(opt_out=opt_out, request_options=request_options)
+        return _response.data
+
+
+class AsyncOptOutsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawOptOutsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawOptOutsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawOptOutsClient
+        """
+        return self._raw_client
+
+    async def list(
+        self,
+        *,
+        sender_id: typing.Optional[str] = None,
+        campaign_id: typing.Optional[str] = None,
+        created_after: typing.Optional[dt.date] = None,
+        created_before: typing.Optional[dt.date] = None,
+        page: typing.Optional[int] = None,
+        per_page: typing.Optional[int] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> OptOutsListResponse:
+        """
+        Returns a paginated list of phone numbers that have opted out of receiving messages from the authenticated account.
+
+        Parameters
+        ----------
+        sender_id : typing.Optional[str]
+            Filters opt-outs by the Sender ID they apply to.
+
+        campaign_id : typing.Optional[str]
+            Filters opt-outs by the 10DLC campaign ID they apply to.
+
+        created_after : typing.Optional[dt.date]
+            Returns opt-outs created on or after this date, in `YYYY-MM-DD` format.
+
+        created_before : typing.Optional[dt.date]
+            Returns opt-outs created on or before this date, in `YYYY-MM-DD` format.
+
+        page : typing.Optional[int]
+            Page number to retrieve. Minimum `1`, default `1`.
+
+        per_page : typing.Optional[int]
+            Number of records to return per page. Default `25`, maximum `100`.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        OptOutsListResponse
+            Returns a paginated list of opted-out phone numbers.
+
+        Examples
+        --------
+        import asyncio
+        import datetime
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.sms_and_mms.opt_outs.list(
+                sender_id="MySender",
+                campaign_id="C123456",
+                created_after=datetime.date.fromisoformat(
+                    "2024-01-01",
+                ),
+                created_before=datetime.date.fromisoformat(
+                    "2024-12-31",
+                ),
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.list(
+            sender_id=sender_id,
+            campaign_id=campaign_id,
+            created_after=created_after,
+            created_before=created_before,
+            page=page,
+            per_page=per_page,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def create(
+        self, *, opt_out: OptOut, request_options: typing.Optional[RequestOptions] = None
+    ) -> CreateOptOutsResponse:
+        """
+        Opts a phone number out of receiving messages from a Sender ID, a 10DLC campaign, or all outbound messages.
+
+        Parameters
+        ----------
+        opt_out : OptOut
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreateOptOutsResponse
+            Returns a success confirmation. The opt-out is created.
+
+        Examples
+        --------
+        import asyncio
+
+        from wavix import AsyncWavix, OptOut
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.sms_and_mms.opt_outs.create(
+                opt_out=OptOut(
+                    number="16419252149",
+                    sender_id="15072429497",
+                ),
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.create(opt_out=opt_out, request_options=request_options)
+        return _response.data