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

wavix/ten_dlc/brand_evidence/client.py

@@ -0,0 +1,365 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ... import core
+from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ...core.request_options import RequestOptions
+from ...types.list_brand_evidence_response import ListBrandEvidenceResponse
+from .raw_client import AsyncRawBrandEvidenceClient, RawBrandEvidenceClient
+from .types.delete_brand_evidence_response import DeleteBrandEvidenceResponse
+from .types.upload_brand_evidence_response import UploadBrandEvidenceResponse
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class BrandEvidenceClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawBrandEvidenceClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawBrandEvidenceClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawBrandEvidenceClient
+        """
+        return self._raw_client
+
+    def list(
+        self, brand_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> ListBrandEvidenceResponse:
+        """
+        Returns the evidence files uploaded for the 10DLC Brand identified by `brand_id`.
+
+        Parameters
+        ----------
+        brand_id : str
+            The unique ID of the 10DLC Brand.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ListBrandEvidenceResponse
+            Returns the list of uploaded evidence files.
+
+        Examples
+        --------
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.ten_dlc.brand_evidence.list(
+            brand_id="B6AI7PA",
+        )
+        """
+        _response = self._raw_client.list(brand_id, request_options=request_options)
+        return _response.data
+
+    def upload(
+        self, brand_id: str, *, file: core.File, request_options: typing.Optional[RequestOptions] = None
+    ) -> UploadBrandEvidenceResponse:
+        """
+        Uploads a supporting evidence file for the 10DLC Brand identified by `brand_id`. Supported formats include `.jpg`, `.png`, and `.pdf`. Maximum size is 10 MB.
+
+        Parameters
+        ----------
+        brand_id : str
+            The unique ID of the 10DLC Brand.
+
+        file : core.File
+            See core.File for more documentation
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        UploadBrandEvidenceResponse
+            Returns the uploaded evidence file.
+
+        Examples
+        --------
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.ten_dlc.brand_evidence.upload(
+            brand_id="B6AI7PA",
+        )
+        """
+        _response = self._raw_client.upload(brand_id, file=file, request_options=request_options)
+        return _response.data
+
+    def get(
+        self, brand_id: str, id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> typing.Iterator[bytes]:
+        """
+        Returns the Brand evidence file identified by the evidence ID.
+
+        Parameters
+        ----------
+        brand_id : str
+            The unique ID of the 10DLC Brand.
+
+        id : str
+            The unique ID of the Brand evidence file.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response.
+
+        Returns
+        -------
+        typing.Iterator[bytes]
+            Returns the Brand evidence file.
+
+        Examples
+        --------
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.ten_dlc.brand_evidence.get(
+            brand_id="brand_id",
+            id="id",
+        )
+        """
+        with self._raw_client.get(brand_id, id, request_options=request_options) as r:
+            yield from r.data
+
+    def delete(
+        self, brand_id: str, id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> DeleteBrandEvidenceResponse:
+        """
+        Deletes the Brand evidence file identified by the evidence ID. Deletion is permanent.
+
+        Parameters
+        ----------
+        brand_id : str
+            The unique ID of the 10DLC Brand.
+
+        id : str
+            The unique ID of the Brand evidence file.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        DeleteBrandEvidenceResponse
+            Returns a success confirmation. The evidence file is deleted.
+
+        Examples
+        --------
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.ten_dlc.brand_evidence.delete(
+            brand_id="B6AI7PA",
+            id="191eb205-8357-4d71-b8da-160a25a000d7",
+        )
+        """
+        _response = self._raw_client.delete(brand_id, id, request_options=request_options)
+        return _response.data
+
+
+class AsyncBrandEvidenceClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawBrandEvidenceClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawBrandEvidenceClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawBrandEvidenceClient
+        """
+        return self._raw_client
+
+    async def list(
+        self, brand_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> ListBrandEvidenceResponse:
+        """
+        Returns the evidence files uploaded for the 10DLC Brand identified by `brand_id`.
+
+        Parameters
+        ----------
+        brand_id : str
+            The unique ID of the 10DLC Brand.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ListBrandEvidenceResponse
+            Returns the list of uploaded evidence files.
+
+        Examples
+        --------
+        import asyncio
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.ten_dlc.brand_evidence.list(
+                brand_id="B6AI7PA",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.list(brand_id, request_options=request_options)
+        return _response.data
+
+    async def upload(
+        self, brand_id: str, *, file: core.File, request_options: typing.Optional[RequestOptions] = None
+    ) -> UploadBrandEvidenceResponse:
+        """
+        Uploads a supporting evidence file for the 10DLC Brand identified by `brand_id`. Supported formats include `.jpg`, `.png`, and `.pdf`. Maximum size is 10 MB.
+
+        Parameters
+        ----------
+        brand_id : str
+            The unique ID of the 10DLC Brand.
+
+        file : core.File
+            See core.File for more documentation
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        UploadBrandEvidenceResponse
+            Returns the uploaded evidence file.
+
+        Examples
+        --------
+        import asyncio
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.ten_dlc.brand_evidence.upload(
+                brand_id="B6AI7PA",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.upload(brand_id, file=file, request_options=request_options)
+        return _response.data
+
+    async def get(
+        self, brand_id: str, id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> typing.AsyncIterator[bytes]:
+        """
+        Returns the Brand evidence file identified by the evidence ID.
+
+        Parameters
+        ----------
+        brand_id : str
+            The unique ID of the 10DLC Brand.
+
+        id : str
+            The unique ID of the Brand evidence file.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response.
+
+        Returns
+        -------
+        typing.AsyncIterator[bytes]
+            Returns the Brand evidence file.
+
+        Examples
+        --------
+        import asyncio
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.ten_dlc.brand_evidence.get(
+                brand_id="brand_id",
+                id="id",
+            )
+
+
+        asyncio.run(main())
+        """
+        async with self._raw_client.get(brand_id, id, request_options=request_options) as r:
+            async for _chunk in r.data:
+                yield _chunk
+
+    async def delete(
+        self, brand_id: str, id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> DeleteBrandEvidenceResponse:
+        """
+        Deletes the Brand evidence file identified by the evidence ID. Deletion is permanent.
+
+        Parameters
+        ----------
+        brand_id : str
+            The unique ID of the 10DLC Brand.
+
+        id : str
+            The unique ID of the Brand evidence file.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        DeleteBrandEvidenceResponse
+            Returns a success confirmation. The evidence file is deleted.
+
+        Examples
+        --------
+        import asyncio
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.ten_dlc.brand_evidence.delete(
+                brand_id="B6AI7PA",
+                id="191eb205-8357-4d71-b8da-160a25a000d7",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.delete(brand_id, id, request_options=request_options)
+        return _response.data