chore: remove Pydantic model

Author: matsk-sinch

sinch/domains/numbers/available_numbers.py

@@ -10,10 +10,10 @@
     ActivateNumberRequest, CheckNumberAvailabilityRequest, ListAvailableNumbersRequest, RentAnyNumberRequest
 )
 from sinch.domains.numbers.models.available import (
-    ActivateNumberResponse, CheckNumberAvailabilityResponse, RentAnyNumberResponse
+    CheckNumberAvailabilityResponse, RentAnyNumberResponse
 )
 from sinch.domains.numbers.models.numbers import (
-    CapabilityTypeValuesList, Number, NumberSearchPatternTypeValues, NumberTypeValues
+    ActiveNumber, CapabilityTypeValuesList, Number, NumberSearchPatternTypeValues, NumberTypeValues
 )
 
 
@@ -66,7 +66,7 @@ def activate(
             sms_configuration: Optional[SmsConfigurationDict] = None,
             voice_configuration: Optional[VoiceConfigurationDictType] = None,
             callback_url: Optional[StrictStr] = None
-    ) -> ActivateNumberResponse:
+    ) -> ActiveNumber:
         pass
 
     @overload
@@ -76,7 +76,7 @@ def activate(
             sms_configuration: SmsConfigurationDict,
             voice_configuration: VoiceConfigurationDictEST,
             callback_url: Optional[StrictStr] = None
-    ) -> ActivateNumberResponse:
+    ) -> ActiveNumber:
         pass
 
     @overload
@@ -86,7 +86,7 @@ def activate(
             sms_configuration: SmsConfigurationDict,
             voice_configuration: VoiceConfigurationDictFAX,
             callback_url: Optional[StrictStr] = None
-    ) -> ActivateNumberResponse:
+    ) -> ActiveNumber:
         pass
 
     @overload
@@ -96,7 +96,7 @@ def activate(
             sms_configuration: SmsConfigurationDict,
             voice_configuration: VoiceConfigurationDictRTC,
             callback_url: Optional[StrictStr] = None
-    ) -> ActivateNumberResponse:
+    ) -> ActiveNumber:
         pass
 
     def activate(
@@ -106,7 +106,7 @@ def activate(
         voice_configuration: Optional[VoiceConfigurationDictType] = None,
         callback_url: Optional[StrictStr] = None,
         **kwargs
-    ) -> ActivateNumberResponse:
+    ) -> ActiveNumber:
         """
         Activate a virtual number to use with SMS, Voice, or both products.
 
@@ -125,7 +125,7 @@ def activate(
             **kwargs: Additional parameters for the request.
 
         Returns:
-            ActivateNumberResponse: A response object with the activated number and its details.
+            ActiveNumber: A response object with the activated number and its details.
 
         For detailed documentation, visit https://developers.sinch.com
         """
@@ -147,7 +147,7 @@ def rent_any(
             voice_configuration: None,
             number_pattern: Optional[NumberPatternDict] = None,
             capabilities: Optional[CapabilityTypeValuesList] = None,
-            callback_url: Optional[str] = None,
+            callback_url: Optional[StrictStr] = None,
     ) -> RentAnyNumberResponse:
         pass
 
@@ -160,7 +160,7 @@ def rent_any(
             voice_configuration: VoiceConfigurationDictRTC,
             number_pattern: Optional[NumberPatternDict] = None,
             capabilities: Optional[CapabilityTypeValuesList] = None,
-            callback_url: Optional[str] = None,
+            callback_url: Optional[StrictStr] = None,
     ) -> RentAnyNumberResponse:
         pass
 
@@ -173,7 +173,7 @@ def rent_any(
             voice_configuration: VoiceConfigurationDictFAX,
             number_pattern: Optional[NumberPatternDict] = None,
             capabilities: Optional[CapabilityTypeValuesList] = None,
-            callback_url: Optional[str] = None,
+            callback_url: Optional[StrictStr] = None,
     ) -> RentAnyNumberResponse:
         pass
 
@@ -186,7 +186,7 @@ def rent_any(
             voice_configuration: VoiceConfigurationDictEST,
             number_pattern: Optional[NumberPatternDict] = None,
             capabilities: Optional[CapabilityTypeValuesList] = None,
-            callback_url: Optional[str] = None,
+            callback_url: Optional[StrictStr] = None,
     ) -> RentAnyNumberResponse:
         pass
 
@@ -198,7 +198,7 @@ def rent_any(
         capabilities: Optional[CapabilityTypeValuesList] = None,
         sms_configuration: Optional[SmsConfigurationDict] = None,
         voice_configuration: Optional[VoiceConfigurationDictType] = None,
-        callback_url: Optional[str] = None,
+        callback_url: Optional[StrictStr] = None,
         **kwargs
     ) -> RentAnyNumberResponse:
         """
@@ -219,7 +219,7 @@ def rent_any(
                     - `VoiceConfigurationDictRTC`: type 'RTC' with an `app_id` field.
                     - `VoiceConfigurationDictEST`: type 'EST' with a `trunk_id` field.
                     - `VoiceConfigurationDictFAX`: type 'FAX' with a `service_id` field.
-            callback_url (str): The callback URL to receive notifications.
+            callback_url (StrictStr): The callback URL to receive notifications.
             **kwargs: Additional parameters for the request.
 
         Returns:

sinch/domains/numbers/endpoints/available/activate_number_endpoint.py

@@ -1,9 +1,10 @@
 import json
 from sinch.core.enums import HTTPAuthentication, HTTPMethods
 from sinch.core.models.http_response import HTTPResponse
+from sinch.domains.numbers.models.numbers import ActiveNumber
 from sinch.domains.numbers.endpoints.numbers_endpoint import NumbersEndpoint
 from sinch.domains.numbers.exceptions import NumberNotFoundException, NumbersException
-from sinch.domains.numbers.models.available import ActivateNumberRequest, ActivateNumberResponse
+from sinch.domains.numbers.models.available import ActivateNumberRequest
 
 
 class ActivateNumberEndpoint(NumbersEndpoint):
@@ -22,10 +23,10 @@ def request_body(self) -> str:
         request_data = self.request_data.model_dump(by_alias=True, exclude_none=True)
         return json.dumps(request_data)
 
-    def handle_response(self, response: HTTPResponse) -> ActivateNumberResponse:
+    def handle_response(self, response: HTTPResponse) -> ActiveNumber:
         try:
             super(ActivateNumberEndpoint, self).handle_response(response)
         except NumbersException as ex:
             raise NumberNotFoundException(message=ex.args[0], response=ex.http_response,
                                           is_from_server=ex.is_from_server)
-        return self.process_response_model(response.body, ActivateNumberResponse)
+        return self.process_response_model(response.body, ActiveNumber)

sinch/domains/numbers/models/available/__init__.py

@@ -1,5 +1,4 @@
 from sinch.domains.numbers.models.available.activate_number_request import ActivateNumberRequest
-from sinch.domains.numbers.models.available.activate_number_response import ActivateNumberResponse
 from sinch.domains.numbers.models.available.check_number_availability_request import CheckNumberAvailabilityRequest
 from sinch.domains.numbers.models.available.check_number_availability_response import CheckNumberAvailabilityResponse
 from sinch.domains.numbers.models.available.list_available_numbers_request import ListAvailableNumbersRequest
@@ -8,7 +7,6 @@
 
 __all__ = [
     "ActivateNumberRequest",
-    "ActivateNumberResponse",
     "CheckNumberAvailabilityRequest",
     "CheckNumberAvailabilityResponse",
     "ListAvailableNumbersRequest",

sinch/domains/numbers/models/available/activate_number_response.py

@@ -2,8 +2,8 @@
 from datetime import timezone, datetime
 from behave import given, when, then
 from decimal import Decimal
+from sinch.domains.numbers.models.numbers import ActiveNumber
 from sinch.domains.numbers.exceptions import NumberNotFoundException
-from sinch.domains.numbers.models.available.activate_number_response import ActivateNumberResponse
 from sinch.domains.numbers.models.available.rent_any_number_response import RentAnyNumberResponse
 from sinch.domains.numbers.models.numbers import NotFoundError
 
@@ -148,7 +148,7 @@ def step_rent_specific_number(context, phone_number):
 
 @then('the response contains this rented phone number "{phone_number}"')
 def step_validate_rented_specific_number(context, phone_number):
-    data: ActivateNumberResponse = context.response
+    data: ActiveNumber = context.response
     assert data.phone_number == phone_number, f'Expected {phone_number}, got {data.phone_number}'
 
 @when('I send a request to rent the unavailable phone number "{phone_number}"')

tests/e2e/numbers/features/steps/numbers.steps.py

@@ -1,6 +1,5 @@
 import pytest
 from datetime import datetime, timezone
-from sinch.domains.numbers.models.available.activate_number_response import ActivateNumberResponse
 
 @pytest.fixture
 def test_data():
@@ -69,62 +68,3 @@ def assert_voice_configuration(voice_config):
     assert scheduled_voice_provisioning.last_updated_time == expected_last_updated_time
     assert scheduled_voice_provisioning.status == "PROVISIONING_STATUS_UNSPECIFIED"
     assert scheduled_voice_provisioning.app_id == "string"
-
-def test_activate_number_response_expects_all_fields_mapped_correctly(test_data):
-    """
-    Expects all fields to map correctly from camelCase input,
-    converts nested keys to snake_case, and handles dynamic fields
-    """
-    data = {
-        "phoneNumber": "+12025550134",
-        "displayName": "string",
-        "regionCode": "US",
-        "type": "MOBILE",
-        "capability": ["SMS"],
-        "money": {"currencyCode": "USD", "amount": "2.00"},
-        "paymentIntervalMonths": 0,
-        "nextChargeDate": "2025-01-22T13:19:31.095Z",
-        "expireAt": "2025-03-29T13:19:31.095Z",
-        "smsConfiguration": {
-            "servicePlanId": "string",
-            "campaignId": "string",
-            "scheduledProvisioning": {
-                "servicePlanId": "string",
-                "campaignId": "string",
-                "status": "PROVISIONING_STATUS_UNSPECIFIED",
-                "lastUpdatedTime": "2025-02-21T13:19:31.095Z",
-                "errorCodes": ["ERROR_CODE_UNSPECIFIED"],
-            },
-        },
-        "voiceConfiguration": {
-            "type": "RTC",
-            "lastUpdatedTime": "2025-01-25T13:49:31.095Z",
-            "scheduledVoiceProvisioning": {
-                "type": "RTC",
-                "lastUpdatedTime": "2025-02-22T13:19:31.095Z",
-                "status": "PROVISIONING_STATUS_UNSPECIFIED",
-                "appId": "string",
-            },
-            "appId": "string",
-        },
-        "callbackUrl": "https://www.your-callback-server.com/callback",
-    }
-    response = ActivateNumberResponse(**data)
-
-    assert response.phone_number == "+12025550134"
-    assert response.display_name == "string"
-    assert response.region_code == "US"
-    assert response.type == "MOBILE"
-    assert response.capability == ["SMS"]
-    assert response.money.currency_code == "USD"
-    assert response.payment_interval_months == 0
-    expected_next_charge_data = (
-        datetime(2025, 1, 22, 13, 19, 31, 95000, tzinfo=timezone.utc))
-    assert response.next_charge_date == expected_next_charge_data
-    expected_expire_at = (
-        datetime(2025, 3, 29, 13, 19, 31, 95000, tzinfo=timezone.utc))
-    assert response.expire_at == expected_expire_at
-    assert response.callback_url == "https://www.your-callback-server.com/callback"
-    # Assert sms_configuration and voice_configuration using helper functions
-    assert_sms_configuration(response.sms_configuration)
-    assert_voice_configuration(response.voice_configuration)

tests/unit/domains/numbers/models/available/response/test_activate_number_response_model.py

@@ -1,5 +1,6 @@
 from datetime import datetime, timezone
 from sinch.domains.numbers.models.numbers import (
+    ActiveNumber,
     ScheduledProvisioningSmsConfiguration,
     SmsConfigurationResponse,
     VoiceConfigurationResponse, NotFoundError,
@@ -135,3 +136,37 @@ def test_not_found_error_deserialize_with_snake_case():
     assert not_found_error.details[0].resource_name == '+1234567890'
     assert not_found_error.details[0].owner == ''
     assert not_found_error.details[0].description == ''
+
+def test_activate_number_response_expects_all_fields_mapped_correctly():
+    """
+    Expects all fields to map correctly from camelCase input,
+    converts nested keys to snake_case, and handles dynamic fields
+    """
+    data = {
+        "phoneNumber": "+12025550134",
+        "displayName": "string",
+        "regionCode": "US",
+        "type": "MOBILE",
+        "capability": ["SMS"],
+        "money": {"currencyCode": "USD", "amount": "2.00"},
+        "paymentIntervalMonths": 0,
+        "nextChargeDate": "2025-01-22T13:19:31.095Z",
+        "expireAt": "2025-03-29T13:19:31.095Z",
+        "callbackUrl": "https://www.your-callback-server.com/callback",
+    }
+    response = ActiveNumber(**data)
+
+    assert response.phone_number == "+12025550134"
+    assert response.display_name == "string"
+    assert response.region_code == "US"
+    assert response.type == "MOBILE"
+    assert response.capability == ["SMS"]
+    assert response.money.currency_code == "USD"
+    assert response.payment_interval_months == 0
+    expected_next_charge_data = (
+        datetime(2025, 1, 22, 13, 19, 31, 95000, tzinfo=timezone.utc))
+    assert response.next_charge_date == expected_next_charge_data
+    expected_expire_at = (
+        datetime(2025, 3, 29, 13, 19, 31, 95000, tzinfo=timezone.utc))
+    assert response.expire_at == expected_expire_at
+    assert response.callback_url == "https://www.your-callback-server.com/callback"

tests/unit/domains/numbers/models/test_numbers.py

@@ -1,5 +1,6 @@
 import pytest
 from unittest.mock import MagicMock
+
 from sinch.domains.numbers.available_numbers import AvailableNumbers
 from sinch.domains.numbers.endpoints.available.list_available_numbers_endpoint import AvailableNumbersEndpoint
 from sinch.domains.numbers.endpoints.available.activate_number_endpoint import ActivateNumberEndpoint
@@ -10,9 +11,10 @@
 from sinch.domains.numbers.models.available.check_number_availability_request import CheckNumberAvailabilityRequest
 
 from sinch.domains.numbers.models.available.list_available_numbers_response import ListAvailableNumbersResponse
-from sinch.domains.numbers.models.available.activate_number_response import ActivateNumberResponse
 from sinch.domains.numbers.models.available.check_number_availability_response import CheckNumberAvailabilityResponse
 
+from sinch.domains.numbers.models.numbers import ActiveNumber
+
 @pytest.fixture
 def mock_sinch():
     """Creates a mocked Sinch client."""
@@ -66,7 +68,7 @@ def test_activate_number_expects_correct_request(mock_sinch, mocker):
     Test that the AvailableNumbers.activate method sends the correct request
     and handles the response properly.
     """
-    mock_response = ActivateNumberResponse.model_construct()
+    mock_response = ActiveNumber.model_construct()
     mock_sinch.configuration.transport.request.return_value = mock_response
 
     spy_endpoint = mocker.spy(ActivateNumberEndpoint, "__init__")