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

wavix/sms_and_mms/opt_outs/raw_client.py

@@ -0,0 +1,438 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+from json.decoder import JSONDecodeError
+
+from ...core.api_error import ApiError
+from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ...core.http_response import AsyncHttpResponse, HttpResponse
+from ...core.parse_error import ParsingError
+from ...core.pydantic_utilities import parse_obj_as
+from ...core.request_options import RequestOptions
+from ...core.serialization import convert_and_respect_annotation_metadata
+from ...errors.bad_request_error import BadRequestError
+from ...errors.forbidden_error import ForbiddenError
+from ...errors.not_found_error import NotFoundError
+from ...errors.unprocessable_entity_error import UnprocessableEntityError
+from ...types.opt_out import OptOut
+from ...types.opt_outs_list_response import OptOutsListResponse
+from .types.create_opt_outs_response import CreateOptOutsResponse
+from pydantic import ValidationError
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class RawOptOutsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    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,
+    ) -> HttpResponse[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
+        -------
+        HttpResponse[OptOutsListResponse]
+            Returns a paginated list of opted-out phone numbers.
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "v3/messages/opt-outs",
+            method="GET",
+            params={
+                "sender_id": sender_id,
+                "campaign_id": campaign_id,
+                "created_after": str(created_after) if created_after is not None else None,
+                "created_before": str(created_before) if created_before is not None else None,
+                "page": page,
+                "per_page": per_page,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    OptOutsListResponse,
+                    parse_obj_as(
+                        type_=OptOutsListResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 422:
+                raise UnprocessableEntityError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    def create(
+        self, *, opt_out: OptOut, request_options: typing.Optional[RequestOptions] = None
+    ) -> HttpResponse[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
+        -------
+        HttpResponse[CreateOptOutsResponse]
+            Returns a success confirmation. The opt-out is created.
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "v3/messages/opt-outs",
+            method="POST",
+            json={
+                "opt_out": convert_and_respect_annotation_metadata(
+                    object_=opt_out, annotation=OptOut, direction="write"
+                ),
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    CreateOptOutsResponse,
+                    parse_obj_as(
+                        type_=CreateOptOutsResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 422:
+                raise UnprocessableEntityError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+
+class AsyncRawOptOutsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    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,
+    ) -> AsyncHttpResponse[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
+        -------
+        AsyncHttpResponse[OptOutsListResponse]
+            Returns a paginated list of opted-out phone numbers.
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "v3/messages/opt-outs",
+            method="GET",
+            params={
+                "sender_id": sender_id,
+                "campaign_id": campaign_id,
+                "created_after": str(created_after) if created_after is not None else None,
+                "created_before": str(created_before) if created_before is not None else None,
+                "page": page,
+                "per_page": per_page,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    OptOutsListResponse,
+                    parse_obj_as(
+                        type_=OptOutsListResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 422:
+                raise UnprocessableEntityError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    async def create(
+        self, *, opt_out: OptOut, request_options: typing.Optional[RequestOptions] = None
+    ) -> AsyncHttpResponse[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
+        -------
+        AsyncHttpResponse[CreateOptOutsResponse]
+            Returns a success confirmation. The opt-out is created.
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "v3/messages/opt-outs",
+            method="POST",
+            json={
+                "opt_out": convert_and_respect_annotation_metadata(
+                    object_=opt_out, annotation=OptOut, direction="write"
+                ),
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    CreateOptOutsResponse,
+                    parse_obj_as(
+                        type_=CreateOptOutsResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 422:
+                raise UnprocessableEntityError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)

wavix/sms_and_mms/opt_outs/types/__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 .create_opt_outs_response import CreateOptOutsResponse
+_dynamic_imports: typing.Dict[str, str] = {"CreateOptOutsResponse": ".create_opt_outs_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__ = ["CreateOptOutsResponse"]

wavix/sms_and_mms/opt_outs/types/create_opt_outs_response.py

@@ -0,0 +1,22 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class CreateOptOutsResponse(UniversalBaseModel):
+    success: bool = pydantic.Field()
+    """
+    Indicates whether the request was successful.
+    """
+
+    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/raw_client.py

@@ -0,0 +1,13 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+
+
+class RawSmsAndMmsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+
+class AsyncRawSmsAndMmsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper

wavix/sms_and_mms/sender_ids/__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 DeleteSenderIdsResponse, SenderIdCreateRequestMonthlyVolume, SenderIdCreateRequestUsecase
+_dynamic_imports: typing.Dict[str, str] = {
+    "DeleteSenderIdsResponse": ".types",
+    "SenderIdCreateRequestMonthlyVolume": ".types",
+    "SenderIdCreateRequestUsecase": ".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__ = ["DeleteSenderIdsResponse", "SenderIdCreateRequestMonthlyVolume", "SenderIdCreateRequestUsecase"]