Skip to content

EngagementProspectingResult

Source code in docs_src/capo_partnercentral_selling/types/engagement_prospecting_result.py
class EngagementProspectingResult(TypedDict, closed=True):
    engagement_identifier: (
        "capo_partnercentral_selling.types.engagement_identifier.EngagementIdentifier"
    )
    """<p>The unique identifier of the engagement that was processed.</p>"""
    engagement_context_id: NotRequired["str"]
    """<p>The identifier of the prospecting context created for this engagement. This field is only populated when the engagement was processed successfully (status is <code>COMPLETED</code>). Use this identifier to reference the prospecting context in subsequent operations.</p>"""
    status: "capo_partnercentral_selling.types.prospecting_task_status.ProspectingTaskStatus"
    """<p>The processing status of this specific engagement. Possible values are <code>PENDING</code>, <code>IN_PROGRESS</code>, <code>COMPLETED</code>, and <code>FAILED</code>.</p>"""
    reason_code: NotRequired["str"]
    """<p>An enumerated code indicating the reason this engagement failed to process. This field is only populated when <code>Status</code> is <code>FAILED</code>.</p>"""
    message: NotRequired["str"]
    """<p>A human-readable description of the failure for this engagement, including suggested recovery steps. This field is only populated when <code>Status</code> is <code>FAILED</code>.</p>"""

engagement_context_id instance-attribute

engagement_context_id: NotRequired[str]

The identifier of the prospecting context created for this engagement. This field is only populated when the engagement was processed successfully (status is COMPLETED). Use this identifier to reference the prospecting context in subsequent operations.

engagement_identifier instance-attribute

engagement_identifier: EngagementIdentifier

The unique identifier of the engagement that was processed.

message instance-attribute

message: NotRequired[str]

A human-readable description of the failure for this engagement, including suggested recovery steps. This field is only populated when Status is FAILED.

reason_code instance-attribute

reason_code: NotRequired[str]

An enumerated code indicating the reason this engagement failed to process. This field is only populated when Status is FAILED.

status instance-attribute

The processing status of this specific engagement. Possible values are PENDING, IN_PROGRESS, COMPLETED, and FAILED.