Skip to content

feat: Add Client for Alarm API - #173

Merged
RSam-NI merged 16 commits into
masterfrom
users/sam/feat/alarm-api-client
Dec 22, 2025
Merged

RSam-NI merged 16 commits into
masterfrom
users/sam/feat/alarm-api-client

Conversation

@RSam-NI

@RSam-NI RSam-NI commented Dec 8, 2025 •

Copy link
Copy Markdown
Contributor

What does this Pull Request accomplish?

This PR adds client module for Alarm Service API.

Why should this Pull Request be merged?

The AlarmClient makes it easier for users to interact with the endpoints of Alarm Service by just creating an instance of it.

What testing has been done?

Automated integration tests are included.

API Link: Swagger Link

@RSam-NI
RSam-NI marked this pull request as ready for review December 8, 2025 18:52
@RSam-NI
RSam-NI marked this pull request as draft December 8, 2025 18:52
@SSadaiyappan-NI

Copy link
Copy Markdown
Contributor

Go through the docs folder in the repo,

  1. Create new rst file in api_reference
  2. Update api_reference.rst
  3. Update getting_started.rst

Comment thread nisystemlink/clients/alarm/_alarm_client.py
Comment thread nisystemlink/clients/alarm/_alarm_client.py Outdated
Comment thread nisystemlink/clients/alarm/_alarm_client.py Outdated
Comment thread nisystemlink/clients/alarm/_alarm_client.py
Comment thread nisystemlink/clients/alarm/_alarm_client.py Outdated
Comment thread nisystemlink/clients/alarm/models/_partial_success_response_base.py Outdated
Comment thread nisystemlink/clients/alarm/models/_acknowledge_by_instance_id_response.py Outdated
Comment thread tests/integration/alarm/test_alarm_client.py
Comment thread tests/integration/alarm/test_alarm_client.py
Comment thread tests/integration/alarm/test_alarm_client.py Outdated
Comment thread tests/integration/alarm/test_alarm_client.py Outdated
Comment thread tests/integration/alarm/test_alarm_client.py
Comment thread nisystemlink/clients/alarm/_alarm_client.py Outdated
Comment thread nisystemlink/clients/alarm/_alarm_client.py Outdated
Comment thread nisystemlink/clients/alarm/_alarm_client.py Outdated
Comment thread nisystemlink/clients/alarm/_alarm_client.py Outdated
Comment thread examples/alarm/alarm.py Outdated
Comment thread nisystemlink/clients/alarm/_alarm_client.py Outdated
Comment thread docs/api_reference/alarm.rst Outdated
Comment thread docs/getting_started.rst Outdated
Comment thread docs/getting_started.rst Outdated
Comment thread examples/alarm/alarm.py Outdated
Comment thread tests/integration/alarm/test_alarm_client.py Outdated
Comment thread tests/integration/alarm/test_alarm_client.py Outdated
Comment thread tests/integration/alarm/test_alarm_client.py Outdated
Comment thread tests/integration/alarm/test_alarm_client.py Outdated
Comment thread docs/api_reference/alarm.rst Outdated
Comment thread docs/getting_started.rst Outdated
Comment thread nisystemlink/clients/alarm/models/_delete_by_instance_id_response.py Outdated
@RSam-NI
RSam-NI marked this pull request as ready for review December 10, 2025 13:57
Comment thread examples/alarm/alarm.py Outdated
Comment thread examples/alarm/alarm.py Outdated
Comment thread examples/alarm/alarm.py Outdated
Comment thread examples/alarm/alarm.py
Comment thread examples/alarm/alarm.py Outdated
Comment thread tests/integration/alarm/test_alarm_client.py Outdated
Comment thread tests/integration/alarm/test_alarm_client.py Outdated
Comment thread tests/integration/alarm/test_alarm_client.py Outdated
Comment thread tests/integration/alarm/test_alarm_client.py Outdated
Comment thread tests/integration/alarm/test_alarm_client.py Outdated
Comment thread examples/alarm/alarm.py Outdated
@RSam-NI
RSam-NI requested a review from spanglerco December 17, 2025 08:49
Comment thread nisystemlink/clients/alarm/models/_alarm.py Outdated
Comment thread nisystemlink/clients/alarm/models/_alarm.py
Comment thread nisystemlink/clients/alarm/models/_create_or_update_alarm_request.py Outdated
Comment thread nisystemlink/clients/alarm/models/_create_or_update_alarm_request.py Outdated
Comment thread examples/alarm/alarm.py Outdated
Comment thread examples/alarm/alarm.py Outdated
Comment thread examples/alarm/alarm.py Outdated
Comment thread tests/integration/alarm/test_alarm_client.py Outdated
Comment thread tests/integration/alarm/test_alarm_client.py Outdated
@RSam-NI
RSam-NI merged commit 722b849 into master Dec 22, 2025
13 checks passed
@RSam-NI
RSam-NI deleted the users/sam/feat/alarm-api-client branch December 22, 2025 07:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants