Skip to content

GetWhatsAppFlowOutput

Source code in docs_src/capo_socialmessaging/types/get_whats_app_flow_output.py
class GetWhatsAppFlowOutput(TypedDict, closed=True):
    flow_id: "capo_socialmessaging.types.meta_flow_id.MetaFlowId"
    """<p>The unique identifier of the Flow.</p>"""
    flow_name: "capo_socialmessaging.types.meta_flow_name.MetaFlowName"
    """<p>The name of the Flow.</p>"""
    flow_status: "capo_socialmessaging.types.meta_flow_status.MetaFlowStatus"
    """<p>The lifecycle status of the Flow. Valid values are DRAFT, PUBLISHED, DEPRECATED, BLOCKED, and THROTTLED.</p>"""
    categories: NotRequired[
        "capo_socialmessaging.types.meta_flow_category_list.MetaFlowCategoryList"
    ]
    """<p>The categories that classify the business purpose of the Flow.</p>"""
    validation_errors: NotRequired[
        "capo_socialmessaging.types.validation_error_list.ValidationErrorList"
    ]
    """<p>A list of validation errors from Meta, if any.</p>"""
    json_version: NotRequired[
        "capo_socialmessaging.types.meta_flow_json_version.MetaFlowJsonVersion"
    ]
    """<p>The version of the Flow JSON schema used by this Flow (for example, 7.3).</p>"""
    data_api_version: NotRequired[
        "capo_socialmessaging.types.meta_flow_data_api_version.MetaFlowDataApiVersion"
    ]
    """<p>The data API version for data exchange endpoint Flows.</p>"""
    endpoint_uri: NotRequired[
        "capo_socialmessaging.types.meta_flow_endpoint_uri.MetaFlowEndpointUri"
    ]
    """<p>The HTTPS endpoint that Meta calls for a data exchange Flow.</p>"""
    preview: NotRequired[
        "capo_socialmessaging.types.meta_flow_preview_info.MetaFlowPreviewInfo"
    ]
    """<p>The preview URL and its expiration timestamp for testing the Flow.</p>"""
    whats_app_business_account: NotRequired[
        "capo_socialmessaging.types.meta_flow_whats_app_business_account_info.MetaFlowWhatsAppBusinessAccountInfo"
    ]
    """<p>The WhatsApp Business Account information from Meta associated with this Flow.</p>"""
    application: NotRequired[
        "capo_socialmessaging.types.meta_flow_application_info.MetaFlowApplicationInfo"
    ]
    """<p>The Meta application information associated with this Flow.</p>"""
    health_status: NotRequired[
        "capo_socialmessaging.types.meta_flow_health_status.MetaFlowHealthStatus"
    ]
    """<p>The health status information for this Flow from Meta.</p>"""

application instance-attribute

application: NotRequired[MetaFlowApplicationInfo]

The Meta application information associated with this Flow.

categories instance-attribute

categories: NotRequired[MetaFlowCategoryList]

The categories that classify the business purpose of the Flow.

data_api_version instance-attribute

data_api_version: NotRequired[MetaFlowDataApiVersion]

The data API version for data exchange endpoint Flows.

endpoint_uri instance-attribute

endpoint_uri: NotRequired[MetaFlowEndpointUri]

The HTTPS endpoint that Meta calls for a data exchange Flow.

flow_id instance-attribute

flow_id: MetaFlowId

The unique identifier of the Flow.

flow_name instance-attribute

flow_name: MetaFlowName

The name of the Flow.

flow_status instance-attribute

flow_status: MetaFlowStatus

The lifecycle status of the Flow. Valid values are DRAFT, PUBLISHED, DEPRECATED, BLOCKED, and THROTTLED.

health_status instance-attribute

health_status: NotRequired[MetaFlowHealthStatus]

The health status information for this Flow from Meta.

json_version instance-attribute

json_version: NotRequired[MetaFlowJsonVersion]

The version of the Flow JSON schema used by this Flow (for example, 7.3).

preview instance-attribute

preview: NotRequired[MetaFlowPreviewInfo]

The preview URL and its expiration timestamp for testing the Flow.

validation_errors instance-attribute

validation_errors: NotRequired[ValidationErrorList]

A list of validation errors from Meta, if any.

whats_app_business_account instance-attribute

whats_app_business_account: NotRequired[MetaFlowWhatsAppBusinessAccountInfo]

The WhatsApp Business Account information from Meta associated with this Flow.