PR code review

Author: matsk-sinch

sinch/domains/sms/api/v1/base/base_sms.py

@@ -4,6 +4,20 @@ class BaseSms:
     def __init__(self, sinch):
         self._sinch = sinch
 
+    def _get_path_identifier(self) -> str:
+        """
+        Returns the appropriate path identifier based on authentication method.
+        - SMS auth: returns service_plan_id
+        - Project auth: returns project_id
+
+        Returns:
+            str: The path identifier to use for the endpoint.
+        """
+        if self._sinch.configuration.authentication_method == "sms_auth":
+            return self._sinch.configuration.service_plan_id
+        else:
+            return self._sinch.configuration.project_id
+
     def _request(self, endpoint_class, request_data):
         """
         A helper method to make requests to endpoints.
@@ -17,14 +31,8 @@ def _request(self, endpoint_class, request_data):
         """
         self._sinch.configuration.validate_authentication_parameters()
 
-        # Use service_plan_id for SMS auth, project_id for project auth
-        if self._sinch.configuration.authentication_method == "sms_auth":
-            path_identifier = self._sinch.configuration.service_plan_id
-        else:
-            path_identifier = self._sinch.configuration.project_id
-
         endpoint = endpoint_class(
-            project_id=path_identifier,
+            project_id=self._get_path_identifier(),
             request_data=request_data,
         )
 

sinch/domains/sms/api/v1/batches_apis.py

@@ -84,24 +84,18 @@ def list(
         page_size: Optional[int] = None,
         start_date: Optional[datetime] = None,
         end_date: Optional[datetime] = None,
-        var_from: Optional[List[str]] = None,
+        from_: Optional[List[str]] = None,
         client_reference: Optional[str] = None,
         **kwargs,
     ) -> Paginator[BatchResponse]:
-        # Use service_plan_id for SMS auth, project_id for project auth
-        if self._sinch.configuration.authentication_method == "sms_auth":
-            path_identifier = self._sinch.configuration.service_plan_id
-        else:
-            path_identifier = self._sinch.configuration.project_id
-
         endpoint = ListBatchesEndpoint(
-            project_id=path_identifier,
+            project_id=self._get_path_identifier(),
             request_data=ListBatchesRequest(
                 page=page,
                 page_size=page_size,
                 start_date=start_date,
                 end_date=end_date,
-                var_from=var_from,
+                from_=from_,
                 client_reference=client_reference,
                 **kwargs,
             ),

sinch/domains/sms/api/v1/delivery_reports_apis.py

@@ -62,14 +62,8 @@ def list(
         client_reference: Optional[str] = None,
         **kwargs,
     ) -> Paginator[RecipientDeliveryReport]:
-        # Use service_plan_id for SMS auth, project_id for project auth
-        if self._sinch.configuration.authentication_method == "sms_auth":
-            path_identifier = self._sinch.configuration.service_plan_id
-        else:
-            path_identifier = self._sinch.configuration.project_id
-
         endpoint = ListDeliveryReportsEndpoint(
-            project_id=path_identifier,
+            project_id=self._get_path_identifier(),
             request_data=ListDeliveryReportsRequest(
                 page=page,
                 page_size=page_size,
@@ -81,7 +75,6 @@ def list(
                 **kwargs,
             ),
         )
-        # Set the authentication method based on configuration
         endpoint.set_authentication_method(self._sinch)
 
         return SMSPaginator(sinch=self._sinch, endpoint=endpoint)

sinch/domains/sms/models/v1/internal/batch_id_request.py

@@ -7,5 +7,5 @@
 class BatchIdRequest(BaseModelConfigurationRequest):
     batch_id: StrictStr = Field(
         default=...,
-        description="The unique identifier of the batch message for which delivery feedback is being provided.",
+        description="The unique identifier of the batch message.",
     )

sinch/domains/sms/models/v1/internal/list_batches_request.py

@@ -11,7 +11,7 @@ class ListBatchesRequest(BaseModelConfigurationRequest):
     page_size: Optional[conint(strict=True, le=100, ge=1)] = 30
     start_date: Optional[datetime] = None
     end_date: Optional[datetime] = None
-    var_from: Optional[conlist(StrictStr)] = Field(default=None, alias="from")
+    from_: Optional[conlist(StrictStr)] = Field(default=None, alias="from")
     client_reference: Optional[
         constr(strict=True, max_length=2048, min_length=0)
     ] = None

sinch/domains/sms/models/v1/internal/update_binary_request.py

@@ -8,13 +8,13 @@
 
 
 class UpdateBinaryRequest(BaseModelConfigurationRequest):
-    var_from: Optional[StrictStr] = Field(
+    from_: Optional[StrictStr] = Field(
         default=None,
         alias="from",
         description="Sender number. Must be valid phone number, short code or alphanumeric.",
     )
     type: Optional[StrictStr] = Field(
-        default=None,
+        default="mt_binary",
         description="SMS in [binary](https://community.sinch.com/t5/Glossary/Binary-SMS/ta-p/7470) format.",
     )
     to_add: Optional[conlist(StrictStr)] = Field(

sinch/domains/sms/models/v1/internal/update_media_request.py

@@ -9,12 +9,12 @@
 
 
 class UpdateMediaRequest(BaseModelConfigurationRequest):
-    var_from: Optional[StrictStr] = Field(
+    from_: Optional[StrictStr] = Field(
         default=None,
         alias="from",
         description="Sender number. Must be valid phone number, short code or alphanumeric.",
     )
-    type: Optional[StrictStr] = Field(default=None, description="MMS")
+    type: Optional[StrictStr] = Field(default="mt_media", description="MMS")
     to_add: Optional[conlist(StrictStr)] = Field(
         default=None,
         description="List of phone numbers and group IDs to add to the batch.",

sinch/domains/sms/models/v1/internal/update_text_request.py

@@ -8,12 +8,14 @@
 
 
 class UpdateTextRequest(BaseModelConfigurationRequest):
-    var_from: Optional[StrictStr] = Field(
+    from_: Optional[StrictStr] = Field(
         default=None,
         alias="from",
         description="Sender number. Must be valid phone number, short code or alphanumeric.",
     )
-    type: Optional[StrictStr] = Field(default=None, description="Regular SMS")
+    type: Optional[StrictStr] = Field(
+        default="mt_text", description="Regular SMS"
+    )
     to_add: Optional[conlist(StrictStr)] = Field(
         default=None,
         description="List of phone numbers and group IDs to add to the batch.",

sinch/domains/sms/models/v1/shared/binary_request.py

@@ -14,7 +14,7 @@ class BinaryRequest(BaseModelConfigurationRequest):
         default=...,
         description="A list of phone numbers and group IDs that will receive the batch. [More info](https://community.sinch.com/t5/Glossary/MSISDN/ta-p/7628).",
     )
-    var_from: Optional[StrictStr] = Field(
+    from_: Optional[StrictStr] = Field(
         default=None,
         alias="from",
         description="Sender number. Must be valid phone number, short code or alphanumeric. Required if Automatic Default Originator not configured.",
@@ -28,7 +28,7 @@ class BinaryRequest(BaseModelConfigurationRequest):
         description="The UDH header of a binary message HEX encoded. Max 140 bytes including the `body`.",
     )
     type: Optional[StrictStr] = Field(
-        default=None,
+        default="mt_binary",
         description="SMS in [binary](https://community.sinch.com/t5/Glossary/Binary-SMS/ta-p/7470) format.",
     )
     delivery_report: Optional[DeliveryReportType] = None

sinch/domains/sms/models/v1/shared/binary_response.py

@@ -14,7 +14,7 @@ class BinaryResponse(BaseModelConfigurationResponse):
         default=None,
         description="A list of phone numbers and group IDs that have received the batch. [More info](https://community.sinch.com/t5/Glossary/MSISDN/ta-p/7628).",
     )
-    var_from: Optional[StrictStr] = Field(
+    from_: Optional[StrictStr] = Field(
         default=None,
         alias="from",
         description="The sender number provided.  Required if the Automatic Default Originator is not configured.",