Skip to content

ObjectTypeKey

Source code in docs_src/capo_customer_profiles/types/object_type_key.py 
12
13
14
15
16
17
18
19
20
class ObjectTypeKey(TypedDict, closed=True):
    standard_identifiers: NotRequired[
        "capo_customer_profiles.types.standard_identifier_list.StandardIdentifierList"
    ]
    """<p>The types of keys that a ProfileObject can have. Each ProfileObject can have only 1 UNIQUE key but multiple PROFILE keys. PROFILE, ASSET, CASE, or ORDER means that this key can be used to tie an object to a PROFILE, ASSET, CASE, or ORDER respectively. UNIQUE means that it can be used to uniquely identify an object. If a key a is marked as SECONDARY, it will be used to search for profiles after all other PROFILE keys have been searched. A LOOKUP_ONLY key is only used to match a profile but is not persisted to be used for searching of the profile. A NEW_ONLY key is only used if the profile does not already exist before the object is ingested, otherwise it is only used for matching objects to profiles.</p>"""
    field_names: NotRequired[
        "capo_customer_profiles.types.field_name_list.FieldNameList"
    ]
    """<p>The reference for the key name of the fields map.</p>"""

field_names instance-attribute 

field_names: NotRequired[FieldNameList]

The reference for the key name of the fields map.

standard_identifiers instance-attribute 

standard_identifiers: NotRequired[StandardIdentifierList]

The types of keys that a ProfileObject can have. Each ProfileObject can have only 1 UNIQUE key but multiple PROFILE keys. PROFILE, ASSET, CASE, or ORDER means that this key can be used to tie an object to a PROFILE, ASSET, CASE, or ORDER respectively. UNIQUE means that it can be used to uniquely identify an object. If a key a is marked as SECONDARY, it will be used to search for profiles after all other PROFILE keys have been searched. A LOOKUP_ONLY key is only used to match a profile but is not persisted to be used for searching of the profile. A NEW_ONLY key is only used if the profile does not already exist before the object is ingested, otherwise it is only used for matching objects to profiles.