|
| 1 | +import json |
| 2 | +from sinch.core.enums import HTTPAuthentication, HTTPMethods |
| 3 | +from sinch.core.models.http_response import HTTPResponse |
| 4 | +from sinch.domains.numbers.models.v1 import ( |
| 5 | + AvailableNumber, CheckNumberAvailabilityResponse, ListAvailableNumbersResponse, |
| 6 | + RentAnyNumberResponse) |
| 7 | +from sinch.domains.numbers.models.v1.active_number import ActiveNumber |
| 8 | + |
| 9 | +from sinch.domains.numbers.numbers_endpoint import NumbersEndpoint |
| 10 | +from sinch.domains.numbers.exceptions import NumberNotFoundException, NumbersException |
| 11 | +from sinch.domains.numbers.models.v1.internal import ( |
| 12 | + ActivateNumberRequest, CheckNumberAvailabilityRequest, ListAvailableNumbersRequest, RentAnyNumberRequest |
| 13 | +) |
| 14 | + |
| 15 | + |
| 16 | +class ActivateNumberEndpoint(NumbersEndpoint): |
| 17 | + """ |
| 18 | + Endpoint to activate a virtual number for a project. |
| 19 | + """ |
| 20 | + ENDPOINT_URL = "{origin}/v1/projects/{project_id}/availableNumbers/{phone_number}:rent" |
| 21 | + HTTP_METHOD = HTTPMethods.POST.value |
| 22 | + HTTP_AUTHENTICATION = HTTPAuthentication.OAUTH.value |
| 23 | + |
| 24 | + def __init__(self, project_id: str, request_data: ActivateNumberRequest): |
| 25 | + super(ActivateNumberEndpoint, self).__init__(project_id, request_data) |
| 26 | + |
| 27 | + def request_body(self) -> str: |
| 28 | + # Convert the request data to a dictionary and remove None values |
| 29 | + request_data = self.request_data.model_dump(by_alias=True, exclude_none=True) |
| 30 | + return json.dumps(request_data) |
| 31 | + |
| 32 | + def handle_response(self, response: HTTPResponse) -> ActiveNumber: |
| 33 | + try: |
| 34 | + super(ActivateNumberEndpoint, self).handle_response(response) |
| 35 | + except NumbersException as ex: |
| 36 | + raise NumberNotFoundException(message=ex.args[0], response=ex.http_response, |
| 37 | + is_from_server=ex.is_from_server) |
| 38 | + return self.process_response_model(response.body, ActiveNumber) |
| 39 | + |
| 40 | + |
| 41 | +class AvailableNumbersEndpoint(NumbersEndpoint): |
| 42 | + """ |
| 43 | + Endpoint to list available virtual numbers for a project. |
| 44 | + """ |
| 45 | + ENDPOINT_URL = "{origin}/v1/projects/{project_id}/availableNumbers" |
| 46 | + HTTP_METHOD = HTTPMethods.GET.value |
| 47 | + HTTP_AUTHENTICATION = HTTPAuthentication.OAUTH.value |
| 48 | + |
| 49 | + def __init__(self, project_id: str, request_data: ListAvailableNumbersRequest): |
| 50 | + super(AvailableNumbersEndpoint, self).__init__(project_id, request_data) |
| 51 | + self.request_data = request_data |
| 52 | + |
| 53 | + def build_query_params(self) -> dict: |
| 54 | + return self.request_data.model_dump(exclude_none=True, by_alias=True) |
| 55 | + |
| 56 | + def handle_response(self, response: HTTPResponse) -> list[AvailableNumber]: |
| 57 | + """ |
| 58 | + Processes the API response and maps it to a response model. |
| 59 | +
|
| 60 | + Args: |
| 61 | + response (HTTPResponse): The raw HTTP response object received from the API. |
| 62 | +
|
| 63 | + Returns: |
| 64 | + list[AvailableNumber]: The response model containing the parsed response data. |
| 65 | + """ |
| 66 | + super(AvailableNumbersEndpoint, self).handle_response(response) |
| 67 | + response = self.process_response_model(response.body, ListAvailableNumbersResponse) |
| 68 | + return response.available_numbers |
| 69 | + |
| 70 | + |
| 71 | +class RentAnyNumberEndpoint(NumbersEndpoint): |
| 72 | + """ |
| 73 | + Endpoint to rent an available virtual number for a project. |
| 74 | + """ |
| 75 | + ENDPOINT_URL = "{origin}/v1/projects/{project_id}/availableNumbers:rentAny" |
| 76 | + HTTP_METHOD = HTTPMethods.POST.value |
| 77 | + HTTP_AUTHENTICATION = HTTPAuthentication.OAUTH.value |
| 78 | + |
| 79 | + def __init__(self, project_id: str, request_data: RentAnyNumberRequest): |
| 80 | + super(RentAnyNumberEndpoint, self).__init__(project_id, request_data) |
| 81 | + self.request_data = request_data |
| 82 | + |
| 83 | + def request_body(self) -> str: |
| 84 | + request_data = self.request_data.model_dump(by_alias=True, exclude_none=True) |
| 85 | + return json.dumps(request_data) |
| 86 | + |
| 87 | + def handle_response(self, response: HTTPResponse) -> RentAnyNumberResponse: |
| 88 | + """ |
| 89 | + Handles the response from the API call. |
| 90 | +
|
| 91 | + Args: |
| 92 | + response (HTTPResponse): The response object from the API call. |
| 93 | +
|
| 94 | + Returns: |
| 95 | + RentAnyNumberResponse: The response data mapped to the RentAnyNumberResponse model. |
| 96 | + """ |
| 97 | + error = super(RentAnyNumberEndpoint, self).handle_response(response) |
| 98 | + if error: |
| 99 | + return error |
| 100 | + return self.process_response_model(response.body, RentAnyNumberResponse) |
| 101 | + |
| 102 | + |
| 103 | +class SearchForNumberEndpoint(NumbersEndpoint): |
| 104 | + """ |
| 105 | + Endpoint to check the availability of a virtual number for a project. |
| 106 | + """ |
| 107 | + ENDPOINT_URL = "{origin}/v1/projects/{project_id}/availableNumbers/{phone_number}" |
| 108 | + HTTP_METHOD = HTTPMethods.GET.value |
| 109 | + HTTP_AUTHENTICATION = HTTPAuthentication.OAUTH.value |
| 110 | + |
| 111 | + def __init__(self, project_id: str, request_data: CheckNumberAvailabilityRequest): |
| 112 | + super(SearchForNumberEndpoint, self).__init__(project_id, request_data) |
| 113 | + |
| 114 | + def handle_response(self, response: HTTPResponse) -> CheckNumberAvailabilityResponse: |
| 115 | + """ |
| 116 | + Processes the API response and maps it to a response |
| 117 | +
|
| 118 | + Args: |
| 119 | + response (HTTPResponse): The raw HTTP response object received from the API. |
| 120 | +
|
| 121 | + Returns: |
| 122 | + CheckNumberAvailabilityResponse: The response model containing the parsed response data |
| 123 | + of the requested phone number. |
| 124 | + """ |
| 125 | + try: |
| 126 | + super(SearchForNumberEndpoint, self).handle_response(response) |
| 127 | + except NumbersException as e: |
| 128 | + raise NumberNotFoundException(message=e.args[0], response=e.http_response, is_from_server=e.is_from_server) |
| 129 | + return self.process_response_model(response.body, CheckNumberAvailabilityResponse) |
0 commit comments