Skip to content

Commit 4004ded

Browse files
refactor: Update address field key names for Notification client (#198)
1 parent 9d9eeb8 commit 4004ded

File tree

3 files changed

+15
-15
lines changed

3 files changed

+15
-15
lines changed

examples/notification/notification.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ def create_notification_request_for_alarm(
8585
retrieved_alarm = alarm_client.get_alarm(instance_id=id)
8686

8787
# Define recipients to notify
88-
recipients = SmtpAddressFields(toAddresses=["sample1@example.com"])
88+
recipients = SmtpAddressFields(to_addresses=["sample1@example.com"])
8989

9090
# Create address group
9191
address_group = SmtpAddressGroup(

nisystemlink/clients/notification/models/_smtp_address_group.py

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@
1010
class SmtpAddressFields(JsonModel):
1111
"""Recipient address fields used in SMTP messaging."""
1212

13-
toAddresses: List[str] | None = None
13+
to_addresses: List[str] | None = None
1414
"""List of primary recipient addresses."""
1515

16-
ccAddresses: List[str] | None = None
16+
cc_addresses: List[str] | None = None
1717
"""List of carbon copy recipient addresses."""
1818

19-
bccAddresses: List[str] | None = None
19+
bcc_addresses: List[str] | None = None
2020
"""List of blind carbon copy recipient addresses."""
2121

2222

@@ -30,15 +30,15 @@ class SmtpAddressGroup(BaseNotificationMetadata):
3030
"""Recipient address fields used for SMTP notifications.
3131
3232
Valid fields:
33-
- toAddresses
34-
- ccAddresses
35-
- bccAddresses
33+
- to_addresses
34+
- cc_addresses
35+
- bcc_addresses
3636
3737
Example:
3838
{
39-
toAddresses: [ "address1@example.com" ],
40-
ccAddresses: [ "address2@example.com" ],
41-
bccAddresses: [ "address3@example.com" ]
39+
to_addresses: [ "address1@example.com" ],
40+
cc_addresses: [ "address2@example.com" ],
41+
bcc_addresses: [ "address3@example.com" ]
4242
}
4343
"""
4444

tests/integration/notification/test_notification_client.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ def _smtp_address_group():
2525
display_name="name",
2626
properties={"property": "value"},
2727
fields=SmtpAddressFields(
28-
toAddresses=["address1@example.com"],
29-
ccAddresses=["address2@example.com"],
30-
bccAddresses=["address3@example.com"],
28+
to_addresses=["address1@example.com"],
29+
cc_addresses=["address2@example.com"],
30+
bcc_addresses=["address3@example.com"],
3131
),
3232
referencing_notification_strategies=["reference_notification_strategy"],
3333
)
@@ -109,7 +109,7 @@ def test__apply_dynamic_strategy_with_invalid_recipient_for_smtp_service__raises
109109
_smtp_message_template: SmtpMessageTemplate,
110110
):
111111
address_group = SmtpAddressGroup(
112-
fields=SmtpAddressFields(toAddresses=["invalid-email"]),
112+
fields=SmtpAddressFields(to_addresses=["invalid-email"]),
113113
)
114114

115115
request_model = DynamicStrategyRequest(
@@ -168,7 +168,7 @@ def test__create_address_group_with_invalid_interpreting_service_name__raises_ex
168168
with pytest.raises(ValidationError):
169169
SmtpAddressGroup(
170170
interpreting_service_name="invalid_service",
171-
fields=SmtpAddressFields(toAddresses=["address1@example.com"]),
171+
fields=SmtpAddressFields(to_addresses=["address1@example.com"]),
172172
)
173173

174174
@responses.activate

0 commit comments

Comments
 (0)