fix:PRComments

Author: RSam-NI

docs/api_reference/alarm.rst

@@ -10,7 +10,7 @@ nisystemlink.clients.alarm
    .. automethod:: create_or_update_alarm
    .. automethod:: get_alarm
    .. automethod:: delete_alarm
-   .. automethod:: delete_instances_by_instance_id
+   .. automethod:: delete_alarms
    .. automethod:: acknowledge_alarm
    .. automethod:: query_alarms
 

docs/getting_started.rst

@@ -35,12 +35,12 @@ With an :class:`.AlarmClient` object, you can:
 
 * Get a specific alarm by its instance_id using :meth:`~.AlarmClient.get_alarm`
 
-* Acknowledge alarms with :meth:`~.AlarmClient.acknowledge_alarm`
+* Acknowledge alarms by its instance_id using :meth:`~.AlarmClient.acknowledge_alarm`
 
   * Optionally force-clear alarms when acknowledging
 
 * Delete alarms using :meth:`~.AlarmClient.delete_alarm` or 
-  :meth:`~.AlarmClient.delete_instances_by_instance_id`
+  :meth:`~.AlarmClient.delete_alarms`
 
 Examples
 ~~~~~~~~

examples/alarm/alarm.py

@@ -1,17 +1,13 @@
 import uuid
-from datetime import datetime, timezone
+from datetime import datetime
 
 from nisystemlink.clients.alarm import AlarmClient
 from nisystemlink.clients.alarm.models import (
-    CreateOrUpdateAlarmRequest,
-    QueryWithFilterRequest,
-)
-from nisystemlink.clients.alarm.models._alarm import AlarmTransitionType
-from nisystemlink.clients.alarm.models._create_or_update_alarm_request import (
-    CreateAlarmTransition,
-)
-from nisystemlink.clients.alarm.models._query_alarms_request import (
     AlarmOrderBy,
+    AlarmTransitionType,
+    CreateAlarmTransition,
+    CreateOrUpdateAlarmRequest,
+    QueryAlarmsWithFilterRequest,
     TransitionInclusionOption,
 )
 from nisystemlink.clients.core import HttpConfiguration
@@ -32,7 +28,7 @@
     alarm_id=alarm_id,
     transition=CreateAlarmTransition(
         transition_type=AlarmTransitionType.SET,
-        occurred_at=datetime.now(timezone.utc),
+        occurred_at=datetime.now(),
         severity_level=3,
         condition="Temperature exceeded threshold",
         message="Temperature sensor reading: 85°C",
@@ -49,7 +45,7 @@
     alarm_id=alarm_id,
     transition=CreateAlarmTransition(
         transition_type=AlarmTransitionType.SET,
-        occurred_at=datetime.now(timezone.utc),
+        occurred_at=datetime.now(),
         severity_level=5,
         condition="Temperature critically high",
         message="Temperature sensor reading: 95°C",
@@ -58,7 +54,7 @@
 client.create_or_update_alarm(update_request)
 
 # Query alarms with a filter (can filter by alarm_id to find all instances)
-query_request = QueryWithFilterRequest(
+query_request = QueryAlarmsWithFilterRequest(
     filter=f'alarmId="{alarm_id}"',
     transition_inclusion_option=TransitionInclusionOption.ALL,
     order_by=AlarmOrderBy.UPDATED_AT,
@@ -68,14 +64,14 @@
 query_response = client.query_alarms(query_request)
 
 # Acknowledge the alarm using its instance ID
-ack_response = client.acknowledge_alarm([id])
+ack_response = client.acknowledge_alarms(ids=[id])
 
 # Clear the alarm
 clear_request = CreateOrUpdateAlarmRequest(
     alarm_id=alarm_id,
     transition=CreateAlarmTransition(
         transition_type=AlarmTransitionType.CLEAR,
-        occurred_at=datetime.now(timezone.utc),
+        occurred_at=datetime.now(),
         severity_level=0,
         condition="Temperature returned to normal",
     ),

nisystemlink/clients/alarm/_alarm_client.py

@@ -1,11 +1,11 @@
 """Implementation of Alarm Client"""
 
-from typing import Optional
+from typing import List, Optional
 
 from nisystemlink.clients import core
 from nisystemlink.clients.core._uplink._base_client import BaseClient
 from nisystemlink.clients.core._uplink._methods import delete, get, post
-from uplink import Field, retry
+from uplink import Field, Path, retry
 
 from . import models
 
@@ -38,15 +38,15 @@ def __init__(self, configuration: Optional[core.HttpConfiguration] = None):
         "acknowledge-instances-by-instance-id",
         args=[Field("instanceIds"), Field("forceClear")],
     )
-    def acknowledge_alarm(
-        self, instance_ids: list[str], force_clear: bool = False
-    ) -> models.AcknowledgeByInstanceIdResponse:
+    def acknowledge_alarms(
+        self, ids: List[str], force_clear: bool = False
+    ) -> models.AcknowledgeAlarmsResponse:
         """Acknowledges one or more alarm instances by their instance IDs.
 
         Args:
-            instance_ids: List of instance IDs (unique occurrence identifiers) of the alarms to acknowledge.
-                         These are the server-generated IDs returned when creating/updating alarms,
-                         not the user-defined alarm_id.
+            ids: List of instance IDs (unique occurrence identifiers) of the alarms to acknowledge.
+                 These are the server-generated IDs returned when creating/updating alarms,
+                 not the user-defined alarm_id.
             force_clear: Whether or not the affected alarms should have their clear field set to true.
                          Defaults to False.
 
@@ -80,14 +80,14 @@ def create_or_update_alarm(self, request: models.CreateOrUpdateAlarmRequest) ->
         """
         ...
 
-    @get("instances/{instance_id}")
-    def get_alarm(self, instance_id: str) -> models.Alarm:
+    @get("instances/{instance_id}", args=[Path("instance_id")])
+    def get_alarm(self, id: str) -> models.Alarm:
         """Gets an alarm by its instance_id.
 
         Args:
-            instance_id: The unique instance ID (occurrence identifier) of the alarm to retrieve.
-                        This is the server-generated ID returned from create_or_update_alarm(),
-                        not the user-defined alarm_id.
+            id: The unique instance ID (occurrence identifier) of the alarm to retrieve.
+                This is the server-generated ID returned from create_or_update_alarm(),
+                not the user-defined alarm_id.
 
         Returns:
             The alarm with the specified instance_id.
@@ -97,30 +97,30 @@ def get_alarm(self, instance_id: str) -> models.Alarm:
         """
         ...
 
-    @delete("instances/{instance_id}")
-    def delete_alarm(self, instance_id: str) -> None:
+    @delete("instances/{instance_id}", args=[Path("instance_id")])
+    def delete_alarm(self, id: str) -> None:
         """Deletes an alarm by its instance_id.
 
         Args:
-            instance_id: The unique instance ID (occurrence identifier) of the alarm to delete.
-                        This is the server-generated ID returned from create_or_update_alarm(),
-                        not the user-defined alarm_id.
+            id: The unique instance ID (occurrence identifier) of the alarm to delete.
+                This is the server-generated ID returned from create_or_update_alarm(),
+                not the user-defined alarm_id.
 
         Raises:
             ApiException: if unable to communicate with the `/nialarm` Service or provided invalid arguments.
         """
         ...
 
     @post("delete-instances-by-instance-id", args=[Field("instanceIds")])
-    def delete_instances_by_instance_id(
-        self, instance_ids: list[str]
+    def delete_alarms(
+        self, ids: List[str]
     ) -> models.DeleteByInstanceIdResponse:
         """Deletes multiple alarm instances by their instance IDs.
 
         Args:
-            instance_ids: List of instance IDs (unique occurrence identifiers) of the alarms to delete.
-                         These are the server-generated IDs returned when creating/updating alarms,
-                         not the user-defined alarm_id.
+            ids: List of instance IDs (unique occurrence identifiers) of the alarms to delete.
+                 These are the server-generated IDs returned when creating/updating alarms,
+                 not the user-defined alarm_id.
 
         Returns:
             A response containing lists of successfully deleted and failed instance IDs,
@@ -133,8 +133,8 @@ def delete_instances_by_instance_id(
 
     @post("query-instances-with-filter")
     def query_alarms(
-        self, request: models.QueryWithFilterRequest
-    ) -> models.QueryWithFilterResponse:
+        self, request: models.QueryAlarmsWithFilterRequest
+    ) -> models.QueryAlarmsWithFilterResponse:
         """Queries for instances, or occurrences, of alarms using Dynamic LINQ.
 
         Specifying an empty JSON object in the request body will result in all alarms being returned.

nisystemlink/clients/alarm/models/__init__.py

@@ -1,4 +1,4 @@
-from ._acknowledge_by_instance_id_response import AcknowledgeByInstanceIdResponse
+from ._acknowledge_alarms_response import AcknowledgeAlarmsResponse
 from ._alarm import Alarm, AlarmNote, AlarmTransition, AlarmTransitionType
 from ._create_or_update_alarm_request import (
     CreateAlarmTransition,
@@ -7,9 +7,9 @@
 from ._delete_by_instance_id_response import DeleteByInstanceIdResponse
 from ._query_alarms_request import (
     AlarmOrderBy,
-    QueryWithFilterRequest,
+    QueryAlarmsWithFilterRequest,
     TransitionInclusionOption,
 )
-from ._query_alarms_response import QueryWithFilterResponse
+from ._query_alarms_response import QueryAlarmsWithFilterResponse
 
 # flake8: noqa

…/_acknowledge_by_instance_id_response.py …m/models/_acknowledge_alarms_response.pynisystemlink/clients/alarm/models/_acknowledge_by_instance_id_response.py renamed to nisystemlink/clients/alarm/models/_acknowledge_alarms_response.py nisystemlink/clients/alarm/models/_acknowledge_by_instance_id_response.py renamed to nisystemlink/clients/alarm/models/_acknowledge_alarms_response.py

@@ -1,11 +1,11 @@
 from typing import List
 
-from nisystemlink.clients.alarm.models._partial_success_response_base import (
+from nisystemlink.clients.alarm.models._alarm_instances_partial_success import (
     AlarmInstancesPartialSuccess,
 )
 
 
-class AcknowledgeByInstanceIdResponse(AlarmInstancesPartialSuccess):
+class AcknowledgeAlarmsResponse(AlarmInstancesPartialSuccess):
     """Contains information about which alarms were acknowledged."""
 
     acknowledged: List[str]

…models/_partial_success_response_base.py …dels/_alarm_instances_partial_success.pynisystemlink/clients/alarm/models/_partial_success_response_base.py renamed to nisystemlink/clients/alarm/models/_alarm_instances_partial_success.py nisystemlink/clients/alarm/models/_partial_success_response_base.py renamed to nisystemlink/clients/alarm/models/_alarm_instances_partial_success.py

@@ -1,6 +1,6 @@
 from typing import List
 
-from nisystemlink.clients.alarm.models._partial_success_response_base import (
+from nisystemlink.clients.alarm.models._alarm_instances_partial_success import (
     AlarmInstancesPartialSuccess,
 )
 

nisystemlink/clients/alarm/models/_delete_by_instance_id_request.py

@@ -25,7 +25,7 @@ class AlarmOrderBy(str, Enum):
     """The date and time the alarm was last updated."""
 
 
-class QueryWithFilterRequest(JsonModel):
+class QueryAlarmsWithFilterRequest(JsonModel):
     """Contains filter information for querying alarms."""
 
     filter: Optional[str] = None