RegistrationFieldDefinition ¶

class RegistrationFieldDefinition(TypedDict, closed=True):
    section_path: "capo_pinpoint_sms_voice_v2.types.section_path.SectionPath"
    """<p>The section path of the field.</p>"""
    field_path: "capo_pinpoint_sms_voice_v2.types.field_path.FieldPath"
    """<p>The path to the registration form field. You can use <a>DescribeRegistrationFieldDefinitions</a> for a list of <b>FieldPaths</b>.</p>"""
    field_type: "capo_pinpoint_sms_voice_v2.types.field_type.FieldType"
    """<p>The type of field.</p>"""
    field_requirement: (
        "capo_pinpoint_sms_voice_v2.types.field_requirement.FieldRequirement"
    )
    """<p>Specifies if the field for the registration form is required, conditional or optional.</p>"""
    select_validation: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.select_validation.SelectValidation"
    ]
    """<p>The validation rules for a select field.</p>"""
    text_validation: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.text_validation.TextValidation"
    ]
    """<p>The validation rules for a text field.</p>"""
    display_hints: "capo_pinpoint_sms_voice_v2.types.registration_field_display_hints.RegistrationFieldDisplayHints"
    """<p>An array of RegistrationFieldDisplayHints objects for the field.</p>"""
    conditional_behavior: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.conditional_behavior.ConditionalBehavior"
    ]
    """<p>The conditional behavior rules for this field. Only present when <b>FieldRequirement</b> is <b>CONDITIONAL</b>. Rules are evaluated in order and the first matching rule determines the field's resolved requirement. If no rule matches, the <b>DefaultBehavior</b> applies.</p>"""