`IProfileNotificationSetting`

The physical TypeScript declaration from the Nuxt starter, with linked types and field comments.

IProfileNotificationSetting

One available email notification type and its current setting.

interfaces/orionplace/accounts/IEmailVerification.ts

TypeScript

export interface IProfileNotificationSetting {
  // Notification type key. Send the returned value when saving this setting.
  template_type: string;
  // Notification type name.
  label: string;
  // Explanation of when this notification is sent.
  description: string;
  // Icon name for the notification type.
  icon: string;
  // Whether this notification type is enabled for the customer.
  enabled: boolean;
  // Whether this type is available to the customer. The customer settings
  // response returns available types with `true`.
  eligible: boolean;
  // Whether the notification is mandatory. The customer settings response
  // contains optional types with `false`.
  required: boolean;
}