src.credential_configurations.credential_configurations_client_port

 1"""Client port for credential configurations operations."""
 2
 3from abc import ABC, abstractmethod
 4
 5from .models import CredentialConfiguration
 6
 7
 8class CredentialConfigurationNotFound(Exception):
 9    """Error raised when a credential configuration is not found."""
10
11
12class CredentialConfigurationsClientError(Exception):
13    """Error raised when credential configurations client operations fail."""
14
15
16class CredentialConfigurationsClientPort(ABC):
17    """Client port: Operations for credential configurations."""
18
19    @abstractmethod
20    def create(self, configuration: CredentialConfiguration) -> CredentialConfiguration:
21        """Create a new credential configuration.
22
23        Args:
24            configuration: The credential configuration to create.
25
26        Returns:
27            The created credential configuration.
28
29        Raises:
30            CredentialConfigurationsClientError: When creation fails.
31        """
32        ...
33
34    @abstractmethod
35    def get(self, configuration_id: str) -> CredentialConfiguration:
36        """Retrieve a credential configuration by ID.
37
38        Args:
39            configuration_id: The unique credential configuration identifier.
40
41        Returns:
42            The matching CredentialConfiguration.
43
44        Raises:
45            CredentialConfigurationNotFound: When not found.
46            CredentialConfigurationsClientError: When retrieval fails.
47        """
48        ...
49
50    @abstractmethod
51    def list(self) -> list[CredentialConfiguration]:
52        """List all credential configurations.
53
54        Returns:
55            A list of all credential configurations.
56
57        Raises:
58            CredentialConfigurationsClientError: When listing fails.
59        """
60        ...
61
62    @abstractmethod
63    def update(self, configuration: CredentialConfiguration) -> CredentialConfiguration:
64        """Update an existing credential configuration.
65
66        Args:
67            configuration: The credential configuration to update.
68
69        Returns:
70            The updated credential configuration.
71
72        Raises:
73            CredentialConfigurationNotFound: When not found.
74            CredentialConfigurationsClientError: When update fails.
75        """
76        ...
77
78    @abstractmethod
79    def delete(self, configuration_id: str) -> None:
80        """Delete a credential configuration.
81
82        Args:
83            configuration_id: The unique credential configuration identifier.
84
85        Raises:
86            CredentialConfigurationNotFound: When not found.
87            CredentialConfigurationsClientError: When deletion fails.
88        """
89        ...