connect-client-py 4.3.3__tar.gz → 4.3.4__tar.gz

{connect_client_py-4.3.3 → connect_client_py-4.3.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: connect-client-py
-Version: 4.3.3
+Version: 4.3.4
 Summary: The official Python HTTP client to interact with the Connect REST API. Developed and maintained by Trinity IoT.
 Author: Andries Niemandt
 Author-email: Andries Niemandt <andries.niemandt@trintel.co.za>

{connect_client_py-4.3.3 → connect_client_py-4.3.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "uv_build"
 
 [project]
 name = "connect-client-py"
-version = "4.3.3"
+version = "4.3.4"
 description = "The official Python HTTP client to interact with the Connect REST API. Developed and maintained by Trinity IoT."
 requires-python = ">=3.9"
 license = "MIT"

{connect_client_py-4.3.3 → connect_client_py-4.3.4}/src/connect_client_py/async_client.py

@@ -5325,10 +5325,11 @@ class AsyncConnectClient:
         return Response(status=__response.status, headers=__response.headers, parsed=__result)
 
 
-    async def sims_crossref_retrieve(self, cr_key: str, cr_value: str) -> CrossReferenceRecord:
+    async def sims_crossref_retrieve(self, cr_key: str, cr_value: str, *, apn: Optional[str] = None) -> CrossReferenceRecord:
         """
-        Returns the cross reference information for a SIM.
-                This includes information about the SIMs:
+        Returns the cross reference information for a SIM, addressed by
+                one of the identifiers the network reports: `msisdn`, `imsi`, `imei`
+                or `ip`. This includes information about the SIMs:
         
         - MSISND
         
@@ -5338,6 +5339,13 @@ class AsyncConnectClient:
         
         - IP
         
+        A framed IP is only unique within its APN's pool, so an `ip` lookup
+                must also name the APN via the `apn` query parameter and is refused
+                with `400 Bad Request` without it. Where several attachments match
+                (a SIM on two APNs, an IP reissued from the pool) the most recently
+                seen one is returned. A SIM with no observed traffic has no
+                cross-reference data and returns 404.
+        
         
         **Required Roles:**
         - No special roles required
@@ -5348,13 +5356,15 @@ class AsyncConnectClient:
                     against the company and folder associated with the resource.
         - The member must have access to the Folder the SIM is in.
         """
-        return (await self.sims_crossref_retrieve_with_response(cr_key, cr_value)).parsed
+        return (await self.sims_crossref_retrieve_with_response(cr_key, cr_value, apn=apn)).parsed
 
-    async def sims_crossref_retrieve_with_response(self, cr_key: str, cr_value: str) -> Response[CrossReferenceRecord]:
+    async def sims_crossref_retrieve_with_response(self, cr_key: str, cr_value: str, *, apn: Optional[str] = None) -> Response[CrossReferenceRecord]:
         cr_key_enc = quote(cr_key, safe="")
         cr_value_enc = quote(cr_value, safe="")
         __path = f"/api/v4/sims/crossref/{cr_key_enc}/{cr_value_enc}/"
         __query: List[Tuple[str, str]] = []
+        if apn is not None:
+            __query.append(("apn", str(apn)))
         __headers: List[Tuple[str, str]] = []
         if self._token is None:
             raise MissingTokenError()

{connect_client_py-4.3.3 → connect_client_py-4.3.4}/src/connect_client_py/client.py

@@ -5335,10 +5335,11 @@ class ConnectClient:
         return Response(status=__response.status, headers=__response.headers, parsed=__result)
 
 
-    def sims_crossref_retrieve(self, cr_key: str, cr_value: str) -> CrossReferenceRecord:
+    def sims_crossref_retrieve(self, cr_key: str, cr_value: str, *, apn: Optional[str] = None) -> CrossReferenceRecord:
         """
-        Returns the cross reference information for a SIM.
-                This includes information about the SIMs:
+        Returns the cross reference information for a SIM, addressed by
+                one of the identifiers the network reports: `msisdn`, `imsi`, `imei`
+                or `ip`. This includes information about the SIMs:
         
         - MSISND
         
@@ -5348,6 +5349,13 @@ class ConnectClient:
         
         - IP
         
+        A framed IP is only unique within its APN's pool, so an `ip` lookup
+                must also name the APN via the `apn` query parameter and is refused
+                with `400 Bad Request` without it. Where several attachments match
+                (a SIM on two APNs, an IP reissued from the pool) the most recently
+                seen one is returned. A SIM with no observed traffic has no
+                cross-reference data and returns 404.
+        
         
         **Required Roles:**
         - No special roles required
@@ -5358,13 +5366,15 @@ class ConnectClient:
                     against the company and folder associated with the resource.
         - The member must have access to the Folder the SIM is in.
         """
-        return self.sims_crossref_retrieve_with_response(cr_key, cr_value).parsed
+        return self.sims_crossref_retrieve_with_response(cr_key, cr_value, apn=apn).parsed
 
-    def sims_crossref_retrieve_with_response(self, cr_key: str, cr_value: str) -> Response[CrossReferenceRecord]:
+    def sims_crossref_retrieve_with_response(self, cr_key: str, cr_value: str, *, apn: Optional[str] = None) -> Response[CrossReferenceRecord]:
         cr_key_enc = quote(cr_key, safe="")
         cr_value_enc = quote(cr_value, safe="")
         __path = f"/api/v4/sims/crossref/{cr_key_enc}/{cr_value_enc}/"
         __query: List[Tuple[str, str]] = []
+        if apn is not None:
+            __query.append(("apn", str(apn)))
         __headers: List[Tuple[str, str]] = []
         if self._token is None:
             raise MissingTokenError()

{connect_client_py-4.3.3 → connect_client_py-4.3.4}/src/connect_client_py/types.py

@@ -4251,7 +4251,7 @@ class MonthData:
 class MqttCommandResult:
     cid: Optional[str]
     detail: str
-    err: Optional[bool]
+    err: bool
     msg: Any
     pid: Optional[str]
     qos: Optional[int]
@@ -4267,7 +4267,7 @@ class MqttCommandResult:
         return cls(
             cid=(data["cid"] if data["cid"] is not None else None),
             detail=data["detail"],
-            err=(data["err"] if data["err"] is not None else None),
+            err=data["err"],
             msg=data["msg"],
             pid=(data["pid"] if data["pid"] is not None else None),
             qos=(data["qos"] if data["qos"] is not None else None),
@@ -4283,7 +4283,7 @@ class MqttCommandResult:
         out: Dict[str, Any] = {}
         out["cid"] = (self.cid if self.cid is not None else None)
         out["detail"] = self.detail
-        out["err"] = (self.err if self.err is not None else None)
+        out["err"] = self.err
         out["msg"] = self.msg
         out["pid"] = (self.pid if self.pid is not None else None)
         out["qos"] = (self.qos if self.qos is not None else None)
@@ -6508,20 +6508,20 @@ class PatchedSimRequest:
 
 @dataclass
 class PatchedTagRequest:
-    company_id: Optional[int] = None
+    company: Optional[int] = None
     name: Optional[str] = None
 
     @classmethod
     def from_dict(cls, data: Dict[str, Any]) -> "PatchedTagRequest":
         return cls(
-            company_id=data.get("company_id"),
+            company=data.get("company"),
             name=data.get("name"),
         )
 
     def to_dict(self) -> Dict[str, Any]:
         out: Dict[str, Any] = {}
-        if self.company_id is not None:
-            out["company_id"] = self.company_id
+        if self.company is not None:
+            out["company"] = self.company
         if self.name is not None:
             out["name"] = self.name
         return out
@@ -8275,7 +8275,7 @@ class StratChoices(Enum):
 
 @dataclass
 class Tag:
-    company_id: int
+    company: int
     company_url: str
     id: int
     name: str
@@ -8284,7 +8284,7 @@ class Tag:
     @classmethod
     def from_dict(cls, data: Dict[str, Any]) -> "Tag":
         return cls(
-            company_id=data["company_id"],
+            company=data["company"],
             company_url=data["company_url"],
             id=data["id"],
             name=data["name"],
@@ -8293,7 +8293,7 @@ class Tag:
 
     def to_dict(self) -> Dict[str, Any]:
         out: Dict[str, Any] = {}
-        out["company_id"] = self.company_id
+        out["company"] = self.company
         out["company_url"] = self.company_url
         out["id"] = self.id
         out["name"] = self.name
@@ -8303,19 +8303,19 @@ class Tag:
 
 @dataclass
 class TagRequest:
-    company_id: int
+    company: int
     name: str
 
     @classmethod
     def from_dict(cls, data: Dict[str, Any]) -> "TagRequest":
         return cls(
-            company_id=data["company_id"],
+            company=data["company"],
             name=data["name"],
         )
 
     def to_dict(self) -> Dict[str, Any]:
         out: Dict[str, Any] = {}
-        out["company_id"] = self.company_id
+        out["company"] = self.company
         out["name"] = self.name
         return out