|
| 1 | +from logging import getLogger |
| 2 | + |
| 3 | +from pydantic import validate_call |
| 4 | +from vonage_http_client.http_client import HttpClient |
| 5 | + |
| 6 | +from .errors import IdentityInsightsError |
| 7 | +from .requests import IdentityInsightsRequest |
| 8 | +from .responses import IdentityInsightsResponse |
| 9 | + |
| 10 | +logger = getLogger("vonage_identity_insights") |
| 11 | + |
| 12 | + |
| 13 | +class IdentityInsights: |
| 14 | + """Calls Vonage's Identity Insights API.""" |
| 15 | + |
| 16 | + def __init__(self, http_client: HttpClient) -> None: |
| 17 | + """Initialize the IdentityInsights client. |
| 18 | +
|
| 19 | + Args: |
| 20 | + http_client (HttpClient): Configured HTTP client used to make |
| 21 | + authenticated requests to the Vonage API. |
| 22 | + """ |
| 23 | + self._http_client = http_client |
| 24 | + self._auth_type = "jwt" |
| 25 | + |
| 26 | + @property |
| 27 | + def http_client(self) -> HttpClient: |
| 28 | + """The HTTP client used to make requests to the Vonage Indentity Insights API. |
| 29 | +
|
| 30 | + Returns: |
| 31 | + HttpClient: The HTTP client used to make requests to the Identity Insights API. |
| 32 | + """ |
| 33 | + return self._http_client |
| 34 | + |
| 35 | + @validate_call |
| 36 | + def get_insights( |
| 37 | + self, insights_request: IdentityInsightsRequest |
| 38 | + ) -> IdentityInsightsResponse: |
| 39 | + """Retrieve identity insights for a phone number. |
| 40 | +
|
| 41 | + Sends an aggregated request to the Identity Insights API and returns |
| 42 | + the results for each requested insight. |
| 43 | +
|
| 44 | + Args: |
| 45 | + insights_request (IdentityInsightsRequest): The request object |
| 46 | + containing the phone number and the set of identity insights |
| 47 | + to retrieve. |
| 48 | +
|
| 49 | + Returns: |
| 50 | + IdentityInsightsResponse: The response object containing the results |
| 51 | + and status of each requested insight. |
| 52 | +
|
| 53 | + Raises: |
| 54 | + IdentityInsightsError: If the API returns an error response in |
| 55 | + `application/problem+json` format. |
| 56 | + """ |
| 57 | + payload = insights_request.model_dump(exclude_none=True) |
| 58 | + |
| 59 | + response = self._http_client.post( |
| 60 | + self._http_client.api_host, |
| 61 | + "/v0.1/identity-insights", |
| 62 | + payload, |
| 63 | + auth_type=self._auth_type, |
| 64 | + ) |
| 65 | + self._check_for_error(response) |
| 66 | + |
| 67 | + return IdentityInsightsResponse(**response) |
| 68 | + |
| 69 | + def _check_for_error(self, response: dict) -> None: |
| 70 | + """Check whether the API response represents an error. |
| 71 | +
|
| 72 | + The Identity Insights API returns errors using the |
| 73 | + `application/problem+json` format. If such an error is detected, this |
| 74 | + method raises an IdentityInsightsError. |
| 75 | +
|
| 76 | + Args: |
| 77 | + response (dict): Raw response returned by the HTTP client. |
| 78 | +
|
| 79 | + Raises: |
| 80 | + IdentityInsightsError: If the response contains an error payload. |
| 81 | + """ |
| 82 | + if "title" in response and "detail" in response: |
| 83 | + error_message = f"Error with the following details: {response}" |
| 84 | + raise IdentityInsightsError(error_message) |
0 commit comments