Skip to content

FieldCondition

Source code in docs_src/capo_pinpoint_sms_voice_v2/types/field_condition.py 
15
16
17
18
19
20
21
22
23
class FieldCondition(TypedDict, closed=True):
    depends_on_field_path: "capo_pinpoint_sms_voice_v2.types.field_path.FieldPath"
    """<p>The path of the field whose value determines this condition, for example <b>companyInfo.businessType</b>.</p>"""
    operator: "capo_pinpoint_sms_voice_v2.types.condition_operator.ConditionOperator"
    """<p>The comparison operator to apply between the dependency field's value and <b>Values</b>. Valid values are <b>EQUALS</b>, <b>NOT_EQUALS</b>, <b>IN</b>, <b>NOT_IN</b>, <b>HAS_VALUE</b>, and <b>NO_VALUE</b>. Operators not in this list are treated as evaluating to false, which causes the containing rule to be skipped. This allows forward-compatible additions of new operators without breaking older SDK clients.</p>"""
    values: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.condition_value_list.ConditionValueList"
    ]
    """<p>The values to compare the dependency field's value against. Required for the <b>EQUALS</b>, <b>NOT_EQUALS</b>, <b>IN</b>, and <b>NOT_IN</b> operators. Omitted for <b>HAS_VALUE</b> and <b>NO_VALUE</b>, which test only presence.</p>"""

depends_on_field_path instance-attribute 

depends_on_field_path: FieldPath

The path of the field whose value determines this condition, for example companyInfo.businessType.

operator instance-attribute 

operator: ConditionOperator

The comparison operator to apply between the dependency field's value and Values. Valid values are EQUALS, NOT_EQUALS, IN, NOT_IN, HAS_VALUE, and NO_VALUE. Operators not in this list are treated as evaluating to false, which causes the containing rule to be skipped. This allows forward-compatible additions of new operators without breaking older SDK clients.

values instance-attribute 

values: NotRequired[ConditionValueList]

The values to compare the dependency field's value against. Required for the EQUALS, NOT_EQUALS, IN, and NOT_IN operators. Omitted for HAS_VALUE and NO_VALUE, which test only presence.