Skip to content

Notifications

SmsNotificationSettings pydantic-model

Bases: OtfItemBase

SMS and phone call notification preferences for a member.

Show JSON schema: 
{
  "description": "SMS and phone call notification preferences for a member.",
  "properties": {
    "isPromotionalSmsOptIn": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Opted in to promotional SMS messages.",
      "title": "Ispromotionalsmsoptin"
    },
    "isTransactionalSmsOptIn": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Opted in to transactional SMS messages.",
      "title": "Istransactionalsmsoptin"
    },
    "isPromotionalPhoneOptIn": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Opted in to promotional phone calls.",
      "title": "Ispromotionalphoneoptin"
    },
    "isTransactionalPhoneOptIn": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Opted in to transactional phone calls.",
      "title": "Istransactionalphoneoptin"
    }
  },
  "title": "SmsNotificationSettings",
  "type": "object"
}

Fields:

is_promotional_sms_opt_in pydantic-field 

is_promotional_sms_opt_in = None

Opted in to promotional SMS messages.

is_transactional_sms_opt_in pydantic-field 

is_transactional_sms_opt_in = None

Opted in to transactional SMS messages.

is_promotional_phone_opt_in pydantic-field 

is_promotional_phone_opt_in = None

Opted in to promotional phone calls.

is_transactional_phone_opt_in pydantic-field 

is_transactional_phone_opt_in = None

Opted in to transactional phone calls.

EmailNotificationSettings pydantic-model

Bases: OtfItemBase

Email notification preferences for a member.

Show JSON schema: 
{
  "description": "Email notification preferences for a member.",
  "properties": {
    "isSystemEmailOptIn": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Opted in to system emails.",
      "title": "Issystememailoptin"
    },
    "isPromotionalEmailOptIn": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Opted in to promotional emails.",
      "title": "Ispromotionalemailoptin"
    },
    "isTransactionalEmailOptIn": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Opted in to transactional emails.",
      "title": "Istransactionalemailoptin"
    },
    "email": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Email address for notifications.",
      "title": "Email"
    }
  },
  "title": "EmailNotificationSettings",
  "type": "object"
}

Fields:

is_system_email_opt_in pydantic-field 

is_system_email_opt_in = None

Opted in to system emails.

is_promotional_email_opt_in pydantic-field 

is_promotional_email_opt_in = None

Opted in to promotional emails.

is_transactional_email_opt_in pydantic-field 

is_transactional_email_opt_in = None

Opted in to transactional emails.

email pydantic-field 

email = None

Email address for notifications.