nisystemlink.clients.notification

class nisystemlink.clients.notification.NotificationClient(configuration=None)[source]

__init__(configuration=None)[source]

Initialize an instance.

Parameters: configuration (Optional[nisystemlink.clients.core.HttpConfiguration]) – Defines the web server to connect to and information about how to connect. If not provided, the HttpConfigurationManager is used to obtain the configuration.
Raises: ApiException – if unable to communicate with the /ninotification service.

apply_dynamic_notification_strategy(request)[source]

Applies the notification strategy from the given request.

Parameters: request (nisystemlink.clients.notification.models.DynamicStrategyRequest) – Request with message template substitution fields and notification strategies.
Return type: None
Returns: None.
Raises: ApiException – if unable to communicate with the /ninotification service or provided invalid arguments.

pydantic model nisystemlink.clients.notification.models.AddressGroup[source]

Model defining notification recipients for generic service.

Show JSON schema

{
   "title": "AddressGroup",
   "description": "Model defining notification recipients for generic service.",
   "type": "object",
   "properties": {
      "id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Id"
      },
      "display_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Display Name"
      },
      "properties": {
         "anyOf": [
            {
               "additionalProperties": {
                  "type": "string"
               },
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Properties"
      },
      "referencing_notification_strategies": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Referencing Notification Strategies"
      },
      "interpreting_service_name": {
         "title": "Interpreting Service Name",
         "type": "string"
      },
      "fields": {
         "additionalProperties": {
            "items": {
               "type": "string"
            },
            "type": "array"
         },
         "title": "Fields",
         "type": "object"
      }
   },
   "required": [
      "interpreting_service_name",
      "fields"
   ]
}

Fields

fields
interpreting_service_name

field fields: Dict[str, List[str]] [Required]: Address group’s fields. Requires at least one valid recipient.

field interpreting_service_name: str [Required]: Name of the interpreting service.

pydantic model nisystemlink.clients.notification.models.DynamicNotificationConfiguration[source]

Model for notification configuration defining address groups and message template for the notification.

Requires at least one of addressGroupId or addressGroup, and one of messageTemplateId or messageTemplate.

Show JSON schema

{
   "title": "DynamicNotificationConfiguration",
   "description": "Model for notification configuration defining address groups and message template for the notification.\n\nRequires at least one of addressGroupId or addressGroup, and one of messageTemplateId or messageTemplate.",
   "type": "object",
   "properties": {
      "address_group_id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Address Group Id"
      },
      "message_template_id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Message Template Id"
      },
      "address_group": {
         "anyOf": [
            {
               "$ref": "#/$defs/AddressGroup"
            },
            {
               "$ref": "#/$defs/SmtpAddressGroup"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Address Group"
      },
      "message_template": {
         "anyOf": [
            {
               "$ref": "#/$defs/MessageTemplate"
            },
            {
               "$ref": "#/$defs/SmtpMessageTemplate"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Message Template"
      }
   },
   "$defs": {
      "AddressGroup": {
         "description": "Model defining notification recipients for generic service.",
         "properties": {
            "id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Id"
            },
            "display_name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Display Name"
            },
            "properties": {
               "anyOf": [
                  {
                     "additionalProperties": {
                        "type": "string"
                     },
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Properties"
            },
            "referencing_notification_strategies": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Referencing Notification Strategies"
            },
            "interpreting_service_name": {
               "title": "Interpreting Service Name",
               "type": "string"
            },
            "fields": {
               "additionalProperties": {
                  "items": {
                     "type": "string"
                  },
                  "type": "array"
               },
               "title": "Fields",
               "type": "object"
            }
         },
         "required": [
            "interpreting_service_name",
            "fields"
         ],
         "title": "AddressGroup",
         "type": "object"
      },
      "MessageTemplate": {
         "description": "Model defining the notification content structure.",
         "properties": {
            "id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Id"
            },
            "display_name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Display Name"
            },
            "properties": {
               "anyOf": [
                  {
                     "additionalProperties": {
                        "type": "string"
                     },
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Properties"
            },
            "referencing_notification_strategies": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Referencing Notification Strategies"
            },
            "interpreting_service_name": {
               "title": "Interpreting Service Name",
               "type": "string"
            },
            "fields": {
               "additionalProperties": {
                  "type": "string"
               },
               "title": "Fields",
               "type": "object"
            }
         },
         "required": [
            "interpreting_service_name",
            "fields"
         ],
         "title": "MessageTemplate",
         "type": "object"
      },
      "SmtpAddressFields": {
         "description": "Recipient address fields used in SMTP messaging.",
         "properties": {
            "to_addresses": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "To Addresses"
            },
            "cc_addresses": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Cc Addresses"
            },
            "bcc_addresses": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Bcc Addresses"
            }
         },
         "title": "SmtpAddressFields",
         "type": "object"
      },
      "SmtpAddressGroup": {
         "description": "Model defining notification recipients for SMTP service.",
         "properties": {
            "id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Id"
            },
            "display_name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Display Name"
            },
            "properties": {
               "anyOf": [
                  {
                     "additionalProperties": {
                        "type": "string"
                     },
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Properties"
            },
            "referencing_notification_strategies": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Referencing Notification Strategies"
            },
            "interpreting_service_name": {
               "const": "smtp",
               "default": "smtp",
               "title": "Interpreting Service Name",
               "type": "string"
            },
            "fields": {
               "$ref": "#/$defs/SmtpAddressFields"
            }
         },
         "required": [
            "fields"
         ],
         "title": "SmtpAddressGroup",
         "type": "object"
      },
      "SmtpMessageTemplate": {
         "description": "Model defining message template for SMTP service",
         "properties": {
            "id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Id"
            },
            "display_name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Display Name"
            },
            "properties": {
               "anyOf": [
                  {
                     "additionalProperties": {
                        "type": "string"
                     },
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Properties"
            },
            "referencing_notification_strategies": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Referencing Notification Strategies"
            },
            "interpreting_service_name": {
               "const": "smtp",
               "default": "smtp",
               "title": "Interpreting Service Name",
               "type": "string"
            },
            "fields": {
               "$ref": "#/$defs/SmtpMessageTemplateFields"
            }
         },
         "required": [
            "fields"
         ],
         "title": "SmtpMessageTemplate",
         "type": "object"
      },
      "SmtpMessageTemplateFields": {
         "description": "Template fields to construct an SMTP message.",
         "properties": {
            "subject_template": {
               "title": "Subject Template",
               "type": "string"
            },
            "body_template": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Body Template"
            }
         },
         "required": [
            "subject_template"
         ],
         "title": "SmtpMessageTemplateFields",
         "type": "object"
      }
   }
}

Fields

address_group
address_group_id
message_template
message_template_id

Validators

validate_required_pairs » all fields

field address_group: AddressGroup | SmtpAddressGroup | None = None

Address group defining notification recipients.

Validated by

validate_required_pairs

field address_group_id: str | None = None

ID referencing the associated address group.

Validated by

validate_required_pairs

field message_template: MessageTemplate | SmtpMessageTemplate | None = None

Message template defining notification content structure

Validated by

validate_required_pairs

field message_template_id: str | None = None

ID referencing the associated message template.

Validated by

validate_required_pairs

validator validate_required_pairs » all fields [source]

Validator to check at least one of address_group_id or address_group, and one of message_template_id or message_template is present.

Return type: nisystemlink.clients.notification.models.DynamicNotificationConfiguration

pydantic model nisystemlink.clients.notification.models.DynamicNotificationStrategy[source]

Model for the notification strategy to be applied.

Show JSON schema

{
   "title": "DynamicNotificationStrategy",
   "description": "Model for the notification strategy to be applied.",
   "type": "object",
   "properties": {
      "notification_configurations": {
         "items": {
            "$ref": "#/$defs/DynamicNotificationConfiguration"
         },
         "minItems": 1,
         "title": "Notification Configurations",
         "type": "array"
      }
   },
   "$defs": {
      "AddressGroup": {
         "description": "Model defining notification recipients for generic service.",
         "properties": {
            "id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Id"
            },
            "display_name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Display Name"
            },
            "properties": {
               "anyOf": [
                  {
                     "additionalProperties": {
                        "type": "string"
                     },
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Properties"
            },
            "referencing_notification_strategies": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Referencing Notification Strategies"
            },
            "interpreting_service_name": {
               "title": "Interpreting Service Name",
               "type": "string"
            },
            "fields": {
               "additionalProperties": {
                  "items": {
                     "type": "string"
                  },
                  "type": "array"
               },
               "title": "Fields",
               "type": "object"
            }
         },
         "required": [
            "interpreting_service_name",
            "fields"
         ],
         "title": "AddressGroup",
         "type": "object"
      },
      "DynamicNotificationConfiguration": {
         "description": "Model for notification configuration defining address groups and message template for the notification.\n\nRequires at least one of addressGroupId or addressGroup, and one of messageTemplateId or messageTemplate.",
         "properties": {
            "address_group_id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Address Group Id"
            },
            "message_template_id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Message Template Id"
            },
            "address_group": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/AddressGroup"
                  },
                  {
                     "$ref": "#/$defs/SmtpAddressGroup"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Address Group"
            },
            "message_template": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/MessageTemplate"
                  },
                  {
                     "$ref": "#/$defs/SmtpMessageTemplate"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Message Template"
            }
         },
         "title": "DynamicNotificationConfiguration",
         "type": "object"
      },
      "MessageTemplate": {
         "description": "Model defining the notification content structure.",
         "properties": {
            "id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Id"
            },
            "display_name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Display Name"
            },
            "properties": {
               "anyOf": [
                  {
                     "additionalProperties": {
                        "type": "string"
                     },
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Properties"
            },
            "referencing_notification_strategies": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Referencing Notification Strategies"
            },
            "interpreting_service_name": {
               "title": "Interpreting Service Name",
               "type": "string"
            },
            "fields": {
               "additionalProperties": {
                  "type": "string"
               },
               "title": "Fields",
               "type": "object"
            }
         },
         "required": [
            "interpreting_service_name",
            "fields"
         ],
         "title": "MessageTemplate",
         "type": "object"
      },
      "SmtpAddressFields": {
         "description": "Recipient address fields used in SMTP messaging.",
         "properties": {
            "to_addresses": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "To Addresses"
            },
            "cc_addresses": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Cc Addresses"
            },
            "bcc_addresses": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Bcc Addresses"
            }
         },
         "title": "SmtpAddressFields",
         "type": "object"
      },
      "SmtpAddressGroup": {
         "description": "Model defining notification recipients for SMTP service.",
         "properties": {
            "id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Id"
            },
            "display_name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Display Name"
            },
            "properties": {
               "anyOf": [
                  {
                     "additionalProperties": {
                        "type": "string"
                     },
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Properties"
            },
            "referencing_notification_strategies": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Referencing Notification Strategies"
            },
            "interpreting_service_name": {
               "const": "smtp",
               "default": "smtp",
               "title": "Interpreting Service Name",
               "type": "string"
            },
            "fields": {
               "$ref": "#/$defs/SmtpAddressFields"
            }
         },
         "required": [
            "fields"
         ],
         "title": "SmtpAddressGroup",
         "type": "object"
      },
      "SmtpMessageTemplate": {
         "description": "Model defining message template for SMTP service",
         "properties": {
            "id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Id"
            },
            "display_name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Display Name"
            },
            "properties": {
               "anyOf": [
                  {
                     "additionalProperties": {
                        "type": "string"
                     },
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Properties"
            },
            "referencing_notification_strategies": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Referencing Notification Strategies"
            },
            "interpreting_service_name": {
               "const": "smtp",
               "default": "smtp",
               "title": "Interpreting Service Name",
               "type": "string"
            },
            "fields": {
               "$ref": "#/$defs/SmtpMessageTemplateFields"
            }
         },
         "required": [
            "fields"
         ],
         "title": "SmtpMessageTemplate",
         "type": "object"
      },
      "SmtpMessageTemplateFields": {
         "description": "Template fields to construct an SMTP message.",
         "properties": {
            "subject_template": {
               "title": "Subject Template",
               "type": "string"
            },
            "body_template": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Body Template"
            }
         },
         "required": [
            "subject_template"
         ],
         "title": "SmtpMessageTemplateFields",
         "type": "object"
      }
   },
   "required": [
      "notification_configurations"
   ]
}

Fields

notification_configurations

field notification_configurations: Annotated[List[DynamicNotificationConfiguration]] [Required]

Notification configurations associated with this strategy.

Constraints

min_length = 1

pydantic model nisystemlink.clients.notification.models.DynamicStrategyRequest[source]

Request model for applying a dynamic notification strategy.

Show JSON schema

{
   "title": "DynamicStrategyRequest",
   "description": "Request model for applying a dynamic notification strategy.",
   "type": "object",
   "properties": {
      "message_template_substitution_fields": {
         "anyOf": [
            {
               "additionalProperties": {
                  "type": "string"
               },
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Message Template Substitution Fields"
      },
      "notification_strategy": {
         "$ref": "#/$defs/DynamicNotificationStrategy"
      }
   },
   "$defs": {
      "AddressGroup": {
         "description": "Model defining notification recipients for generic service.",
         "properties": {
            "id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Id"
            },
            "display_name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Display Name"
            },
            "properties": {
               "anyOf": [
                  {
                     "additionalProperties": {
                        "type": "string"
                     },
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Properties"
            },
            "referencing_notification_strategies": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Referencing Notification Strategies"
            },
            "interpreting_service_name": {
               "title": "Interpreting Service Name",
               "type": "string"
            },
            "fields": {
               "additionalProperties": {
                  "items": {
                     "type": "string"
                  },
                  "type": "array"
               },
               "title": "Fields",
               "type": "object"
            }
         },
         "required": [
            "interpreting_service_name",
            "fields"
         ],
         "title": "AddressGroup",
         "type": "object"
      },
      "DynamicNotificationConfiguration": {
         "description": "Model for notification configuration defining address groups and message template for the notification.\n\nRequires at least one of addressGroupId or addressGroup, and one of messageTemplateId or messageTemplate.",
         "properties": {
            "address_group_id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Address Group Id"
            },
            "message_template_id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Message Template Id"
            },
            "address_group": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/AddressGroup"
                  },
                  {
                     "$ref": "#/$defs/SmtpAddressGroup"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Address Group"
            },
            "message_template": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/MessageTemplate"
                  },
                  {
                     "$ref": "#/$defs/SmtpMessageTemplate"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Message Template"
            }
         },
         "title": "DynamicNotificationConfiguration",
         "type": "object"
      },
      "DynamicNotificationStrategy": {
         "description": "Model for the notification strategy to be applied.",
         "properties": {
            "notification_configurations": {
               "items": {
                  "$ref": "#/$defs/DynamicNotificationConfiguration"
               },
               "minItems": 1,
               "title": "Notification Configurations",
               "type": "array"
            }
         },
         "required": [
            "notification_configurations"
         ],
         "title": "DynamicNotificationStrategy",
         "type": "object"
      },
      "MessageTemplate": {
         "description": "Model defining the notification content structure.",
         "properties": {
            "id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Id"
            },
            "display_name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Display Name"
            },
            "properties": {
               "anyOf": [
                  {
                     "additionalProperties": {
                        "type": "string"
                     },
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Properties"
            },
            "referencing_notification_strategies": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Referencing Notification Strategies"
            },
            "interpreting_service_name": {
               "title": "Interpreting Service Name",
               "type": "string"
            },
            "fields": {
               "additionalProperties": {
                  "type": "string"
               },
               "title": "Fields",
               "type": "object"
            }
         },
         "required": [
            "interpreting_service_name",
            "fields"
         ],
         "title": "MessageTemplate",
         "type": "object"
      },
      "SmtpAddressFields": {
         "description": "Recipient address fields used in SMTP messaging.",
         "properties": {
            "to_addresses": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "To Addresses"
            },
            "cc_addresses": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Cc Addresses"
            },
            "bcc_addresses": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Bcc Addresses"
            }
         },
         "title": "SmtpAddressFields",
         "type": "object"
      },
      "SmtpAddressGroup": {
         "description": "Model defining notification recipients for SMTP service.",
         "properties": {
            "id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Id"
            },
            "display_name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Display Name"
            },
            "properties": {
               "anyOf": [
                  {
                     "additionalProperties": {
                        "type": "string"
                     },
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Properties"
            },
            "referencing_notification_strategies": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Referencing Notification Strategies"
            },
            "interpreting_service_name": {
               "const": "smtp",
               "default": "smtp",
               "title": "Interpreting Service Name",
               "type": "string"
            },
            "fields": {
               "$ref": "#/$defs/SmtpAddressFields"
            }
         },
         "required": [
            "fields"
         ],
         "title": "SmtpAddressGroup",
         "type": "object"
      },
      "SmtpMessageTemplate": {
         "description": "Model defining message template for SMTP service",
         "properties": {
            "id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Id"
            },
            "display_name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Display Name"
            },
            "properties": {
               "anyOf": [
                  {
                     "additionalProperties": {
                        "type": "string"
                     },
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Properties"
            },
            "referencing_notification_strategies": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Referencing Notification Strategies"
            },
            "interpreting_service_name": {
               "const": "smtp",
               "default": "smtp",
               "title": "Interpreting Service Name",
               "type": "string"
            },
            "fields": {
               "$ref": "#/$defs/SmtpMessageTemplateFields"
            }
         },
         "required": [
            "fields"
         ],
         "title": "SmtpMessageTemplate",
         "type": "object"
      },
      "SmtpMessageTemplateFields": {
         "description": "Template fields to construct an SMTP message.",
         "properties": {
            "subject_template": {
               "title": "Subject Template",
               "type": "string"
            },
            "body_template": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Body Template"
            }
         },
         "required": [
            "subject_template"
         ],
         "title": "SmtpMessageTemplateFields",
         "type": "object"
      }
   },
   "required": [
      "notification_strategy"
   ]
}

Fields

message_template_substitution_fields
notification_strategy

field message_template_substitution_fields: Optional[Dict[str, str]] = None

Defines the fields used for substituting values in the message template.

Example: { “replacement”: “value” }

field notification_strategy: DynamicNotificationStrategy [Required]: Notification strategy containing configurations for address groups and message templates.

pydantic model nisystemlink.clients.notification.models.MessageTemplate[source]

Model defining the notification content structure.

Show JSON schema

{
   "title": "MessageTemplate",
   "description": "Model defining the notification content structure.",
   "type": "object",
   "properties": {
      "id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Id"
      },
      "display_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Display Name"
      },
      "properties": {
         "anyOf": [
            {
               "additionalProperties": {
                  "type": "string"
               },
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Properties"
      },
      "referencing_notification_strategies": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Referencing Notification Strategies"
      },
      "interpreting_service_name": {
         "title": "Interpreting Service Name",
         "type": "string"
      },
      "fields": {
         "additionalProperties": {
            "type": "string"
         },
         "title": "Fields",
         "type": "object"
      }
   },
   "required": [
      "interpreting_service_name",
      "fields"
   ]
}

Fields

fields
interpreting_service_name

field fields: Dict[str, str] [Required]: Template fields for message.

field interpreting_service_name: str [Required]: Name of the interpreting service

pydantic model nisystemlink.clients.notification.models.SmtpAddressFields[source]

Recipient address fields used in SMTP messaging.

Show JSON schema

{
   "title": "SmtpAddressFields",
   "description": "Recipient address fields used in SMTP messaging.",
   "type": "object",
   "properties": {
      "to_addresses": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "To Addresses"
      },
      "cc_addresses": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Cc Addresses"
      },
      "bcc_addresses": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Bcc Addresses"
      }
   }
}

Fields

bcc_addresses
cc_addresses
to_addresses

field bcc_addresses: Optional[List[str]] = None: List of blind carbon copy recipient addresses.

field cc_addresses: Optional[List[str]] = None: List of carbon copy recipient addresses.

field to_addresses: Optional[List[str]] = None: List of primary recipient addresses.

pydantic model nisystemlink.clients.notification.models.SmtpAddressGroup[source]

Model defining notification recipients for SMTP service.

Show JSON schema

{
   "title": "SmtpAddressGroup",
   "description": "Model defining notification recipients for SMTP service.",
   "type": "object",
   "properties": {
      "id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Id"
      },
      "display_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Display Name"
      },
      "properties": {
         "anyOf": [
            {
               "additionalProperties": {
                  "type": "string"
               },
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Properties"
      },
      "referencing_notification_strategies": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Referencing Notification Strategies"
      },
      "interpreting_service_name": {
         "const": "smtp",
         "default": "smtp",
         "title": "Interpreting Service Name",
         "type": "string"
      },
      "fields": {
         "$ref": "#/$defs/SmtpAddressFields"
      }
   },
   "$defs": {
      "SmtpAddressFields": {
         "description": "Recipient address fields used in SMTP messaging.",
         "properties": {
            "to_addresses": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "To Addresses"
            },
            "cc_addresses": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Cc Addresses"
            },
            "bcc_addresses": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Bcc Addresses"
            }
         },
         "title": "SmtpAddressFields",
         "type": "object"
      }
   },
   "required": [
      "fields"
   ]
}

Fields

fields
interpreting_service_name

Validators

set_interpreting_service_name » all fields

field fields: SmtpAddressFields [Required]

Recipient address fields used for SMTP notifications.

Valid fields:

to_addresses
cc_addresses
bcc_addresses

Example

{: to_addresses: [ “address1@example.com” ], cc_addresses: [ “address2@example.com” ], bcc_addresses: [ “address3@example.com” ]

}

Validated by

set_interpreting_service_name

field interpreting_service_name: Literal['smtp'] = 'smtp'

Service name for SMTP-based interpretation.

Validated by

set_interpreting_service_name

validator set_interpreting_service_name » all fields [source]

Return type: nisystemlink.clients.notification.models.SmtpAddressGroup

pydantic model nisystemlink.clients.notification.models.SmtpMessageTemplate[source]

Model defining message template for SMTP service

Show JSON schema

{
   "title": "SmtpMessageTemplate",
   "description": "Model defining message template for SMTP service",
   "type": "object",
   "properties": {
      "id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Id"
      },
      "display_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Display Name"
      },
      "properties": {
         "anyOf": [
            {
               "additionalProperties": {
                  "type": "string"
               },
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Properties"
      },
      "referencing_notification_strategies": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Referencing Notification Strategies"
      },
      "interpreting_service_name": {
         "const": "smtp",
         "default": "smtp",
         "title": "Interpreting Service Name",
         "type": "string"
      },
      "fields": {
         "$ref": "#/$defs/SmtpMessageTemplateFields"
      }
   },
   "$defs": {
      "SmtpMessageTemplateFields": {
         "description": "Template fields to construct an SMTP message.",
         "properties": {
            "subject_template": {
               "title": "Subject Template",
               "type": "string"
            },
            "body_template": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Body Template"
            }
         },
         "required": [
            "subject_template"
         ],
         "title": "SmtpMessageTemplateFields",
         "type": "object"
      }
   },
   "required": [
      "fields"
   ]
}

Fields

fields
interpreting_service_name

Validators

set_interpreting_service_name » all fields

field fields: SmtpMessageTemplateFields [Required]

Subject and body template fields for SMTP messages.

Validated by

set_interpreting_service_name

field interpreting_service_name: Literal['smtp'] = 'smtp'

Service name for SMTP-based interpretation.

Validated by

set_interpreting_service_name

validator set_interpreting_service_name » all fields [source]

Return type: nisystemlink.clients.notification.models.SmtpMessageTemplate

pydantic model nisystemlink.clients.notification.models.SmtpMessageTemplateFields[source]

Template fields to construct an SMTP message.

Show JSON schema

{
   "title": "SmtpMessageTemplateFields",
   "description": "Template fields to construct an SMTP message.",
   "type": "object",
   "properties": {
      "subject_template": {
         "title": "Subject Template",
         "type": "string"
      },
      "body_template": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Body Template"
      }
   },
   "required": [
      "subject_template"
   ]
}

Fields

body_template
subject_template

field body_template: Optional[str] = None: Body template of the message.

field subject_template: str [Required]: Subject template of the message.