Skip to content

ObjectTypeField

Source code in docs_src/capo_customer_profiles/types/object_type_field.py 
12
13
14
15
16
17
18
19
20
class ObjectTypeField(TypedDict, closed=True):
    source: NotRequired["capo_customer_profiles.types.text.text"]
    """<p>A field of a ProfileObject. For example: _source.FirstName, where “_source” is a ProfileObjectType of a Zendesk user and “FirstName” is a field in that ObjectType.</p>"""
    target: NotRequired["capo_customer_profiles.types.text.text"]
    """<p>The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode. Do not include sensitive or personally identifiable information (PII) in the target field name.</p>"""
    content_type: NotRequired[
        "capo_customer_profiles.types.field_content_type.FieldContentType"
    ]
    """<p>The content type of the field. Used for determining equality when searching.</p>"""

content_type instance-attribute 

content_type: NotRequired[FieldContentType]

The content type of the field. Used for determining equality when searching.

source instance-attribute 

source: NotRequired[text]

A field of a ProfileObject. For example: _source.FirstName, where “_source” is a ProfileObjectType of a Zendesk user and “FirstName” is a field in that ObjectType.

target instance-attribute 

target: NotRequired[text]

The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode. Do not include sensitive or personally identifiable information (PII) in the target field name.