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

dfns_sdk/generated/networks/types.py

@@ -0,0 +1,77 @@
+"""Types for the networks domain."""
+
+from typing import Any, Literal, NotRequired, Optional, TypedDict, Union
+
+class EstimateFeesQuery(TypedDict, total=False):
+    """estimateFees query parameters."""
+
+    network: Literal["Bitcoin", "BitcoinSignet", "BitcoinTestnet3", "Adi", "AdiTestnet", "AdiTestnetAb", "ArbitrumOne", "ArbitrumGoerli", "ArbitrumSepolia", "ArcTestnet", "AvalancheC", "AvalancheCFuji", "Base", "BaseGoerli", "BaseSepolia", "Bob", "BobSepolia", "Bsc", "BscTestnet", "Berachain", "BerachainBArtio", "BerachainBepolia", "Celo", "CeloAlfajores", "Codex", "CodexSepolia", "Ethereum", "EthereumClassic", "EthereumClassicMordor", "EthereumGoerli", "EthereumSepolia", "EthereumHolesky", "EthereumHoodi", "FantomOpera", "FantomTestnet", "FlareC", "FlareCCoston2", "FlowEvm", "FlowEvmTestnet", "Ink", "InkSepolia", "Optimism", "OptimismGoerli", "OptimismSepolia", "Plasma", "PlasmaTestnet", "Plume", "PlumeSepolia", "Polygon", "PolygonAmoy", "PolygonMumbai", "Race", "RaceSepolia", "Sonic", "SonicTestnet", "TempoAndantino", "Tsc", "TscTestnet1"]
+
+class ReadContractResponse(TypedDict, total=False):
+    """readContract response."""
+
+    kind: Literal["Evm"]
+    data: str
+
+class GetCantonValidatorResponse(TypedDict, total=False):
+    """getCantonValidator response."""
+
+    id: str
+    org_id: str
+    network: Literal["Canton", "CantonDevnet", "CantonTestnet"]
+    name: NotRequired[str]
+    kind: Literal["Shared", "Custom"]
+    date_created: str
+    party_hint: str
+
+class UpdateCantonValidatorRequest(TypedDict, total=False):
+    """updateCantonValidator request body."""
+
+    name: NotRequired[str]
+    validator: NotRequired[TypedDict]
+    ledger: NotRequired[TypedDict]
+
+class UpdateCantonValidatorResponse(TypedDict, total=False):
+    """updateCantonValidator response."""
+
+    id: str
+    org_id: str
+    network: Literal["Canton", "CantonDevnet", "CantonTestnet"]
+    name: NotRequired[str]
+    kind: Literal["Shared", "Custom"]
+    date_created: str
+    party_hint: str
+
+class DeleteCantonValidatorResponse(TypedDict, total=False):
+    """deleteCantonValidator response."""
+
+    id: str
+    org_id: str
+    network: Literal["Canton", "CantonDevnet", "CantonTestnet"]
+    name: NotRequired[str]
+    kind: Literal["Shared", "Custom"]
+    date_created: str
+    party_hint: str
+
+class ListCantonValidatorsResponse(TypedDict, total=False):
+    """listCantonValidators response."""
+
+    items: list[TypedDict]
+    next_page_token: NotRequired[str]
+
+class ListCantonValidatorsQuery(TypedDict, total=False):
+    """listCantonValidators query parameters."""
+
+    limit: NotRequired[int]
+    pagination_token: NotRequired[str]
+
+class CreateCantonValidatorResponse(TypedDict, total=False):
+    """createCantonValidator response."""
+
+    id: str
+    org_id: str
+    network: Literal["Canton", "CantonDevnet", "CantonTestnet"]
+    name: NotRequired[str]
+    kind: Literal["Shared", "Custom"]
+    date_created: str
+    party_hint: str

dfns_sdk/generated/permissions/__init__.py

@@ -0,0 +1,7 @@
+"""Permissions domain module."""
+
+from .client import PermissionsClient
+from .delegated_client import DelegatedPermissionsClient
+from . import types
+
+__all__ = ["PermissionsClient", "DelegatedPermissionsClient", "types"]

dfns_sdk/generated/permissions/client.py

@@ -0,0 +1,185 @@
+"""Client for the permissions domain."""
+
+from typing import Any, Literal, Optional, TypedDict, Union
+
+from ..._internal import HttpClient
+from . import types as T
+
+
+class PermissionsClient:
+    """Client for permissions operations."""
+
+    def __init__(self, http_client: HttpClient):
+        self._http = http_client
+
+    def list_permission_assignments(self, permission_id: str) -> T.ListPermissionAssignmentsResponse:
+        """
+        List Permission Assignments.
+
+        Retrieves a list of permission assignments (success) or gives a reason why it's not possible (failure).
+
+        Args:
+        permission_id: Path parameter.
+
+        Returns:
+            T.ListPermissionAssignmentsResponse: The API response.
+        """
+        return self._http.request(
+            method="GET",
+            path="/permissions/{permissionId}/assignments",
+            path_params={"permissionId": permission_id},
+            query_params=None,
+            body=None,
+            requires_signature=False,
+        )
+
+    def assign_permission(self, permission_id: str, body: T.AssignPermissionRequest) -> T.AssignPermissionResponse:
+        """
+        Assign Permission.
+
+        Creates a permission that allows certain specified operations to be executed. 
+  
+  Response is either the permission object itself (success) or a reason why it was not possible to create the permission (failure).
+
+        Args:
+        permission_id: Path parameter.
+        body: Request body.
+
+        Returns:
+            T.AssignPermissionResponse: The API response.
+        """
+        return self._http.request(
+            method="POST",
+            path="/permissions/{permissionId}/assignments",
+            path_params={"permissionId": permission_id},
+            query_params=None,
+            body=body,
+            requires_signature=True,
+        )
+
+    def revoke_permission(self, permission_id: str, assignment_id: str, query: Optional[T.RevokePermissionQuery] = None) -> None:
+        """
+        Revoke Permission.
+
+        Revokes a permission assignment (success) or gives reason why it’s not possible (failure).
+
+        Args:
+        permission_id: Path parameter.
+        assignment_id: Path parameter.
+        query: Query parameters.
+        """
+        return self._http.request(
+            method="DELETE",
+            path="/permissions/{permissionId}/assignments/{assignmentId}",
+            path_params={"permissionId": permission_id, "assignmentId": assignment_id},
+            query_params=query,
+            body=None,
+            requires_signature=True,
+        )
+
+    def delete_permission(self, permission_id: str, body: T.DeletePermissionRequest) -> T.DeletePermissionResponse:
+        """
+        Delete Permission.
+
+        Delete a specific Permission.
+
+        Args:
+        permission_id: Path parameter.
+        body: Request body.
+
+        Returns:
+            T.DeletePermissionResponse: The API response.
+        """
+        return self._http.request(
+            method="PUT",
+            path="/permissions/{permissionId}/archive",
+            path_params={"permissionId": permission_id},
+            query_params=None,
+            body=body,
+            requires_signature=True,
+        )
+
+    def list_permissions(self, query: Optional[T.ListPermissionsQuery] = None) -> T.ListPermissionsResponse:
+        """
+        List Permissions.
+
+        Retrieves a list of permissions (success) or gives a reason why it's not possible (failure).
+
+        Args:
+        query: Query parameters.
+
+        Returns:
+            T.ListPermissionsResponse: The API response.
+        """
+        return self._http.request(
+            method="GET",
+            path="/permissions",
+            path_params={},
+            query_params=query,
+            body=None,
+            requires_signature=False,
+        )
+
+    def create_permission(self, body: T.CreatePermissionRequest) -> T.CreatePermissionResponse:
+        """
+        Create Permission.
+
+        Creates a permission that allows certain specified operations to be executed.
+
+        Args:
+        body: Request body.
+
+        Returns:
+            T.CreatePermissionResponse: The API response.
+        """
+        return self._http.request(
+            method="POST",
+            path="/permissions",
+            path_params={},
+            query_params=None,
+            body=body,
+            requires_signature=True,
+        )
+
+    def get_permission(self, permission_id: str) -> T.GetPermissionResponse:
+        """
+        Get Permission.
+
+        Retrieves a specific permission (success) or gives a reason why it's not possible (failure).
+
+        Args:
+        permission_id: Path parameter.
+
+        Returns:
+            T.GetPermissionResponse: The API response.
+        """
+        return self._http.request(
+            method="GET",
+            path="/permissions/{permissionId}",
+            path_params={"permissionId": permission_id},
+            query_params=None,
+            body=None,
+            requires_signature=False,
+        )
+
+    def update_permission(self, permission_id: str, body: T.UpdatePermissionRequest) -> T.UpdatePermissionResponse:
+        """
+        Update Permission.
+
+        Updates an existing permission. Response either returns the updated permission (success) or the reason why it was not possible to update (failure).
+
+        Args:
+        permission_id: Path parameter.
+        body: Request body.
+
+        Returns:
+            T.UpdatePermissionResponse: The API response.
+        """
+        return self._http.request(
+            method="PUT",
+            path="/permissions/{permissionId}",
+            path_params={"permissionId": permission_id},
+            query_params=None,
+            body=body,
+            requires_signature=True,
+        )

dfns_sdk/generated/permissions/delegated_client.py

@@ -0,0 +1,344 @@
+"""Delegated client for the permissions 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 DelegatedPermissionsClient:
+    """
+    Delegated client for permissions 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 list_permission_assignments(self, permission_id: str) -> T.ListPermissionAssignmentsResponse:
+        """
+        List Permission Assignments.
+
+        Retrieves a list of permission assignments (success) or gives a reason why it's not possible (failure).
+
+        Args:
+        permission_id: Path parameter.
+
+        Returns:
+            T.ListPermissionAssignmentsResponse: The API response.
+        """
+        return self._http.request(
+            method="GET",
+            path="/permissions/{permissionId}/assignments",
+            path_params={"permissionId": permission_id},
+            query_params=None,
+            body=None,
+            requires_signature=False,
+        )
+
+    def assign_permission_init(self, permission_id: str, body: T.AssignPermissionRequest) -> UserActionChallengeResponse:
+        """
+        Initialize Assign Permission.
+
+        Creates a user action challenge for external signing.
+
+        Args:
+        permission_id: Path parameter.
+        body: Request body.
+
+        Returns:
+            UserActionChallengeResponse: The challenge to sign externally.
+        """
+        path = "/permissions/{permissionId}/assignments"
+        path = path.replace("{permissionId}", str(permission_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 assign_permission_complete(self, permission_id: str, body: T.AssignPermissionRequest, signed_challenge: SignUserActionChallengeRequest) -> T.AssignPermissionResponse:
+        """
+        Complete Assign Permission.
+
+        Submits the signed challenge and makes the API request.
+
+        Args:
+        permission_id: Path parameter.
+        body: Request body.
+        signed_challenge: The signed challenge from external signing.
+
+        Returns:
+            T.AssignPermissionResponse: 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="/permissions/{permissionId}/assignments",
+            path_params={"permissionId": permission_id},
+            query_params=None,
+            body=body,
+            user_action=user_action_token,
+        )
+
+    def revoke_permission_init(self, permission_id: str, assignment_id: str, query: Optional[T.RevokePermissionQuery] = None) -> UserActionChallengeResponse:
+        """
+        Initialize Revoke Permission.
+
+        Creates a user action challenge for external signing.
+
+        Args:
+        permission_id: Path parameter.
+        assignment_id: Path parameter.
+        query: Query parameters.
+
+        Returns:
+            UserActionChallengeResponse: The challenge to sign externally.
+        """
+        path = "/permissions/{permissionId}/assignments/{assignmentId}"
+        path = path.replace("{permissionId}", str(permission_id))
+        path = path.replace("{assignmentId}", str(assignment_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 revoke_permission_complete(self, permission_id: str, assignment_id: str, signed_challenge: SignUserActionChallengeRequest, query: Optional[T.RevokePermissionQuery] = None) -> None:
+        """
+        Complete Revoke Permission.
+
+        Submits the signed challenge and makes the API request.
+
+        Args:
+        permission_id: Path parameter.
+        assignment_id: Path parameter.
+        signed_challenge: The signed challenge from external signing.
+        query: Query parameters.
+        """
+        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="/permissions/{permissionId}/assignments/{assignmentId}",
+            path_params={"permissionId": permission_id, "assignmentId": assignment_id},
+            query_params=query,
+            body=None,
+            user_action=user_action_token,
+        )
+
+    def delete_permission_init(self, permission_id: str, body: T.DeletePermissionRequest) -> UserActionChallengeResponse:
+        """
+        Initialize Delete Permission.
+
+        Creates a user action challenge for external signing.
+
+        Args:
+        permission_id: Path parameter.
+        body: Request body.
+
+        Returns:
+            UserActionChallengeResponse: The challenge to sign externally.
+        """
+        path = "/permissions/{permissionId}/archive"
+        path = path.replace("{permissionId}", str(permission_id))
+        payload = json.dumps(body, separators=(",", ":")) if body else ""
+
+        return BaseAuthApi.create_user_action_challenge(
+            self._http,
+            user_action_http_method="PUT",
+            user_action_http_path=path,
+            user_action_payload=payload,
+        )
+
+    def delete_permission_complete(self, permission_id: str, body: T.DeletePermissionRequest, signed_challenge: SignUserActionChallengeRequest) -> T.DeletePermissionResponse:
+        """
+        Complete Delete Permission.
+
+        Submits the signed challenge and makes the API request.
+
+        Args:
+        permission_id: Path parameter.
+        body: Request body.
+        signed_challenge: The signed challenge from external signing.
+
+        Returns:
+            T.DeletePermissionResponse: 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="PUT",
+            path="/permissions/{permissionId}/archive",
+            path_params={"permissionId": permission_id},
+            query_params=None,
+            body=body,
+            user_action=user_action_token,
+        )
+
+    def list_permissions(self, query: Optional[T.ListPermissionsQuery] = None) -> T.ListPermissionsResponse:
+        """
+        List Permissions.
+
+        Retrieves a list of permissions (success) or gives a reason why it's not possible (failure).
+
+        Args:
+        query: Query parameters.
+
+        Returns:
+            T.ListPermissionsResponse: The API response.
+        """
+        return self._http.request(
+            method="GET",
+            path="/permissions",
+            path_params={},
+            query_params=query,
+            body=None,
+            requires_signature=False,
+        )
+
+    def create_permission_init(self, body: T.CreatePermissionRequest) -> UserActionChallengeResponse:
+        """
+        Initialize Create Permission.
+
+        Creates a user action challenge for external signing.
+
+        Args:
+        body: Request body.
+
+        Returns:
+            UserActionChallengeResponse: The challenge to sign externally.
+        """
+        path = "/permissions"
+        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_permission_complete(self, body: T.CreatePermissionRequest, signed_challenge: SignUserActionChallengeRequest) -> T.CreatePermissionResponse:
+        """
+        Complete Create Permission.
+
+        Submits the signed challenge and makes the API request.
+
+        Args:
+        body: Request body.
+        signed_challenge: The signed challenge from external signing.
+
+        Returns:
+            T.CreatePermissionResponse: 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="/permissions",
+            path_params={},
+            query_params=None,
+            body=body,
+            user_action=user_action_token,
+        )
+
+    def get_permission(self, permission_id: str) -> T.GetPermissionResponse:
+        """
+        Get Permission.
+
+        Retrieves a specific permission (success) or gives a reason why it's not possible (failure).
+
+        Args:
+        permission_id: Path parameter.
+
+        Returns:
+            T.GetPermissionResponse: The API response.
+        """
+        return self._http.request(
+            method="GET",
+            path="/permissions/{permissionId}",
+            path_params={"permissionId": permission_id},
+            query_params=None,
+            body=None,
+            requires_signature=False,
+        )
+
+    def update_permission_init(self, permission_id: str, body: T.UpdatePermissionRequest) -> UserActionChallengeResponse:
+        """
+        Initialize Update Permission.
+
+        Creates a user action challenge for external signing.
+
+        Args:
+        permission_id: Path parameter.
+        body: Request body.
+
+        Returns:
+            UserActionChallengeResponse: The challenge to sign externally.
+        """
+        path = "/permissions/{permissionId}"
+        path = path.replace("{permissionId}", str(permission_id))
+        payload = json.dumps(body, separators=(",", ":")) if body else ""
+
+        return BaseAuthApi.create_user_action_challenge(
+            self._http,
+            user_action_http_method="PUT",
+            user_action_http_path=path,
+            user_action_payload=payload,
+        )
+
+    def update_permission_complete(self, permission_id: str, body: T.UpdatePermissionRequest, signed_challenge: SignUserActionChallengeRequest) -> T.UpdatePermissionResponse:
+        """
+        Complete Update Permission.
+
+        Submits the signed challenge and makes the API request.
+
+        Args:
+        permission_id: Path parameter.
+        body: Request body.
+        signed_challenge: The signed challenge from external signing.
+
+        Returns:
+            T.UpdatePermissionResponse: 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="PUT",
+            path="/permissions/{permissionId}",
+            path_params={"permissionId": permission_id},
+            query_params=None,
+            body=body,
+            user_action=user_action_token,
+        )