Skip to content

AttributeTypesSelector

Source code in docs_src/capo_customer_profiles/types/attribute_types_selector.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
class AttributeTypesSelector(TypedDict, closed=True):
    attribute_matching_model: (
        "capo_customer_profiles.types.attribute_matching_model.AttributeMatchingModel"
    )
    """<p>Configures the <code>AttributeMatchingModel</code>, you can either choose <code>ONE_TO_ONE</code> or <code>MANY_TO_MANY</code>.</p>"""
    address: NotRequired["capo_customer_profiles.types.address_list.AddressList"]
    """<p>The <code>Address</code> type. You can choose from <code>Address</code>, <code>BusinessAddress</code>, <code>MaillingAddress</code>, and <code>ShippingAddress</code>.</p> <p>You only can use the Address type in the <code>MatchingRule</code>. For example, if you want to match profile based on <code>BusinessAddress.City</code> or <code>MaillingAddress.City</code>, you need to choose the <code>BusinessAddress</code> and the <code>MaillingAddress</code> to represent the Address type and specify the <code>Address.City</code> on the matching rule.</p>"""
    phone_number: NotRequired[
        "capo_customer_profiles.types.phone_number_list.PhoneNumberList"
    ]
    """<p>The <code>PhoneNumber</code> type. You can choose from <code>PhoneNumber</code>, <code>HomePhoneNumber</code>, and <code>MobilePhoneNumber</code>.</p> <p>You only can use the <code>PhoneNumber</code> type in the <code>MatchingRule</code>. For example, if you want to match a profile based on <code>Phone</code> or <code>HomePhone</code>, you need to choose the <code>Phone</code> and the <code>HomePhone</code> to represent the <code>PhoneNumber</code> type and only specify the <code>PhoneNumber</code> on the matching rule.</p>"""
    email_address: NotRequired["capo_customer_profiles.types.email_list.EmailList"]
    """<p>The <code>Email</code> type. You can choose from <code>EmailAddress</code>, <code>BusinessEmailAddress</code> and <code>PersonalEmailAddress</code>.</p> <p>You only can use the <code>EmailAddress</code> type in the <code>MatchingRule</code>. For example, if you want to match profile based on <code>PersonalEmailAddress</code> or <code>BusinessEmailAddress</code>, you need to choose the <code>PersonalEmailAddress</code> and the <code>BusinessEmailAddress</code> to represent the <code>EmailAddress</code> type and only specify the <code>EmailAddress</code> on the matching rule.</p>"""

address instance-attribute 

address: NotRequired[AddressList]

The Address type. You can choose from Address, BusinessAddress, MaillingAddress, and ShippingAddress.

You only can use the Address type in the MatchingRule. For example, if you want to match profile based on BusinessAddress.City or MaillingAddress.City, you need to choose the BusinessAddress and the MaillingAddress to represent the Address type and specify the Address.City on the matching rule.

attribute_matching_model instance-attribute 

attribute_matching_model: AttributeMatchingModel

Configures the AttributeMatchingModel, you can either choose ONE_TO_ONE or MANY_TO_MANY.

email_address instance-attribute 

email_address: NotRequired[EmailList]

The Email type. You can choose from EmailAddress, BusinessEmailAddress and PersonalEmailAddress.

You only can use the EmailAddress type in the MatchingRule. For example, if you want to match profile based on PersonalEmailAddress or BusinessEmailAddress, you need to choose the PersonalEmailAddress and the BusinessEmailAddress to represent the EmailAddress type and only specify the EmailAddress on the matching rule.

phone_number instance-attribute 

phone_number: NotRequired[PhoneNumberList]

The PhoneNumber type. You can choose from PhoneNumber, HomePhoneNumber, and MobilePhoneNumber.

You only can use the PhoneNumber type in the MatchingRule. For example, if you want to match a profile based on Phone or HomePhone, you need to choose the Phone and the HomePhone to represent the PhoneNumber type and only specify the PhoneNumber on the matching rule.