dfns-sdk 0.0.0.dev0__py3-none-any.whl

dfns_sdk/generated/exchanges/client.py

@@ -0,0 +1,209 @@
+"""Client for the exchanges domain."""
+
+from typing import Any, Literal, Optional, TypedDict, Union
+
+from ..._internal import HttpClient
+from . import types as T
+
+
+class ExchangesClient:
+    """Client for exchanges operations."""
+
+    def __init__(self, http_client: HttpClient):
+        self._http = http_client
+
+    def get_exchange(self, exchange_id: str) -> T.GetExchangeResponse:
+        """
+        Get Exchange.
+
+        Retrieve the details of a specific exchange integration configuration.
+
+        Args:
+        exchange_id: Path parameter.
+
+        Returns:
+            T.GetExchangeResponse: The API response.
+        """
+        return self._http.request(
+            method="GET",
+            path="/exchanges/{exchangeId}",
+            path_params={"exchangeId": exchange_id},
+            query_params=None,
+            body=None,
+            requires_signature=False,
+        )
+
+    def delete_exchange(self, exchange_id: str) -> T.DeleteExchangeResponse:
+        """
+        Delete Exchange.
+
+        Delete the exchange configuration from your organization.
+
+        Args:
+        exchange_id: Path parameter.
+
+        Returns:
+            T.DeleteExchangeResponse: The API response.
+        """
+        return self._http.request(
+            method="DELETE",
+            path="/exchanges/{exchangeId}",
+            path_params={"exchangeId": exchange_id},
+            query_params=None,
+            body=None,
+            requires_signature=True,
+        )
+
+    def list_exchanges(self, query: Optional[T.ListExchangesQuery] = None) -> T.ListExchangesResponse:
+        """
+        List Exchanges.
+
+        List all configured exchange integrations.
+
+        Args:
+        query: Query parameters.
+
+        Returns:
+            T.ListExchangesResponse: The API response.
+        """
+        return self._http.request(
+            method="GET",
+            path="/exchanges",
+            path_params={},
+            query_params=query,
+            body=None,
+            requires_signature=False,
+        )
+
+    def create_exchange(self, body: T.CreateExchangeRequest) -> T.CreateExchangeResponse:
+        """
+        Create Exchange.
+
+        Link your organization with a cryptocurrency exchange.
+
+        Args:
+        body: Request body.
+
+        Returns:
+            T.CreateExchangeResponse: The API response.
+        """
+        return self._http.request(
+            method="POST",
+            path="/exchanges",
+            path_params={},
+            query_params=None,
+            body=body,
+            requires_signature=True,
+        )
+
+    def list_accounts(self, exchange_id: str, query: Optional[T.ListAccountsQuery] = None) -> T.ListAccountsResponse:
+        """
+        List Accounts.
+
+        Get a list of accounts for a specific exchange.
+
+        Args:
+        exchange_id: Path parameter.
+        query: Query parameters.
+
+        Returns:
+            T.ListAccountsResponse: The API response.
+        """
+        return self._http.request(
+            method="GET",
+            path="/exchanges/{exchangeId}/accounts",
+            path_params={"exchangeId": exchange_id},
+            query_params=query,
+            body=None,
+            requires_signature=False,
+        )
+
+    def list_account_assets(self, exchange_id: str, account_id: str, query: Optional[T.ListAccountAssetsQuery] = None) -> T.ListAccountAssetsResponse:
+        """
+        List Account Assets.
+
+        Retrieve the list of assets for a specific account on a specific exchange.
+
+        Args:
+        exchange_id: Path parameter.
+        account_id: Path parameter.
+        query: Query parameters.
+
+        Returns:
+            T.ListAccountAssetsResponse: The API response.
+        """
+        return self._http.request(
+            method="GET",
+            path="/exchanges/{exchangeId}/accounts/{accountId}/assets",
+            path_params={"exchangeId": exchange_id, "accountId": account_id},
+            query_params=query,
+            body=None,
+            requires_signature=False,
+        )
+
+    def list_asset_withdrawal_networks(self, exchange_id: str, account_id: str, asset: str) -> list[TypedDict]:
+        """
+        List Asset Withdrawal Networks.
+
+        Args:
+        exchange_id: Path parameter.
+        account_id: Path parameter.
+        asset: Path parameter.
+
+        Returns:
+            list[TypedDict]: The API response.
+        """
+        return self._http.request(
+            method="GET",
+            path="/exchanges/{exchangeId}/accounts/{accountId}/assets/{asset}/withdrawal-networks",
+            path_params={"exchangeId": exchange_id, "accountId": account_id, "asset": asset},
+            query_params=None,
+            body=None,
+            requires_signature=False,
+        )
+
+    def create_exchange_deposit(self, exchange_id: str, account_id: str, body: dict[str, Any]) -> T.CreateExchangeDepositResponse:
+        """
+        Create Exchange Deposit.
+
+        Creates a new exchange deposit transaction.
+
+        Args:
+        exchange_id: The exchange id obtained from the Create Exchange endpoint. Ex: `ex-1f04s-lqc9q-xxxxxxxxxxxxxxxx`
+        account_id: Unique identifier for the account like "spot"
+        body: Request body.
+
+        Returns:
+            T.CreateExchangeDepositResponse: The API response.
+        """
+        return self._http.request(
+            method="POST",
+            path="/exchanges/{exchangeId}/accounts/{accountId}/deposits",
+            path_params={"exchangeId": exchange_id, "accountId": account_id},
+            query_params=None,
+            body=body,
+            requires_signature=True,
+        )
+
+    def create_exchange_withdrawal(self, exchange_id: str, account_id: str, body: dict[str, Any]) -> T.CreateExchangeWithdrawalResponse:
+        """
+        Create Exchange Withdrawal.
+
+        Creates a new exchange withdrawal transaction.
+
+        Args:
+        exchange_id: The exchange id obtained from the Create Exchange endpoint. Ex: `ex-1f04s-lqc9q-xxxxxxxxxxxxxxxx`
+        account_id: Unique identifier for the account like "spot"
+        body: Request body.
+
+        Returns:
+            T.CreateExchangeWithdrawalResponse: The API response.
+        """
+        return self._http.request(
+            method="POST",
+            path="/exchanges/{exchangeId}/accounts/{accountId}/withdrawals",
+            path_params={"exchangeId": exchange_id, "accountId": account_id},
+            query_params=None,
+            body=body,
+            requires_signature=True,
+        )

dfns_sdk/generated/exchanges/delegated_client.py

@@ -0,0 +1,341 @@
+"""Delegated client for the exchanges domain."""
+
+import json
+from typing import Any, Literal, Optional, TypedDict, Union
+
+from ..._internal import HttpClient
+from ...base_auth_api import (
+    BaseAuthApi,
+    SignUserActionChallengeRequest,
+    UserActionChallengeResponse,
+)
+from . import types as T
+
+
+class DelegatedExchangesClient:
+    """
+    Delegated client for exchanges operations.
+
+    This client separates user action signing into _init() and _complete() method pairs,
+    allowing external systems to handle the signing process.
+    """
+
+    def __init__(self, http_client: HttpClient):
+        self._http = http_client
+
+    def get_exchange(self, exchange_id: str) -> T.GetExchangeResponse:
+        """
+        Get Exchange.
+
+        Retrieve the details of a specific exchange integration configuration.
+
+        Args:
+        exchange_id: Path parameter.
+
+        Returns:
+            T.GetExchangeResponse: The API response.
+        """
+        return self._http.request(
+            method="GET",
+            path="/exchanges/{exchangeId}",
+            path_params={"exchangeId": exchange_id},
+            query_params=None,
+            body=None,
+            requires_signature=False,
+        )
+
+    def delete_exchange_init(self, exchange_id: str) -> UserActionChallengeResponse:
+        """
+        Initialize Delete Exchange.
+
+        Creates a user action challenge for external signing.
+
+        Args:
+        exchange_id: Path parameter.
+
+        Returns:
+            UserActionChallengeResponse: The challenge to sign externally.
+        """
+        path = "/exchanges/{exchangeId}"
+        path = path.replace("{exchangeId}", str(exchange_id))
+        payload = ""
+
+        return BaseAuthApi.create_user_action_challenge(
+            self._http,
+            user_action_http_method="DELETE",
+            user_action_http_path=path,
+            user_action_payload=payload,
+        )
+
+    def delete_exchange_complete(self, exchange_id: str, signed_challenge: SignUserActionChallengeRequest) -> T.DeleteExchangeResponse:
+        """
+        Complete Delete Exchange.
+
+        Submits the signed challenge and makes the API request.
+
+        Args:
+        exchange_id: Path parameter.
+        signed_challenge: The signed challenge from external signing.
+
+        Returns:
+            T.DeleteExchangeResponse: The API response.
+        """
+        user_action_result = BaseAuthApi.sign_user_action_challenge(
+            self._http, signed_challenge
+        )
+        user_action_token = user_action_result["userAction"]
+
+        return self._http.request_with_user_action(
+            method="DELETE",
+            path="/exchanges/{exchangeId}",
+            path_params={"exchangeId": exchange_id},
+            query_params=None,
+            body=None,
+            user_action=user_action_token,
+        )
+
+    def list_exchanges(self, query: Optional[T.ListExchangesQuery] = None) -> T.ListExchangesResponse:
+        """
+        List Exchanges.
+
+        List all configured exchange integrations.
+
+        Args:
+        query: Query parameters.
+
+        Returns:
+            T.ListExchangesResponse: The API response.
+        """
+        return self._http.request(
+            method="GET",
+            path="/exchanges",
+            path_params={},
+            query_params=query,
+            body=None,
+            requires_signature=False,
+        )
+
+    def create_exchange_init(self, body: T.CreateExchangeRequest) -> UserActionChallengeResponse:
+        """
+        Initialize Create Exchange.
+
+        Creates a user action challenge for external signing.
+
+        Args:
+        body: Request body.
+
+        Returns:
+            UserActionChallengeResponse: The challenge to sign externally.
+        """
+        path = "/exchanges"
+        payload = json.dumps(body, separators=(",", ":")) if body else ""
+
+        return BaseAuthApi.create_user_action_challenge(
+            self._http,
+            user_action_http_method="POST",
+            user_action_http_path=path,
+            user_action_payload=payload,
+        )
+
+    def create_exchange_complete(self, body: T.CreateExchangeRequest, signed_challenge: SignUserActionChallengeRequest) -> T.CreateExchangeResponse:
+        """
+        Complete Create Exchange.
+
+        Submits the signed challenge and makes the API request.
+
+        Args:
+        body: Request body.
+        signed_challenge: The signed challenge from external signing.
+
+        Returns:
+            T.CreateExchangeResponse: The API response.
+        """
+        user_action_result = BaseAuthApi.sign_user_action_challenge(
+            self._http, signed_challenge
+        )
+        user_action_token = user_action_result["userAction"]
+
+        return self._http.request_with_user_action(
+            method="POST",
+            path="/exchanges",
+            path_params={},
+            query_params=None,
+            body=body,
+            user_action=user_action_token,
+        )
+
+    def list_accounts(self, exchange_id: str, query: Optional[T.ListAccountsQuery] = None) -> T.ListAccountsResponse:
+        """
+        List Accounts.
+
+        Get a list of accounts for a specific exchange.
+
+        Args:
+        exchange_id: Path parameter.
+        query: Query parameters.
+
+        Returns:
+            T.ListAccountsResponse: The API response.
+        """
+        return self._http.request(
+            method="GET",
+            path="/exchanges/{exchangeId}/accounts",
+            path_params={"exchangeId": exchange_id},
+            query_params=query,
+            body=None,
+            requires_signature=False,
+        )
+
+    def list_account_assets(self, exchange_id: str, account_id: str, query: Optional[T.ListAccountAssetsQuery] = None) -> T.ListAccountAssetsResponse:
+        """
+        List Account Assets.
+
+        Retrieve the list of assets for a specific account on a specific exchange.
+
+        Args:
+        exchange_id: Path parameter.
+        account_id: Path parameter.
+        query: Query parameters.
+
+        Returns:
+            T.ListAccountAssetsResponse: The API response.
+        """
+        return self._http.request(
+            method="GET",
+            path="/exchanges/{exchangeId}/accounts/{accountId}/assets",
+            path_params={"exchangeId": exchange_id, "accountId": account_id},
+            query_params=query,
+            body=None,
+            requires_signature=False,
+        )
+
+    def list_asset_withdrawal_networks(self, exchange_id: str, account_id: str, asset: str) -> list[TypedDict]:
+        """
+        List Asset Withdrawal Networks.
+
+        Args:
+        exchange_id: Path parameter.
+        account_id: Path parameter.
+        asset: Path parameter.
+
+        Returns:
+            list[TypedDict]: The API response.
+        """
+        return self._http.request(
+            method="GET",
+            path="/exchanges/{exchangeId}/accounts/{accountId}/assets/{asset}/withdrawal-networks",
+            path_params={"exchangeId": exchange_id, "accountId": account_id, "asset": asset},
+            query_params=None,
+            body=None,
+            requires_signature=False,
+        )
+
+    def create_exchange_deposit_init(self, exchange_id: str, account_id: str, body: dict[str, Any]) -> UserActionChallengeResponse:
+        """
+        Initialize Create Exchange Deposit.
+
+        Creates a user action challenge for external signing.
+
+        Args:
+        exchange_id: The exchange id obtained from the Create Exchange endpoint. Ex: `ex-1f04s-lqc9q-xxxxxxxxxxxxxxxx`
+        account_id: Unique identifier for the account like "spot"
+        body: Request body.
+
+        Returns:
+            UserActionChallengeResponse: The challenge to sign externally.
+        """
+        path = "/exchanges/{exchangeId}/accounts/{accountId}/deposits"
+        path = path.replace("{exchangeId}", str(exchange_id))
+        path = path.replace("{accountId}", str(account_id))
+        payload = json.dumps(body, separators=(",", ":")) if body else ""
+
+        return BaseAuthApi.create_user_action_challenge(
+            self._http,
+            user_action_http_method="POST",
+            user_action_http_path=path,
+            user_action_payload=payload,
+        )
+
+    def create_exchange_deposit_complete(self, exchange_id: str, account_id: str, body: dict[str, Any], signed_challenge: SignUserActionChallengeRequest) -> T.CreateExchangeDepositResponse:
+        """
+        Complete Create Exchange Deposit.
+
+        Submits the signed challenge and makes the API request.
+
+        Args:
+        exchange_id: The exchange id obtained from the Create Exchange endpoint. Ex: `ex-1f04s-lqc9q-xxxxxxxxxxxxxxxx`
+        account_id: Unique identifier for the account like "spot"
+        body: Request body.
+        signed_challenge: The signed challenge from external signing.
+
+        Returns:
+            T.CreateExchangeDepositResponse: The API response.
+        """
+        user_action_result = BaseAuthApi.sign_user_action_challenge(
+            self._http, signed_challenge
+        )
+        user_action_token = user_action_result["userAction"]
+
+        return self._http.request_with_user_action(
+            method="POST",
+            path="/exchanges/{exchangeId}/accounts/{accountId}/deposits",
+            path_params={"exchangeId": exchange_id, "accountId": account_id},
+            query_params=None,
+            body=body,
+            user_action=user_action_token,
+        )
+
+    def create_exchange_withdrawal_init(self, exchange_id: str, account_id: str, body: dict[str, Any]) -> UserActionChallengeResponse:
+        """
+        Initialize Create Exchange Withdrawal.
+
+        Creates a user action challenge for external signing.
+
+        Args:
+        exchange_id: The exchange id obtained from the Create Exchange endpoint. Ex: `ex-1f04s-lqc9q-xxxxxxxxxxxxxxxx`
+        account_id: Unique identifier for the account like "spot"
+        body: Request body.
+
+        Returns:
+            UserActionChallengeResponse: The challenge to sign externally.
+        """
+        path = "/exchanges/{exchangeId}/accounts/{accountId}/withdrawals"
+        path = path.replace("{exchangeId}", str(exchange_id))
+        path = path.replace("{accountId}", str(account_id))
+        payload = json.dumps(body, separators=(",", ":")) if body else ""
+
+        return BaseAuthApi.create_user_action_challenge(
+            self._http,
+            user_action_http_method="POST",
+            user_action_http_path=path,
+            user_action_payload=payload,
+        )
+
+    def create_exchange_withdrawal_complete(self, exchange_id: str, account_id: str, body: dict[str, Any], signed_challenge: SignUserActionChallengeRequest) -> T.CreateExchangeWithdrawalResponse:
+        """
+        Complete Create Exchange Withdrawal.
+
+        Submits the signed challenge and makes the API request.
+
+        Args:
+        exchange_id: The exchange id obtained from the Create Exchange endpoint. Ex: `ex-1f04s-lqc9q-xxxxxxxxxxxxxxxx`
+        account_id: Unique identifier for the account like "spot"
+        body: Request body.
+        signed_challenge: The signed challenge from external signing.
+
+        Returns:
+            T.CreateExchangeWithdrawalResponse: The API response.
+        """
+        user_action_result = BaseAuthApi.sign_user_action_challenge(
+            self._http, signed_challenge
+        )
+        user_action_token = user_action_result["userAction"]
+
+        return self._http.request_with_user_action(
+            method="POST",
+            path="/exchanges/{exchangeId}/accounts/{accountId}/withdrawals",
+            path_params={"exchangeId": exchange_id, "accountId": account_id},
+            query_params=None,
+            body=body,
+            user_action=user_action_token,
+        )

dfns_sdk/generated/exchanges/types.py

@@ -0,0 +1,96 @@
+"""Types for the exchanges domain."""
+
+from typing import Any, Literal, NotRequired, Optional, TypedDict, Union
+
+class GetExchangeResponse(TypedDict, total=False):
+    """getExchange response."""
+
+    id: str
+    name: NotRequired[str]
+    kind: Literal["Binance", "Kraken", "CoinbaseApp", "CoinbasePrime"]
+    date_created: str
+
+class DeleteExchangeResponse(TypedDict, total=False):
+    """deleteExchange response."""
+
+    deleted: Literal[True]
+
+class ListExchangesResponse(TypedDict, total=False):
+    """listExchanges response."""
+
+    items: list[TypedDict]
+    next_page_token: NotRequired[str]
+
+class ListExchangesQuery(TypedDict, total=False):
+    """listExchanges query parameters."""
+
+    limit: NotRequired[int]
+    pagination_token: NotRequired[str]
+
+class CreateExchangeRequest(TypedDict, total=False):
+    """createExchange request body."""
+
+    name: NotRequired[str]
+    kind: Literal["Binance", "Kraken", "CoinbaseApp", "CoinbasePrime"]
+    read_configuration: TypedDict
+    write_configuration: TypedDict
+
+class CreateExchangeResponse(TypedDict, total=False):
+    """createExchange response."""
+
+    id: str
+    name: NotRequired[str]
+    kind: Literal["Binance", "Kraken", "CoinbaseApp", "CoinbasePrime"]
+    date_created: str
+
+class ListAccountsResponse(TypedDict, total=False):
+    """listAccounts response."""
+
+    items: list[TypedDict]
+    next_page_token: NotRequired[str]
+
+class ListAccountsQuery(TypedDict, total=False):
+    """listAccounts query parameters."""
+
+    limit: NotRequired[int]
+    pagination_token: NotRequired[str]
+
+class ListAccountAssetsResponse(TypedDict, total=False):
+    """listAccountAssets response."""
+
+    items: list[TypedDict]
+    next_page_token: NotRequired[str]
+
+class ListAccountAssetsQuery(TypedDict, total=False):
+    """listAccountAssets query parameters."""
+
+    limit: NotRequired[int]
+    pagination_token: NotRequired[str]
+
+class CreateExchangeDepositResponse(TypedDict, total=False):
+    """createExchangeDeposit response."""
+
+    id: str
+    exchange_id: str
+    account_id: str
+    transfer_id: NotRequired[str]
+    exchange_reference: NotRequired[str]
+    kind: Literal["Withdrawal", "Deposit"]
+    wallet_id: str
+    requester: TypedDict
+    request_body: TypedDict
+    date_created: str
+
+class CreateExchangeWithdrawalResponse(TypedDict, total=False):
+    """createExchangeWithdrawal response."""
+
+    id: str
+    exchange_id: str
+    account_id: str
+    transfer_id: NotRequired[str]
+    exchange_reference: NotRequired[str]
+    kind: Literal["Withdrawal", "Deposit"]
+    wallet_id: str
+    requester: TypedDict
+    request_body: TypedDict
+    date_created: str

dfns_sdk/generated/fee_sponsors/__init__.py

@@ -0,0 +1,7 @@
+"""FeeSponsors domain module."""
+
+from .client import FeeSponsorsClient
+from .delegated_client import DelegatedFeeSponsorsClient
+from . import types
+
+__all__ = ["FeeSponsorsClient", "DelegatedFeeSponsorsClient", "types"]