# NotificationEventTypeDto

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

Output DTO for a notification event type definition.

## Fields
- `eventType` (string): Canonical event type string. (nullable)
- `displayName` (string): Human-readable display name. (nullable)
- `description` (string): Description of when this event is published. (nullable)
- `maxScope` ([SubscriptionScope](https://devportal.demo.winkpg.io/docs/api/models/SubscriptionScope.md)): The broadest scope that can subscribe to this event.
  Values:
  - `Merchant`: Subscription scoped to a specific merchant. Only matches events originating from that merchant.
  - `Reseller`: Subscription scoped to a reseller and all its descendants (sub-resellers and merchants). Uses ResellerPathPrefix for efficient hierarchy matching.
  - `Admin`: Subscription with tenant-wide scope. Matches events across all resellers and merchants within the tenant. Requires admin-level permissions.
- `category` (string): Category for grouping (e.g., "Transactions"). (nullable)
- `filterFields` (array<[FilterFieldDefinitionDto](https://devportal.demo.winkpg.io/docs/api/models/FilterFieldDefinitionDto.md)>): Fields available for filter conditions. (nullable)
  Fields of each item:
  - `field` (string): Dot-delimited attribute path. (nullable)
  - `displayName` (string): Human-readable label. (nullable)
  - `type` ([FilterFieldType](https://devportal.demo.winkpg.io/docs/api/models/FilterFieldType.md)): Data type.
    Values:
    - `String`: Free-text string field. Supports Eq, Ne, Contains, StartsWith, In.
    - `Number`: Numeric field (decimal). Supports Eq, Ne, Gt, Gte, Lt, Lte, In.
    - `Boolean`: Boolean field. Supports Eq, Ne only.
    - `DateTime`: Date/time field (UTC). Supports Eq, Ne, Gt, Gte, Lt, Lte.
    - `Enum`: Enumerated value field with a fixed set of allowed values. Supports Eq, Ne, In.
  - `allowedValues` (array<string>): Allowed values for enum fields. (nullable)
  - `allowedOperators` (array<[NotificationsFilterOperator](https://devportal.demo.winkpg.io/docs/api/models/NotificationsFilterOperator.md)>): Operators valid for this field. (nullable)
    Values:
    - `Eq`: Exact equality comparison.
    - `Ne`: Not equal comparison.
    - `Gt`: Greater than (numeric/datetime fields only).
    - `Gte`: Greater than or equal (numeric/datetime fields only).
    - `Lt`: Less than (numeric/datetime fields only).
    - `Lte`: Less than or equal (numeric/datetime fields only).
    - `Contains`: Substring containment (string fields only).
    - `StartsWith`: Prefix match (string fields only).
    - `In`: Value is one of a set (any field type).

## See also

- [All documentation](https://devportal.demo.winkpg.io/llms.txt): the machine-readable index of every public page on this site.