Skip to content

NumberPreferenceItem

Source code in docs_src/capo_pinpoint_sms_voice_v2/types/number_preference_item.py
class NumberPreferenceItem(TypedDict, closed=True):
    preference_type: (
        "capo_pinpoint_sms_voice_v2.types.preference_type_list.PreferenceTypeList"
    )
    """<p>The type of match to apply to the filter values.</p> <ul> <li> <p> <code>StartsWith</code>: Returns numbers that begin with the filter value.</p> </li> <li> <p> <code>EndsWith</code>: Returns numbers that end with the filter value.</p> </li> <li> <p> <code>Contains</code>: Returns numbers that contain the filter value.</p> </li> <li> <p> <code>ExactMatch</code>: Returns the number that exactly matches the filter value.</p> </li> </ul>"""
    filter: "capo_pinpoint_sms_voice_v2.types.number_filter_list.NumberFilterList"
    """<p>The digit pattern values to match against available phone numbers, using the specified preference type.</p>"""

filter instance-attribute

The digit pattern values to match against available phone numbers, using the specified preference type.

preference_type instance-attribute

preference_type: PreferenceTypeList

The type of match to apply to the filter values.

  • StartsWith: Returns numbers that begin with the filter value.

  • EndsWith: Returns numbers that end with the filter value.

  • Contains: Returns numbers that contain the filter value.

  • ExactMatch: Returns the number that exactly matches the filter value.