Skip to content

RegistrationFieldDisplayHints

Source code in docs_src/capo_pinpoint_sms_voice_v2/types/registration_field_display_hints.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class RegistrationFieldDisplayHints(TypedDict, closed=True):
    title: "str"
    """<p>The title of the display hint.</p>"""
    short_description: "str"
    """<p>A short description of the display hint.</p>"""
    long_description: NotRequired["str"]
    """<p>A full description of the display hint.</p>"""
    documentation_title: NotRequired["str"]
    """<p>The title of the document the display hint is associated with.</p>"""
    documentation_link: NotRequired["str"]
    """<p>The link to the document the display hint is associated with.</p>"""
    select_option_descriptions: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.select_option_descriptions_list.SelectOptionDescriptionsList"
    ]
    """<p>An array of SelectOptionDescription objects.</p>"""
    text_validation_description: NotRequired["str"]
    """<p>The validation rules for the text field.</p>"""
    example_text_value: NotRequired["str"]
    """<p>Example text of what the value of a field should contain.</p>"""

documentation_link: NotRequired[str]

The link to the document the display hint is associated with.

documentation_title instance-attribute 

documentation_title: NotRequired[str]

The title of the document the display hint is associated with.

example_text_value instance-attribute 

example_text_value: NotRequired[str]

Example text of what the value of a field should contain.

long_description instance-attribute 

long_description: NotRequired[str]

A full description of the display hint.

select_option_descriptions instance-attribute 

select_option_descriptions: NotRequired[SelectOptionDescriptionsList]

An array of SelectOptionDescription objects.

short_description instance-attribute 

short_description: str

A short description of the display hint.

text_validation_description instance-attribute 

text_validation_description: NotRequired[str]

The validation rules for the text field.

title instance-attribute 

title: str

The title of the display hint.