Skip to content

TreatmentResource

Source code in docs_src/capo_pinpoint/types/treatment_resource.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
class TreatmentResource(TypedDict, closed=True):
    custom_delivery_configuration: NotRequired[
        "capo_pinpoint.types.custom_delivery_configuration.CustomDeliveryConfiguration"
    ]
    """<p>The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.</p>"""
    id: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The unique identifier for the treatment.</p>"""
    message_configuration: NotRequired[
        "capo_pinpoint.types.message_configuration.MessageConfiguration"
    ]
    """<p>The message configuration settings for the treatment.</p>"""
    schedule: NotRequired["capo_pinpoint.types.schedule.Schedule"]
    """<p>The schedule settings for the treatment.</p>"""
    size_percent: NotRequired["capo_pinpoint.types.__integer.__integer"]
    """<p>The allocated percentage of users (segment members) that the treatment is sent to.</p>"""
    state: NotRequired["capo_pinpoint.types.campaign_state.CampaignState"]
    """<p>The current status of the treatment.</p>"""
    template_configuration: NotRequired[
        "capo_pinpoint.types.template_configuration.TemplateConfiguration"
    ]
    """<p>The message template to use for the treatment.</p>"""
    treatment_description: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The custom description of the treatment.</p>"""
    treatment_name: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The custom name of the treatment.</p>"""

custom_delivery_configuration instance-attribute 

custom_delivery_configuration: NotRequired[CustomDeliveryConfiguration]

The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.

id instance-attribute 

id: NotRequired[__string]

The unique identifier for the treatment.

message_configuration instance-attribute 

message_configuration: NotRequired[MessageConfiguration]

The message configuration settings for the treatment.

schedule instance-attribute 

schedule: NotRequired[Schedule]

The schedule settings for the treatment.

size_percent instance-attribute 

size_percent: NotRequired[__integer]

The allocated percentage of users (segment members) that the treatment is sent to.

state instance-attribute 

state: NotRequired[CampaignState]

The current status of the treatment.

template_configuration instance-attribute 

template_configuration: NotRequired[TemplateConfiguration]

The message template to use for the treatment.

treatment_description instance-attribute 

treatment_description: NotRequired[__string]

The custom description of the treatment.

treatment_name instance-attribute 

treatment_name: NotRequired[__string]

The custom name of the treatment.