whitebit-python-sdk 1.1.0__py3-none-any.whl

whitebit/codes/client.py

@@ -0,0 +1,510 @@
+# 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 AsyncRawCodesClient, RawCodesClient
+from .types.apply_code_response import ApplyCodeResponse
+from .types.create_code_response import CreateCodeResponse
+from .types.get_codes_history_response import GetCodesHistoryResponse
+from .types.get_my_codes_response import GetMyCodesResponse
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class CodesClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawCodesClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawCodesClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawCodesClient
+        """
+        return self._raw_client
+
+    def create_code(
+        self,
+        *,
+        ticker: str,
+        amount: str,
+        request: str,
+        nonce: str,
+        passphrase: typing.Optional[str] = OMIT,
+        description: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> CreateCodeResponse:
+        """
+        The endpoint creates [WhiteBIT code](/glossary#whitebit-codes).
+
+        <Warning>
+        Rate limit: 1000 requests/10 sec.
+        </Warning>
+
+        <Note>
+        The API does not cache the response.
+        </Note>
+
+        Parameters
+        ----------
+        ticker : str
+            Currency's [ticker](/glossary#ticker). Example: BTC
+
+        amount : str
+            Amount to transfer. Max [precision](/glossary#precision) = 8, value must be greater than zero and less than or equal to the [main balance](/glossary#balance-main).
+
+        request : str
+            Request signature
+
+        nonce : str
+            Unique request identifier
+
+        passphrase : typing.Optional[str]
+            Passphrase for applying [WhiteBIT codes](/glossary#whitebit-codes). Passphrase must contain only latin letters, numbers and symbols (like !@#$%^, no whitespaces). Max: 25 symbols.
+
+        description : typing.Optional[str]
+            Additional text description for [code](/glossary#whitebit-codes). Visible only for creator. Max: 75 symbols.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreateCodeResponse
+            All validations succeeded and creating transaction is started
+
+        Examples
+        --------
+        from whitebit import WhitebitApi
+        client = WhitebitApi(api_key="YOUR_API_KEY", )
+        client.codes.create_code(ticker='ETH', amount='0.002', passphrase='some passphrase', description='some description', request='{{request}}', nonce='{{nonce}}', )
+        """
+        _response = self._raw_client.create_code(
+            ticker=ticker,
+            amount=amount,
+            request=request,
+            nonce=nonce,
+            passphrase=passphrase,
+            description=description,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def apply_code(
+        self,
+        *,
+        code: str,
+        request: str,
+        nonce: str,
+        passphrase: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ApplyCodeResponse:
+        """
+        The endpoint applies [WhiteBIT code](/glossary#whitebit-codes).
+
+        <Warning>
+        Rate limit: 60 requests/1 sec.
+        </Warning>
+
+        <Note>
+        The API does not cache the response.
+        </Note>
+
+        Parameters
+        ----------
+        code : str
+            [Code](/glossary#whitebit-codes) that will be applied.
+
+        request : str
+            Request signature
+
+        nonce : str
+            Unique request identifier
+
+        passphrase : typing.Optional[str]
+            Should be provided if the [code](/glossary#whitebit-codes) was created with passphrase. Max: 25 symbols.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ApplyCodeResponse
+            All validations succeeded and creating transaction is started
+
+        Examples
+        --------
+        from whitebit import WhitebitApi
+        client = WhitebitApi(api_key="YOUR_API_KEY", )
+        client.codes.apply_code(code='WBe11f4fce-2a53-4edc-b195-66b693bd77e3ETH', passphrase='some passphrase', request='{{request}}', nonce='{{nonce}}', )
+        """
+        _response = self._raw_client.apply_code(
+            code=code, request=request, nonce=nonce, passphrase=passphrase, request_options=request_options
+        )
+        return _response.data
+
+    def get_my_codes(
+        self,
+        *,
+        request: str,
+        nonce: str,
+        limit: typing.Optional[int] = OMIT,
+        offset: typing.Optional[int] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GetMyCodesResponse:
+        """
+        The endpoint retrieves the list of [WhiteBIT codes](/glossary#whitebit-codes) created by my account.
+
+        <Warning>
+        Rate limit: 1000 requests/10 sec.
+        </Warning>
+
+        <Note>
+        The API does not cache the response.
+        </Note>
+
+        Parameters
+        ----------
+        request : str
+            Request signature
+
+        nonce : str
+            Unique request identifier
+
+        limit : typing.Optional[int]
+            LIMIT is a special clause used to limit records a particular query can return.
+
+        offset : typing.Optional[int]
+            Use the OFFSET clause to return entries starting from a particular line.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetMyCodesResponse
+            All validations succeeded and creating transaction is started
+
+        Examples
+        --------
+        from whitebit import WhitebitApi
+        client = WhitebitApi(api_key="YOUR_API_KEY", )
+        client.codes.get_my_codes(request='{{request}}', nonce='{{nonce}}', )
+        """
+        _response = self._raw_client.get_my_codes(
+            request=request, nonce=nonce, limit=limit, offset=offset, request_options=request_options
+        )
+        return _response.data
+
+    def get_codes_history(
+        self,
+        *,
+        request: str,
+        nonce: str,
+        limit: typing.Optional[int] = OMIT,
+        offset: typing.Optional[int] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GetCodesHistoryResponse:
+        """
+        The endpoint retrieves the whole [codes](/glossary#whitebit-codes) history for the account.
+
+        <Warning>
+        Rate limit: 1000 requests/10 sec.
+        </Warning>
+
+        <Note>
+        The API does not cache the response.
+        </Note>
+
+        Parameters
+        ----------
+        request : str
+            Request signature
+
+        nonce : str
+            Unique request identifier
+
+        limit : typing.Optional[int]
+            LIMIT is a special clause used to limit records a particular query can return.
+
+        offset : typing.Optional[int]
+            Use the OFFSET clause to return entries starting from a particular line.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetCodesHistoryResponse
+            All validations succeeded and creating transaction is started
+
+        Examples
+        --------
+        from whitebit import WhitebitApi
+        client = WhitebitApi(api_key="YOUR_API_KEY", )
+        client.codes.get_codes_history(request='{{request}}', nonce='{{nonce}}', )
+        """
+        _response = self._raw_client.get_codes_history(
+            request=request, nonce=nonce, limit=limit, offset=offset, request_options=request_options
+        )
+        return _response.data
+
+
+class AsyncCodesClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawCodesClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawCodesClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawCodesClient
+        """
+        return self._raw_client
+
+    async def create_code(
+        self,
+        *,
+        ticker: str,
+        amount: str,
+        request: str,
+        nonce: str,
+        passphrase: typing.Optional[str] = OMIT,
+        description: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> CreateCodeResponse:
+        """
+        The endpoint creates [WhiteBIT code](/glossary#whitebit-codes).
+
+        <Warning>
+        Rate limit: 1000 requests/10 sec.
+        </Warning>
+
+        <Note>
+        The API does not cache the response.
+        </Note>
+
+        Parameters
+        ----------
+        ticker : str
+            Currency's [ticker](/glossary#ticker). Example: BTC
+
+        amount : str
+            Amount to transfer. Max [precision](/glossary#precision) = 8, value must be greater than zero and less than or equal to the [main balance](/glossary#balance-main).
+
+        request : str
+            Request signature
+
+        nonce : str
+            Unique request identifier
+
+        passphrase : typing.Optional[str]
+            Passphrase for applying [WhiteBIT codes](/glossary#whitebit-codes). Passphrase must contain only latin letters, numbers and symbols (like !@#$%^, no whitespaces). Max: 25 symbols.
+
+        description : typing.Optional[str]
+            Additional text description for [code](/glossary#whitebit-codes). Visible only for creator. Max: 75 symbols.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreateCodeResponse
+            All validations succeeded and creating transaction is started
+
+        Examples
+        --------
+        from whitebit import AsyncWhitebitApi
+        import asyncio
+        client = AsyncWhitebitApi(api_key="YOUR_API_KEY", )
+        async def main() -> None:
+            await client.codes.create_code(ticker='ETH', amount='0.002', passphrase='some passphrase', description='some description', request='{{request}}', nonce='{{nonce}}', )
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.create_code(
+            ticker=ticker,
+            amount=amount,
+            request=request,
+            nonce=nonce,
+            passphrase=passphrase,
+            description=description,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def apply_code(
+        self,
+        *,
+        code: str,
+        request: str,
+        nonce: str,
+        passphrase: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ApplyCodeResponse:
+        """
+        The endpoint applies [WhiteBIT code](/glossary#whitebit-codes).
+
+        <Warning>
+        Rate limit: 60 requests/1 sec.
+        </Warning>
+
+        <Note>
+        The API does not cache the response.
+        </Note>
+
+        Parameters
+        ----------
+        code : str
+            [Code](/glossary#whitebit-codes) that will be applied.
+
+        request : str
+            Request signature
+
+        nonce : str
+            Unique request identifier
+
+        passphrase : typing.Optional[str]
+            Should be provided if the [code](/glossary#whitebit-codes) was created with passphrase. Max: 25 symbols.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ApplyCodeResponse
+            All validations succeeded and creating transaction is started
+
+        Examples
+        --------
+        from whitebit import AsyncWhitebitApi
+        import asyncio
+        client = AsyncWhitebitApi(api_key="YOUR_API_KEY", )
+        async def main() -> None:
+            await client.codes.apply_code(code='WBe11f4fce-2a53-4edc-b195-66b693bd77e3ETH', passphrase='some passphrase', request='{{request}}', nonce='{{nonce}}', )
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.apply_code(
+            code=code, request=request, nonce=nonce, passphrase=passphrase, request_options=request_options
+        )
+        return _response.data
+
+    async def get_my_codes(
+        self,
+        *,
+        request: str,
+        nonce: str,
+        limit: typing.Optional[int] = OMIT,
+        offset: typing.Optional[int] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GetMyCodesResponse:
+        """
+        The endpoint retrieves the list of [WhiteBIT codes](/glossary#whitebit-codes) created by my account.
+
+        <Warning>
+        Rate limit: 1000 requests/10 sec.
+        </Warning>
+
+        <Note>
+        The API does not cache the response.
+        </Note>
+
+        Parameters
+        ----------
+        request : str
+            Request signature
+
+        nonce : str
+            Unique request identifier
+
+        limit : typing.Optional[int]
+            LIMIT is a special clause used to limit records a particular query can return.
+
+        offset : typing.Optional[int]
+            Use the OFFSET clause to return entries starting from a particular line.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetMyCodesResponse
+            All validations succeeded and creating transaction is started
+
+        Examples
+        --------
+        from whitebit import AsyncWhitebitApi
+        import asyncio
+        client = AsyncWhitebitApi(api_key="YOUR_API_KEY", )
+        async def main() -> None:
+            await client.codes.get_my_codes(request='{{request}}', nonce='{{nonce}}', )
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_my_codes(
+            request=request, nonce=nonce, limit=limit, offset=offset, request_options=request_options
+        )
+        return _response.data
+
+    async def get_codes_history(
+        self,
+        *,
+        request: str,
+        nonce: str,
+        limit: typing.Optional[int] = OMIT,
+        offset: typing.Optional[int] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GetCodesHistoryResponse:
+        """
+        The endpoint retrieves the whole [codes](/glossary#whitebit-codes) history for the account.
+
+        <Warning>
+        Rate limit: 1000 requests/10 sec.
+        </Warning>
+
+        <Note>
+        The API does not cache the response.
+        </Note>
+
+        Parameters
+        ----------
+        request : str
+            Request signature
+
+        nonce : str
+            Unique request identifier
+
+        limit : typing.Optional[int]
+            LIMIT is a special clause used to limit records a particular query can return.
+
+        offset : typing.Optional[int]
+            Use the OFFSET clause to return entries starting from a particular line.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetCodesHistoryResponse
+            All validations succeeded and creating transaction is started
+
+        Examples
+        --------
+        from whitebit import AsyncWhitebitApi
+        import asyncio
+        client = AsyncWhitebitApi(api_key="YOUR_API_KEY", )
+        async def main() -> None:
+            await client.codes.get_codes_history(request='{{request}}', nonce='{{nonce}}', )
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_codes_history(
+            request=request, nonce=nonce, limit=limit, offset=offset, request_options=request_options
+        )
+        return _response.data