Skip to content

TemplateVariableMetadata

Source code in docs_src/capo_pinpoint_sms_voice_v2/types/template_variable_metadata.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
class TemplateVariableMetadata(TypedDict, closed=True):
    type: "capo_pinpoint_sms_voice_v2.types.template_variable_type.TemplateVariableType"
    """<p>The type of the variable.</p>"""
    required: "bool"
    """<p>Whether the variable is required.</p>"""
    description: NotRequired["str"]
    """<p>A description of the variable.</p>"""
    max_length: NotRequired["int"]
    """<p>The maximum length for string variables.</p>"""
    min_value: NotRequired["int"]
    """<p>The minimum value for numeric variables.</p>"""
    max_value: NotRequired["int"]
    """<p>The maximum value for numeric variables.</p>"""
    default_value: NotRequired["str"]
    """<p>The default value for the variable.</p>"""
    pattern: NotRequired["str"]
    """<p>The regex pattern the variable value must match.</p>"""
    sample: NotRequired["str"]
    """<p>A sample value for the variable.</p>"""
    source: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.template_variable_source.TemplateVariableSource"
    ]
    """<p>The source of the variable, either <code>CUSTOMER</code> or <code>SYSTEM</code>.</p>"""

default_value instance-attribute 

default_value: NotRequired[str]

The default value for the variable.

description instance-attribute 

description: NotRequired[str]

A description of the variable.

max_length instance-attribute 

max_length: NotRequired[int]

The maximum length for string variables.

max_value instance-attribute 

max_value: NotRequired[int]

The maximum value for numeric variables.

min_value instance-attribute 

min_value: NotRequired[int]

The minimum value for numeric variables.

pattern instance-attribute 

pattern: NotRequired[str]

The regex pattern the variable value must match.

required instance-attribute 

required: bool

Whether the variable is required.

sample instance-attribute 

sample: NotRequired[str]

A sample value for the variable.

source instance-attribute 

source: NotRequired[TemplateVariableSource]

The source of the variable, either CUSTOMER or SYSTEM.

type instance-attribute 

type: TemplateVariableType

The type of the variable.